xref: /dragonfly/sys/sys/_uio.h (revision d8082429)
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. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)uio.h	8.5 (Berkeley) 2/22/94
30  */
31 
32 #ifndef _SYS__UIO_H_
33 #define	_SYS__UIO_H_
34 
35 /*
36  * Do not include this header outside _KERNEL or _KERNEL_STRUCTURES scopes.
37  * Used in <sys/user.h>.
38  */
39 
40 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
41 enum uio_rw {
42 	UIO_READ,
43 	UIO_WRITE
44 };
45 
46 /* Segment flag values. */
47 enum uio_seg {
48 	UIO_USERSPACE,		/* from user data space */
49 	UIO_SYSSPACE,		/* from system space */
50 	UIO_NOCOPY		/* don't copy, already in object */
51 };
52 
53 struct iovec;
54 struct thread;
55 
56 /*
57  * uio_td is primarily used for USERSPACE transfers, but some devices
58  * like ttys may also use it to get at the process.
59  *
60  * NOTE: uio_resid: Previously used int and FreeBSD decided to use ssize_t,
61  *	 but after reviewing use cases and in particular the fact that the
62  *	 iov uses an unsigned quantity, DragonFly will use the (unsigned)
63  *	 size_t.
64  */
65 struct uio {
66 	struct	iovec *uio_iov;
67 	int	uio_iovcnt;
68 	off_t	uio_offset;
69 	size_t	uio_resid;
70 	enum	uio_seg uio_segflg;
71 	enum	uio_rw uio_rw;
72 	struct	thread *uio_td;
73 };
74 #endif /* _KERNEL || _KERNEL_STRUCTURES */
75 
76 #endif /* !_SYS__UIO_H_ */
77