uio.h revision 104925 
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: head/sys/sys/uio.h 104925 2002-10-11 18:21:50Z mike $
35 */
36
37#ifndef _SYS_UIO_H_
38#define	_SYS_UIO_H_
39
40#include <sys/cdefs.h>
41#include <sys/_types.h>
42
43#ifndef _SIZE_T_DECLARED
44typedef	__size_t	size_t;
45#define	_SIZE_T_DECLARED
46#endif
47
48#ifndef _SSIZE_T_DECLARED
49typedef	__ssize_t	ssize_t;
50#define	_SSIZE_T_DECLARED
51#endif
52
53#ifndef _STRUCT_IOVEC_DECLARED
54#define	_STRUCT_IOVEC_DECLARED
55struct iovec {
56	void	*iov_base;	/* Base address. */
57	size_t	 iov_len;	/* Length. */
58};
59#endif
60
61#if __BSD_VISIBLE
62enum	uio_rw { UIO_READ, UIO_WRITE };
63
64/* Segment flag values. */
65enum uio_seg {
66	UIO_USERSPACE,		/* from user data space */
67	UIO_SYSSPACE,		/* from system space */
68	UIO_NOCOPY		/* don't copy, already in object */
69};
70#endif
71
72#ifdef _KERNEL
73
74struct uio {
75	struct	iovec *uio_iov;
76	int	uio_iovcnt;
77	off_t	uio_offset;
78	int	uio_resid;
79	enum	uio_seg uio_segflg;
80	enum	uio_rw uio_rw;
81	struct	thread *uio_td;
82};
83
84/*
85 * Limits
86 *
87 * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
88 * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
89 * we ever make this tunable (probably pointless), then IOV_MAX should be
90 * removed from <sys/syslimits.h> and applications would be expected to use
91 * sysconf(3) to find out the correct value, or else assume the worst
92 * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
93 * IOV_MAX.
94 */
95#define UIO_MAXIOV	1024		/* max 1K of iov's */
96#define UIO_SMALLIOV	8		/* 8 on stack, else malloc */
97
98struct vm_object;
99
100void	uio_yield(void);
101int	uiomove(caddr_t, int, struct uio *);
102int	uiomoveco(caddr_t, int, struct uio *, struct vm_object *, int);
103int	uioread(int, struct uio *, struct vm_object *, int *);
104int	copyinfrom(const void *src, void *dst, size_t len, int seg);
105int	copyinstrfrom(const void *src, void *dst, size_t len,
106	    size_t *copied, int seg);
107
108#else /* !_KERNEL */
109
110__BEGIN_DECLS
111ssize_t	readv(int, const struct iovec *, int);
112ssize_t	writev(int, const struct iovec *, int);
113__END_DECLS
114
115#endif /* _KERNEL */
116
117#endif /* !_SYS_UIO_H_ */
118