uio.h revision 127976 
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 * 4. 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 * $FreeBSD: head/sys/sys/uio.h 127976 2004-04-07 04:19:52Z imp $
31 */
32
33#ifndef _SYS_UIO_H_
34#define	_SYS_UIO_H_
35
36#include <sys/cdefs.h>
37#include <sys/_types.h>
38#include <sys/_iovec.h>
39
40#ifndef _SSIZE_T_DECLARED
41typedef	__ssize_t	ssize_t;
42#define	_SSIZE_T_DECLARED
43#endif
44
45#if __BSD_VISIBLE
46enum	uio_rw { UIO_READ, UIO_WRITE };
47
48/* Segment flag values. */
49enum uio_seg {
50	UIO_USERSPACE,		/* from user data space */
51	UIO_SYSSPACE,		/* from system space */
52	UIO_NOCOPY		/* don't copy, already in object */
53};
54#endif
55
56#ifdef _KERNEL
57
58struct uio {
59	struct	iovec *uio_iov;
60	int	uio_iovcnt;
61	off_t	uio_offset;
62	int	uio_resid;
63	enum	uio_seg uio_segflg;
64	enum	uio_rw uio_rw;
65	struct	thread *uio_td;
66};
67
68/*
69 * Limits
70 *
71 * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
72 * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
73 * we ever make this tunable (probably pointless), then IOV_MAX should be
74 * removed from <sys/syslimits.h> and applications would be expected to use
75 * sysconf(3) to find out the correct value, or else assume the worst
76 * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
77 * IOV_MAX.
78 */
79#define UIO_MAXIOV	1024		/* max 1K of iov's */
80#define UIO_SMALLIOV	8		/* 8 on stack, else malloc */
81
82struct vm_object;
83struct vm_page;
84
85int	copyinfrom(const void * __restrict src, void * __restrict dst,
86	    size_t len, int seg);
87int	copyinstrfrom(const void * __restrict src, void * __restrict dst,
88	    size_t len, size_t * __restrict copied, int seg);
89void	uio_yield(void);
90int	uiofromiov(struct iovec *iovp, u_int iovcnt, struct uio *auio);
91int	uiomove(void *cp, int n, struct uio *uio);
92int	uiomove_frombuf(void *buf, int buflen, struct uio *uio);
93int	uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
94	    struct uio *uio);
95int	uiomoveco(void *cp, int n, struct uio *uio, struct vm_object *obj,
96	    int disposable);
97
98#else /* !_KERNEL */
99
100__BEGIN_DECLS
101ssize_t	readv(int, const struct iovec *, int);
102ssize_t	writev(int, const struct iovec *, int);
103__END_DECLS
104
105#endif /* _KERNEL */
106
107#endif /* !_SYS_UIO_H_ */
108