bits/stropts.h

   1 /* Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 #ifndef _BITS_STROPTS_H
  20 #define _BITS_STROPTS_H 1
  21
  22 #include <bits/types.h>
  23
  24 /* Macros used as `request' argument to `ioctl'.  */
  25 #define __SID           ('S' << 8)
  26
  27 #define I_NREAD     (__SID | 1) /* Counts the number of data bytes in the data
  28                                    block in the first message.  */
  29 #define I_PUSH      (__SID | 2) /* Push STREAMS module onto top of the current
  30                                    STREAM, just below the STREAM head.  */
  31 #define I_POP       (__SID | 3) /* Remove STREAMS module from just below the
  32                                    STREAM head.  */
  33 #define I_LOOK      (__SID | 4) /* Retrieve the name of the module just below
  34                                    the STREAM head and place it in a character
  35                                    string.  */
  36 #define I_FLUSH     (__SID | 5) /* Flush all input and/or output.  */
  37 #define I_SRDOPT    (__SID | 6) /* Sets the read mode.  */
  38 #define I_GRDOPT    (__SID | 7) /* Returns the current read mode setting.  */
  39 #define I_STR       (__SID | 8) /* Construct an internal STREAMS `ioctl'
  40                                    message and send that message downstream. */
  41 #define I_SETSIG    (__SID | 9) /* Inform the STREAM head that the process
  42                                    wants the SIGPOLL signal issued.  */
  43 #define I_GETSIG    (__SID |10) /* Return the events for which the calling
  44                                    process is currently registered to be sent
  45                                    a SIGPOLL signal.  */
  46 #define I_FIND      (__SID |11) /* Compares the names of all modules currently
  47                                    present in the STREAM to the name pointed to
  48                                    by `arg'.  */
  49 #define I_LINK      (__SID |12) /* Connect two STREAMs.  */
  50 #define I_UNLINK    (__SID |13) /* Disconnects the two STREAMs.  */
  51 #define I_PEEK      (__SID |15) /* Allows a process to retrieve the information
  52                                    in the first message on the STREAM head read
  53                                    queue without taking the message off the
  54                                    queue.  */
  55 #define I_FDINSERT  (__SID |16) /* Create a message from the specified
  56                                    buffer(s), adds information about another
  57                                    STREAM, and send the message downstream.  */
  58 #define I_SENDFD    (__SID |17) /* Requests the STREAM associated with `fildes'
  59                                    to send a message, containing a file
  60                                    pointer, to the STREAM head at the other end
  61                                    of a STREAMS pipe.  */
  62 #define I_RECVFD    (__SID |14) /* Non-EFT definition.  */
  63 #define I_SWROPT    (__SID |19) /* Set the write mode.  */
  64 #define I_GWROPT    (__SID |20) /* Return the current write mode setting.  */
  65 #define I_LIST      (__SID |21) /* List all the module names on the STREAM, up
  66                                    to and including the topmost driver name. */
  67 #define I_PLINK     (__SID |22) /* Connect two STREAMs with a persistent
  68                                    link.  */
  69 #define I_PUNLINK   (__SID |23) /* Disconnect the two STREAMs that were
  70                                    connected with a persistent link.  */
  71 #define I_FLUSHBAND (__SID |28) /* Flush only band specified.  */
  72 #define I_CKBAND    (__SID |29) /* Check if the message of a given priority
  73                                    band exists on the STREAM head read
  74                                    queue.  */
  75 #define I_GETBAND   (__SID |30) /* Return the priority band of the first
  76                                    message on the STREAM head read queue.  */
  77 #define I_ATMARK    (__SID |31) /* See if the current message on the STREAM
  78                                    head read queue is "marked" by some module
  79                                    downstream.  */
  80 #define I_SETCLTIME (__SID |32) /* Set the time the STREAM head will delay when
  81                                    a STREAM is closing and there is data on
  82                                    the write queues.  */
  83 #define I_GETCLTIME (__SID |33) /* Get current value for closing timeout.  */
  84 #define I_CANPUT    (__SID |34) /* Check if a certain band is writable.  */
  85
  86
  87 /* Used in `I_LOOK' request.  */
  88 #define FMNAMESZ        8       /* compatibility w/UnixWare/Solaris.  */
  89
  90 /* Flush options.  */
  91 #define FLUSHR          0x01    /* Flush read queues.  */
  92 #define FLUSHW          0x02    /* Flush write queues.  */
  93 #define FLUSHRW         0x03    /* Flush read and write queues.  */
  94 #ifdef __USE_GNU
  95 # define FLUSHBAND      0x04    /* Flush only specified band.  */
  96 #endif
  97
  98 /* Possible arguments for `I_SETSIG'.  */
  99 #define S_INPUT         0x0001  /* A message, other than a high-priority
 100                                    message, has arrived.  */
 101 #define S_HIPRI         0x0002  /* A high-priority message is present.  */
 102 #define S_OUTPUT        0x0004  /* The write queue for normal data is no longer
 103                                    full.  */
 104 #define S_MSG           0x0008  /* A STREAMS signal message that contains the
 105                                    SIGPOLL signal reaches the front of the
 106                                    STREAM head read queue.  */
 107 #define S_ERROR         0x0010  /* Notification of an error condition.  */
 108 #define S_HANGUP        0x0020  /* Notification of a hangup.  */
 109 #define S_RDNORM        0x0040  /* A normal message has arrived.  */
 110 #define S_WRNORM        S_OUTPUT
 111 #define S_RDBAND        0x0080  /* A message with a non-zero priority has
 112                                    arrived.  */
 113 #define S_WRBAND        0x0100  /* The write queue for a non-zero priority
 114                                    band is no longer full.  */
 115 #define S_BANDURG       0x0200  /* When used in conjunction with S_RDBAND,
 116                                    SIGURG is generated instead of SIGPOLL when
 117                                    a priority message reaches the front of the
 118                                    STREAM head read queue.  */
 119
 120 /* Option for `I_PEEK'.  */
 121 #define RS_HIPRI        0x01    /* Only look for high-priority messages.  */
 122
 123 /* Options for `I_SRDOPT'.  */
 124 #define RNORM           0x0000  /* Byte-STREAM mode, the default.  */
 125 #define RMSGD           0x0001  /* Message-discard mode.   */
 126 #define RMSGN           0x0002  /* Message-nondiscard mode.   */
 127 #define RPROTDAT        0x0004  /* Deliver the control part of a message as
 128                                    data.  */
 129 #define RPROTDIS        0x0008  /* Discard the control part of a message,
 130                                    delivering any data part.  */
 131 #define RPROTNORM       0x0010  /* Fail `read' with EBADMSG if a message
 132                                    containing a control part is at the front
 133                                    of the STREAM head read queue.  */
 134 #ifdef __USE_GNU
 135 # define RPROTMASK      0x001C  /* The RPROT bits */
 136 #endif
 137
 138 /* Possible mode for `I_SWROPT'.  */
 139 #define SNDZERO         0x001   /* Send a zero-length message downstream when a
 140                                    `write' of 0 bytes occurs.  */
 141 #ifdef __USE_GNU
 142 # define SNDPIPE        0x002   /* Send SIGPIPE on write and putmsg if
 143                                    sd_werror is set.  */
 144 #endif
 145
 146 /* Arguments for `I_ATMARK'.  */
 147 #define ANYMARK         0x01    /* Check if the message is marked.  */
 148 #define LASTMARK        0x02    /* Check if the message is the last one marked
 149                                    on the queue.  */
 150
 151 /* Argument for `I_UNLINK'.  */
 152 #ifdef __USE_GNU
 153 # define MUXID_ALL      (-1)    /* Unlink all STREAMs linked to the STREAM
 154                                    associated with `fildes'.  */
 155 #endif
 156
 157
 158 /* Macros for `getmsg', `getpmsg', `putmsg' and `putpmsg'.  */
 159 #define MSG_HIPRI       0x01    /* Send/receive high priority message.  */
 160 #define MSG_ANY         0x02    /* Receive any message.  */
 161 #define MSG_BAND        0x04    /* Receive message from specified band.  */
 162
 163 /* Values returned by getmsg and getpmsg */
 164 #define MORECTL         1       /* More control information is left in
 165                                    message.  */
 166 #define MOREDATA        2       /* More data is left in message.  */
 167
 168
 169 /* Structure used for the I_FLUSHBAND ioctl on streams.  */
 170 struct bandinfo
 171   {
 172     unsigned char bi_pri;
 173     int bi_flag;
 174   };
 175
 176 struct strbuf
 177   {
 178     int maxlen;         /* Maximum buffer length.  */
 179     int len;            /* Length of data.  */
 180     char *buf;          /* Pointer to buffer.  */
 181   };
 182
 183 struct strpeek
 184   {
 185     struct strbuf ctlbuf;
 186     struct strbuf databuf;
 187     t_uscalar_t flags;                  /* UnixWare/Solaris compatibility.  */
 188   };
 189
 190 struct strfdinsert
 191   {
 192     struct strbuf ctlbuf;
 193     struct strbuf databuf;
 194     t_uscalar_t flags;                  /* UnixWare/Solaris compatibility.  */
 195     int fildes;
 196     int offset;
 197   };
 198
 199 struct strioctl
 200   {
 201     int ic_cmd;
 202     int ic_timout;
 203     int ic_len;
 204     char *ic_dp;
 205   };
 206
 207 struct strrecvfd
 208   {
 209     int fd;
 210     uid_t uid;
 211     gid_t gid;
 212     char __fill[8];                     /* UnixWare/Solaris compatibility */
 213   };
 214
 215
 216 struct str_mlist
 217   {
 218     char l_name[FMNAMESZ + 1];
 219   };
 220
 221 struct str_list
 222   {
 223     int sl_nmods;
 224     struct str_mlist *sl_modlist;
 225   };
 226
 227 #endif /* bits/stropts.h */