xref: /openbsd/sys/sys/uio.h (revision 2cfc28ad)
1 /*	$OpenBSD: uio.h,v 1.20 2024/10/26 05:39:03 jsg Exp $	*/
2 /*	$NetBSD: uio.h,v 1.12 1996/02/09 18:25:45 christos Exp $	*/
3 
4 /*
5  * Copyright (c) 1982, 1986, 1993, 1994
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)uio.h	8.5 (Berkeley) 2/22/94
33  */
34 
35 #ifndef _SYS_UIO_H_
36 #define	_SYS_UIO_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/_types.h>
40 
41 #ifndef	_SIZE_T_DEFINED_
42 #define	_SIZE_T_DEFINED_
43 typedef	__size_t	size_t;
44 #endif
45 
46 #ifndef	_SSIZE_T_DEFINED_
47 #define	_SSIZE_T_DEFINED_
48 typedef	__ssize_t	ssize_t;
49 #endif
50 
51 struct iovec {
52 	void	*iov_base;	/* Base address. */
53 	size_t	 iov_len;	/* Length. */
54 };
55 
56 #if __BSD_VISIBLE	/* needed by kdump */
57 enum	uio_rw { UIO_READ, UIO_WRITE };
58 
59 /* Segment flag values. */
60 enum uio_seg {
61 	UIO_USERSPACE,		/* from user data space */
62 	UIO_SYSSPACE		/* from system space */
63 };
64 #endif /* __BSD_VISIBLE */
65 
66 #ifdef _KERNEL
67 struct uio {
68 	struct	iovec *uio_iov;	/* pointer to array of iovecs */
69 	int	uio_iovcnt;	/* number of iovecs in array */
70 	off_t	uio_offset;	/* offset into file this uio corresponds to */
71 	size_t	uio_resid;	/* residual i/o count */
72 	enum	uio_seg uio_segflg; /* see above */
73 	enum	uio_rw uio_rw;	/* see above */
74 	struct	proc *uio_procp;/* associated thread or NULL */
75 };
76 
77 /*
78  * Limits
79  */
80 #define UIO_SMALLIOV	8		/* 8 on stack, else malloc */
81 #endif /* _KERNEL */
82 
83 #if __BSD_VISIBLE
84 #define UIO_MAXIOV	1024		/* Deprecated, use IOV_MAX instead */
85 #endif
86 
87 #ifndef	_KERNEL
88 __BEGIN_DECLS
89 #if __BSD_VISIBLE
90 ssize_t preadv(int, const struct iovec *, int, __off_t);
91 ssize_t pwritev(int, const struct iovec *, int, __off_t);
92 #endif /* __BSD_VISIBLE */
93 ssize_t	readv(int, const struct iovec *, int);
94 ssize_t	writev(int, const struct iovec *, int);
95 __END_DECLS
96 #else
97 int	ureadc(int c, struct uio *);
98 
99 int	iovec_copyin(const struct iovec *, struct iovec **, struct iovec *,
100 	    unsigned int, size_t *);
101 void	iovec_free(struct iovec *, unsigned int );
102 int	dofilereadv(struct proc *, int, struct uio *, int, register_t *);
103 int	dofilewritev(struct proc *, int, struct uio *, int, register_t *);
104 
105 #endif /* !_KERNEL */
106 
107 #endif /* !_SYS_UIO_H_ */
108