1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1986, 1993, 1994
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_UIO_H_
33#define	_SYS_UIO_H_
34
35#include <sys/cdefs.h>
36#include <sys/_types.h>
37#include <sys/_iovec.h>
38#include <sys/_uio.h>
39
40#ifndef _SSIZE_T_DECLARED
41typedef	__ssize_t	ssize_t;
42#define	_SSIZE_T_DECLARED
43#endif
44
45#ifndef _OFF_T_DECLARED
46typedef	__off_t	off_t;
47#define	_OFF_T_DECLARED
48#endif
49
50#ifdef _KERNEL
51
52struct uio {
53	struct	iovec *uio_iov;		/* scatter/gather list */
54	int	uio_iovcnt;		/* length of scatter/gather list */
55	off_t	uio_offset;		/* offset in target object */
56	ssize_t	uio_resid;		/* remaining bytes to process */
57	enum	uio_seg uio_segflg;	/* address space */
58	enum	uio_rw uio_rw;		/* operation */
59	struct	thread *uio_td;		/* owner */
60};
61
62/*
63 * Limits
64 *
65 * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
66 * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
67 * we ever make this tunable (probably pointless), then IOV_MAX should be
68 * removed from <sys/syslimits.h> and applications would be expected to use
69 * sysconf(3) to find out the correct value, or else assume the worst
70 * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
71 * IOV_MAX.
72 */
73#define UIO_MAXIOV	1024		/* max 1K of iov's */
74
75struct vm_object;
76struct vm_page;
77struct bus_dma_segment;
78
79struct uio *allocuio(u_int iovcnt);
80void	freeuio(struct uio *uio);
81struct uio *cloneuio(struct uio *uiop);
82int	copyiniov(const struct iovec *iovp, u_int iovcnt, struct iovec **iov,
83	    int error);
84int	copyinuio(const struct iovec *iovp, u_int iovcnt, struct uio **uiop);
85int	copyout_map(struct thread *td, vm_offset_t *addr, size_t sz);
86int	copyout_unmap(struct thread *td, vm_offset_t addr, size_t sz);
87int	physcopyin(void *src, vm_paddr_t dst, size_t len);
88int	physcopyout(vm_paddr_t src, void *dst, size_t len);
89int	physcopyin_vlist(struct bus_dma_segment *src, off_t offset,
90	    vm_paddr_t dst, size_t len);
91int	physcopyout_vlist(vm_paddr_t src, struct bus_dma_segment *dst,
92	    off_t offset, size_t len);
93int	uiomove(void *cp, int n, struct uio *uio);
94int	uiomove_frombuf(void *buf, int buflen, struct uio *uio);
95int	uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
96	    struct uio *uio);
97int	uiomove_nofault(void *cp, int n, struct uio *uio);
98int	uiomove_object(struct vm_object *obj, off_t obj_size, struct uio *uio);
99
100#else /* !_KERNEL */
101
102__BEGIN_DECLS
103ssize_t	readv(int, const struct iovec *, int);
104ssize_t	writev(int, const struct iovec *, int);
105#if __BSD_VISIBLE
106ssize_t	preadv(int, const struct iovec *, int, off_t);
107ssize_t	pwritev(int, const struct iovec *, int, off_t);
108#endif
109__END_DECLS
110
111#endif /* _KERNEL */
112
113#endif /* !_SYS_UIO_H_ */
114