socket.h 12 KB

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