Line data    Source code

       1             : /* System-specific socket constants and types.  Linux version.
       2             :    Copyright (C) 1991-2022 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 Lesser General Public
       7             :    License as published by the Free Software Foundation; either
       8             :    version 2.1 of the 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             :    Lesser General Public License for more details.
      14             : 
      15             :    You should have received a copy of the GNU Lesser General Public
      16             :    License along with the GNU C Library; if not, see
      17             :    <https://www.gnu.org/licenses/>.  */
      18             : 
      19             : #ifndef __BITS_SOCKET_H
      20             : #define __BITS_SOCKET_H
      21             : 
      22             : #ifndef _SYS_SOCKET_H
      23             : # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
      24             : #endif
      25             : 
      26             : #define __need_size_t
      27             : #include <stddef.h>
      28             : 
      29             : #include <sys/types.h>
      30             : 
      31             : /* Type for length arguments in socket calls.  */
      32             : #ifndef __socklen_t_defined
      33             : typedef __socklen_t socklen_t;
      34             : # define __socklen_t_defined
      35             : #endif
      36             : 
      37             : /* Get the architecture-dependent definition of enum __socket_type.  */
      38             : #include <bits/socket_type.h>
      39             : 
      40             : /* Protocol families.  */
      41             : #define PF_UNSPEC       0       /* Unspecified.  */
      42             : #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
      43             : #define PF_UNIX         PF_LOCAL /* POSIX name for PF_LOCAL.  */
      44             : #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
      45             : #define PF_INET         2       /* IP protocol family.  */
      46             : #define PF_AX25         3       /* Amateur Radio AX.25.  */
      47             : #define PF_IPX          4       /* Novell Internet Protocol.  */
      48             : #define PF_APPLETALK    5       /* Appletalk DDP.  */
      49             : #define PF_NETROM       6       /* Amateur radio NetROM.  */
      50             : #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
      51             : #define PF_ATMPVC       8       /* ATM PVCs.  */
      52             : #define PF_X25          9       /* Reserved for X.25 project.  */
      53             : #define PF_INET6        10      /* IP version 6.  */
      54             : #define PF_ROSE         11      /* Amateur Radio X.25 PLP.  */
      55             : #define PF_DECnet       12      /* Reserved for DECnet project.  */
      56             : #define PF_NETBEUI      13      /* Reserved for 802.2LLC project.  */
      57             : #define PF_SECURITY     14      /* Security callback pseudo AF.  */
      58             : #define PF_KEY          15      /* PF_KEY key management API.  */
      59             : #define PF_NETLINK      16
      60             : #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
      61             : #define PF_PACKET       17      /* Packet family.  */
      62             : #define PF_ASH          18      /* Ash.  */
      63             : #define PF_ECONET       19      /* Acorn Econet.  */
      64             : #define PF_ATMSVC       20      /* ATM SVCs.  */
      65             : #define PF_RDS          21      /* RDS sockets.  */
      66             : #define PF_SNA          22      /* Linux SNA Project */
      67             : #define PF_IRDA         23      /* IRDA sockets.  */
      68             : #define PF_PPPOX        24      /* PPPoX sockets.  */
      69             : #define PF_WANPIPE      25      /* Wanpipe API sockets.  */
      70             : #define PF_LLC          26      /* Linux LLC.  */
      71             : #define PF_IB           27      /* Native InfiniBand address.  */
      72             : #define PF_MPLS         28      /* MPLS.  */
      73             : #define PF_CAN          29      /* Controller Area Network.  */
      74             : #define PF_TIPC         30      /* TIPC sockets.  */
      75             : #define PF_BLUETOOTH    31      /* Bluetooth sockets.  */
      76             : #define PF_IUCV         32      /* IUCV sockets.  */
      77             : #define PF_RXRPC        33      /* RxRPC sockets.  */
      78             : #define PF_ISDN         34      /* mISDN sockets.  */
      79             : #define PF_PHONET       35      /* Phonet sockets.  */
      80             : #define PF_IEEE802154   36      /* IEEE 802.15.4 sockets.  */
      81             : #define PF_CAIF         37      /* CAIF sockets.  */
      82             : #define PF_ALG          38      /* Algorithm sockets.  */
      83             : #define PF_NFC          39      /* NFC sockets.  */
      84             : #define PF_VSOCK        40      /* vSockets.  */
      85             : #define PF_KCM          41      /* Kernel Connection Multiplexor.  */
      86             : #define PF_QIPCRTR      42      /* Qualcomm IPC Router.  */
      87             : #define PF_SMC          43      /* SMC sockets.  */
      88             : #define PF_XDP          44      /* XDP sockets.  */
      89             : #define PF_MCTP         45      /* Management component transport protocol.  */
      90             : #define PF_MAX          46      /* 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_RDS          PF_RDS
     118             : #define AF_SNA          PF_SNA
     119             : #define AF_IRDA         PF_IRDA
     120             : #define AF_PPPOX        PF_PPPOX
     121             : #define AF_WANPIPE      PF_WANPIPE
     122             : #define AF_LLC          PF_LLC
     123             : #define AF_IB           PF_IB
     124             : #define AF_MPLS         PF_MPLS
     125             : #define AF_CAN          PF_CAN
     126             : #define AF_TIPC         PF_TIPC
     127             : #define AF_BLUETOOTH    PF_BLUETOOTH
     128             : #define AF_IUCV         PF_IUCV
     129             : #define AF_RXRPC        PF_RXRPC
     130             : #define AF_ISDN         PF_ISDN
     131             : #define AF_PHONET       PF_PHONET
     132             : #define AF_IEEE802154   PF_IEEE802154
     133             : #define AF_CAIF         PF_CAIF
     134             : #define AF_ALG          PF_ALG
     135             : #define AF_NFC          PF_NFC
     136             : #define AF_VSOCK        PF_VSOCK
     137             : #define AF_KCM          PF_KCM
     138             : #define AF_QIPCRTR      PF_QIPCRTR
     139             : #define AF_SMC          PF_SMC
     140             : #define AF_XDP          PF_XDP
     141             : #define AF_MCTP         PF_MCTP
     142             : #define AF_MAX          PF_MAX
     143             : 
     144             : /* Socket level values.  Others are defined in the appropriate headers.
     145             : 
     146             :    XXX These definitions also should go into the appropriate headers as
     147             :    far as they are available.  */
     148             : #define SOL_RAW         255
     149             : #define SOL_DECNET      261
     150             : #define SOL_X25         262
     151             : #define SOL_PACKET      263
     152             : #define SOL_ATM         264     /* ATM layer (cell level).  */
     153             : #define SOL_AAL         265     /* ATM Adaption Layer (packet level).  */
     154             : #define SOL_IRDA        266
     155             : #define SOL_NETBEUI     267
     156             : #define SOL_LLC         268
     157             : #define SOL_DCCP        269
     158             : #define SOL_NETLINK     270
     159             : #define SOL_TIPC        271
     160             : #define SOL_RXRPC       272
     161             : #define SOL_PPPOL2TP    273
     162             : #define SOL_BLUETOOTH   274
     163             : #define SOL_PNPIPE      275
     164             : #define SOL_RDS         276
     165             : #define SOL_IUCV        277
     166             : #define SOL_CAIF        278
     167             : #define SOL_ALG         279
     168             : #define SOL_NFC         280
     169             : #define SOL_KCM         281
     170             : #define SOL_TLS         282
     171             : #define SOL_XDP         283
     172             : 
     173             : /* Maximum queue length specifiable by listen.  */
     174             : #define SOMAXCONN       4096
     175             : 
     176             : /* Get the definition of the macro to define the common sockaddr members.  */
     177             : #include <bits/sockaddr.h>
     178             : 
     179             : /* Structure describing a generic socket address.  */
     180             : struct sockaddr
     181             :   {
     182             :     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
     183             :     char sa_data[14];           /* Address data.  */
     184             :   };
     185             : 
     186             : 
     187             : /* Structure large enough to hold any socket address (with the historical
     188             :    exception of AF_UNIX).  */
     189             : #define __ss_aligntype  unsigned long int
     190             : #define _SS_PADSIZE \
     191             :   (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype))
     192             : 
     193             : struct sockaddr_storage
     194             :   {
     195             :     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
     196             :     char __ss_padding[_SS_PADSIZE];
     197             :     __ss_aligntype __ss_align;  /* Force desired alignment.  */
     198             :   };
     199             : 
     200             : 
     201             : /* Bits in the FLAGS argument to `send', `recv', et al.  */
     202             : enum
     203             :   {
     204             :     MSG_OOB             = 0x01, /* Process out-of-band data.  */
     205             : #define MSG_OOB         MSG_OOB
     206             :     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
     207             : #define MSG_PEEK        MSG_PEEK
     208             :     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
     209             : #define MSG_DONTROUTE   MSG_DONTROUTE
     210             : #ifdef __USE_GNU
     211             :     /* DECnet uses a different name.  */
     212             :     MSG_TRYHARD         = MSG_DONTROUTE,
     213             : # define MSG_TRYHARD    MSG_DONTROUTE
     214             : #endif
     215             :     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
     216             : #define MSG_CTRUNC      MSG_CTRUNC
     217             :     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
     218             : #define MSG_PROXY       MSG_PROXY
     219             :     MSG_TRUNC           = 0x20,
     220             : #define MSG_TRUNC       MSG_TRUNC
     221             :     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
     222             : #define MSG_DONTWAIT    MSG_DONTWAIT
     223             :     MSG_EOR             = 0x80, /* End of record.  */
     224             : #define MSG_EOR         MSG_EOR
     225             :     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
     226             : #define MSG_WAITALL     MSG_WAITALL
     227             :     MSG_FIN             = 0x200,
     228             : #define MSG_FIN         MSG_FIN
     229             :     MSG_SYN             = 0x400,
     230             : #define MSG_SYN         MSG_SYN
     231             :     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
     232             : #define MSG_CONFIRM     MSG_CONFIRM
     233             :     MSG_RST             = 0x1000,
     234             : #define MSG_RST         MSG_RST
     235             :     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
     236             : #define MSG_ERRQUEUE    MSG_ERRQUEUE
     237             :     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
     238             : #define MSG_NOSIGNAL    MSG_NOSIGNAL
     239             :     MSG_MORE            = 0x8000,  /* Sender will send more.  */
     240             : #define MSG_MORE        MSG_MORE
     241             :     MSG_WAITFORONE      = 0x10000, /* Wait for at least one packet to return.*/
     242             : #define MSG_WAITFORONE  MSG_WAITFORONE
     243             :     MSG_BATCH           = 0x40000, /* sendmmsg: more messages coming.  */
     244             : #define MSG_BATCH       MSG_BATCH
     245             :     MSG_ZEROCOPY        = 0x4000000, /* Use user data in kernel path.  */
     246             : #define MSG_ZEROCOPY    MSG_ZEROCOPY
     247             :     MSG_FASTOPEN        = 0x20000000, /* Send data in TCP SYN.  */
     248             : #define MSG_FASTOPEN    MSG_FASTOPEN
     249             : 
     250             :     MSG_CMSG_CLOEXEC    = 0x40000000    /* Set close_on_exit for file
     251             :                                            descriptor received through
     252             :                                            SCM_RIGHTS.  */
     253             : #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
     254             :   };
     255             : 
     256             : 
     257             : /* Structure describing messages sent by
     258             :    `sendmsg' and received by `recvmsg'.  */
     259             : struct msghdr
     260             :   {
     261             :     void *msg_name;             /* Address to send to/receive from.  */
     262             :     socklen_t msg_namelen;      /* Length of address data.  */
     263             : 
     264             :     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
     265             :     size_t msg_iovlen;          /* Number of elements in the vector.  */
     266             : 
     267             :     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
     268             :     size_t msg_controllen;      /* Ancillary data buffer length.
     269             :                                    !! The type should be socklen_t but the
     270             :                                    definition of the kernel is incompatible
     271             :                                    with this.  */
     272             : 
     273             :     int msg_flags;              /* Flags on received message.  */
     274             :   };
     275             : 
     276             : /* Structure used for storage of ancillary data object information.  */
     277             : struct cmsghdr
     278             :   {
     279             :     size_t cmsg_len;            /* Length of data in cmsg_data plus length
     280             :                                    of cmsghdr structure.
     281             :                                    !! The type should be socklen_t but the
     282             :                                    definition of the kernel is incompatible
     283             :                                    with this.  */
     284             :     int cmsg_level;             /* Originating protocol.  */
     285             :     int cmsg_type;              /* Protocol specific type.  */
     286             : #if __glibc_c99_flexarr_available
     287             :     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
     288             : #endif
     289             :   };
     290             : 
     291             : /* Ancillary data object manipulation macros.  */
     292             : #if __glibc_c99_flexarr_available
     293             : # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
     294             : #else
     295             : # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
     296             : #endif
     297             : #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
     298             : #define CMSG_FIRSTHDR(mhdr) \
     299             :   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                   \
     300             :    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
     301             : #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
     302             :                          & (size_t) ~(sizeof (size_t) - 1))
     303             : #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
     304             :                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
     305             : #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
     306             : 
     307             : extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
     308             :                                       struct cmsghdr *__cmsg) __THROW;
     309             : #ifdef __USE_EXTERN_INLINES
     310             : # ifndef _EXTERN_INLINE
     311             : #  define _EXTERN_INLINE __extern_inline
     312             : # endif
     313             : _EXTERN_INLINE struct cmsghdr *
     314         110 : __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
     315             : {
     316         110 :   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
     317             :     /* The kernel header does this so there may be a reason.  */
     318             :     return (struct cmsghdr *) 0;
     319             : 
     320         110 :   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
     321         110 :                                + CMSG_ALIGN (__cmsg->cmsg_len));
     322         110 :   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
     323         110 :                                         + __mhdr->msg_controllen)
     324           0 :       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
     325             :           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
     326             :     /* No more entries.  */
     327           0 :     return (struct cmsghdr *) 0;
     328             :   return __cmsg;
     329             : }
     330             : #endif  /* Use `extern inline'.  */
     331             : 
     332             : /* Socket level message types.  This must match the definitions in
     333             :    <linux/socket.h>.  */
     334             : enum
     335             :   {
     336             :     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
     337             : #define SCM_RIGHTS SCM_RIGHTS
     338             : #ifdef __USE_GNU
     339             :     , SCM_CREDENTIALS = 0x02    /* Credentials passing.  */
     340             : # define SCM_CREDENTIALS SCM_CREDENTIALS
     341             : #endif
     342             :   };
     343             : 
     344             : #ifdef __USE_GNU
     345             : /* User visible structure for SCM_CREDENTIALS message */
     346             : struct ucred
     347             : {
     348             :   pid_t pid;                    /* PID of sending process.  */
     349             :   uid_t uid;                    /* UID of sending process.  */
     350             :   gid_t gid;                    /* GID of sending process.  */
     351             : };
     352             : #endif
     353             : 
     354             : #ifdef __USE_MISC
     355             : # include <bits/types/time_t.h>
     356             : # include <asm/socket.h>
     357             : #else
     358             : # define SO_DEBUG 1
     359             : # include <bits/socket-constants.h>
     360             : #endif
     361             : 
     362             : /* Structure used to manipulate the SO_LINGER option.  */
     363             : struct linger
     364             :   {
     365             :     int l_onoff;                /* Nonzero to linger on close.  */
     366             :     int l_linger;               /* Time to linger.  */
     367             :   };
     368             : 
     369             : #endif  /* bits/socket.h */