1/*-
2 * Copyright (c) 2015-2017 Nuxi, https://nuxi.nl/
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 *
25 * $FreeBSD: stable/11/sys/compat/cloudabi/cloudabi_util.h 328127 2018-01-18 13:43:09Z ed $
26 */
27
28#ifndef _CLOUDABI_UTIL_H_
29#define	_CLOUDABI_UTIL_H_
30
31#include <sys/socket.h>
32
33#include <contrib/cloudabi/cloudabi_types_common.h>
34
35struct file;
36struct sysentvec;
37struct thread;
38struct timespec;
39
40/* Fetches the time value of a clock. */
41int cloudabi_clock_time_get(struct thread *, cloudabi_clockid_t,
42    cloudabi_timestamp_t *);
43
44/* Converts a FreeBSD errno to a CloudABI errno. */
45cloudabi_errno_t cloudabi_convert_errno(int);
46
47/* Converts a file descriptor to a CloudABI file descriptor type. */
48cloudabi_filetype_t cloudabi_convert_filetype(const struct file *);
49
50/* Converts CloudABI rights to a set of Capsicum capabilities. */
51int cloudabi_convert_rights(cloudabi_rights_t, cap_rights_t *);
52
53/* Removes rights that conflict with the file descriptor type. */
54void cloudabi_remove_conflicting_rights(cloudabi_filetype_t,
55    cloudabi_rights_t *, cloudabi_rights_t *);
56
57/* Converts a struct timespec to a CloudABI timestamp. */
58int cloudabi_convert_timespec(const struct timespec *, cloudabi_timestamp_t *);
59
60/*
61 * Blocking futex functions.
62 *
63 * These functions are called by CloudABI's polling system calls to
64 * sleep on a lock or condition variable.
65 */
66int cloudabi_futex_condvar_wait(struct thread *, cloudabi_condvar_t *,
67    cloudabi_scope_t, cloudabi_lock_t *, cloudabi_scope_t, cloudabi_clockid_t,
68    cloudabi_timestamp_t, cloudabi_timestamp_t, bool);
69int cloudabi_futex_lock_rdlock(struct thread *, cloudabi_lock_t *,
70    cloudabi_scope_t, cloudabi_clockid_t, cloudabi_timestamp_t,
71    cloudabi_timestamp_t, bool);
72int cloudabi_futex_lock_wrlock(struct thread *, cloudabi_lock_t *,
73    cloudabi_scope_t, cloudabi_clockid_t, cloudabi_timestamp_t,
74    cloudabi_timestamp_t, bool);
75
76/* Socket operations. */
77int cloudabi_sock_recv(struct thread *, cloudabi_fd_t, struct iovec *, size_t,
78    cloudabi_fd_t *, size_t, cloudabi_riflags_t, size_t *, size_t *,
79    cloudabi_roflags_t *);
80int cloudabi_sock_send(struct thread *, cloudabi_fd_t, struct iovec *, size_t,
81    const cloudabi_fd_t *, size_t, size_t *);
82
83/* vDSO setup and teardown. */
84void cloudabi_vdso_init(struct sysentvec *, char *, char *);
85void cloudabi_vdso_destroy(struct sysentvec *);
86
87#endif
88