a732ee325fb7809065ab582e8acc079e583dee90
[dragonfly.git] / sys / sys / uio.h
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  */
36
37 #ifndef _SYS_UIO_H_
38 #define _SYS_UIO_H_
39
40 #include <sys/_iovec.h>
41
42 #ifndef _SYS_TYPES_H_
43 #include <sys/types.h>
44 #endif
45 #ifndef _SYS_PARAM_H_
46 #include <sys/param.h>
47 #endif
48 #ifndef _SYS_MALLOC_H_
49 #include <sys/malloc.h>         /* Needed to inline iovec_free(). */
50 #endif
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  * NOTE: uio_resid: Previously used int and FreeBSD decided to use ssize_t,
68  *       but after reviewing use cases and in particular the fact that the
69  *       iov uses an unsigned quantity, DragonFly will use the (unsigned)
70  *       size_t.
71  */
72 struct uio {
73         struct  iovec *uio_iov;
74         int     uio_iovcnt;
75         off_t   uio_offset;
76         size_t  uio_resid;
77         enum    uio_seg uio_segflg;
78         enum    uio_rw uio_rw;
79         struct  thread *uio_td;
80 };
81
82 /*
83  * Limits
84  */
85 #define UIO_MAXIOV      1024            /* max 1K of iov's */
86 #define UIO_SMALLIOV    8               /* 8 on stack, else malloc */
87
88 #endif
89
90 #if defined(_KERNEL)
91
92 struct vm_object;
93 struct vm_page;
94
95 int     uiomove (caddr_t, size_t, struct uio *);
96 int     uiomovez (size_t, struct uio *);
97 int     uiomove_frombuf (void *buf, size_t buflen, struct uio *uio);
98 int     uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset,
99                             size_t n, struct uio *uio);
100 int     uioread (int, struct uio *, struct vm_object *, int *);
101 int     iovec_copyin(struct iovec *, struct iovec **, struct iovec *,
102                             size_t, size_t *);
103
104 /*
105  * MPSAFE
106  */
107 static __inline void
108 iovec_free(struct iovec **kiov, struct iovec *siov)
109 {
110         if (*kiov != siov) {
111                 kfree(*kiov, M_IOV);
112                 *kiov = NULL;
113         }
114 }
115
116 #else /* !_KERNEL */
117
118 #include <sys/cdefs.h>
119
120 __BEGIN_DECLS
121 ssize_t readv(int, const struct iovec *, int);
122 ssize_t writev(int, const struct iovec *, int);
123 ssize_t preadv(int, const struct iovec *, int, off_t);
124 ssize_t pwritev(int, const struct iovec *, int, off_t);
125 __END_DECLS
126
127 #endif /* _KERNEL */
128
129 #endif /* !_SYS_UIO_H_ */