socket.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. /* System-specific socket constants and types. Linux version.
  2. Copyright (C) 1991-2016 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_MAX 41 /* For now.. */
  76. /* Address families. */
  77. #define AF_UNSPEC PF_UNSPEC
  78. #define AF_LOCAL PF_LOCAL
  79. #define AF_UNIX PF_UNIX
  80. #define AF_FILE PF_FILE
  81. #define AF_INET PF_INET
  82. #define AF_AX25 PF_AX25
  83. #define AF_IPX PF_IPX
  84. #define AF_APPLETALK PF_APPLETALK
  85. #define AF_NETROM PF_NETROM
  86. #define AF_BRIDGE PF_BRIDGE
  87. #define AF_ATMPVC PF_ATMPVC
  88. #define AF_X25 PF_X25
  89. #define AF_INET6 PF_INET6
  90. #define AF_ROSE PF_ROSE
  91. #define AF_DECnet PF_DECnet
  92. #define AF_NETBEUI PF_NETBEUI
  93. #define AF_SECURITY PF_SECURITY
  94. #define AF_KEY PF_KEY
  95. #define AF_NETLINK PF_NETLINK
  96. #define AF_ROUTE PF_ROUTE
  97. #define AF_PACKET PF_PACKET
  98. #define AF_ASH PF_ASH
  99. #define AF_ECONET PF_ECONET
  100. #define AF_ATMSVC PF_ATMSVC
  101. #define AF_RDS PF_RDS
  102. #define AF_SNA PF_SNA
  103. #define AF_IRDA PF_IRDA
  104. #define AF_PPPOX PF_PPPOX
  105. #define AF_WANPIPE PF_WANPIPE
  106. #define AF_LLC PF_LLC
  107. #define AF_IB PF_IB
  108. #define AF_MPLS PF_MPLS
  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_MAX PF_MAX
  122. /* Socket level values. Others are defined in the appropriate headers.
  123. XXX These definitions also should go into the appropriate headers as
  124. far as they are available. */
  125. #define SOL_RAW 255
  126. #define SOL_DECNET 261
  127. #define SOL_X25 262
  128. #define SOL_PACKET 263
  129. #define SOL_ATM 264 /* ATM layer (cell level). */
  130. #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
  131. #define SOL_IRDA 266
  132. /* Maximum queue length specifiable by listen. */
  133. #define SOMAXCONN 128
  134. /* Get the definition of the macro to define the common sockaddr members. */
  135. #include <bits/sockaddr.h>
  136. /* Structure describing a generic socket address. */
  137. struct sockaddr
  138. {
  139. __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
  140. char sa_data[14]; /* Address data. */
  141. };
  142. /* Structure large enough to hold any socket address (with the historical
  143. exception of AF_UNIX). */
  144. #define __ss_aligntype unsigned long int
  145. #define _SS_PADSIZE \
  146. (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype))
  147. struct sockaddr_storage
  148. {
  149. __SOCKADDR_COMMON (ss_); /* Address family, etc. */
  150. char __ss_padding[_SS_PADSIZE];
  151. __ss_aligntype __ss_align; /* Force desired alignment. */
  152. };
  153. /* Bits in the FLAGS argument to `send', `recv', et al. */
  154. enum
  155. {
  156. MSG_OOB = 0x01, /* Process out-of-band data. */
  157. #define MSG_OOB MSG_OOB
  158. MSG_PEEK = 0x02, /* Peek at incoming messages. */
  159. #define MSG_PEEK MSG_PEEK
  160. MSG_DONTROUTE = 0x04, /* Don't use local routing. */
  161. #define MSG_DONTROUTE MSG_DONTROUTE
  162. #ifdef __USE_GNU
  163. /* DECnet uses a different name. */
  164. MSG_TRYHARD = MSG_DONTROUTE,
  165. # define MSG_TRYHARD MSG_DONTROUTE
  166. #endif
  167. MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
  168. #define MSG_CTRUNC MSG_CTRUNC
  169. MSG_PROXY = 0x10, /* Supply or ask second address. */
  170. #define MSG_PROXY MSG_PROXY
  171. MSG_TRUNC = 0x20,
  172. #define MSG_TRUNC MSG_TRUNC
  173. MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
  174. #define MSG_DONTWAIT MSG_DONTWAIT
  175. MSG_EOR = 0x80, /* End of record. */
  176. #define MSG_EOR MSG_EOR
  177. MSG_WAITALL = 0x100, /* Wait for a full request. */
  178. #define MSG_WAITALL MSG_WAITALL
  179. MSG_FIN = 0x200,
  180. #define MSG_FIN MSG_FIN
  181. MSG_SYN = 0x400,
  182. #define MSG_SYN MSG_SYN
  183. MSG_CONFIRM = 0x800, /* Confirm path validity. */
  184. #define MSG_CONFIRM MSG_CONFIRM
  185. MSG_RST = 0x1000,
  186. #define MSG_RST MSG_RST
  187. MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
  188. #define MSG_ERRQUEUE MSG_ERRQUEUE
  189. MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */
  190. #define MSG_NOSIGNAL MSG_NOSIGNAL
  191. MSG_MORE = 0x8000, /* Sender will send more. */
  192. #define MSG_MORE MSG_MORE
  193. MSG_WAITFORONE = 0x10000, /* Wait for at least one packet to return.*/
  194. #define MSG_WAITFORONE MSG_WAITFORONE
  195. MSG_FASTOPEN = 0x20000000, /* Send data in TCP SYN. */
  196. #define MSG_FASTOPEN MSG_FASTOPEN
  197. MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file
  198. descriptor received through
  199. SCM_RIGHTS. */
  200. #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
  201. };
  202. /* Structure describing messages sent by
  203. `sendmsg' and received by `recvmsg'. */
  204. struct msghdr
  205. {
  206. void *msg_name; /* Address to send to/receive from. */
  207. socklen_t msg_namelen; /* Length of address data. */
  208. struct iovec *msg_iov; /* Vector of data to send/receive into. */
  209. size_t msg_iovlen; /* Number of elements in the vector. */
  210. void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
  211. size_t msg_controllen; /* Ancillary data buffer length.
  212. !! The type should be socklen_t but the
  213. definition of the kernel is incompatible
  214. with this. */
  215. int msg_flags; /* Flags on received message. */
  216. };
  217. /* Structure used for storage of ancillary data object information. */
  218. struct cmsghdr
  219. {
  220. size_t cmsg_len; /* Length of data in cmsg_data plus length
  221. of cmsghdr structure.
  222. !! The type should be socklen_t but the
  223. definition of the kernel is incompatible
  224. with this. */
  225. int cmsg_level; /* Originating protocol. */
  226. int cmsg_type; /* Protocol specific type. */
  227. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  228. __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
  229. #endif
  230. };
  231. /* Ancillary data object manipulation macros. */
  232. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  233. # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
  234. #else
  235. # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
  236. #endif
  237. #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
  238. #define CMSG_FIRSTHDR(mhdr) \
  239. ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
  240. ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
  241. #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
  242. & (size_t) ~(sizeof (size_t) - 1))
  243. #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
  244. + CMSG_ALIGN (sizeof (struct cmsghdr)))
  245. #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
  246. extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
  247. struct cmsghdr *__cmsg) __THROW;
  248. #ifdef __USE_EXTERN_INLINES
  249. # ifndef _EXTERN_INLINE
  250. # define _EXTERN_INLINE __extern_inline
  251. # endif
  252. _EXTERN_INLINE struct cmsghdr *
  253. __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
  254. {
  255. if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
  256. /* The kernel header does this so there may be a reason. */
  257. return (struct cmsghdr *) 0;
  258. __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
  259. + CMSG_ALIGN (__cmsg->cmsg_len));
  260. if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
  261. + __mhdr->msg_controllen)
  262. || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
  263. > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
  264. /* No more entries. */
  265. return (struct cmsghdr *) 0;
  266. return __cmsg;
  267. }
  268. #endif /* Use `extern inline'. */
  269. /* Socket level message types. This must match the definitions in
  270. <linux/socket.h>. */
  271. enum
  272. {
  273. SCM_RIGHTS = 0x01 /* Transfer file descriptors. */
  274. #define SCM_RIGHTS SCM_RIGHTS
  275. #ifdef __USE_GNU
  276. , SCM_CREDENTIALS = 0x02 /* Credentials passing. */
  277. # define SCM_CREDENTIALS SCM_CREDENTIALS
  278. #endif
  279. };
  280. #ifdef __USE_GNU
  281. /* User visible structure for SCM_CREDENTIALS message */
  282. struct ucred
  283. {
  284. pid_t pid; /* PID of sending process. */
  285. uid_t uid; /* UID of sending process. */
  286. gid_t gid; /* GID of sending process. */
  287. };
  288. #endif
  289. /* Ugly workaround for unclean kernel headers. */
  290. #ifndef __USE_MISC
  291. # ifndef FIOGETOWN
  292. # define __SYS_SOCKET_H_undef_FIOGETOWN
  293. # endif
  294. # ifndef FIOSETOWN
  295. # define __SYS_SOCKET_H_undef_FIOSETOWN
  296. # endif
  297. # ifndef SIOCATMARK
  298. # define __SYS_SOCKET_H_undef_SIOCATMARK
  299. # endif
  300. # ifndef SIOCGPGRP
  301. # define __SYS_SOCKET_H_undef_SIOCGPGRP
  302. # endif
  303. # ifndef SIOCGSTAMP
  304. # define __SYS_SOCKET_H_undef_SIOCGSTAMP
  305. # endif
  306. # ifndef SIOCGSTAMPNS
  307. # define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
  308. # endif
  309. # ifndef SIOCSPGRP
  310. # define __SYS_SOCKET_H_undef_SIOCSPGRP
  311. # endif
  312. #endif
  313. /* Get socket manipulation related informations from kernel headers. */
  314. #include <asm/socket.h>
  315. #ifndef __USE_MISC
  316. # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
  317. # undef __SYS_SOCKET_H_undef_FIOGETOWN
  318. # undef FIOGETOWN
  319. # endif
  320. # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
  321. # undef __SYS_SOCKET_H_undef_FIOSETOWN
  322. # undef FIOSETOWN
  323. # endif
  324. # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
  325. # undef __SYS_SOCKET_H_undef_SIOCATMARK
  326. # undef SIOCATMARK
  327. # endif
  328. # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
  329. # undef __SYS_SOCKET_H_undef_SIOCGPGRP
  330. # undef SIOCGPGRP
  331. # endif
  332. # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
  333. # undef __SYS_SOCKET_H_undef_SIOCGSTAMP
  334. # undef SIOCGSTAMP
  335. # endif
  336. # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
  337. # undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
  338. # undef SIOCGSTAMPNS
  339. # endif
  340. # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
  341. # undef __SYS_SOCKET_H_undef_SIOCSPGRP
  342. # undef SIOCSPGRP
  343. # endif
  344. #endif
  345. /* Structure used to manipulate the SO_LINGER option. */
  346. struct linger
  347. {
  348. int l_onoff; /* Nonzero to linger on close. */
  349. int l_linger; /* Time to linger. */
  350. };
  351. #endif /* bits/socket.h */