xref: /dragonfly/sys/sys/uio.h (revision fcce2b94)
1 /*
2  * Copyright (c) 1982, 1986, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)uio.h	8.5 (Berkeley) 2/22/94
34  * $FreeBSD: src/sys/sys/uio.h,v 1.11.2.1 2001/09/28 16:58:35 dillon Exp $
35  * $DragonFly: src/sys/sys/uio.h,v 1.14 2006/05/27 20:17:17 dillon Exp $
36  */
37 
38 #ifndef _SYS_UIO_H_
39 #define	_SYS_UIO_H_
40 
41 #ifndef _SYS_TYPES_H_
42 #include <sys/types.h>
43 #endif
44 #ifndef _SYS_PARAM_H_
45 #include <sys/param.h>
46 #endif
47 #ifndef _SYS_MALLOC_H_
48 #include <sys/malloc.h>		/* Needed to inline iovec_free(). */
49 #endif
50 
51 /*
52  * XXX
53  * iov_base should be a void *.
54  */
55 struct iovec {
56 	char	*iov_base;	/* Base address. */
57 	size_t	 iov_len;	/* Length. */
58 };
59 
60 enum	uio_rw { UIO_READ, UIO_WRITE };
61 
62 /* Segment flag values. */
63 enum uio_seg {
64 	UIO_USERSPACE,		/* from user data space */
65 	UIO_SYSSPACE,		/* from system space */
66 	UIO_NOCOPY		/* don't copy, already in object */
67 };
68 
69 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
70 
71 /*
72  * uio_td is primarily used for USERSPACE transfers, but some devices
73  * like ttys may also use it to get at the process.
74  */
75 struct uio {
76 	struct	iovec *uio_iov;
77 	int	uio_iovcnt;
78 	off_t	uio_offset;
79 	int	uio_resid;
80 	enum	uio_seg uio_segflg;
81 	enum	uio_rw uio_rw;
82 	struct	thread *uio_td;
83 };
84 
85 /*
86  * Limits
87  */
88 #define UIO_MAXIOV	1024		/* max 1K of iov's */
89 #define UIO_SMALLIOV	8		/* 8 on stack, else malloc */
90 
91 #endif
92 
93 #if defined(_KERNEL)
94 
95 struct vm_object;
96 struct vm_page;
97 
98 void	uio_yield (void);
99 int	uiomove (caddr_t, int, struct uio *);
100 int 	uiomove_frombuf (void *buf, int buflen, struct uio *uio);
101 int     uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
102 			    struct uio *uio);
103 int	uiomoveco (caddr_t, int, struct uio *, struct vm_object *);
104 int	uioread (int, struct uio *, struct vm_object *, int *);
105 int	iovec_copyin(struct iovec *, struct iovec **, struct iovec *,
106 			    size_t, int *);
107 
108 /*
109  * MPSAFE
110  */
111 static __inline void
112 iovec_free(struct iovec **kiov, struct iovec *siov)
113 {
114 	if (*kiov != siov) {
115 		FREE(*kiov, M_IOV);
116 		*kiov = NULL;
117 	}
118 }
119 
120 #else /* !_KERNEL */
121 
122 #include <sys/cdefs.h>
123 
124 __BEGIN_DECLS
125 ssize_t	readv(int, const struct iovec *, int);
126 ssize_t	writev(int, const struct iovec *, int);
127 ssize_t	preadv(int, const struct iovec *, int, off_t);
128 ssize_t	pwritev(int, const struct iovec *, int, off_t);
129 __END_DECLS
130 
131 #endif /* _KERNEL */
132 
133 #endif /* !_SYS_UIO_H_ */
134