socket.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. /* System-specific socket constants and types. Linux version.
  2. Copyright (C) 1991,1992,1994-1999,2000,2001 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, write to the Free
  14. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  15. 02111-1307 USA. */
  16. #ifndef __BITS_SOCKET_H
  17. #define __BITS_SOCKET_H
  18. #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_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>
  25. #include <sys/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. SOCK_PACKET = 10 /* Linux specific way of getting packets
  48. at the dev level. For writing rarp and
  49. other similar things on the user level. */
  50. #define SOCK_PACKET SOCK_PACKET
  51. };
  52. /* Protocol families. */
  53. #define PF_UNSPEC 0 /* Unspecified. */
  54. #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
  55. #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
  56. #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
  57. #define PF_INET 2 /* IP protocol family. */
  58. #define PF_AX25 3 /* Amateur Radio AX.25. */
  59. #define PF_IPX 4 /* Novell Internet Protocol. */
  60. #define PF_APPLETALK 5 /* Appletalk DDP. */
  61. #define PF_NETROM 6 /* Amateur radio NetROM. */
  62. #define PF_BRIDGE 7 /* Multiprotocol bridge. */
  63. #define PF_ATMPVC 8 /* ATM PVCs. */
  64. #define PF_X25 9 /* Reserved for X.25 project. */
  65. #define PF_INET6 10 /* IP version 6. */
  66. #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
  67. #define PF_DECnet 12 /* Reserved for DECnet project. */
  68. #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
  69. #define PF_SECURITY 14 /* Security callback pseudo AF. */
  70. #define PF_KEY 15 /* PF_KEY key management API. */
  71. #define PF_NETLINK 16
  72. #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
  73. #define PF_PACKET 17 /* Packet family. */
  74. #define PF_ASH 18 /* Ash. */
  75. #define PF_ECONET 19 /* Acorn Econet. */
  76. #define PF_ATMSVC 20 /* ATM SVCs. */
  77. #define PF_SNA 22 /* Linux SNA Project */
  78. #define PF_IRDA 23 /* IRDA sockets. */
  79. #define PF_PPPOX 24 /* PPPoX sockets. */
  80. #define PF_WANPIPE 25 /* Wanpipe API sockets. */
  81. #define PF_BLUETOOTH 31 /* Bluetooth sockets. */
  82. #define PF_MAX 32 /* For now.. */
  83. /* Address families. */
  84. #define AF_UNSPEC PF_UNSPEC
  85. #define AF_LOCAL PF_LOCAL
  86. #define AF_UNIX PF_UNIX
  87. #define AF_FILE PF_FILE
  88. #define AF_INET PF_INET
  89. #define AF_AX25 PF_AX25
  90. #define AF_IPX PF_IPX
  91. #define AF_APPLETALK PF_APPLETALK
  92. #define AF_NETROM PF_NETROM
  93. #define AF_BRIDGE PF_BRIDGE
  94. #define AF_ATMPVC PF_ATMPVC
  95. #define AF_X25 PF_X25
  96. #define AF_INET6 PF_INET6
  97. #define AF_ROSE PF_ROSE
  98. #define AF_DECnet PF_DECnet
  99. #define AF_NETBEUI PF_NETBEUI
  100. #define AF_SECURITY PF_SECURITY
  101. #define AF_KEY PF_KEY
  102. #define AF_NETLINK PF_NETLINK
  103. #define AF_ROUTE PF_ROUTE
  104. #define AF_PACKET PF_PACKET
  105. #define AF_ASH PF_ASH
  106. #define AF_ECONET PF_ECONET
  107. #define AF_ATMSVC PF_ATMSVC
  108. #define AF_SNA PF_SNA
  109. #define AF_IRDA PF_IRDA
  110. #define AF_PPPOX PF_PPPOX
  111. #define AF_WANPIPE PF_WANPIPE
  112. #define AF_BLUETOOTH PF_BLUETOOTH
  113. #define AF_MAX PF_MAX
  114. /* Socket level values. Others are defined in the appropriate headers.
  115. XXX These definitions also should go into the appropriate headers as
  116. far as they are available. */
  117. #define SOL_RAW 255
  118. #define SOL_DECNET 261
  119. #define SOL_X25 262
  120. #define SOL_PACKET 263
  121. #define SOL_ATM 264 /* ATM layer (cell level). */
  122. #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
  123. #define SOL_IRDA 266
  124. /* Maximum queue length specifiable by listen. */
  125. #define SOMAXCONN 128
  126. /* Get the definition of the macro to define the common sockaddr members. */
  127. #include <bits/sockaddr.h>
  128. /* Structure describing a generic socket address. */
  129. struct sockaddr
  130. {
  131. __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
  132. char sa_data[14]; /* Address data. */
  133. };
  134. /* Structure large enough to hold any socket address (with the historical
  135. exception of AF_UNIX). We reserve 128 bytes. */
  136. #if ULONG_MAX > 0xffffffff
  137. # define __ss_aligntype __uint64_t
  138. #else
  139. # define __ss_aligntype __uint32_t
  140. #endif
  141. #define _SS_SIZE 128
  142. #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
  143. struct sockaddr_storage
  144. {
  145. __SOCKADDR_COMMON (ss_); /* Address family, etc. */
  146. __ss_aligntype __ss_align; /* Force desired alignment. */
  147. char __ss_padding[_SS_PADSIZE];
  148. };
  149. /* Bits in the FLAGS argument to `send', `recv', et al. */
  150. enum
  151. {
  152. MSG_OOB = 0x01, /* Process out-of-band data. */
  153. #define MSG_OOB MSG_OOB
  154. MSG_PEEK = 0x02, /* Peek at incoming messages. */
  155. #define MSG_PEEK MSG_PEEK
  156. MSG_DONTROUTE = 0x04, /* Don't use local routing. */
  157. #define MSG_DONTROUTE MSG_DONTROUTE
  158. #ifdef __USE_GNU
  159. /* DECnet uses a different name. */
  160. MSG_TRYHARD = MSG_DONTROUTE,
  161. # define MSG_TRYHARD MSG_DONTROUTE
  162. #endif
  163. MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
  164. #define MSG_CTRUNC MSG_CTRUNC
  165. MSG_PROXY = 0x10, /* Supply or ask second address. */
  166. #define MSG_PROXY MSG_PROXY
  167. MSG_TRUNC = 0x20,
  168. #define MSG_TRUNC MSG_TRUNC
  169. MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
  170. #define MSG_DONTWAIT MSG_DONTWAIT
  171. MSG_EOR = 0x80, /* End of record. */
  172. #define MSG_EOR MSG_EOR
  173. MSG_WAITALL = 0x100, /* Wait for a full request. */
  174. #define MSG_WAITALL MSG_WAITALL
  175. MSG_FIN = 0x200,
  176. #define MSG_FIN MSG_FIN
  177. MSG_SYN = 0x400,
  178. #define MSG_SYN MSG_SYN
  179. MSG_CONFIRM = 0x800, /* Confirm path validity. */
  180. #define MSG_CONFIRM MSG_CONFIRM
  181. MSG_RST = 0x1000,
  182. #define MSG_RST MSG_RST
  183. MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
  184. #define MSG_ERRQUEUE MSG_ERRQUEUE
  185. MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */
  186. #define MSG_NOSIGNAL MSG_NOSIGNAL
  187. MSG_MORE = 0x8000 /* Sender will send more. */
  188. #define MSG_MORE MSG_MORE
  189. };
  190. /* Structure describing messages sent by
  191. `sendmsg' and received by `recvmsg'. */
  192. struct msghdr
  193. {
  194. void *msg_name; /* Address to send to/receive from. */
  195. socklen_t msg_namelen; /* Length of address data. */
  196. struct iovec *msg_iov; /* Vector of data to send/receive into. */
  197. int msg_iovlen; /* Number of elements in the vector. */
  198. void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
  199. socklen_t msg_controllen; /* Ancillary data buffer length. */
  200. int msg_flags; /* Flags on received message. */
  201. };
  202. /* Structure used for storage of ancillary data object information. */
  203. struct cmsghdr
  204. {
  205. size_t cmsg_len; /* Length of data in cmsg_data plus length
  206. of cmsghdr structure. */
  207. int cmsg_level; /* Originating protocol. */
  208. int cmsg_type; /* Protocol specific type. */
  209. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  210. __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
  211. #endif
  212. };
  213. /* Ancillary data object manipulation macros. */
  214. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  215. # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
  216. #else
  217. # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
  218. #endif
  219. #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
  220. #define CMSG_FIRSTHDR(mhdr) \
  221. ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
  222. ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
  223. #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
  224. & (size_t) ~(sizeof (size_t) - 1))
  225. #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
  226. + CMSG_ALIGN (sizeof (struct cmsghdr)))
  227. #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
  228. extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
  229. struct cmsghdr *__cmsg) __THROW;
  230. #ifdef __USE_EXTERN_INLINES
  231. # ifndef _EXTERN_INLINE
  232. # define _EXTERN_INLINE extern __inline
  233. # endif
  234. _EXTERN_INLINE struct cmsghdr *
  235. __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg) __THROW
  236. {
  237. if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
  238. /* The kernel header does this so there may be a reason. */
  239. return 0;
  240. __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
  241. + CMSG_ALIGN (__cmsg->cmsg_len));
  242. if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
  243. + __mhdr->msg_controllen)
  244. || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
  245. > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
  246. /* No more entries. */
  247. return 0;
  248. return __cmsg;
  249. }
  250. #endif /* Use `extern inline'. */
  251. /* Socket level message types. This must match the definitions in
  252. <linux/socket.h>. */
  253. enum
  254. {
  255. SCM_RIGHTS = 0x01, /* Transfer file descriptors. */
  256. #define SCM_RIGHTS SCM_RIGHTS
  257. #ifdef __USE_BSD
  258. SCM_CREDENTIALS = 0x02, /* Credentials passing. */
  259. # define SCM_CREDENTIALS SCM_CREDENTIALS
  260. #endif
  261. __SCM_CONNECT = 0x03 /* Data array is `struct scm_connect'. */
  262. };
  263. /* User visible structure for SCM_CREDENTIALS message */
  264. struct ucred
  265. {
  266. pid_t pid; /* PID of sending process. */
  267. uid_t uid; /* UID of sending process. */
  268. gid_t gid; /* GID of sending process. */
  269. };
  270. /* Get socket manipulation related informations from kernel headers. */
  271. #include <asm/socket.h>
  272. /* Structure used to manipulate the SO_LINGER option. */
  273. struct linger
  274. {
  275. int l_onoff; /* Nonzero to linger on close. */
  276. int l_linger; /* Time to linger. */
  277. };
  278. #endif /* bits/socket.h */