xref: /freebsd/sys/sys/uio.h (revision c697fb7f)
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  *	@(#)uio.h	8.5 (Berkeley) 2/22/94
32  * $FreeBSD$
33  */
34 
35 #ifndef _SYS_UIO_H_
36 #define	_SYS_UIO_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/_types.h>
40 #include <sys/_iovec.h>
41 #include <sys/_uio.h>
42 
43 #ifndef _SSIZE_T_DECLARED
44 typedef	__ssize_t	ssize_t;
45 #define	_SSIZE_T_DECLARED
46 #endif
47 
48 #ifndef _OFF_T_DECLARED
49 typedef	__off_t	off_t;
50 #define	_OFF_T_DECLARED
51 #endif
52 
53 #ifdef _KERNEL
54 
55 struct uio {
56 	struct	iovec *uio_iov;		/* scatter/gather list */
57 	int	uio_iovcnt;		/* length of scatter/gather list */
58 	off_t	uio_offset;		/* offset in target object */
59 	ssize_t	uio_resid;		/* remaining bytes to process */
60 	enum	uio_seg uio_segflg;	/* address space */
61 	enum	uio_rw uio_rw;		/* operation */
62 	struct	thread *uio_td;		/* owner */
63 };
64 
65 /*
66  * Limits
67  *
68  * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
69  * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
70  * we ever make this tunable (probably pointless), then IOV_MAX should be
71  * removed from <sys/syslimits.h> and applications would be expected to use
72  * sysconf(3) to find out the correct value, or else assume the worst
73  * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
74  * IOV_MAX.
75  */
76 #define UIO_MAXIOV	1024		/* max 1K of iov's */
77 
78 struct vm_object;
79 struct vm_page;
80 struct bus_dma_segment;
81 
82 struct uio *cloneuio(struct uio *uiop);
83 int	copyinfrom(const void * __restrict src, void * __restrict dst,
84 	    size_t len, int seg);
85 int	copyiniov(const struct iovec *iovp, u_int iovcnt, struct iovec **iov,
86 	    int error);
87 int	copyinstrfrom(const void * __restrict src, void * __restrict dst,
88 	    size_t len, size_t * __restrict copied, int seg);
89 int	copyinuio(const struct iovec *iovp, u_int iovcnt, struct uio **uiop);
90 int	copyout_map(struct thread *td, vm_offset_t *addr, size_t sz);
91 int	copyout_unmap(struct thread *td, vm_offset_t addr, size_t sz);
92 int	physcopyin(void *src, vm_paddr_t dst, size_t len);
93 int	physcopyout(vm_paddr_t src, void *dst, size_t len);
94 int	physcopyin_vlist(struct bus_dma_segment *src, off_t offset,
95 	    vm_paddr_t dst, size_t len);
96 int	physcopyout_vlist(vm_paddr_t src, struct bus_dma_segment *dst,
97 	    off_t offset, size_t len);
98 int	uiomove(void *cp, int n, struct uio *uio);
99 int	uiomove_frombuf(void *buf, int buflen, struct uio *uio);
100 int	uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
101 	    struct uio *uio);
102 int	uiomove_nofault(void *cp, int n, struct uio *uio);
103 int	uiomove_object(struct vm_object *obj, off_t obj_size, struct uio *uio);
104 
105 #else /* !_KERNEL */
106 
107 __BEGIN_DECLS
108 ssize_t	readv(int, const struct iovec *, int);
109 ssize_t	writev(int, const struct iovec *, int);
110 #if __BSD_VISIBLE
111 ssize_t	preadv(int, const struct iovec *, int, off_t);
112 ssize_t	pwritev(int, const struct iovec *, int, off_t);
113 #endif
114 __END_DECLS
115 
116 #endif /* _KERNEL */
117 
118 #endif /* !_SYS_UIO_H_ */
119