]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - bits/socket.h
Fix all the remaining misspellings -- BZ 25337
[thirdparty/glibc.git] / bits / socket.h
index 01844bc143df33ca70f82268c0f750d8308711c9..a22ff3b07bd2c240ba07034f3277ed4a7e82e6af 100644 (file)
@@ -1,34 +1,39 @@
-/* System-specific socket constants and types.  Generic/4.3 BSD version.
-   Copyright (C) 1991, 92, 94, 95, 96, 97, 98 Free Software Foundation, Inc.
+/* System-specific socket constants and types.  4.4 BSD version.
+   Copyright (C) 1991-2023 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
+   modify it under the terms of the GNU Lesser General Public License as
+   published by the Free Software Foundation; either version 2.1 of the
    License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; see the file COPYING.LIB.  If
+   not, see <https://www.gnu.org/licenses/>.  */
 
 #ifndef __BITS_SOCKET_H
 #define __BITS_SOCKET_H        1
 
-#if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
+#ifndef _SYS_SOCKET_H
 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
 #endif
 
 #define        __need_size_t
 #include <stddef.h>
 
+#include <bits/wordsize.h>
+#include <bits/types.h>
+
 /* Type for length arguments in socket calls.  */
-typedef unsigned int socklen_t;
+#ifndef __socklen_t_defined
+typedef __socklen_t socklen_t;
+# define __socklen_t_defined
+#endif
 
 
 /* Types of sockets.  */
@@ -47,6 +52,22 @@ enum __socket_type
   SOCK_SEQPACKET = 5,          /* Sequenced, reliable, connection-based,
                                   datagrams of fixed maximum length.  */
 #define SOCK_SEQPACKET SOCK_SEQPACKET
+
+#define SOCK_MAX (SOCK_SEQPACKET + 1)
+  /* Mask which covers at least up to SOCK_MASK-1.
+     The remaining bits are used as flags. */
+#define SOCK_TYPE_MASK 0xf
+
+  /* Flags to be ORed into the type parameter of socket and socketpair and
+     used for the flags parameter of accept4.  */
+
+  SOCK_CLOEXEC = 0x10000000,   /* Atomically set close-on-exec flag for the
+                                  new descriptor(s).  */
+#define SOCK_CLOEXEC SOCK_CLOEXEC
+
+  SOCK_NONBLOCK = 0x20000000   /* Atomically mark descriptor(s) as
+                                  non-blocking.  */
+#define SOCK_NONBLOCK SOCK_NONBLOCK
 };
 
 /* Protocol families.  */
@@ -105,16 +126,24 @@ enum __socket_type
 #define        AF_APPLETALK    PF_APPLETALK
 #define        AF_ROUTE        PF_ROUTE
 #define        AF_LINK         PF_LINK
-#define        pseudo_AF_XTP   PF_XTP
+#ifdef __USE_MISC
+# define       pseudo_AF_XTP   PF_XTP
+#endif
 #define        AF_COIP         PF_COIP
 #define        AF_CNT          PF_CNT
-#define pseudo_AF_RTIP PF_RTIP
+#ifdef __USE_MISC
+# define pseudo_AF_RTIP        PF_RTIP
+#endif
 #define        AF_IPX          PF_IPX
 #define        AF_SIP          PF_SIP
-#define pseudo_AF_PIP  PF_PIP
+#ifdef __USE_MISC
+# define pseudo_AF_PIP PF_PIP
+#endif
 #define AF_INET6       PF_INET6
 #define        AF_MAX          PF_MAX
 
+/* Maximum queue length specifiable by listen.  */
+#define SOMAXCONN      128     /* 5 on the original 4.4 BSD.  */
 
 /* Get the definition of the macro to define the common sockaddr members.  */
 #include <bits/sockaddr.h>
@@ -127,17 +156,45 @@ struct sockaddr
   };
 
 
+/* Structure large enough to hold any socket address (with the historical
+   exception of AF_UNIX).  */
+#if __WORDSIZE == 64
+# define __ss_aligntype        __uint64_t
+#else
+# define __ss_aligntype        __uint32_t
+#endif
+#define _SS_PADSIZE \
+  (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype))
+
+struct sockaddr_storage
+  {
+    __SOCKADDR_COMMON (ss_);   /* Address family, etc.  */
+    char __ss_padding[_SS_PADSIZE];
+    __ss_aligntype __ss_align; /* Force desired alignment.  */
+  };
+
+
 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 enum
   {
     MSG_OOB            = 0x01, /* Process out-of-band data.  */
+#define MSG_OOB MSG_OOB
     MSG_PEEK           = 0x02, /* Peek at incoming messages.  */
+#define MSG_PEEK MSG_PEEK
     MSG_DONTROUTE      = 0x04, /* Don't use local routing.  */
+#define MSG_DONTROUTE MSG_DONTROUTE
     MSG_EOR            = 0x08, /* Data completes record.  */
+#define MSG_EOR MSG_EOR
     MSG_TRUNC          = 0x10, /* Data discarded before delivery.  */
+#define MSG_TRUNC MSG_TRUNC
     MSG_CTRUNC         = 0x20, /* Control data lost before delivery.  */
+#define MSG_CTRUNC MSG_CTRUNC
     MSG_WAITALL                = 0x40, /* Wait for full request or error.  */
+#define MSG_WAITALL MSG_WAITALL
     MSG_DONTWAIT       = 0x80, /* This message should be nonblocking.  */
+#define MSG_DONTWAIT MSG_DONTWAIT
+    MSG_NOSIGNAL       = 0x0400        /* Do not generate SIGPIPE on EPIPE.  */
+#define MSG_NOSIGNAL MSG_NOSIGNAL
   };
 
 
