socket.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. /* System-specific socket constants and types. Linux/MIPS version.
  2. Copyright (C) 1991, 92, 1994-1999, 2000, 2001, 2004, 2005, 2006
  3. Free Software Foundation, Inc.
  4. This file is part of the GNU C Library.
  5. The GNU C Library is free software; you can redistribute it and/or
  6. modify it under the terms of the GNU Lesser General Public
  7. License as published by the Free Software Foundation; either
  8. version 2.1 of the License, or (at your option) any later version.
  9. The GNU C Library is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. Lesser General Public License for more details.
  13. You should have received a copy of the GNU Lesser General Public
  14. License along with the GNU C Library; if not, write to the Free
  15. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  16. 02111-1307 USA. */
  17. #ifndef __BITS_SOCKET_H
  18. #define __BITS_SOCKET_H
  19. #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
  20. # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
  21. #endif
  22. #define __need_size_t
  23. #define __need_NULL
  24. #include <stddef.h>
  25. #include <limits.h>
  26. #include <sys/types.h>
  27. /* Type for length arguments in socket calls. */
  28. #ifndef __socklen_t_defined
  29. typedef __socklen_t socklen_t;
  30. # define __socklen_t_defined
  31. #endif
  32. /* Types of sockets. */
  33. enum __socket_type
  34. {
  35. SOCK_DGRAM = 1, /* Connectionless, unreliable datagrams
  36. of fixed maximum length. */
  37. #define SOCK_DGRAM SOCK_DGRAM
  38. SOCK_STREAM = 2, /* Sequenced, reliable, connection-based
  39. byte streams. */
  40. #define SOCK_STREAM SOCK_STREAM
  41. SOCK_RAW = 3, /* Raw protocol interface. */
  42. #define SOCK_RAW SOCK_RAW
  43. SOCK_RDM = 4, /* Reliably-delivered messages. */
  44. #define SOCK_RDM SOCK_RDM
  45. SOCK_SEQPACKET = 5, /* Sequenced, reliable, connection-based,
  46. datagrams of fixed maximum length. */
  47. #define SOCK_SEQPACKET SOCK_SEQPACKET
  48. SOCK_DCCP = 6,
  49. #define SOCK_DCCP SOCK_DCCP /* Datagram Congestion Control Protocol. */
  50. SOCK_PACKET = 10, /* Linux specific way of getting packets
  51. at the dev level. For writing rarp and
  52. other similar things on the user level. */
  53. #define SOCK_PACKET SOCK_PACKET
  54. /* Flags to be ORed into the type parameter of socket and socketpair and
  55. used for the flags parameter of paccept. */
  56. SOCK_CLOEXEC = 02000000, /* Atomically set close-on-exec flag for the
  57. new descriptor(s). */
  58. #define SOCK_CLOEXEC SOCK_CLOEXEC
  59. SOCK_NONBLOCK = 0200 /* Atomically mark descriptor(s) as
  60. non-blocking. */
  61. #define SOCK_NONBLOCK SOCK_NONBLOCK
  62. };
  63. /* Protocol families. */
  64. #define PF_UNSPEC 0 /* Unspecified. */
  65. #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
  66. #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
  67. #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
  68. #define PF_INET 2 /* IP protocol family. */
  69. #define PF_AX25 3 /* Amateur Radio AX.25. */
  70. #define PF_IPX 4 /* Novell Internet Protocol. */
  71. #define PF_APPLETALK 5 /* Appletalk DDP. */
  72. #define PF_NETROM 6 /* Amateur radio NetROM. */
  73. #define PF_BRIDGE 7 /* Multiprotocol bridge. */
  74. #define PF_ATMPVC 8 /* ATM PVCs. */
  75. #define PF_X25 9 /* Reserved for X.25 project. */
  76. #define PF_INET6 10 /* IP version 6. */
  77. #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
  78. #define PF_DECnet 12 /* Reserved for DECnet project. */
  79. #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
  80. #define PF_SECURITY 14 /* Security callback pseudo AF. */
  81. #define PF_KEY 15 /* PF_KEY key management API. */
  82. #define PF_NETLINK 16
  83. #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
  84. #define PF_PACKET 17 /* Packet family. */
  85. #define PF_ASH 18 /* Ash. */
  86. #define PF_ECONET 19 /* Acorn Econet. */
  87. #define PF_ATMSVC 20 /* ATM SVCs. */
  88. #define PF_SNA 22 /* Linux SNA Project */
  89. #define PF_IRDA 23 /* IRDA sockets. */
  90. #define PF_PPPOX 24 /* PPPoX sockets. */
  91. #define PF_WANPIPE 25 /* Wanpipe API sockets. */
  92. #define PF_BLUETOOTH 31 /* Bluetooth sockets. */
  93. #define PF_MAX 32 /* For now.. */
  94. /* Address families. */
  95. #define AF_UNSPEC PF_UNSPEC
  96. #define AF_LOCAL PF_LOCAL
  97. #define AF_UNIX PF_UNIX
  98. #define AF_FILE PF_FILE
  99. #define AF_INET PF_INET
  100. #define AF_AX25 PF_AX25
  101. #define AF_IPX PF_IPX
  102. #define AF_APPLETALK PF_APPLETALK
  103. #define AF_NETROM PF_NETROM
  104. #define AF_BRIDGE PF_BRIDGE
  105. #define AF_ATMPVC PF_ATMPVC
  106. #define AF_X25 PF_X25
  107. #define AF_INET6 PF_INET6
  108. #define AF_ROSE PF_ROSE
  109. #define AF_DECnet PF_DECnet
  110. #define AF_NETBEUI PF_NETBEUI
  111. #define AF_SECURITY PF_SECURITY
  112. #define AF_KEY PF_KEY
  113. #define AF_NETLINK PF_NETLINK
  114. #define AF_ROUTE PF_ROUTE
  115. #define AF_PACKET PF_PACKET
  116. #define AF_ASH PF_ASH
  117. #define AF_ECONET PF_ECONET
  118. #define AF_ATMSVC PF_ATMSVC
  119. #define AF_SNA PF_SNA
  120. #define AF_IRDA PF_IRDA
  121. #define AF_PPPOX PF_PPPOX
  122. #define AF_WANPIPE PF_WANPIPE
  123. #define AF_BLUETOOTH PF_BLUETOOTH
  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. /* Maximum queue length specifiable by listen. */
  136. #define SOMAXCONN 128
  137. /* Get the definition of the macro to define the common sockaddr members. */
  138. #include <bits/sockaddr.h>
  139. /* Structure describing a generic socket address. */
  140. struct sockaddr
  141. {
  142. __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
  143. char sa_data[14]; /* Address data. */
  144. };
  145. /* Structure large enough to hold any socket address (with the historical
  146. exception of AF_UNIX). We reserve 128 bytes. */
  147. #define __ss_aligntype unsigned long int
  148. #define _SS_SIZE 128
  149. #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
  150. struct sockaddr_storage
  151. {
  152. __SOCKADDR_COMMON (ss_); /* Address family, etc. */
  153. __ss_aligntype __ss_align; /* Force desired alignment. */
  154. char __ss_padding[_SS_PADSIZE];
  155. };
  156. /* Bits in the FLAGS argument to `send', `recv', et al. */
  157. enum
  158. {
  159. MSG_OOB = 0x01, /* Process out-of-band data. */
  160. #define MSG_OOB MSG_OOB
  161. MSG_PEEK = 0x02, /* Peek at incoming messages. */
  162. #define MSG_PEEK MSG_PEEK
  163. MSG_DONTROUTE = 0x04, /* Don't use local routing. */
  164. #define MSG_DONTROUTE MSG_DONTROUTE
  165. #ifdef __USE_GNU
  166. /* DECnet uses a different name. */
  167. MSG_TRYHARD = MSG_DONTROUTE,
  168. # define MSG_TRYHARD MSG_DONTROUTE
  169. #endif
  170. MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
  171. #define MSG_CTRUNC MSG_CTRUNC
  172. MSG_PROXY = 0x10, /* Supply or ask second address. */
  173. #define MSG_PROXY MSG_PROXY
  174. MSG_TRUNC = 0x20,
  175. #define MSG_TRUNC MSG_TRUNC
  176. MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
  177. #define MSG_DONTWAIT MSG_DONTWAIT
  178. MSG_EOR = 0x80, /* End of record. */
  179. #define MSG_EOR MSG_EOR
  180. MSG_WAITALL = 0x100, /* Wait for a full request. */
  181. #define MSG_WAITALL MSG_WAITALL
  182. MSG_FIN = 0x200,
  183. #define MSG_FIN MSG_FIN
  184. MSG_SYN = 0x400,
  185. #define MSG_SYN MSG_SYN
  186. MSG_CONFIRM = 0x800, /* Confirm path validity. */
  187. #define MSG_CONFIRM MSG_CONFIRM
  188. MSG_RST = 0x1000,
  189. #define MSG_RST MSG_RST
  190. MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
  191. #define MSG_ERRQUEUE MSG_ERRQUEUE
  192. MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */
  193. #define MSG_NOSIGNAL MSG_NOSIGNAL
  194. MSG_MORE = 0x8000, /* Sender will send more. */
  195. #define MSG_MORE MSG_MORE
  196. MSG_WAITFORONE = 0x10000, /* Wait for at least one packet to return.*/
  197. #define MSG_WAITFORONE MSG_WAITFORONE
  198. MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file
  199. descriptor received through
  200. SCM_RIGHTS. */
  201. #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
  202. };
  203. /* Structure describing messages sent by
  204. `sendmsg' and received by `recvmsg'. */
  205. /* Note: do not change these members to match glibc; these match the
  206. SuSv3 spec already (e.g. msg_iovlen/msg_controllen).
  207. http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html */
  208. /* Note: linux kernel uses __kernel_size_t (which is 8bytes on 64bit
  209. platforms, and 4bytes on 32bit platforms) for msg_iovlen/msg_controllen */
  210. struct msghdr
  211. {
  212. void *msg_name; /* Address to send to/receive from. */
  213. socklen_t msg_namelen; /* Length of address data. */
  214. struct iovec *msg_iov; /* Vector of data to send/receive into. */
  215. #if __WORDSIZE == 32
  216. int msg_iovlen; /* Number of elements in the vector. */
  217. #else
  218. size_t msg_iovlen; /* Number of elements in the vector. */
  219. #endif
  220. void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
  221. #if __WORDSIZE == 32
  222. socklen_t msg_controllen; /* Ancillary data buffer length. */
  223. #else
  224. size_t msg_controllen; /* Ancillary data buffer length. */
  225. #endif
  226. int msg_flags; /* Flags on received message. */
  227. };
  228. /* Structure used for storage of ancillary data object information. */
  229. struct cmsghdr
  230. {
  231. size_t cmsg_len; /* Length of data in cmsg_data plus length
  232. of cmsghdr structure. */
  233. int cmsg_level; /* Originating protocol. */
  234. int cmsg_type; /* Protocol specific type. */
  235. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  236. __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
  237. #endif
  238. };
  239. /* Ancillary data object manipulation macros. */
  240. #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
  241. # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
  242. #else
  243. # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
  244. #endif
  245. #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
  246. #define CMSG_FIRSTHDR(mhdr) \
  247. ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
  248. ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
  249. #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
  250. & (size_t) ~(sizeof (size_t) - 1))
  251. #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
  252. + CMSG_ALIGN (sizeof (struct cmsghdr)))
  253. #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
  254. extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
  255. struct cmsghdr *__cmsg) __THROW;
  256. libc_hidden_proto(__cmsg_nxthdr)
  257. #ifdef __USE_EXTERN_INLINES
  258. # ifndef _EXTERN_INLINE
  259. # define _EXTERN_INLINE extern __inline
  260. # endif
  261. _EXTERN_INLINE struct cmsghdr *
  262. __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
  263. {
  264. if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
  265. /* The kernel header does this so there may be a reason. */
  266. return 0;
  267. __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
  268. + CMSG_ALIGN (__cmsg->cmsg_len));
  269. if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
  270. + __mhdr->msg_controllen)
  271. || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
  272. > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
  273. /* No more entries. */
  274. return 0;
  275. return __cmsg;
  276. }
  277. #endif /* Use `extern inline'. */
  278. /* Socket level message types. This must match the definitions in
  279. <linux/socket.h>. */
  280. enum
  281. {
  282. SCM_RIGHTS = 0x01 /* Transfer file descriptors. */
  283. #define SCM_RIGHTS SCM_RIGHTS
  284. #ifdef __USE_BSD
  285. , SCM_CREDENTIALS = 0x02 /* Credentials passing. */
  286. # define SCM_CREDENTIALS SCM_CREDENTIALS
  287. #endif
  288. };
  289. /* User visible structure for SCM_CREDENTIALS message */
  290. struct ucred
  291. {
  292. pid_t pid; /* PID of sending process. */
  293. uid_t uid; /* UID of sending process. */
  294. gid_t gid; /* GID of sending process. */
  295. };
  296. /* Get socket manipulation related informations from kernel headers. */
  297. #ifndef __GLIBC__
  298. #define __GLIBC__ 2
  299. #include <asm/socket.h>
  300. #undef __GLIBC__
  301. #else
  302. #include <asm/socket.h>
  303. #endif
  304. /* Structure used to manipulate the SO_LINGER option. */
  305. struct linger
  306. {
  307. int l_onoff; /* Nonzero to linger on close. */
  308. int l_linger; /* Time to linger. */
  309. };
  310. #endif /* bits/socket.h */