2015-07-16 18:24:06 +00:00
|
|
|
/*-
|
2017-03-22 19:20:39 +00:00
|
|
|
* Copyright (c) 2015-2017 Nuxi, https://nuxi.nl/
|
2015-07-16 18:24:06 +00:00
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* $FreeBSD$
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _CLOUDABI_UTIL_H_
|
|
|
|
#define _CLOUDABI_UTIL_H_
|
|
|
|
|
2015-08-05 08:18:05 +00:00
|
|
|
#include <sys/socket.h>
|
|
|
|
|
2016-03-24 21:47:15 +00:00
|
|
|
#include <contrib/cloudabi/cloudabi_types_common.h>
|
2015-07-16 18:24:06 +00:00
|
|
|
|
Make fstat() and friends work.
Summary:
CloudABI provides access to two different stat structures:
- fdstat, containing file descriptor level status: oflags, file
descriptor type and Capsicum rights, used by cap_rights_get(),
fcntl(F_GETFL), getsockopt(SO_TYPE).
- filestat, containing your regular file status: timestamps, inode
number, used by fstat().
Unlike FreeBSD's stat::st_mode, CloudABI file descriptor types don't
have overloaded meanings (e.g., returning S_ISCHR() for kqueues). Add a
utility function to extract the type of a file descriptor accurately.
CloudABI does not work with O_ACCMODEs. File descriptors have two sets
of Capsicum-style rights: rights that apply to the file descriptor
itself ('base') and rights that apply to any new file descriptors
yielded through openat() ('inheriting'). Though not perfect, we can
pretty safely decompose Capsicum rights to such a pair. This is done in
convert_capabilities().
Test Plan: Tests for these system calls are fairly extensive in cloudlibc.
Reviewers: jonathan, mjg, #manpages
Reviewed By: mjg
Subscribers: imp
Differential Revision: https://reviews.freebsd.org/D3171
2015-07-28 06:36:49 +00:00
|
|
|
struct file;
|
2016-08-10 21:02:41 +00:00
|
|
|
struct sysentvec;
|
2015-07-27 10:07:29 +00:00
|
|
|
struct thread;
|
2015-07-21 15:08:13 +00:00
|
|
|
struct timespec;
|
|
|
|
|
2015-07-27 10:07:29 +00:00
|
|
|
/* Fetches the time value of a clock. */
|
|
|
|
int cloudabi_clock_time_get(struct thread *, cloudabi_clockid_t,
|
|
|
|
cloudabi_timestamp_t *);
|
|
|
|
|
2015-07-16 18:24:06 +00:00
|
|
|
/* Converts a FreeBSD errno to a CloudABI errno. */
|
|
|
|
cloudabi_errno_t cloudabi_convert_errno(int);
|
|
|
|
|
Make fstat() and friends work.
Summary:
CloudABI provides access to two different stat structures:
- fdstat, containing file descriptor level status: oflags, file
descriptor type and Capsicum rights, used by cap_rights_get(),
fcntl(F_GETFL), getsockopt(SO_TYPE).
- filestat, containing your regular file status: timestamps, inode
number, used by fstat().
Unlike FreeBSD's stat::st_mode, CloudABI file descriptor types don't
have overloaded meanings (e.g., returning S_ISCHR() for kqueues). Add a
utility function to extract the type of a file descriptor accurately.
CloudABI does not work with O_ACCMODEs. File descriptors have two sets
of Capsicum-style rights: rights that apply to the file descriptor
itself ('base') and rights that apply to any new file descriptors
yielded through openat() ('inheriting'). Though not perfect, we can
pretty safely decompose Capsicum rights to such a pair. This is done in
convert_capabilities().
Test Plan: Tests for these system calls are fairly extensive in cloudlibc.
Reviewers: jonathan, mjg, #manpages
Reviewed By: mjg
Subscribers: imp
Differential Revision: https://reviews.freebsd.org/D3171
2015-07-28 06:36:49 +00:00
|
|
|
/* Converts a file descriptor to a CloudABI file descriptor type. */
|
|
|
|
cloudabi_filetype_t cloudabi_convert_filetype(const struct file *);
|
|
|
|
|
Add file_open(): the underlying system call of openat().
CloudABI purely operates on file descriptor rights (CAP_*). File
descriptor access modes (O_ACCMODE) are emulated on top of rights.
Instead of accepting the traditional flags argument, file_open() copies
in an fdstat_t object that contains the initial rights the descriptor
should have, but also file descriptor flags that should persist after
opening (APPEND, NONBLOCK, *SYNC). Only flags that don't persist (EXCL,
TRUNC, CREAT, DIRECTORY) are passed in as an argument.
file_open() first converts the rights, the persistent flags and the
non-persistent flags to fflags. It then calls into vn_open(). If
successful, it installs the file descriptor with the requested
rights, trimming off rights that don't apply to the type of
the file that has been opened.
Unlike kern_openat(), this function does not support /dev/fd/*. I can't
think of a reason why we need to support this for CloudABI.
Obtained from: https://github.com/NuxiNL/freebsd
Differential Revision: https://reviews.freebsd.org/D3235
2015-08-06 06:47:28 +00:00
|
|
|
/* Converts CloudABI rights to a set of Capsicum capabilities. */
|
|
|
|
int cloudabi_convert_rights(cloudabi_rights_t, cap_rights_t *);
|
|
|
|
|
|
|
|
/* Removes rights that conflict with the file descriptor type. */
|
|
|
|
void cloudabi_remove_conflicting_rights(cloudabi_filetype_t,
|
|
|
|
cloudabi_rights_t *, cloudabi_rights_t *);
|
|
|
|
|
2015-07-21 15:08:13 +00:00
|
|
|
/* Converts a struct timespec to a CloudABI timestamp. */
|
|
|
|
int cloudabi_convert_timespec(const struct timespec *, cloudabi_timestamp_t *);
|
|
|
|
|
2015-07-27 10:07:29 +00:00
|
|
|
/*
|
|
|
|
* Blocking futex functions.
|
|
|
|
*
|
|
|
|
* These functions are called by CloudABI's polling system calls to
|
|
|
|
* sleep on a lock or condition variable.
|
|
|
|
*/
|
|
|
|
int cloudabi_futex_condvar_wait(struct thread *, cloudabi_condvar_t *,
|
2016-03-31 18:50:06 +00:00
|
|
|
cloudabi_scope_t, cloudabi_lock_t *, cloudabi_scope_t, cloudabi_clockid_t,
|
2018-01-04 21:57:37 +00:00
|
|
|
cloudabi_timestamp_t, cloudabi_timestamp_t, bool);
|
2015-07-27 10:07:29 +00:00
|
|
|
int cloudabi_futex_lock_rdlock(struct thread *, cloudabi_lock_t *,
|
2016-03-31 18:50:06 +00:00
|
|
|
cloudabi_scope_t, cloudabi_clockid_t, cloudabi_timestamp_t,
|
2018-01-04 21:57:37 +00:00
|
|
|
cloudabi_timestamp_t, bool);
|
2015-07-27 10:07:29 +00:00
|
|
|
int cloudabi_futex_lock_wrlock(struct thread *, cloudabi_lock_t *,
|
2016-03-31 18:50:06 +00:00
|
|
|
cloudabi_scope_t, cloudabi_clockid_t, cloudabi_timestamp_t,
|
2018-01-04 21:57:37 +00:00
|
|
|
cloudabi_timestamp_t, bool);
|
2015-07-27 10:07:29 +00:00
|
|
|
|
2017-03-22 06:43:10 +00:00
|
|
|
/* Socket operations. */
|
2017-03-22 19:20:39 +00:00
|
|
|
int cloudabi_sock_recv(struct thread *, cloudabi_fd_t, struct iovec *, size_t,
|
2017-07-26 06:57:15 +00:00
|
|
|
cloudabi_fd_t *, size_t, cloudabi_riflags_t, size_t *, size_t *,
|
|
|
|
cloudabi_roflags_t *);
|
2017-03-22 06:43:10 +00:00
|
|
|
int cloudabi_sock_send(struct thread *, cloudabi_fd_t, struct iovec *, size_t,
|
2017-07-26 06:57:15 +00:00
|
|
|
const cloudabi_fd_t *, size_t, size_t *);
|
2017-03-22 06:43:10 +00:00
|
|
|
|
2016-08-10 21:02:41 +00:00
|
|
|
/* vDSO setup and teardown. */
|
|
|
|
void cloudabi_vdso_init(struct sysentvec *, char *, char *);
|
|
|
|
void cloudabi_vdso_destroy(struct sysentvec *);
|
|
|
|
|
2015-07-16 18:24:06 +00:00
|
|
|
#endif
|