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$
  22  */
  23
  24 #ifndef _SYS_PIPE_H_
  25 #define _SYS_PIPE_H_
  26
  27 #ifndef _KERNEL
  28 #include <sys/time.h>                   /* for struct timespec */
  29 #include <sys/selinfo.h>                /* for struct selinfo */
  30 #include <vm/vm.h>                      /* for vm_page_t */
  31 #include <sys/_label.h>                 /* for struct label */
  32 #include <machine/param.h>              /* for PAGE_SIZE */
  33 #endif
  34
  35 /*
  36  * Pipe buffer size, keep moderate in value, pipes take kva space.
  37  */
  38 #ifndef PIPE_SIZE
  39 #define PIPE_SIZE       16384
  40 #endif
  41
  42 #ifndef BIG_PIPE_SIZE
  43 #define BIG_PIPE_SIZE   (64*1024)
  44 #endif
  45
  46 #ifndef SMALL_PIPE_SIZE
  47 #define SMALL_PIPE_SIZE PAGE_SIZE
  48 #endif
  49
  50 /*
  51  * PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
  52  * than PIPE_BUF.
  53  */
  54 #ifndef PIPE_MINDIRECT
  55 #define PIPE_MINDIRECT  8192
  56 #endif
  57
  58 #define PIPENPAGES      (BIG_PIPE_SIZE / PAGE_SIZE + 1)
  59
  60 /*
  61  * See sys_pipe.c for info on what these limits mean.
  62  */
  63 extern int      maxpipekva;
  64 extern int      maxpipekvawired;
  65
  66 /*
  67  * Pipe buffer information.
  68  * Separate in, out, cnt are used to simplify calculations.
  69  * Buffered write is active when the buffer.cnt field is set.
  70  */
  71 struct pipebuf {
  72         u_int   cnt;            /* number of chars currently in buffer */
  73         u_int   in;             /* in pointer */
  74         u_int   out;            /* out pointer */
  75         u_int   size;           /* size of buffer */
  76         caddr_t buffer;         /* kva of buffer */
  77 };
  78
  79 /*
  80  * Information to support direct transfers between processes for pipes.
  81  */
  82 struct pipemapping {
  83         vm_offset_t     kva;            /* kernel virtual address */
  84         vm_size_t       cnt;            /* number of chars in buffer */
  85         vm_size_t       pos;            /* current position of transfer */
  86         int             npages;         /* number of pages */
  87         vm_page_t       ms[PIPENPAGES]; /* pages in source process */
  88 };
  89
  90 /*
  91  * Bits in pipe_state.
  92  */
  93 #define PIPE_ASYNC      0x004   /* Async? I/O. */
  94 #define PIPE_WANTR      0x008   /* Reader wants some characters. */
  95 #define PIPE_WANTW      0x010   /* Writer wants space to put characters. */
  96 #define PIPE_WANT       0x020   /* Pipe is wanted to be run-down. */
  97 #define PIPE_SEL        0x040   /* Pipe has a select active. */
  98 #define PIPE_EOF        0x080   /* Pipe is in EOF condition. */
  99 #define PIPE_LOCKFL     0x100   /* Process has exclusive access to pointers/data. */
 100 #define PIPE_LWANT      0x200   /* Process wants exclusive access to pointers/data. */
 101 #define PIPE_DIRECTW    0x400   /* Pipe direct write active. */
 102 #define PIPE_DIRECTOK   0x800   /* Direct mode ok. */
 103
 104 /*
 105  * Per-pipe data structure.
 106  * Two of these are linked together to produce bi-directional pipes.
 107  */
 108 struct pipe {
 109         struct  pipebuf pipe_buffer;    /* data storage */
 110         struct  pipemapping pipe_map;   /* pipe mapping for direct I/O */
 111         struct  selinfo pipe_sel;       /* for compat with select */
 112         struct  timespec pipe_atime;    /* time of last access */
 113         struct  timespec pipe_mtime;    /* time of last modify */
 114         struct  timespec pipe_ctime;    /* time of status change */
 115         struct  sigio *pipe_sigio;      /* information for async I/O */
 116         struct  pipe *pipe_peer;        /* link with other direction */
 117         u_int   pipe_state;             /* pipe status info */
 118         int     pipe_busy;              /* busy flag, mostly to handle rundown sanely */
 119         struct  label *pipe_label;      /* pipe MAC label - shared */
 120         struct  mtx *pipe_mtxp;         /* shared mutex between both pipes */
 121 };
 122
 123 #define PIPE_MTX(pipe)          (pipe)->pipe_mtxp
 124 #define PIPE_LOCK(pipe)         mtx_lock(PIPE_MTX(pipe))
 125 #define PIPE_UNLOCK(pipe)       mtx_unlock(PIPE_MTX(pipe))
 126 #define PIPE_LOCK_ASSERT(pipe, type)  mtx_assert(PIPE_MTX(pipe), (type))
 127
 128
 129 #endif /* !_SYS_PIPE_H_ */