sysdeps/unix/sysv/linux/mips/bits/socket.h

   1 /* System-specific socket constants and types.  Linux/MIPS version.
   2    Copyright (C) 1991, 92, 1994-1999, 2000, 2001, 2004
   3         Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef __BITS_SOCKET_H
  22 #define __BITS_SOCKET_H
  23
  24 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
  25 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
  26 #endif
  27
  28 #define __need_size_t
  29 #define __need_NULL
  30 #include <stddef.h>
  31
  32 #include <limits.h>
  33 #include <sys/types.h>
  34
  35 /* Type for length arguments in socket calls.  */
  36 #ifndef __socklen_t_defined
  37 typedef __socklen_t socklen_t;
  38 # define __socklen_t_defined
  39 #endif
  40
  41 /* Types of sockets.  */
  42 enum __socket_type
  43 {
  44   SOCK_DGRAM = 1,               /* Connectionless, unreliable datagrams
  45                                    of fixed maximum length.  */
  46 #define SOCK_DGRAM SOCK_DGRAM
  47   SOCK_STREAM = 2,              /* Sequenced, reliable, connection-based
  48                                    byte streams.  */
  49 #define SOCK_STREAM SOCK_STREAM
  50   SOCK_RAW = 3,                 /* Raw protocol interface.  */
  51 #define SOCK_RAW SOCK_RAW
  52   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
  53 #define SOCK_RDM SOCK_RDM
  54   SOCK_SEQPACKET = 5,           /* Sequenced, reliable, connection-based,
  55                                    datagrams of fixed maximum length.  */
  56 #define SOCK_SEQPACKET SOCK_SEQPACKET
  57   SOCK_PACKET = 10              /* Linux specific way of getting packets
  58                                    at the dev level.  For writing rarp and
  59                                    other similar things on the user level. */
  60 #define SOCK_PACKET SOCK_PACKET
  61 };
  62
  63 /* Protocol families.  */
  64 #define PF_UNSPEC       0       /* Unspecified.  */
  65 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
  66 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
  67 #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
  68 #define PF_INET         2       /* IP protocol family.  */
  69 #define PF_AX25         3       /* Amateur Radio AX.25.  */
  70 #define PF_IPX          4       /* Novell Internet Protocol.  */
  71 #define PF_APPLETALK    5       /* Appletalk DDP.  */
  72 #define PF_NETROM       6       /* Amateur radio NetROM.  */
  73 #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
  74 #define PF_ATMPVC       8       /* ATM PVCs.  */
  75 #define PF_X25          9       /* Reserved for X.25 project.  */
  76 #define PF_INET6        10      /* IP version 6.  */
  77 #define PF_ROSE         11      /* Amateur Radio X.25 PLP.  */
  78 #define PF_DECnet       12      /* Reserved for DECnet project.  */
  79 #define PF_NETBEUI      13      /* Reserved for 802.2LLC project.  */
  80 #define PF_SECURITY     14      /* Security callback pseudo AF.  */
  81 #define PF_KEY          15      /* PF_KEY key management API.  */
  82 #define PF_NETLINK      16
  83 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
  84 #define PF_PACKET       17      /* Packet family.  */
  85 #define PF_ASH          18      /* Ash.  */
  86 #define PF_ECONET       19      /* Acorn Econet.  */
  87 #define PF_ATMSVC       20      /* ATM SVCs.  */
  88 #define PF_SNA          22      /* Linux SNA Project */
  89 #define PF_IRDA         23      /* IRDA sockets.  */
  90 #define PF_PPPOX        24      /* PPPoX sockets.  */
  91 #define PF_WANPIPE      25      /* Wanpipe API sockets.  */
  92 #define PF_BLUETOOTH    31      /* Bluetooth sockets.  */
  93 #define PF_MAX          32      /* For now..  */
  94
  95 /* Address families.  */
  96 #define AF_UNSPEC       PF_UNSPEC
  97 #define AF_LOCAL        PF_LOCAL
  98 #define AF_UNIX         PF_UNIX
  99 #define AF_FILE         PF_FILE
 100 #define AF_INET         PF_INET
 101 #define AF_AX25         PF_AX25
 102 #define AF_IPX          PF_IPX
 103 #define AF_APPLETALK    PF_APPLETALK
 104 #define AF_NETROM       PF_NETROM
 105 #define AF_BRIDGE       PF_BRIDGE
 106 #define AF_ATMPVC       PF_ATMPVC
 107 #define AF_X25          PF_X25
 108 #define AF_INET6        PF_INET6
 109 #define AF_ROSE         PF_ROSE
 110 #define AF_DECnet       PF_DECnet
 111 #define AF_NETBEUI      PF_NETBEUI
 112 #define AF_SECURITY     PF_SECURITY
 113 #define AF_KEY          PF_KEY
 114 #define AF_NETLINK      PF_NETLINK
 115 #define AF_ROUTE        PF_ROUTE
 116 #define AF_PACKET       PF_PACKET
 117 #define AF_ASH          PF_ASH
 118 #define AF_ECONET       PF_ECONET
 119 #define AF_ATMSVC       PF_ATMSVC
 120 #define AF_SNA          PF_SNA
 121 #define AF_IRDA         PF_IRDA
 122 #define AF_PPPOX        PF_PPPOX
 123 #define AF_WANPIPE      PF_WANPIPE
 124 #define AF_BLUETOOTH    PF_BLUETOOTH
 125 #define AF_MAX          PF_MAX
 126
 127 /* Socket level values.  Others are defined in the appropriate headers.
 128
 129    XXX These definitions also should go into the appropriate headers as
 130    far as they are available.  */
 131 #define SOL_RAW         255
 132 #define SOL_DECNET      261
 133 #define SOL_X25         262
 134 #define SOL_PACKET      263
 135 #define SOL_ATM         264     /* ATM layer (cell level).  */
 136 #define SOL_AAL         265     /* ATM Adaption Layer (packet level).  */
 137 #define SOL_IRDA        266
 138
 139 /* Maximum queue length specifiable by listen.  */
 140 #define SOMAXCONN       128
 141
 142 /* Get the definition of the macro to define the common sockaddr members.  */
 143 #include <bits/sockaddr.h>
 144
 145 /* Structure describing a generic socket address.  */
 146 struct sockaddr
 147   {
 148     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 149     char sa_data[14];           /* Address data.  */
 150   };
 151
 152
 153 /* Structure large enough to hold any socket address (with the historical
 154    exception of AF_UNIX).  We reserve 128 bytes.  */
 155 #if ULONG_MAX > 0xffffffff
 156 # define __ss_aligntype __uint64_t
 157 #else
 158 # define __ss_aligntype __uint32_t
 159 #endif
 160 #define _SS_SIZE        128
 161 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
 162
 163 struct sockaddr_storage
 164   {
 165     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
 166     __ss_aligntype __ss_align;  /* Force desired alignment.  */
 167     char __ss_padding[_SS_PADSIZE];
 168   };
 169
 170
 171 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 172 enum
 173   {
 174     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 175 #define MSG_OOB         MSG_OOB
 176     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 177 #define MSG_PEEK        MSG_PEEK
 178     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 179 #define MSG_DONTROUTE   MSG_DONTROUTE
 180 #ifdef __USE_GNU
 181     /* DECnet uses a different name.  */
 182     MSG_TRYHARD         = MSG_DONTROUTE,
 183 # define MSG_TRYHARD    MSG_DONTROUTE
 184 #endif
 185     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 186 #define MSG_CTRUNC      MSG_CTRUNC
 187     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
 188 #define MSG_PROXY       MSG_PROXY
 189     MSG_TRUNC           = 0x20,
 190 #define MSG_TRUNC       MSG_TRUNC
 191     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
 192 #define MSG_DONTWAIT    MSG_DONTWAIT
 193     MSG_EOR             = 0x80, /* End of record.  */
 194 #define MSG_EOR         MSG_EOR
 195     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
 196 #define MSG_WAITALL     MSG_WAITALL
 197     MSG_FIN             = 0x200,
 198 #define MSG_FIN         MSG_FIN
 199     MSG_SYN             = 0x400,
 200 #define MSG_SYN         MSG_SYN
 201     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
 202 #define MSG_CONFIRM     MSG_CONFIRM
 203     MSG_RST             = 0x1000,
 204 #define MSG_RST         MSG_RST
 205     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
 206 #define MSG_ERRQUEUE    MSG_ERRQUEUE
 207     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
 208 #define MSG_NOSIGNAL    MSG_NOSIGNAL
 209     MSG_MORE            = 0x8000  /* Sender will send more.  */
 210 #define MSG_MORE        MSG_MORE
 211   };
 212
 213
 214 /* Structure describing messages sent by
 215    `sendmsg' and received by `recvmsg'.  */
 216 struct msghdr
 217   {
 218     void *msg_name;             /* Address to send to/receive from.  */
 219     socklen_t msg_namelen;      /* Length of address data.  */
 220
 221     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 222     int msg_iovlen;             /* Number of elements in the vector.  */
 223
 224     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
 225     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
 226
 227     int msg_flags;              /* Flags on received message.  */
 228   };
 229
 230 /* Structure used for storage of ancillary data object information.  */
 231 struct cmsghdr
 232   {
 233     size_t cmsg_len;            /* Length of data in cmsg_data plus length
 234                                    of cmsghdr structure.  */
 235     int cmsg_level;             /* Originating protocol.  */
 236     int cmsg_type;              /* Protocol specific type.  */
 237 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 238     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
 239 #endif
 240   };
 241
 242 /* Ancillary data object manipulation macros.  */
 243 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 244 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 245 #else
 246 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 247 #endif
 248 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 249 #define CMSG_FIRSTHDR(mhdr) \
 250   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 251    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
 252 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
 253                          & (size_t) ~(sizeof (size_t) - 1))
 254 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
 255                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
 256 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
 257
 258 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
 259                                       struct cmsghdr *__cmsg) __THROW;
 260 #ifdef __USE_EXTERN_INLINES
 261 # ifndef _EXTERN_INLINE
 262 #  define _EXTERN_INLINE extern __inline
 263 # endif
 264 _EXTERN_INLINE struct cmsghdr *
 265 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
 266 {
 267   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 268     /* The kernel header does this so there may be a reason.  */
 269     return 0;
 270
 271   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
 272                                + CMSG_ALIGN (__cmsg->cmsg_len));
 273   if ((unsigned char *) (__cmsg + 1) >= ((unsigned char *) __mhdr->msg_control
 274                                          + __mhdr->msg_controllen)
 275       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
 276           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
 277     /* No more entries.  */
 278     return 0;
 279   return __cmsg;
 280 }
 281 #endif  /* Use `extern inline'.  */
 282
 283 /* Socket level message types.  This must match the definitions in
 284    <linux/socket.h>.  */
 285 enum
 286   {
 287     SCM_RIGHTS = 0x01,          /* Transfer file descriptors.  */
 288 #define SCM_RIGHTS SCM_RIGHTS
 289 #ifdef __USE_BSD
 290     SCM_CREDENTIALS = 0x02,     /* Credentials passing.  */
 291 # define SCM_CREDENTIALS SCM_CREDENTIALS
 292 #endif
 293     __SCM_CONNECT = 0x03        /* Data array is `struct scm_connect'.  */
 294   };
 295
 296 /* User visible structure for SCM_CREDENTIALS message */
 297
 298 struct ucred
 299 {
 300   pid_t pid;                    /* PID of sending process.  */
 301   uid_t uid;                    /* UID of sending process.  */
 302   gid_t gid;                    /* GID of sending process.  */
 303 };
 304
 305 /* Get socket manipulation related informations from kernel headers.  */
 306 #include <asm/socket.h>
 307
 308
 309 /* Structure used to manipulate the SO_LINGER option.  */
 310 struct linger
 311   {
 312     int l_onoff;                /* Nonzero to linger on close.  */
 313     int l_linger;               /* Time to linger.  */
 314   };
 315
 316 #endif  /* bits/socket.h */