a318ae03cd4167c65cdadd0e9b3aaa8f8369f807
[dragonfly.git] / sys / sys / pipe.h
1 /*
2  * Copyright (c) 1996 John S. Dyson
3  * 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 immediately at the beginning of the file, without modification,
10  *    this list of conditions, and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Absolutely no warranty of function or purpose is made by the author
15  *    John S. Dyson.
16  * 4. This work was done expressly for inclusion into FreeBSD.  Other use
17  *    is allowed if this notation is included.
18  * 5. Modifications may be freely made to this file if the above conditions
19  *    are met.
20  *
21  * $FreeBSD: src/sys/sys/pipe.h,v 1.16 1999/12/29 04:24:45 peter Exp $
22  * $DragonFly: src/sys/sys/pipe.h,v 1.10 2006/06/10 20:00:17 dillon Exp $
23  */
24
25 #ifndef _SYS_PIPE_H_
26 #define _SYS_PIPE_H_
27
28 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
29
30 #ifndef _SYS_TYPES_H_
31 #include <sys/types.h>
32 #endif
33 #ifndef _SYS_TIME_H_
34 #include <sys/time.h>                   /* for struct timespec */
35 #endif
36 #ifndef _SYS_SELINFO_H_
37 #include <sys/selinfo.h>                /* for struct selinfo */
38 #endif
39 #ifndef _SYS_XIO_H_
40 #include <sys/xio.h>                    /* for struct xio */
41 #endif
42 #ifndef _MACHINE_PARAM_H_
43 #include <machine/param.h>              /* for PAGE_SIZE */
44 #endif
45
46 /*
47  * Pipe buffer size, keep moderate in value, pipes take kva space.
48  * Must be a multiple of PAGE_SIZE.
49  */
50 #ifndef PIPE_SIZE
51 #define PIPE_SIZE       16384
52 #endif
53
54 #ifndef BIG_PIPE_SIZE
55 #define BIG_PIPE_SIZE   (64*1024)
56 #endif
57
58 #if PIPE_SIZE < PAGE_SIZE
59 #error "PIPE_SIZE is too small for this architecture"
60 #endif
61
62 /*
63  * Pipe buffer information.
64  * Separate in, out, cnt are used to simplify calculations.
65  * Buffered write is active when the buffer.cnt field is set.
66  */
67 struct pipebuf {
68         u_int   cnt;            /* number of chars currently in buffer */
69         u_int   in;             /* in pointer */
70         u_int   out;            /* out pointer */
71         u_int   size;           /* size of buffer */
72         caddr_t buffer;         /* kva of buffer */
73         struct  vm_object *object;      /* VM object containing buffer */
74 };
75
76 /*
77  * Bits in pipe_state.
78  */
79 #define PIPE_ASYNC      0x0004  /* Async? I/O */
80 #define PIPE_WANTR      0x0008  /* Reader wants some characters */
81 #define PIPE_WANTW      0x0010  /* Writer wants space to put characters */
82 #define PIPE_WANT       0x0020  /* Pipe is wanted to be run-down */
83 #define PIPE_SEL        0x0040  /* Pipe has a select active */
84 #define PIPE_EOF        0x0080  /* Pipe is in EOF condition */
85 #define PIPE_LOCK       0x0100  /* Process has exclusive access to pts/data */
86 #define PIPE_LWANT      0x0200  /* Process wants exclusive access to pts/data */
87
88 /*
89  * Per-pipe data structure.
90  * Two of these are linked together to produce bi-directional pipes.
91  */
92 struct pipe {
93         struct  pipebuf pipe_buffer;    /* data storage */
94         vm_offset_t pipe_kva;           /* kva mapping (testing only) */
95         struct  selinfo pipe_sel;       /* for compat with select */
96         struct  timespec pipe_atime;    /* time of last access */
97         struct  timespec pipe_mtime;    /* time of last modify */
98         struct  timespec pipe_ctime;    /* time of status change */
99         struct  sigio *pipe_sigio;      /* information for async I/O */
100         struct  pipe *pipe_peer;        /* link with other direction */
101         u_int   pipe_state;             /* pipe status info */
102         int     pipe_busy;              /* busy flag, mostly to handle rundown sanely */
103 };
104
105 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
106 #endif /* !_SYS_PIPE_H_ */