sysdeps/unix/sysv/linux/s390/s390-64/bits/socket.h

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