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.8 2006/05/20 02:42:13 dillon Exp $
  23  */
  24
  25 #ifndef _SYS_PIPE_H_
  26 #define _SYS_PIPE_H_
  27
  28 #ifndef _SYS_TYPES_H_
  29 #include <sys/types.h>
  30 #endif
  31 #ifndef _SYS_TIME_H_
  32 #include <sys/time.h>                   /* for struct timespec */
  33 #endif
  34 #ifndef _SYS_SELECT_H_
  35 #include <sys/select.h>                 /* for struct selinfo */
  36 #endif
  37 #ifndef _SYS_XIO_H_
  38 #include <sys/xio.h>                    /* for struct xio */
  39 #endif
  40 #ifndef _MACHINE_PARAM_H_
  41 #include <machine/param.h>              /* for PAGE_SIZE */
  42 #endif
  43
  44 /*
  45  * Pipe buffer size, keep moderate in value, pipes take kva space.
  46  */
  47 #ifndef PIPE_SIZE
  48 #define PIPE_SIZE       16384
  49 #endif
  50
  51 #ifndef BIG_PIPE_SIZE
  52 #define BIG_PIPE_SIZE   (64*1024)
  53 #endif
  54
  55 /*
  56  * PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
  57  * than PIPE_BUF.
  58  */
  59 #ifndef PIPE_MINDIRECT
  60 #define PIPE_MINDIRECT  8192
  61 #endif
  62
  63 /*
  64  * Pipe buffer information.
  65  * Separate in, out, cnt are used to simplify calculations.
  66  * Buffered write is active when the buffer.cnt field is set.
  67  */
  68 struct pipebuf {
  69         u_int   cnt;            /* number of chars currently in buffer */
  70         u_int   in;             /* in pointer */
  71         u_int   out;            /* out pointer */
  72         u_int   size;           /* size of buffer */
  73         caddr_t buffer;         /* kva of buffer */
  74         struct  vm_object *object;      /* VM object containing buffer */
  75 };
  76
  77 /*
  78  * Bits in pipe_state.
  79  */
  80 #define PIPE_ASYNC      0x0004  /* Async? I/O. */
  81 #define PIPE_WANTR      0x0008  /* Reader wants some characters. */
  82 #define PIPE_WANTW      0x0010  /* Writer wants space to put characters. */
  83 #define PIPE_WANT       0x0020  /* Pipe is wanted to be run-down. */
  84 #define PIPE_SEL        0x0040  /* Pipe has a select active. */
  85 #define PIPE_EOF        0x0080  /* Pipe is in EOF condition. */
  86 #define PIPE_LOCK       0x0100  /* Process has exclusive access to pointers/data. */
  87 #define PIPE_LWANT      0x0200  /* Process wants exclusive access to pointers/data. */
  88 #define PIPE_DIRECTW    0x0400  /* Pipe direct write active. */
  89 #define PIPE_DIRECTOK   0x0800  /* Direct mode ok. */
  90 #define PIPE_DIRECTIP   0x1000  /* Direct write buffer build in progress */
  91
  92 enum pipe_feature { PIPE_COPY, PIPE_KMEM, PIPE_SFBUF1, PIPE_SFBUF2 };
  93 /*
  94  * Per-pipe data structure.
  95  * Two of these are linked together to produce bi-directional pipes.
  96  *
  97  * NOTE: pipe_buffer.out has the dual purpose of tracking the copy offset
  98  * for both the direct write case (with the rest of pipe_buffer) and the
  99  * buffered write case (with pipe_map).
 100  */
 101 struct pipe {
 102         struct  pipebuf pipe_buffer;    /* data storage */
 103         struct  xio pipe_map;           /* mapping for direct I/O */
 104         vm_offset_t pipe_kva;           /* kva mapping (testing only) */
 105         cpumask_t pipe_kvamask;         /* kva cpu mask opt */
 106         struct  selinfo pipe_sel;       /* for compat with select */
 107         struct  timespec pipe_atime;    /* time of last access */
 108         struct  timespec pipe_mtime;    /* time of last modify */
 109         struct  timespec pipe_ctime;    /* time of status change */
 110         struct  sigio *pipe_sigio;      /* information for async I/O */
 111         struct  pipe *pipe_peer;        /* link with other direction */
 112         u_int   pipe_state;             /* pipe status info */
 113         enum pipe_feature pipe_feature; /* pipe transfer features */
 114         int     pipe_busy;              /* busy flag, mostly to handle rundown sanely */
 115 };
 116
 117 #endif /* !_SYS_PIPE_H_ */