xref: /dragonfly/sys/sys/uio.h (revision 43b4d1bd)
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.9 2004/07/27 13:11:22 hmp Exp $
36  */
37 
38 #ifndef _SYS_UIO_H_
39 #define	_SYS_UIO_H_
40 
41 #include <sys/malloc.h>		/* Needed to inline iovec_free(). */
42 
43 /*
44  * XXX
45  * iov_base should be a void *.
46  */
47 struct iovec {
48 	char	*iov_base;	/* Base address. */
49 	size_t	 iov_len;	/* Length. */
50 };
51 
52 enum	uio_rw { UIO_READ, UIO_WRITE };
53 
54 /* Segment flag values. */
55 enum uio_seg {
56 	UIO_USERSPACE,		/* from user data space */
57 	UIO_SYSSPACE,		/* from system space */
58 	UIO_NOCOPY		/* don't copy, already in object */
59 };
60 
61 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
62 
63 /*
64  * uio_td is primarily used for USERSPACE transfers, but some devices
65  * like ttys may also use it to get at the process.
66  */
67 struct uio {
68 	struct	iovec *uio_iov;
69 	int	uio_iovcnt;
70 	off_t	uio_offset;
71 	int	uio_resid;
72 	enum	uio_seg uio_segflg;
73 	enum	uio_rw uio_rw;
74 	struct	thread *uio_td;
75 };
76 
77 /*
78  * Limits
79  */
80 #define UIO_MAXIOV	1024		/* max 1K of iov's */
81 #define UIO_SMALLIOV	8		/* 8 on stack, else malloc */
82 
83 #endif
84 
85 #if defined(_KERNEL)
86 
87 struct vm_object;
88 
89 void	uio_yield (void);
90 int	uiomove (caddr_t, int, struct uio *);
91 int 	uiomove_frombuf (void *buf, int buflen, struct uio *uio);
92 int     uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
93 			    struct uio *uio);
94 int	uiomoveco (caddr_t, int, struct uio *, struct vm_object *);
95 int	uioread (int, struct uio *, struct vm_object *, int *);
96 int	iovec_copyin(struct iovec *, struct iovec **, struct iovec *,
97 	size_t, size_t *);
98 
99 static __inline void
100 iovec_free(struct iovec **kiov, struct iovec *siov)
101 {
102 	if (*kiov != siov) {
103 		FREE(*kiov, M_IOV);
104 		*kiov = NULL;
105 	}
106 }
107 
108 #else /* !_KERNEL */
109 
110 #include <sys/cdefs.h>
111 
112 __BEGIN_DECLS
113 ssize_t	readv (int, const struct iovec *, int);
114 ssize_t	writev (int, const struct iovec *, int);
115 __END_DECLS
116 
117 #endif /* _KERNEL */
118 
119 #endif /* !_SYS_UIO_H_ */
120