Back to index

glibc  2.9
stropts.h
Go to the documentation of this file.
00001 /* Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
00002    This file is part of the GNU C Library.
00003 
00004    The GNU C Library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Lesser General Public
00006    License as published by the Free Software Foundation; either
00007    version 2.1 of the License, or (at your option) any later version.
00008 
00009    The GNU C Library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Lesser General Public License for more details.
00013 
00014    You should have received a copy of the GNU Lesser General Public
00015    License along with the GNU C Library; if not, write to the Free
00016    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00017    02111-1307 USA.  */
00018 
00019 #ifndef _STROPTS_H
00020 # error "Never include <bits/stropts.h> directly; use <stropts.h> instead."
00021 #endif
00022 
00023 #ifndef _BITS_STROPTS_H
00024 #define _BITS_STROPTS_H     1
00025 
00026 #include <bits/types.h>
00027 
00028 /* Macros used as `request' argument to `ioctl'.  */
00029 #define __SID        ('S' << 8)
00030 
00031 #define I_NREAD          (__SID | 1)      /* Counts the number of data bytes in the data
00032                                block in the first message.  */
00033 #define I_PUSH           (__SID | 2)      /* Push STREAMS module onto top of the current
00034                                STREAM, just below the STREAM head.  */
00035 #define I_POP     (__SID | 3)      /* Remove STREAMS module from just below the
00036                                STREAM head.  */
00037 #define I_LOOK           (__SID | 4)      /* Retrieve the name of the module just below
00038                                the STREAM head and place it in a character
00039                                string.  */
00040 #define I_FLUSH          (__SID | 5)      /* Flush all input and/or output.  */
00041 #define I_SRDOPT    (__SID | 6)    /* Sets the read mode.  */
00042 #define I_GRDOPT    (__SID | 7)    /* Returns the current read mode setting.  */
00043 #define I_STR     (__SID | 8)      /* Construct an internal STREAMS `ioctl'
00044                                message and send that message downstream. */
00045 #define I_SETSIG    (__SID | 9)    /* Inform the STREAM head that the process
00046                                wants the SIGPOLL signal issued.  */
00047 #define I_GETSIG    (__SID |10) /* Return the events for which the calling
00048                                process is currently registered to be sent
00049                                a SIGPOLL signal.  */
00050 #define I_FIND           (__SID |11) /* Compares the names of all modules currently
00051                                present in the STREAM to the name pointed to
00052                                by `arg'.  */
00053 #define I_LINK           (__SID |12) /* Connect two STREAMs.  */
00054 #define I_UNLINK    (__SID |13) /* Disconnects the two STREAMs.  */
00055 #define I_PEEK           (__SID |15) /* Allows a process to retrieve the information
00056                                in the first message on the STREAM head read
00057                                queue without taking the message off the
00058                                queue.  */
00059 #define I_FDINSERT  (__SID |16) /* Create a message from the specified
00060                                buffer(s), adds information about another
00061                                STREAM, and send the message downstream.  */
00062 #define I_SENDFD    (__SID |17) /* Requests the STREAM associated with `fildes'
00063                                to send a message, containing a file
00064                                pointer, to the STREAM head at the other end
00065                                of a STREAMS pipe.  */
00066 #define I_RECVFD    (__SID |14) /* Non-EFT definition.  */
00067 #define I_SWROPT    (__SID |19) /* Set the write mode.  */
00068 #define I_GWROPT    (__SID |20) /* Return the current write mode setting.  */
00069 #define I_LIST           (__SID |21) /* List all the module names on the STREAM, up
00070                                to and including the topmost driver name. */
00071 #define I_PLINK          (__SID |22) /* Connect two STREAMs with a persistent
00072                                link.  */
00073 #define I_PUNLINK   (__SID |23) /* Disconnect the two STREAMs that were
00074                                connected with a persistent link.  */
00075 #define I_FLUSHBAND (__SID |28) /* Flush only band specified.  */
00076 #define I_CKBAND    (__SID |29) /* Check if the message of a given priority
00077                                band exists on the STREAM head read
00078                                queue.  */
00079 #define I_GETBAND   (__SID |30) /* Return the priority band of the first
00080                                message on the STREAM head read queue.  */
00081 #define I_ATMARK    (__SID |31) /* See if the current message on the STREAM
00082                                head read queue is "marked" by some module
00083                                downstream.  */
00084 #define I_SETCLTIME (__SID |32) /* Set the time the STREAM head will delay when
00085                                a STREAM is closing and there is data on
00086                                the write queues.  */
00087 #define I_GETCLTIME (__SID |33) /* Get current value for closing timeout.  */
00088 #define I_CANPUT    (__SID |34) /* Check if a certain band is writable.  */
00089 
00090 
00091 /* Used in `I_LOOK' request.  */
00092 #define FMNAMESZ     8      /* compatibility w/UnixWare/Solaris.  */
00093 
00094 /* Flush options.  */
00095 #define FLUSHR              0x01   /* Flush read queues.  */
00096 #define FLUSHW              0x02   /* Flush write queues.  */
00097 #define FLUSHRW             0x03   /* Flush read and write queues.  */
00098 #ifdef __USE_GNU
00099 # define FLUSHBAND   0x04   /* Flush only specified band.  */
00100 #endif
00101 
00102 /* Possible arguments for `I_SETSIG'.  */
00103 #define S_INPUT             0x0001 /* A message, other than a high-priority
00104                                message, has arrived.  */
00105 #define S_HIPRI             0x0002 /* A high-priority message is present.  */
00106 #define S_OUTPUT     0x0004 /* The write queue for normal data is no longer
00107                                full.  */
00108 #define S_MSG        0x0008 /* A STREAMS signal message that contains the
00109                                SIGPOLL signal reaches the front of the
00110                                STREAM head read queue.  */
00111 #define S_ERROR             0x0010 /* Notification of an error condition.  */
00112 #define S_HANGUP     0x0020 /* Notification of a hangup.  */
00113 #define S_RDNORM     0x0040 /* A normal message has arrived.  */
00114 #define S_WRNORM     S_OUTPUT
00115 #define S_RDBAND     0x0080 /* A message with a non-zero priority has
00116                                arrived.  */
00117 #define S_WRBAND     0x0100 /* The write queue for a non-zero priority
00118                                band is no longer full.  */
00119 #define S_BANDURG    0x0200 /* When used in conjunction with S_RDBAND,
00120                                SIGURG is generated instead of SIGPOLL when
00121                                a priority message reaches the front of the
00122                                STREAM head read queue.  */
00123 
00124 /* Option for `I_PEEK'.  */
00125 #define RS_HIPRI     0x01   /* Only look for high-priority messages.  */
00126 
00127 /* Options for `I_SRDOPT'.  */
00128 #define RNORM        0x0000 /* Byte-STREAM mode, the default.  */
00129 #define RMSGD        0x0001 /* Message-discard mode.   */
00130 #define RMSGN        0x0002 /* Message-nondiscard mode.   */
00131 #define RPROTDAT     0x0004 /* Deliver the control part of a message as
00132                                data.  */
00133 #define RPROTDIS     0x0008 /* Discard the control part of a message,
00134                                delivering any data part.  */
00135 #define RPROTNORM    0x0010 /* Fail `read' with EBADMSG if a message
00136                                containing a control part is at the front
00137                                of the STREAM head read queue.  */
00138 #ifdef __USE_GNU
00139 # define RPROTMASK   0x001C /* The RPROT bits */
00140 #endif
00141 
00142 /* Possible mode for `I_SWROPT'.  */
00143 #define SNDZERO             0x001  /* Send a zero-length message downstream when a
00144                                `write' of 0 bytes occurs.  */
00145 #ifdef __USE_GNU
00146 # define SNDPIPE     0x002  /* Send SIGPIPE on write and putmsg if
00147                                sd_werror is set.  */
00148 #endif
00149 
00150 /* Arguments for `I_ATMARK'.  */
00151 #define ANYMARK             0x01   /* Check if the message is marked.  */
00152 #define LASTMARK     0x02   /* Check if the message is the last one marked
00153                                on the queue.  */
00154 
00155 /* Argument for `I_UNLINK'.  */
00156 #ifdef __USE_GNU
00157 # define MUXID_ALL   (-1)   /* Unlink all STREAMs linked to the STREAM
00158                                associated with `fildes'.  */
00159 #endif
00160 
00161 
00162 /* Macros for `getmsg', `getpmsg', `putmsg' and `putpmsg'.  */
00163 #define MSG_HIPRI    0x01   /* Send/receive high priority message.  */
00164 #define MSG_ANY             0x02   /* Receive any message.  */
00165 #define MSG_BAND     0x04   /* Receive message from specified band.  */
00166 
00167 /* Values returned by getmsg and getpmsg */
00168 #define MORECTL             1      /* More control information is left in
00169                                message.  */
00170 #define MOREDATA     2      /* More data is left in message.  */
00171 
00172 
00173 /* Structure used for the I_FLUSHBAND ioctl on streams.  */
00174 struct bandinfo
00175   {
00176     unsigned char bi_pri;
00177     int bi_flag;
00178   };
00179 
00180 struct strbuf
00181   {
00182     int maxlen;             /* Maximum buffer length.  */
00183     int len;         /* Length of data.  */
00184     char *buf;              /* Pointer to buffer.  */
00185   };
00186 
00187 struct strpeek
00188   {
00189     struct strbuf ctlbuf;
00190     struct strbuf databuf;
00191     t_uscalar_t flags;                    /* UnixWare/Solaris compatibility.  */
00192   };
00193 
00194 struct strfdinsert
00195   {
00196     struct strbuf ctlbuf;
00197     struct strbuf databuf;
00198     t_uscalar_t flags;                    /* UnixWare/Solaris compatibility.  */
00199     int fildes;
00200     int offset;
00201   };
00202 
00203 struct strioctl
00204   {
00205     int ic_cmd;
00206     int ic_timout;
00207     int ic_len;
00208     char *ic_dp;
00209   };
00210 
00211 struct strrecvfd
00212   {
00213     int fd;
00214     uid_t uid;
00215     gid_t gid;
00216     char __fill[8];                /* UnixWare/Solaris compatibility */
00217   };
00218 
00219 
00220 struct str_mlist
00221   {
00222     char l_name[FMNAMESZ + 1];
00223   };
00224 
00225 struct str_list
00226   {
00227     int sl_nmods;
00228     struct str_mlist *sl_modlist;
00229   };
00230 
00231 #endif /* bits/stropts.h */