@@ -145,18 +202,133 @@ enum
    `sendmsg' and received by `recvmsg'.  */
 struct msghdr
   {
-    __ptr_t msg_name;          /* Address to send to/receive from.  */
+    void *msg_name;            /* Address to send to/receive from.  */
     socklen_t msg_namelen;     /* Length of address data.  */
 
     struct iovec *msg_iov;     /* Vector of data to send/receive into.  */
     int msg_iovlen;            /* Number of elements in the vector.  */
 
-    __ptr_t msg_accrights;     /* Access rights information.  */
-    socklen_t msg_accrightslen;        /* Length of access rights information.  */
+    void *msg_control;         /* Ancillary data (eg BSD filedesc passing). */
+    socklen_t msg_controllen;  /* Ancillary data buffer length.  */
 
     int msg_flags;             /* Flags in received message.  */
   };
 
+/* Structure used for storage of ancillary data object information.  */
+struct cmsghdr
+  {
+    socklen_t cmsg_len;                /* Length of data in cmsg_data plus length
+                                  of cmsghdr structure.  */
+    int cmsg_level;            /* Originating protocol.  */
+    int cmsg_type;             /* Protocol specific type.  */
+#if __glibc_c99_flexarr_available
+    __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
+#endif
+  };
+
+/* Ancillary data object manipulation macros.  */
+#if __glibc_c99_flexarr_available
+# define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
+#else
+# define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
+#endif
+
+#define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
+
+#define CMSG_FIRSTHDR(mhdr) \
+  ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                \
+   ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
+
+#define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
+                          & (size_t) ~(sizeof (size_t) - 1))
+#define CMSG_SPACE(len) (CMSG_ALIGN (len) \
+                        + CMSG_ALIGN (sizeof (struct cmsghdr)))
+#define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
+
+/* Given a length, return the additional padding necessary such that
+   len + __CMSG_PADDING(len) == CMSG_ALIGN (len).  */
+#define __CMSG_PADDING(len) ((sizeof (size_t) \
+                              - ((len) & (sizeof (size_t) - 1))) \
+                             & (sizeof (size_t) - 1))
+
+extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
+                                     struct cmsghdr *__cmsg) __THROW;
+#ifdef __USE_EXTERN_INLINES
+# ifndef _EXTERN_INLINE
+#  define _EXTERN_INLINE __extern_inline
+# endif
+_EXTERN_INLINE struct cmsghdr *
+__NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
+{
+  /* We may safely assume that __cmsg lies between __mhdr->msg_control and
+     __mhdr->msg_controllen because the user is required to obtain the first
+     cmsg via CMSG_FIRSTHDR, set its length, then obtain subsequent cmsgs
+     via CMSG_NXTHDR, setting lengths along the way.  However, we don't yet
+     trust the value of __cmsg->cmsg_len and therefore do not use it in any
+     pointer arithmetic until we check its value.  */
+
+  unsigned char * __msg_control_ptr = (unsigned char *) __mhdr->msg_control;
+  unsigned char * __cmsg_ptr = (unsigned char *) __cmsg;
+
+  size_t __size_needed = sizeof (struct cmsghdr)
+                         + __CMSG_PADDING (__cmsg->cmsg_len);
+
+  /* The current header is malformed, too small to be a full header.  */
+  if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
+    return (struct cmsghdr *) 0;
+
+  /* There isn't enough space between __cmsg and the end of the buffer to
+  hold the current cmsg *and* the next one.  */
+  if (((size_t)
+         (__msg_control_ptr + __mhdr->msg_controllen - __cmsg_ptr)
+       < __size_needed)
+      || ((size_t)
+            (__msg_control_ptr + __mhdr->msg_controllen - __cmsg_ptr
+             - __size_needed)
+          < __cmsg->cmsg_len))
+
+    return (struct cmsghdr *) 0;
+
+  /* Now, we trust cmsg_len and can use it to find the next header.  */
+  __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
+                              + CMSG_ALIGN (__cmsg->cmsg_len));
+  return __cmsg;
+}
+#endif /* Use `extern inline'.  */
+
+/* Socket level message types.  */
+enum
+  {
+    SCM_RIGHTS = 0x01,         /* Access rights (array of int).  */
+#define SCM_RIGHTS SCM_RIGHTS
+    SCM_TIMESTAMP = 0x02,      /* Timestamp (struct timeval).  */
+#define SCM_TIMESTAMP SCM_TIMESTAMP
+    SCM_CREDS = 0x03           /* Process creds (struct cmsgcred).  */
+#define SCM_CREDS SCM_CREDS
+  };
+
+#ifdef __USE_MISC
+/* Unfortunately, BSD practice dictates this structure be of fixed size.
+   If there are more than CMGROUP_MAX groups, the list is truncated.
+   (On GNU systems, the `cmcred_euid' field is just the first in the
+   list of effective UIDs.)  */
+#define CMGROUP_MAX    16
+
+/* Structure delivered by SCM_CREDS.  This describes the identity of the
+   sender of the data simultaneously received on the socket.  By BSD
+   convention, this is included only when a sender on a AF_LOCAL socket
+   sends cmsg data of this type and size; the sender's structure is
+   ignored, and the system fills in the various IDs of the sender process.  */
+struct cmsgcred
+  {
+    __pid_t cmcred_pid;
+    __uid_t cmcred_uid;
+    __uid_t cmcred_euid;
+    __gid_t cmcred_gid;
+    int cmcred_ngroups;
+    __gid_t cmcred_groups[CMGROUP_MAX];
+  };
+#endif
 
 /* Protocol number used to manipulate socket-level options
    with `getsockopt' and `setsockopt'.  */
