PageRenderTime 59ms CodeModel.GetById 31ms RepoModel.GetById 0ms app.codeStats 1ms

/sysdeps/unix/bsd/bsd4.4/bits/socket.h

https://github.com/mseaborn/plash-glibc
C Header | 343 lines | 251 code | 36 blank | 56 comment | 7 complexity | ec7713ef9e75f08c9cf8cafd7155b815 MD5 | raw file
Possible License(s): GPL-2.0
  1. /* System-specific socket constants and types. 4.4 BSD version.
  2. Copyright (C) 1991,92,1994-2002,2004,2007 Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public License as
  6. published by the Free Software Foundation; either version 2.1 of the
  7. License, or (at your option) any later version.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; see the file COPYING.LIB. If not,
  14. write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  15. Boston, MA 02111-1307, USA. */
  16. #ifndef __BITS_SOCKET_H
  17. #define __BITS_SOCKET_H 1
  18. #ifndef _SYS_SOCKET_H
  19. # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
  20. #endif
  21. #define __need_size_t
  22. #define __need_NULL
  23. #include <stddef.h>
  24. #include <limits.h> /* XXX Is this allowed? */
  25. #include <bits/types.h>
  26. /* Type for length arguments in socket calls. */
  27. #ifndef __socklen_t_defined
  28. typedef __socklen_t socklen_t;
  29. # define __socklen_t_defined
  30. #endif
  31. /* Types of sockets. */
  32. enum __socket_type
  33. {
  34. SOCK_STREAM = 1, /* Sequenced, reliable, connection-based
  35. byte streams. */
  36. #define SOCK_STREAM SOCK_STREAM
  37. SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams
  38. of fixed maximum length. */
  39. #define SOCK_DGRAM SOCK_DGRAM
  40. SOCK_RAW = 3, /* Raw protocol interface. */
  41. #define SOCK_RAW SOCK_RAW
  42. SOCK_RDM = 4, /* Reliably-delivered messages. */
  43. #define SOCK_RDM SOCK_RDM
  44. SOCK_SEQPACKET = 5 /* Sequenced, reliable, connection-based,
  45. datagrams of fixed maximum length. */
  46. #define SOCK_SEQPACKET SOCK_SEQPACKET
  47. };
  48. /* Protocol families. */
  49. #define PF_UNSPEC 0 /* Unspecified. */
  50. #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
  51. #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
  52. #define PF_FILE PF_LOCAL /* POSIX name for PF_LOCAL. */
  53. #define PF_INET 2 /* IP protocol family. */
  54. #define PF_IMPLINK 3 /* ARPAnet IMP protocol. */
  55. #define PF_PUP 4 /* PUP protocols. */
  56. #define PF_CHAOS 5 /* MIT Chaos protocols. */
  57. #define PF_NS 6 /* Xerox NS protocols. */
  58. #define PF_ISO 7 /* ISO protocols. */
  59. #define PF_OSI PF_ISO
  60. #define PF_ECMA 8 /* ECMA protocols. */
  61. #define PF_DATAKIT 9 /* AT&T Datakit protocols. */
  62. #define PF_CCITT 10 /* CCITT protocols (X.25 et al). */
  63. #define PF_SNA 11 /* IBM SNA protocol. */
  64. #define PF_DECnet 12 /* DECnet protocols. */
  65. #define PF_DLI 13 /* Direct data link interface. */
  66. #define PF_LAT 14 /* DEC Local Area Transport protocol. */
  67. #define PF_HYLINK 15 /* NSC Hyperchannel protocol. */
  68. #define PF_APPLETALK 16 /* Don't use this. */
  69. #define PF_ROUTE 17 /* Internal Routing Protocol. */
  70. #define PF_LINK 18 /* Link layer interface. */
  71. #define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */
  72. #define PF_COIP 20 /* Connection-oriented IP, aka ST II. */
  73. #define PF_CNT 21 /* Computer Network Technology. */
  74. #define PF_RTIP 22 /* Help Identify RTIP packets. **/
  75. #define PF_IPX 23 /* Novell Internet Protocol. */
  76. #define PF_SIP 24 /* Simple Internet Protocol. */
  77. #define PF_PIP 25 /* Help Identify PIP packets. */
  78. #define PF_INET6 26 /* IP version 6. */
  79. #define PF_MAX 27
  80. /* Address families. */
  81. #define AF_UNSPEC PF_UNSPEC
  82. #define AF_LOCAL PF_LOCAL
  83. #define AF_UNIX PF_UNIX
  84. #define AF_FILE PF_FILE
  85. #define AF_INET PF_INET
  86. #define AF_IMPLINK PF_IMPLINK
  87. #define AF_PUP PF_PUP
  88. #define AF_CHAOS PF_CHAOS
  89. #define AF_NS PF_NS
  90. #define AF_ISO PF_ISO
  91. #define AF_OSI PF_OSI
  92. #define AF_ECMA PF_ECMA
  93. #define AF_DATAKIT PF_DATAKIT
  94. #define AF_CCITT PF_CCITT
  95. #define AF_SNA PF_SNA
  96. #define AF_DECnet PF_DECnet
  97. #define AF_DLI PF_DLI
  98. #define AF_LAT PF_LAT
  99. #define AF_HYLINK PF_HYLINK
  100. #define AF_APPLETALK PF_APPLETALK
  101. #define AF_ROUTE PF_ROUTE
  102. #define AF_LINK PF_LINK
  103. #define pseudo_AF_XTP PF_XTP
  104. #define AF_COIP PF_COIP
  105. #define AF_CNT PF_CNT
  106. #define pseudo_AF_RTIP PF_RTIP
  107. #define AF_IPX PF_IPX
  108. #define AF_SIP PF_SIP
  109. #define pseudo_AF_PIP PF_PIP
  110. #define AF_INET6 PF_INET6
  111. #define AF_MAX PF_MAX
  112. /* Maximum queue length specifiable by listen. */
  113. #define SOMAXCONN 128 /* 5 on the origional 4.4 BSD. */
  114. /* Get the definition of the macro to define the common sockaddr members. */
  115. #include <bits/sockaddr.h>
  116. /* Structure describing a generic socket address. */
  117. struct sockaddr
  118. {
  119. __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
  120. char sa_data[14]; /* Address data. */
  121. };
  122. /* Structure large enough to hold any socket address (with the historical
  123. exception of AF_UNIX). We reserve 128 bytes. */
  124. #if ULONG_MAX > 0xffffffff
  125. # define __ss_aligntype __uint64_t
  126. #else
  127. # define __ss_aligntype __uint32_t
  128. #endif
  129. #define _SS_SIZE 128
  130. #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
  131. struct sockaddr_storage
  132. {
  133. __SOCKADDR_COMMON (ss_); /* Address family, etc. */
  134. __ss_aligntype __ss_align; /* Force desired alignment. */
  135. char __ss_padding[_SS_PADSIZE];
  136. };
  137. /* Bits in the FLAGS argument to `send', `recv', et al. */
  138. enum
  139. {
  140. MSG_OOB = 0x01, /* Process out-of-band data. */
  141. #define MSG_OOB MSG_OOB
  142. MSG_PEEK = 0x02, /* Peek at incoming messages. */
  143. #define MSG_PEEK MSG_PEEK
  144. MSG_DONTROUTE = 0x04, /* Don't use local routing. */
  145. #define MSG_DONTROUTE MSG_DONTROUTE
  146. MSG_EOR = 0x08, /* Data completes record. */
  147. #define MSG_EOR MSG_EOR
  148. MSG_TRUNC = 0x10, /* Data discarded before delivery. */
  149. #define MSG_TRUNC MSG_TRUNC
  150. MSG_CTRUNC = 0x20, /* Control data lost before delivery. */
  151. #define MSG_CTRUNC MSG_CTRUNC
  152. MSG_WAITALL = 0x40, /* Wait for full request or error. */
  153. #define MSG_WAITALL MSG_WAITALL
  154. MSG_DONTWAIT = 0x80, /* This message should be nonblocking. */
  155. #define MSG_DONTWAIT MSG_DONTWAIT
  156. MSG_NOSIGNAL = 0x0400 /* Do not generate SIGPIPE on EPIPE. */
  157. #define MSG_NOSIGNAL MSG_NOSIGNAL
  158. };
  159. /* Structure describing messages sent by
  160. `sendmsg' and received by `recvmsg'. */
  161. struct msghdr
  162. {
  163. void *msg_name; /* Address to send to/receive from. */
  164. socklen_t msg_namelen; /* Length of address data. */
  165. struct iovec *msg_iov; /* Vector of data to send/receive into. */
  166. int msg_iovlen; /* Number of elements in the vector. */
  167. void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
  168. socklen_t msg_controllen; /* Ancillary data buffer length. */
  169. int msg_flags; /* Flags in received message. */
  170. };
  171. /* Structure used for storage of ancillary data object information. */
  172. struct cmsghdr
  173. {
  174. socklen_t cmsg_len; /* Length of data in cmsg_data plus length
  175. of cmsghdr structure. */
  176. int cmsg_level; /* Originating protocol. */
  177. int cmsg_type; /* Protocol specific type. */
  178. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  179. __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
  180. #endif
  181. };
  182. /* Ancillary data object manipulation macros. */
  183. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  184. # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
  185. #else
  186. # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
  187. #endif
  188. #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
  189. #define CMSG_FIRSTHDR(mhdr) \
  190. ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
  191. ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
  192. #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
  193. & (size_t) ~(sizeof (size_t) - 1))
  194. #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
  195. + CMSG_ALIGN (sizeof (struct cmsghdr)))
  196. #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
  197. extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
  198. struct cmsghdr *__cmsg) __THROW;
  199. #ifdef __USE_EXTERN_INLINES
  200. # ifndef _EXTERN_INLINE
  201. # define _EXTERN_INLINE __extern_inline
  202. # endif
  203. _EXTERN_INLINE struct cmsghdr *
  204. __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
  205. {
  206. if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
  207. /* The kernel header does this so there may be a reason. */
  208. return 0;
  209. __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
  210. + CMSG_ALIGN (__cmsg->cmsg_len));
  211. if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
  212. + __mhdr->msg_controllen)
  213. || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
  214. > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
  215. /* No more entries. */
  216. return 0;
  217. return __cmsg;
  218. }
  219. #endif /* Use `extern inline'. */
  220. /* Socket level message types. */
  221. enum
  222. {
  223. SCM_RIGHTS = 0x01, /* Access rights (array of int). */
  224. #define SCM_RIGHTS SCM_RIGHTS
  225. SCM_TIMESTAMP = 0x02, /* Timestamp (struct timeval). */
  226. #define SCM_TIMESTAMP SCM_TIMESTAMP
  227. SCM_CREDS = 0x03 /* Process creds (struct cmsgcred). */
  228. #define SCM_CREDS SCM_CREDS
  229. };
  230. /* Unfortunately, BSD practice dictates this structure be of fixed size.
  231. If there are more than CMGROUP_MAX groups, the list is truncated.
  232. (On GNU systems, the `cmcred_euid' field is just the first in the
  233. list of effective UIDs.) */
  234. #define CMGROUP_MAX 16
  235. /* Structure delivered by SCM_CREDS. This describes the identity of the
  236. sender of the data simultaneously received on the socket. By BSD
  237. convention, this is included only when a sender on a AF_LOCAL socket
  238. sends cmsg data of this type and size; the sender's structure is
  239. ignored, and the system fills in the various IDs of the sender process. */
  240. struct cmsgcred
  241. {
  242. __pid_t cmcred_pid;
  243. __uid_t cmcred_uid;
  244. __uid_t cmcred_euid;
  245. __gid_t cmcred_gid;
  246. int cmcred_ngroups;
  247. __gid_t cmcred_groups[CMGROUP_MAX];
  248. };
  249. /* Protocol number used to manipulate socket-level options
  250. with `getsockopt' and `setsockopt'. */
  251. #define SOL_SOCKET 0xffff
  252. /* Socket-level options for `getsockopt' and `setsockopt'. */
  253. enum
  254. {
  255. SO_DEBUG = 0x0001, /* Record debugging information. */
  256. #define SO_DEBUG SO_DEBUG
  257. SO_ACCEPTCONN = 0x0002, /* Accept connections on socket. */
  258. #define SO_ACCEPTCONN SO_ACCEPTCONN
  259. SO_REUSEADDR = 0x0004, /* Allow reuse of local addresses. */
  260. #define SO_REUSEADDR SO_REUSEADDR
  261. SO_KEEPALIVE = 0x0008, /* Keep connections alive and send
  262. SIGPIPE when they die. */
  263. #define SO_KEEPALIVE SO_KEEPALIVE
  264. SO_DONTROUTE = 0x0010, /* Don't do local routing. */
  265. #define SO_DONTROUTE SO_DONTROUTE
  266. SO_BROADCAST = 0x0020, /* Allow transmission of
  267. broadcast messages. */
  268. #define SO_BROADCAST SO_BROADCAST
  269. SO_USELOOPBACK = 0x0040, /* Use the software loopback to avoid
  270. hardware use when possible. */
  271. #define SO_USELOOPBACK SO_USELOOPBACK
  272. SO_LINGER = 0x0080, /* Block on close of a reliable
  273. socket to transmit pending data. */
  274. #define SO_LINGER SO_LINGER
  275. SO_OOBINLINE = 0x0100, /* Receive out-of-band data in-band. */
  276. #define SO_OOBINLINE SO_OOBINLINE
  277. SO_REUSEPORT = 0x0200, /* Allow local address and port reuse. */
  278. #define SO_REUSEPORT SO_REUSEPORT
  279. SO_SNDBUF = 0x1001, /* Send buffer size. */
  280. #define SO_SNDBUF SO_SNDBUF
  281. SO_RCVBUF = 0x1002, /* Receive buffer. */
  282. #define SO_RCVBUF SO_RCVBUF
  283. SO_SNDLOWAT = 0x1003, /* Send low-water mark. */
  284. #define SO_SNDLOWAT SO_SNDLOWAT
  285. SO_RCVLOWAT = 0x1004, /* Receive low-water mark. */
  286. #define SO_RCVLOWAT SO_RCVLOWAT
  287. SO_SNDTIMEO = 0x1005, /* Send timeout. */
  288. #define SO_SNDTIMEO SO_SNDTIMEO
  289. SO_RCVTIMEO = 0x1006, /* Receive timeout. */
  290. #define SO_RCVTIMEO SO_RCVTIMEO
  291. SO_ERROR = 0x1007, /* Get and clear error status. */
  292. #define SO_ERROR SO_ERROR
  293. SO_STYLE = 0x1008, /* Get socket connection style. */
  294. #define SO_STYLE SO_STYLE
  295. SO_TYPE = SO_STYLE /* Compatible name for SO_STYLE. */
  296. #define SO_TYPE SO_TYPE
  297. };
  298. /* Structure used to manipulate the SO_LINGER option. */
  299. struct linger
  300. {
  301. int l_onoff; /* Nonzero to linger on close. */
  302. int l_linger; /* Time to linger. */
  303. };
  304. #endif /* bits/socket.h */