libc/sysdeps/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, 2005, 2006
   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_DCCP = 6,
  58 #define SOCK_DCCP SOCK_DCCP     /* Datagram Congestion Control Protocol.  */
  59   SOCK_PACKET = 10,             /* Linux specific way of getting packets
  60                                    at the dev level.  For writing rarp and
  61                                    other similar things on the user level. */
  62 #define SOCK_PACKET SOCK_PACKET
  63   /* Flags to be ORed into the type parameter of socket and socketpair and
  64      used for the flags parameter of paccept.  */
  65
  66   SOCK_CLOEXEC = 02000000,      /* Atomically set close-on-exec flag for the
  67                                    new descriptor(s).  */
  68 #define SOCK_CLOEXEC SOCK_CLOEXEC
  69   SOCK_NONBLOCK = 0200          /* Atomically mark descriptor(s) as
  70                                    non-blocking.  */
  71 #define SOCK_NONBLOCK SOCK_NONBLOCK
  72 };
  73
  74 /* Protocol families.  */
  75 #define PF_UNSPEC       0       /* Unspecified.  */
  76 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
  77 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
  78 #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
  79 #define PF_INET         2       /* IP protocol family.  */
  80 #define PF_AX25         3       /* Amateur Radio AX.25.  */
  81 #define PF_IPX          4       /* Novell Internet Protocol.  */
  82 #define PF_APPLETALK    5       /* Appletalk DDP.  */
  83 #define PF_NETROM       6       /* Amateur radio NetROM.  */
  84 #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
  85 #define PF_ATMPVC       8       /* ATM PVCs.  */
  86 #define PF_X25          9       /* Reserved for X.25 project.  */
  87 #define PF_INET6        10      /* IP version 6.  */
  88 #define PF_ROSE         11      /* Amateur Radio X.25 PLP.  */
  89 #define PF_DECnet       12      /* Reserved for DECnet project.  */
  90 #define PF_NETBEUI      13      /* Reserved for 802.2LLC project.  */
  91 #define PF_SECURITY     14      /* Security callback pseudo AF.  */
  92 #define PF_KEY          15      /* PF_KEY key management API.  */
  93 #define PF_NETLINK      16
  94 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
  95 #define PF_PACKET       17      /* Packet family.  */
  96 #define PF_ASH          18      /* Ash.  */
  97 #define PF_ECONET       19      /* Acorn Econet.  */
  98 #define PF_ATMSVC       20      /* ATM SVCs.  */
  99 #define PF_SNA          22      /* Linux SNA Project */
 100 #define PF_IRDA         23      /* IRDA sockets.  */
 101 #define PF_PPPOX        24      /* PPPoX sockets.  */
 102 #define PF_WANPIPE      25      /* Wanpipe API sockets.  */
 103 #define PF_BLUETOOTH    31      /* Bluetooth sockets.  */
 104 #define PF_MAX          32      /* For now..  */
 105
 106 /* Address families.  */
 107 #define AF_UNSPEC       PF_UNSPEC
 108 #define AF_LOCAL        PF_LOCAL
 109 #define AF_UNIX         PF_UNIX
 110 #define AF_FILE         PF_FILE
 111 #define AF_INET         PF_INET
 112 #define AF_AX25         PF_AX25
 113 #define AF_IPX          PF_IPX
 114 #define AF_APPLETALK    PF_APPLETALK
 115 #define AF_NETROM       PF_NETROM
 116 #define AF_BRIDGE       PF_BRIDGE
 117 #define AF_ATMPVC       PF_ATMPVC
 118 #define AF_X25          PF_X25
 119 #define AF_INET6        PF_INET6
 120 #define AF_ROSE         PF_ROSE
 121 #define AF_DECnet       PF_DECnet
 122 #define AF_NETBEUI      PF_NETBEUI
 123 #define AF_SECURITY     PF_SECURITY
 124 #define AF_KEY          PF_KEY
 125 #define AF_NETLINK      PF_NETLINK
 126 #define AF_ROUTE        PF_ROUTE
 127 #define AF_PACKET       PF_PACKET
 128 #define AF_ASH          PF_ASH
 129 #define AF_ECONET       PF_ECONET
 130 #define AF_ATMSVC       PF_ATMSVC
 131 #define AF_SNA          PF_SNA
 132 #define AF_IRDA         PF_IRDA
 133 #define AF_PPPOX        PF_PPPOX
 134 #define AF_WANPIPE      PF_WANPIPE
 135 #define AF_BLUETOOTH    PF_BLUETOOTH
 136 #define AF_MAX          PF_MAX
 137
 138 /* Socket level values.  Others are defined in the appropriate headers.
 139
 140    XXX These definitions also should go into the appropriate headers as
 141    far as they are available.  */
 142 #define SOL_RAW         255
 143 #define SOL_DECNET      261
 144 #define SOL_X25         262
 145 #define SOL_PACKET      263
 146 #define SOL_ATM         264     /* ATM layer (cell level).  */
 147 #define SOL_AAL         265     /* ATM Adaption Layer (packet level).  */
 148 #define SOL_IRDA        266
 149
 150 /* Maximum queue length specifiable by listen.  */
 151 #define SOMAXCONN       128
 152
 153 /* Get the definition of the macro to define the common sockaddr members.  */
 154 #include <bits/sockaddr.h>
 155
 156 /* Structure describing a generic socket address.  */
 157 struct sockaddr
 158   {
 159     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 160     char sa_data[14];           /* Address data.  */
 161   };
 162
 163
 164 /* Structure large enough to hold any socket address (with the historical
 165    exception of AF_UNIX).  We reserve 128 bytes.  */
 166 #define __ss_aligntype  unsigned long int
 167 #define _SS_SIZE        128
 168 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
 169
 170 struct sockaddr_storage
 171   {
 172     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
 173     __ss_aligntype __ss_align;  /* Force desired alignment.  */
 174     char __ss_padding[_SS_PADSIZE];
 175   };
 176
 177
 178 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 179 enum
 180   {
 181     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 182 #define MSG_OOB         MSG_OOB
 183     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 184 #define MSG_PEEK        MSG_PEEK
 185     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 186 #define MSG_DONTROUTE   MSG_DONTROUTE
 187 #ifdef __USE_GNU
 188     /* DECnet uses a different name.  */
 189     MSG_TRYHARD         = MSG_DONTROUTE,
 190 # define MSG_TRYHARD    MSG_DONTROUTE
 191 #endif
 192     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 193 #define MSG_CTRUNC      MSG_CTRUNC
 194     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
 195 #define MSG_PROXY       MSG_PROXY
 196     MSG_TRUNC           = 0x20,
 197 #define MSG_TRUNC       MSG_TRUNC
 198     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
 199 #define MSG_DONTWAIT    MSG_DONTWAIT
 200     MSG_EOR             = 0x80, /* End of record.  */
 201 #define MSG_EOR         MSG_EOR
 202     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
 203 #define MSG_WAITALL     MSG_WAITALL
 204     MSG_FIN             = 0x200,
 205 #define MSG_FIN         MSG_FIN
 206     MSG_SYN             = 0x400,
 207 #define MSG_SYN         MSG_SYN
 208     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
 209 #define MSG_CONFIRM     MSG_CONFIRM
 210     MSG_RST             = 0x1000,
 211 #define MSG_RST         MSG_RST
 212     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
 213 #define MSG_ERRQUEUE    MSG_ERRQUEUE
 214     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
 215 #define MSG_NOSIGNAL    MSG_NOSIGNAL
 216     MSG_MORE            = 0x8000, /* Sender will send more.  */
 217 #define MSG_MORE        MSG_MORE
 218     MSG_WAITFORONE      = 0x10000, /* Wait for at least one packet to return.*/
 219 #define MSG_WAITFORONE  MSG_WAITFORONE
 220
 221     MSG_CMSG_CLOEXEC    = 0x40000000    /* Set close_on_exit for file
 222                                            descriptor received through
 223                                            SCM_RIGHTS.  */
 224 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
 225   };
 226
 227
 228 /* Structure describing messages sent by
 229    `sendmsg' and received by `recvmsg'.  */
 230 /* Note: do not change these members to match glibc; these match the
 231    SuSv3 spec already (e.g. msg_iovlen/msg_controllen).
 232    http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html */
 233 /* Note: linux kernel uses __kernel_size_t (which is 8bytes on 64bit
 234    platforms, and 4bytes on 32bit platforms) for msg_iovlen/msg_controllen */
 235 struct msghdr
 236   {
 237     void *msg_name;             /* Address to send to/receive from.  */
 238     socklen_t msg_namelen;      /* Length of address data.  */
 239
 240     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 241 #if __WORDSIZE == 32
 242     int msg_iovlen;             /* Number of elements in the vector.  */
 243 #else
 244     size_t msg_iovlen;          /* Number of elements in the vector.  */
 245 #endif
 246
 247     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
 248 #if __WORDSIZE == 32
 249     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
 250 #else
 251     size_t msg_controllen;      /* Ancillary data buffer length.  */
 252 #endif
 253
 254     int msg_flags;              /* Flags on received message.  */
 255   };
 256
 257 /* Structure used for storage of ancillary data object information.  */
 258 struct cmsghdr
 259   {
 260     size_t cmsg_len;            /* Length of data in cmsg_data plus length
 261                                    of cmsghdr structure.  */
 262     int cmsg_level;             /* Originating protocol.  */
 263     int cmsg_type;              /* Protocol specific type.  */
 264 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 265     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
 266 #endif
 267   };
 268
 269 /* Ancillary data object manipulation macros.  */
 270 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 271 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 272 #else
 273 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 274 #endif
 275 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 276 #define CMSG_FIRSTHDR(mhdr) \
 277   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 278    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
 279 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
 280                          & (size_t) ~(sizeof (size_t) - 1))
 281 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
 282                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
 283 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
 284
 285 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
 286                                       struct cmsghdr *__cmsg) __THROW;
 287 libc_hidden_proto(__cmsg_nxthdr)
 288 #ifdef __USE_EXTERN_INLINES
 289 # ifndef _EXTERN_INLINE
 290 #  define _EXTERN_INLINE extern __inline
 291 # endif
 292 _EXTERN_INLINE struct cmsghdr *
 293 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
 294 {
 295   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 296     /* The kernel header does this so there may be a reason.  */
 297     return 0;
 298
 299   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
 300                                + CMSG_ALIGN (__cmsg->cmsg_len));
 301   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
 302                                         + __mhdr->msg_controllen)
 303       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
 304           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
 305     /* No more entries.  */
 306     return 0;
 307   return __cmsg;
 308 }
 309 #endif  /* Use `extern inline'.  */
 310
 311 /* Socket level message types.  This must match the definitions in
 312    <linux/socket.h>.  */
 313 enum
 314   {
 315     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
 316 #define SCM_RIGHTS SCM_RIGHTS
 317 #ifdef __USE_BSD
 318     , SCM_CREDENTIALS = 0x02    /* Credentials passing.  */
 319 # define SCM_CREDENTIALS SCM_CREDENTIALS
 320 #endif
 321   };
 322
 323 /* User visible structure for SCM_CREDENTIALS message */
 324
 325 struct ucred
 326 {
 327   pid_t pid;                    /* PID of sending process.  */
 328   uid_t uid;                    /* UID of sending process.  */
 329   gid_t gid;                    /* GID of sending process.  */
 330 };
 331
 332 /* Get socket manipulation related informations from kernel headers.  */
 333 #ifndef __GLIBC__
 334 #define __GLIBC__ 2
 335 #include <asm/socket.h>
 336 #undef __GLIBC__
 337 #else
 338 #include <asm/socket.h>
 339 #endif
 340
 341
 342 /* Structure used to manipulate the SO_LINGER option.  */
 343 struct linger
 344   {
 345     int l_onoff;                /* Nonzero to linger on close.  */
 346     int l_linger;               /* Time to linger.  */
 347   };
 348
 349 #endif  /* bits/socket.h */