socket.h 13 KB

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