Warning: This file is not a C or C++ file. It does not have highlighting.
| 1 | /* System-specific socket constants and types. Hurd version. |
|---|---|
| 2 | Copyright (C) 1991-2024 Free Software Foundation, Inc. |
| 3 | |
| 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 License as |
| 8 | published by the Free Software Foundation; either version 2.1 of the |
| 9 | 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; see the file COPYING.LIB. If |
| 18 | not, see <https://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef __BITS_SOCKET_H |
| 21 | #define __BITS_SOCKET_H 1 |
| 22 | |
| 23 | #ifndef _SYS_SOCKET_H |
| 24 | # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead." |
| 25 | #endif |
| 26 | |
| 27 | #define __need_size_t |
| 28 | #include <stddef.h> |
| 29 | |
| 30 | #include <bits/wordsize.h> |
| 31 | #include <sys/types.h> |
| 32 | |
| 33 | /* Type for length arguments in socket calls. */ |
| 34 | #ifndef __socklen_t_defined |
| 35 | typedef __socklen_t socklen_t; |
| 36 | # define __socklen_t_defined |
| 37 | #endif |
| 38 | |
| 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 | |
| 57 | #define SOCK_MAX (SOCK_SEQPACKET + 1) |
| 58 | /* Mask which covers at least up to SOCK_MASK-1. The |
| 59 | remaining bits are used as flags. */ |
| 60 | #define SOCK_TYPE_MASK 0xf |
| 61 | |
| 62 | /* Flags to be ORed into the type parameter of socket and socketpair and |
| 63 | used for the flags parameter of accept4. */ |
| 64 | |
| 65 | SOCK_CLOEXEC = 0x00400000, /* Atomically set close-on-exec flag for the |
| 66 | new descriptor(s). */ |
| 67 | #define SOCK_CLOEXEC SOCK_CLOEXEC |
| 68 | |
| 69 | /* Changed from the O_NONBLOCK value (0x8, which is unusable for us as it is |
| 70 | conflicting with the original SOCK_* flags' values) to the Linux value |
| 71 | (04000). TODO: is there a ``better'' value? */ |
| 72 | SOCK_NONBLOCK = 0x0800 /* Atomically mark descriptor(s) as |
| 73 | non-blocking. */ |
| 74 | #define SOCK_NONBLOCK SOCK_NONBLOCK |
| 75 | }; |
| 76 | |
| 77 | /* Protocol families. */ |
| 78 | #define PF_UNSPEC 0 /* Unspecified. */ |
| 79 | #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */ |
| 80 | #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */ |
| 81 | #define PF_FILE PF_LOCAL /* POSIX name for PF_LOCAL. */ |
| 82 | #define PF_INET 2 /* IP protocol family. */ |
| 83 | #define PF_IMPLINK 3 /* ARPAnet IMP protocol. */ |
| 84 | #define PF_PUP 4 /* PUP protocols. */ |
| 85 | #define PF_CHAOS 5 /* MIT Chaos protocols. */ |
| 86 | #define PF_NS 6 /* Xerox NS protocols. */ |
| 87 | #define PF_ISO 7 /* ISO protocols. */ |
| 88 | #define PF_OSI PF_ISO |
| 89 | #define PF_ECMA 8 /* ECMA protocols. */ |
| 90 | #define PF_DATAKIT 9 /* AT&T Datakit protocols. */ |
| 91 | #define PF_CCITT 10 /* CCITT protocols (X.25 et al). */ |
| 92 | #define PF_SNA 11 /* IBM SNA protocol. */ |
| 93 | #define PF_DECnet 12 /* DECnet protocols. */ |
| 94 | #define PF_DLI 13 /* Direct data link interface. */ |
| 95 | #define PF_LAT 14 /* DEC Local Area Transport protocol. */ |
| 96 | #define PF_HYLINK 15 /* NSC Hyperchannel protocol. */ |
| 97 | #define PF_APPLETALK 16 /* Don't use this. */ |
| 98 | #define PF_ROUTE 17 /* Internal Routing Protocol. */ |
| 99 | #define PF_LINK 18 /* Link layer interface. */ |
| 100 | #define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */ |
| 101 | #define PF_COIP 20 /* Connection-oriented IP, aka ST II. */ |
| 102 | #define PF_CNT 21 /* Computer Network Technology. */ |
| 103 | #define PF_RTIP 22 /* Help Identify RTIP packets. **/ |
| 104 | #define PF_IPX 23 /* Novell Internet Protocol. */ |
| 105 | #define PF_SIP 24 /* Simple Internet Protocol. */ |
| 106 | #define PF_PIP 25 /* Help Identify PIP packets. */ |
| 107 | #define PF_INET6 26 /* IP version 6. */ |
| 108 | #define PF_MAX 27 |
| 109 | |
| 110 | /* Address families. */ |
| 111 | #define AF_UNSPEC PF_UNSPEC |
| 112 | #define AF_LOCAL PF_LOCAL |
| 113 | #define AF_UNIX PF_UNIX |
| 114 | #define AF_FILE PF_FILE |
| 115 | #define AF_INET PF_INET |
| 116 | #define AF_IMPLINK PF_IMPLINK |
| 117 | #define AF_PUP PF_PUP |
| 118 | #define AF_CHAOS PF_CHAOS |
| 119 | #define AF_NS PF_NS |
| 120 | #define AF_ISO PF_ISO |
| 121 | #define AF_OSI PF_OSI |
| 122 | #define AF_ECMA PF_ECMA |
| 123 | #define AF_DATAKIT PF_DATAKIT |
| 124 | #define AF_CCITT PF_CCITT |
| 125 | #define AF_SNA PF_SNA |
| 126 | #define AF_DECnet PF_DECnet |
| 127 | #define AF_DLI PF_DLI |
| 128 | #define AF_LAT PF_LAT |
| 129 | #define AF_HYLINK PF_HYLINK |
| 130 | #define AF_APPLETALK PF_APPLETALK |
| 131 | #define AF_ROUTE PF_ROUTE |
| 132 | #define AF_LINK PF_LINK |
| 133 | #ifdef __USE_MISC |
| 134 | # define pseudo_AF_XTP PF_XTP |
| 135 | #endif |
| 136 | #define AF_COIP PF_COIP |
| 137 | #define AF_CNT PF_CNT |
| 138 | #ifdef __USE_MISC |
| 139 | # define pseudo_AF_RTIP PF_RTIP |
| 140 | #endif |
| 141 | #define AF_IPX PF_IPX |
| 142 | #define AF_SIP PF_SIP |
| 143 | #ifdef __USE_MISC |
| 144 | # define pseudo_AF_PIP PF_PIP |
| 145 | #endif |
| 146 | #define AF_INET6 PF_INET6 |
| 147 | #define AF_MAX PF_MAX |
| 148 | |
| 149 | /* Maximum queue length specifiable by listen. */ |
| 150 | #define SOMAXCONN 4096 /* 5 on the original 4.4 BSD. */ |
| 151 | |
| 152 | /* Get the definition of the macro to define the common sockaddr members. */ |
| 153 | #include <bits/sockaddr.h> |
| 154 | |
| 155 | /* Structure describing a generic socket address. */ |
| 156 | struct sockaddr |
| 157 | { |
| 158 | __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */ |
| 159 | char sa_data[14]; /* Address data. */ |
| 160 | }; |
| 161 | |
| 162 | |
| 163 | /* Structure large enough to hold any socket address (with the historical |
| 164 | exception of AF_UNIX). */ |
| 165 | #if __WORDSIZE == 64 |
| 166 | # define __ss_aligntype __uint64_t |
| 167 | #else |
| 168 | # define __ss_aligntype __uint32_t |
| 169 | #endif |
| 170 | #define _SS_PADSIZE \ |
| 171 | (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype)) |
| 172 | |
| 173 | struct sockaddr_storage |
| 174 | { |
| 175 | __SOCKADDR_COMMON (ss_); /* Address family, etc. */ |
| 176 | char __ss_padding[_SS_PADSIZE]; |
| 177 | __ss_aligntype __ss_align; /* Force desired alignment. */ |
| 178 | }; |
| 179 | |
| 180 | |
| 181 | /* Bits in the FLAGS argument to `send', `recv', et al. */ |
| 182 | enum |
| 183 | { |
| 184 | MSG_OOB = 0x01, /* Process out-of-band data. */ |
| 185 | #define MSG_OOB MSG_OOB |
| 186 | MSG_PEEK = 0x02, /* Peek at incoming messages. */ |
| 187 | #define MSG_PEEK MSG_PEEK |
| 188 | MSG_DONTROUTE = 0x04, /* Don't use local routing. */ |
| 189 | #define MSG_DONTROUTE MSG_DONTROUTE |
| 190 | MSG_EOR = 0x08, /* Data completes record. */ |
| 191 | #define MSG_EOR MSG_EOR |
| 192 | MSG_TRUNC = 0x10, /* Data discarded before delivery. */ |
| 193 | #define MSG_TRUNC MSG_TRUNC |
| 194 | MSG_CTRUNC = 0x20, /* Control data lost before delivery. */ |
| 195 | #define MSG_CTRUNC MSG_CTRUNC |
| 196 | MSG_WAITALL = 0x40, /* Wait for full request or error. */ |
| 197 | #define MSG_WAITALL MSG_WAITALL |
| 198 | MSG_DONTWAIT = 0x80, /* This message should be nonblocking. */ |
| 199 | #define MSG_DONTWAIT MSG_DONTWAIT |
| 200 | MSG_NOSIGNAL = 0x0400, /* Do not generate SIGPIPE on EPIPE. */ |
| 201 | #define MSG_NOSIGNAL MSG_NOSIGNAL |
| 202 | MSG_CMSG_CLOEXEC = 0x40000 /* Atomically set close-on-exec flag |
| 203 | for file descriptors in SCM_RIGHTS. */ |
| 204 | #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC |
| 205 | }; |
| 206 | |
| 207 | |
| 208 | /* Structure describing messages sent by |
| 209 | `sendmsg' and received by `recvmsg'. */ |
| 210 | struct msghdr |
| 211 | { |
| 212 | void *msg_name; /* Address to send to/receive from. */ |
| 213 | socklen_t msg_namelen; /* Length of address data. */ |
| 214 | |
| 215 | struct iovec *msg_iov; /* Vector of data to send/receive into. */ |
| 216 | int msg_iovlen; /* Number of elements in the vector. */ |
| 217 | |
| 218 | void *msg_control; /* Ancillary data (eg BSD filedesc passing). */ |
| 219 | socklen_t msg_controllen; /* Ancillary data buffer length. */ |
| 220 | |
| 221 | int msg_flags; /* Flags in received message. */ |
| 222 | }; |
| 223 | |
| 224 | /* Structure used for storage of ancillary data object information. */ |
| 225 | struct cmsghdr |
| 226 | { |
| 227 | socklen_t cmsg_len; /* Length of data in cmsg_data plus length |
| 228 | of cmsghdr structure. */ |
| 229 | int cmsg_level; /* Originating protocol. */ |
| 230 | int cmsg_type; /* Protocol specific type. */ |
| 231 | #if __glibc_c99_flexarr_available |
| 232 | __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */ |
| 233 | #endif |
| 234 | }; |
| 235 | |
| 236 | /* Ancillary data object manipulation macros. */ |
| 237 | #if __glibc_c99_flexarr_available |
| 238 | # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data) |
| 239 | #else |
| 240 | # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1)) |
| 241 | #endif |
| 242 | |
| 243 | #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg) |
| 244 | |
| 245 | #define CMSG_FIRSTHDR(mhdr) \ |
| 246 | ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \ |
| 247 | ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0) |
| 248 | |
| 249 | #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \ |
| 250 | & (size_t) ~(sizeof (size_t) - 1)) |
| 251 | #define CMSG_SPACE(len) (CMSG_ALIGN (len) \ |
| 252 | + CMSG_ALIGN (sizeof (struct cmsghdr))) |
| 253 | #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len)) |
| 254 | |
| 255 | /* Given a length, return the additional padding necessary such that |
| 256 | len + __CMSG_PADDING(len) == CMSG_ALIGN (len). */ |
| 257 | #define __CMSG_PADDING(len) ((sizeof (size_t) \ |
| 258 | - ((len) & (sizeof (size_t) - 1))) \ |
| 259 | & (sizeof (size_t) - 1)) |
| 260 | |
| 261 | extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr, |
| 262 | struct cmsghdr *__cmsg) __THROW; |
| 263 | #ifdef __USE_EXTERN_INLINES |
| 264 | # ifndef _EXTERN_INLINE |
| 265 | # define _EXTERN_INLINE __extern_inline |
| 266 | # endif |
| 267 | _EXTERN_INLINE struct cmsghdr * |
| 268 | __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)) |
| 269 | { |
| 270 | /* We may safely assume that __cmsg lies between __mhdr->msg_control and |
| 271 | __mhdr->msg_controllen because the user is required to obtain the first |
| 272 | cmsg via CMSG_FIRSTHDR, set its length, then obtain subsequent cmsgs |
| 273 | via CMSG_NXTHDR, setting lengths along the way. However, we don't yet |
| 274 | trust the value of __cmsg->cmsg_len and therefore do not use it in any |
| 275 | pointer arithmetic until we check its value. */ |
| 276 | |
| 277 | unsigned char * __msg_control_ptr = (unsigned char *) __mhdr->msg_control; |
| 278 | unsigned char * __cmsg_ptr = (unsigned char *) __cmsg; |
| 279 | |
| 280 | size_t __size_needed = sizeof (struct cmsghdr) |
| 281 | + __CMSG_PADDING (__cmsg->cmsg_len); |
| 282 | |
| 283 | /* The current header is malformed, too small to be a full header. */ |
| 284 | if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr)) |
| 285 | return (struct cmsghdr *) 0; |
| 286 | |
| 287 | /* There isn't enough space between __cmsg and the end of the buffer to |
| 288 | hold the current cmsg *and* the next one. */ |
| 289 | if (((size_t) |
| 290 | (__msg_control_ptr + __mhdr->msg_controllen - __cmsg_ptr) |
| 291 | < __size_needed) |
| 292 | || ((size_t) |
| 293 | (__msg_control_ptr + __mhdr->msg_controllen - __cmsg_ptr |
| 294 | - __size_needed) |
| 295 | < __cmsg->cmsg_len)) |
| 296 | |
| 297 | return (struct cmsghdr *) 0; |
| 298 | |
| 299 | /* Now, we trust cmsg_len and can use it to find the next header. */ |
| 300 | __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg |
| 301 | + CMSG_ALIGN (__cmsg->cmsg_len)); |
| 302 | return __cmsg; |
| 303 | } |
| 304 | #endif /* Use `extern inline'. */ |
| 305 | |
| 306 | /* Socket level message types. */ |
| 307 | enum |
| 308 | { |
| 309 | SCM_RIGHTS = 0x01, /* Access rights (array of int). */ |
| 310 | #define SCM_RIGHTS SCM_RIGHTS |
| 311 | SCM_TIMESTAMP = 0x02, /* Timestamp (struct timeval). */ |
| 312 | #define SCM_TIMESTAMP SCM_TIMESTAMP |
| 313 | SCM_CREDS = 0x03 /* Process creds (struct cmsgcred). */ |
| 314 | #define SCM_CREDS SCM_CREDS |
| 315 | }; |
| 316 | |
| 317 | #ifdef __USE_MISC |
| 318 | /* Unfortunately, BSD practice dictates this structure be of fixed size. |
| 319 | If there are more than CMGROUP_MAX groups, the list is truncated. |
| 320 | (On GNU systems, the `cmcred_euid' field is just the first in the |
| 321 | list of effective UIDs.) */ |
| 322 | #define CMGROUP_MAX 16 |
| 323 | |
| 324 | /* Structure delivered by SCM_CREDS. This describes the identity of the |
| 325 | sender of the data simultaneously received on the socket. By BSD |
| 326 | convention, this is included only when a sender on a AF_LOCAL socket |
| 327 | sends cmsg data of this type and size; the sender's structure is |
| 328 | ignored, and the system fills in the various IDs of the sender process. */ |
| 329 | struct cmsgcred |
| 330 | { |
| 331 | __pid_t cmcred_pid; |
| 332 | __uid_t cmcred_uid; |
| 333 | __uid_t cmcred_euid; |
| 334 | __gid_t cmcred_gid; |
| 335 | int cmcred_ngroups; |
| 336 | __gid_t cmcred_groups[CMGROUP_MAX]; |
| 337 | }; |
| 338 | #endif |
| 339 | |
| 340 | /* Protocol number used to manipulate socket-level options |
| 341 | with `getsockopt' and `setsockopt'. */ |
| 342 | #define SOL_SOCKET 0xffff |
| 343 | |
| 344 | /* Socket-level options for `getsockopt' and `setsockopt'. */ |
| 345 | enum |
| 346 | { |
| 347 | SO_DEBUG = 0x0001, /* Record debugging information. */ |
| 348 | #define SO_DEBUG SO_DEBUG |
| 349 | SO_ACCEPTCONN = 0x0002, /* Accept connections on socket. */ |
| 350 | #define SO_ACCEPTCONN SO_ACCEPTCONN |
| 351 | SO_REUSEADDR = 0x0004, /* Allow reuse of local addresses. */ |
| 352 | #define SO_REUSEADDR SO_REUSEADDR |
| 353 | SO_KEEPALIVE = 0x0008, /* Keep connections alive and send |
| 354 | SIGPIPE when they die. */ |
| 355 | #define SO_KEEPALIVE SO_KEEPALIVE |
| 356 | SO_DONTROUTE = 0x0010, /* Don't do local routing. */ |
| 357 | #define SO_DONTROUTE SO_DONTROUTE |
| 358 | SO_BROADCAST = 0x0020, /* Allow transmission of |
| 359 | broadcast messages. */ |
| 360 | #define SO_BROADCAST SO_BROADCAST |
| 361 | SO_USELOOPBACK = 0x0040, /* Use the software loopback to avoid |
| 362 | hardware use when possible. */ |
| 363 | #define SO_USELOOPBACK SO_USELOOPBACK |
| 364 | SO_LINGER = 0x0080, /* Block on close of a reliable |
| 365 | socket to transmit pending data. */ |
| 366 | #define SO_LINGER SO_LINGER |
| 367 | SO_OOBINLINE = 0x0100, /* Receive out-of-band data in-band. */ |
| 368 | #define SO_OOBINLINE SO_OOBINLINE |
| 369 | SO_REUSEPORT = 0x0200, /* Allow local address and port reuse. */ |
| 370 | #define SO_REUSEPORT SO_REUSEPORT |
| 371 | SO_SNDBUF = 0x1001, /* Send buffer size. */ |
| 372 | #define SO_SNDBUF SO_SNDBUF |
| 373 | SO_RCVBUF = 0x1002, /* Receive buffer. */ |
| 374 | #define SO_RCVBUF SO_RCVBUF |
| 375 | SO_SNDLOWAT = 0x1003, /* Send low-water mark. */ |
| 376 | #define SO_SNDLOWAT SO_SNDLOWAT |
| 377 | SO_RCVLOWAT = 0x1004, /* Receive low-water mark. */ |
| 378 | #define SO_RCVLOWAT SO_RCVLOWAT |
| 379 | SO_SNDTIMEO = 0x1005, /* Send timeout. */ |
| 380 | #define SO_SNDTIMEO SO_SNDTIMEO |
| 381 | SO_RCVTIMEO = 0x1006, /* Receive timeout. */ |
| 382 | #define SO_RCVTIMEO SO_RCVTIMEO |
| 383 | SO_ERROR = 0x1007, /* Get and clear error status. */ |
| 384 | #define SO_ERROR SO_ERROR |
| 385 | SO_STYLE = 0x1008, /* Get socket connection style. */ |
| 386 | #define SO_STYLE SO_STYLE |
| 387 | SO_TYPE = SO_STYLE /* Compatible name for SO_STYLE. */ |
| 388 | #define SO_TYPE SO_TYPE |
| 389 | }; |
| 390 | |
| 391 | /* Structure used to manipulate the SO_LINGER option. */ |
| 392 | struct linger |
| 393 | { |
| 394 | int l_onoff; /* Nonzero to linger on close. */ |
| 395 | int l_linger; /* Time to linger. */ |
| 396 | }; |
| 397 | |
| 398 | #endif /* bits/socket.h */ |
| 399 |
Warning: This file is not a C or C++ file. It does not have highlighting.