@@ -166,31 +338,47 @@ struct msghdr
 enum
   {
     SO_DEBUG = 0x0001,         /* Record debugging information.  */
+#define SO_DEBUG SO_DEBUG
     SO_ACCEPTCONN = 0x0002,    /* Accept connections on socket.  */
+#define SO_ACCEPTCONN SO_ACCEPTCONN
     SO_REUSEADDR = 0x0004,     /* Allow reuse of local addresses.  */
+#define SO_REUSEADDR SO_REUSEADDR
     SO_KEEPALIVE = 0x0008,     /* Keep connections alive and send
                                   SIGPIPE when they die.  */
+#define SO_KEEPALIVE SO_KEEPALIVE
     SO_DONTROUTE = 0x0010,     /* Don't do local routing.  */
+#define SO_DONTROUTE SO_DONTROUTE
     SO_BROADCAST = 0x0020,     /* Allow transmission of
                                   broadcast messages.  */
+#define SO_BROADCAST SO_BROADCAST
     SO_USELOOPBACK = 0x0040,   /* Use the software loopback to avoid
                                   hardware use when possible.  */
+#define SO_USELOOPBACK SO_USELOOPBACK
     SO_LINGER = 0x0080,                /* Block on close of a reliable
                                   socket to transmit pending data.  */
+#define SO_LINGER SO_LINGER
     SO_OOBINLINE = 0x0100,     /* Receive out-of-band data in-band.  */
-
+#define SO_OOBINLINE SO_OOBINLINE
     SO_REUSEPORT = 0x0200,     /* Allow local address and port reuse.  */
-
+#define SO_REUSEPORT SO_REUSEPORT
     SO_SNDBUF = 0x1001,                /* Send buffer size.  */
+#define SO_SNDBUF SO_SNDBUF
     SO_RCVBUF = 0x1002,                /* Receive buffer.  */
+#define SO_RCVBUF SO_RCVBUF
     SO_SNDLOWAT = 0x1003,      /* Send low-water mark.  */
+#define SO_SNDLOWAT SO_SNDLOWAT
     SO_RCVLOWAT = 0x1004,      /* Receive low-water mark.  */
+#define SO_RCVLOWAT SO_RCVLOWAT
     SO_SNDTIMEO = 0x1005,      /* Send timeout.  */
+#define SO_SNDTIMEO SO_SNDTIMEO
     SO_RCVTIMEO = 0x1006,      /* Receive timeout.  */
-
+#define SO_RCVTIMEO SO_RCVTIMEO
     SO_ERROR = 0x1007,         /* Get and clear error status.  */
+#define SO_ERROR SO_ERROR
     SO_STYLE = 0x1008,         /* Get socket connection style.  */
-    SO_TYPE = SO_STYLE,                /* Compatible name for SO_STYLE.  */
+#define SO_STYLE SO_STYLE
+    SO_TYPE = SO_STYLE         /* Compatible name for SO_STYLE.  */
+#define SO_TYPE SO_TYPE
   };
 
 /* Structure used to manipulate the SO_LINGER option.  */