socket.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _LINUX_SOCKET_H
  3. #define _LINUX_SOCKET_H
  4. #include <asm/socket.h> /* arch-dependent defines */
  5. #include <linux/sockios.h> /* the SIOCxxx I/O controls */
  6. #include <linux/uio.h> /* iovec support */
  7. #include <linux/types.h> /* pid_t */
  8. #include <linux/compiler.h> /* __user */
  9. #include <uapi/linux/socket.h>
  10. struct file;
  11. struct pid;
  12. struct cred;
  13. struct socket;
  14. struct sock;
  15. struct sk_buff;
  16. #define __sockaddr_check_size(size) \
  17. BUILD_BUG_ON(((size) > sizeof(struct __kernel_sockaddr_storage)))
  18. #ifdef CONFIG_PROC_FS
  19. struct seq_file;
  20. extern void socket_seq_show(struct seq_file *seq);
  21. #endif
  22. typedef __kernel_sa_family_t sa_family_t;
  23. /*
  24. * 1003.1g requires sa_family_t and that sa_data is char.
  25. */
  26. struct sockaddr {
  27. sa_family_t sa_family; /* address family, AF_xxx */
  28. char sa_data[14]; /* 14 bytes of protocol address */
  29. };
  30. struct linger {
  31. int l_onoff; /* Linger active */
  32. int l_linger; /* How long to linger for */
  33. };
  34. #define sockaddr_storage __kernel_sockaddr_storage
  35. /*
  36. * As we do 4.4BSD message passing we use a 4.4BSD message passing
  37. * system, not 4.3. Thus msg_accrights(len) are now missing. They
  38. * belong in an obscure libc emulation or the bin.
  39. */
  40. struct msghdr {
  41. void *msg_name; /* ptr to socket address structure */
  42. int msg_namelen; /* size of socket address structure */
  43. int msg_inq; /* output, data left in socket */
  44. struct iov_iter msg_iter; /* data */
  45. /*
  46. * Ancillary data. msg_control_user is the user buffer used for the
  47. * recv* side when msg_control_is_user is set, msg_control is the kernel
  48. * buffer used for all other cases.
  49. */
  50. union {
  51. void *msg_control;
  52. void __user *msg_control_user;
  53. };
  54. bool msg_control_is_user : 1;
  55. bool msg_get_inq : 1;/* return INQ after receive */
  56. unsigned int msg_flags; /* flags on received message */
  57. __kernel_size_t msg_controllen; /* ancillary data buffer length */
  58. struct kiocb *msg_iocb; /* ptr to iocb for async requests */
  59. struct ubuf_info *msg_ubuf;
  60. int (*sg_from_iter)(struct sock *sk, struct sk_buff *skb,
  61. struct iov_iter *from, size_t length);
  62. };
  63. struct user_msghdr {
  64. void __user *msg_name; /* ptr to socket address structure */
  65. int msg_namelen; /* size of socket address structure */
  66. struct iovec __user *msg_iov; /* scatter/gather array */
  67. __kernel_size_t msg_iovlen; /* # elements in msg_iov */
  68. void __user *msg_control; /* ancillary data */
  69. __kernel_size_t msg_controllen; /* ancillary data buffer length */
  70. unsigned int msg_flags; /* flags on received message */
  71. };
  72. /* For recvmmsg/sendmmsg */
  73. struct mmsghdr {
  74. struct user_msghdr msg_hdr;
  75. unsigned int msg_len;
  76. };
  77. /*
  78. * POSIX 1003.1g - ancillary data object information
  79. * Ancillary data consists of a sequence of pairs of
  80. * (cmsghdr, cmsg_data[])
  81. */
  82. struct cmsghdr {
  83. __kernel_size_t cmsg_len; /* data byte count, including hdr */
  84. int cmsg_level; /* originating protocol */
  85. int cmsg_type; /* protocol-specific type */
  86. };
  87. /*
  88. * Ancillary data object information MACROS
  89. * Table 5-14 of POSIX 1003.1g
  90. */
  91. #define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
  92. #define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
  93. #define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
  94. #define CMSG_DATA(cmsg) \
  95. ((void *)(cmsg) + sizeof(struct cmsghdr))
  96. #define CMSG_USER_DATA(cmsg) \
  97. ((void __user *)(cmsg) + sizeof(struct cmsghdr))
  98. #define CMSG_SPACE(len) (sizeof(struct cmsghdr) + CMSG_ALIGN(len))
  99. #define CMSG_LEN(len) (sizeof(struct cmsghdr) + (len))
  100. #define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
  101. (struct cmsghdr *)(ctl) : \
  102. (struct cmsghdr *)NULL)
  103. #define CMSG_FIRSTHDR(msg) __CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
  104. #define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
  105. (cmsg)->cmsg_len <= (unsigned long) \
  106. ((mhdr)->msg_controllen - \
  107. ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
  108. #define for_each_cmsghdr(cmsg, msg) \
  109. for (cmsg = CMSG_FIRSTHDR(msg); \
  110. cmsg; \
  111. cmsg = CMSG_NXTHDR(msg, cmsg))
  112. /*
  113. * Get the next cmsg header
  114. *
  115. * PLEASE, do not touch this function. If you think, that it is
  116. * incorrect, grep kernel sources and think about consequences
  117. * before trying to improve it.
  118. *
  119. * Now it always returns valid, not truncated ancillary object
  120. * HEADER. But caller still MUST check, that cmsg->cmsg_len is
  121. * inside range, given by msg->msg_controllen before using
  122. * ancillary object DATA. --ANK (980731)
  123. */
  124. static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
  125. struct cmsghdr *__cmsg)
  126. {
  127. struct cmsghdr * __ptr;
  128. __ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) + CMSG_ALIGN(__cmsg->cmsg_len));
  129. if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
  130. return (struct cmsghdr *)0;
  131. return __ptr;
  132. }
  133. static inline struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
  134. {
  135. return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
  136. }
  137. static inline size_t msg_data_left(struct msghdr *msg)
  138. {
  139. return iov_iter_count(&msg->msg_iter);
  140. }
  141. /* "Socket"-level control message types: */
  142. #define SCM_RIGHTS 0x01 /* rw: access rights (array of int) */
  143. #define SCM_CREDENTIALS 0x02 /* rw: struct ucred */
  144. #define SCM_SECURITY 0x03 /* rw: security label */
  145. struct ucred {
  146. __u32 pid;
  147. __u32 uid;
  148. __u32 gid;
  149. };
  150. /* Supported address families. */
  151. #define AF_UNSPEC 0
  152. #define AF_UNIX 1 /* Unix domain sockets */
  153. #define AF_LOCAL 1 /* POSIX name for AF_UNIX */
  154. #define AF_INET 2 /* Internet IP Protocol */
  155. #define AF_AX25 3 /* Amateur Radio AX.25 */
  156. #define AF_IPX 4 /* Novell IPX */
  157. #define AF_APPLETALK 5 /* AppleTalk DDP */
  158. #define AF_NETROM 6 /* Amateur Radio NET/ROM */
  159. #define AF_BRIDGE 7 /* Multiprotocol bridge */
  160. #define AF_ATMPVC 8 /* ATM PVCs */
  161. #define AF_X25 9 /* Reserved for X.25 project */
  162. #define AF_INET6 10 /* IP version 6 */
  163. #define AF_ROSE 11 /* Amateur Radio X.25 PLP */
  164. #define AF_DECnet 12 /* Reserved for DECnet project */
  165. #define AF_NETBEUI 13 /* Reserved for 802.2LLC project*/
  166. #define AF_SECURITY 14 /* Security callback pseudo AF */
  167. #define AF_KEY 15 /* PF_KEY key management API */
  168. #define AF_NETLINK 16
  169. #define AF_ROUTE AF_NETLINK /* Alias to emulate 4.4BSD */
  170. #define AF_PACKET 17 /* Packet family */
  171. #define AF_ASH 18 /* Ash */
  172. #define AF_ECONET 19 /* Acorn Econet */
  173. #define AF_ATMSVC 20 /* ATM SVCs */
  174. #define AF_RDS 21 /* RDS sockets */
  175. #define AF_SNA 22 /* Linux SNA Project (nutters!) */
  176. #define AF_IRDA 23 /* IRDA sockets */
  177. #define AF_PPPOX 24 /* PPPoX sockets */
  178. #define AF_WANPIPE 25 /* Wanpipe API Sockets */
  179. #define AF_LLC 26 /* Linux LLC */
  180. #define AF_IB 27 /* Native InfiniBand address */
  181. #define AF_MPLS 28 /* MPLS */
  182. #define AF_CAN 29 /* Controller Area Network */
  183. #define AF_TIPC 30 /* TIPC sockets */
  184. #define AF_BLUETOOTH 31 /* Bluetooth sockets */
  185. #define AF_IUCV 32 /* IUCV sockets */
  186. #define AF_RXRPC 33 /* RxRPC sockets */
  187. #define AF_ISDN 34 /* mISDN sockets */
  188. #define AF_PHONET 35 /* Phonet sockets */
  189. #define AF_IEEE802154 36 /* IEEE802154 sockets */
  190. #define AF_CAIF 37 /* CAIF sockets */
  191. #define AF_ALG 38 /* Algorithm sockets */
  192. #define AF_NFC 39 /* NFC sockets */
  193. #define AF_VSOCK 40 /* vSockets */
  194. #define AF_KCM 41 /* Kernel Connection Multiplexor*/
  195. #define AF_QIPCRTR 42 /* Qualcomm IPC Router */
  196. #define AF_SMC 43 /* smc sockets: reserve number for
  197. * PF_SMC protocol family that
  198. * reuses AF_INET address family
  199. */
  200. #define AF_XDP 44 /* XDP sockets */
  201. #define AF_MCTP 45 /* Management component
  202. * transport protocol
  203. */
  204. #define AF_MAX 46 /* For now.. */
  205. /* Protocol families, same as address families. */
  206. #define PF_UNSPEC AF_UNSPEC
  207. #define PF_UNIX AF_UNIX
  208. #define PF_LOCAL AF_LOCAL
  209. #define PF_INET AF_INET
  210. #define PF_AX25 AF_AX25
  211. #define PF_IPX AF_IPX
  212. #define PF_APPLETALK AF_APPLETALK
  213. #define PF_NETROM AF_NETROM
  214. #define PF_BRIDGE AF_BRIDGE
  215. #define PF_ATMPVC AF_ATMPVC
  216. #define PF_X25 AF_X25
  217. #define PF_INET6 AF_INET6
  218. #define PF_ROSE AF_ROSE
  219. #define PF_DECnet AF_DECnet
  220. #define PF_NETBEUI AF_NETBEUI
  221. #define PF_SECURITY AF_SECURITY
  222. #define PF_KEY AF_KEY
  223. #define PF_NETLINK AF_NETLINK
  224. #define PF_ROUTE AF_ROUTE
  225. #define PF_PACKET AF_PACKET
  226. #define PF_ASH AF_ASH
  227. #define PF_ECONET AF_ECONET
  228. #define PF_ATMSVC AF_ATMSVC
  229. #define PF_RDS AF_RDS
  230. #define PF_SNA AF_SNA
  231. #define PF_IRDA AF_IRDA
  232. #define PF_PPPOX AF_PPPOX
  233. #define PF_WANPIPE AF_WANPIPE
  234. #define PF_LLC AF_LLC
  235. #define PF_IB AF_IB
  236. #define PF_MPLS AF_MPLS
  237. #define PF_CAN AF_CAN
  238. #define PF_TIPC AF_TIPC
  239. #define PF_BLUETOOTH AF_BLUETOOTH
  240. #define PF_IUCV AF_IUCV
  241. #define PF_RXRPC AF_RXRPC
  242. #define PF_ISDN AF_ISDN
  243. #define PF_PHONET AF_PHONET
  244. #define PF_IEEE802154 AF_IEEE802154
  245. #define PF_CAIF AF_CAIF
  246. #define PF_ALG AF_ALG
  247. #define PF_NFC AF_NFC
  248. #define PF_VSOCK AF_VSOCK
  249. #define PF_KCM AF_KCM
  250. #define PF_QIPCRTR AF_QIPCRTR
  251. #define PF_SMC AF_SMC
  252. #define PF_XDP AF_XDP
  253. #define PF_MCTP AF_MCTP
  254. #define PF_MAX AF_MAX
  255. /* Maximum queue length specifiable by listen. */
  256. #define SOMAXCONN 4096
  257. /* Flags we can use with send/ and recv.
  258. Added those for 1003.1g not all are supported yet
  259. */
  260. #define MSG_OOB 1
  261. #define MSG_PEEK 2
  262. #define MSG_DONTROUTE 4
  263. #define MSG_TRYHARD 4 /* Synonym for MSG_DONTROUTE for DECnet */
  264. #define MSG_CTRUNC 8
  265. #define MSG_PROBE 0x10 /* Do not send. Only probe path f.e. for MTU */
  266. #define MSG_TRUNC 0x20
  267. #define MSG_DONTWAIT 0x40 /* Nonblocking io */
  268. #define MSG_EOR 0x80 /* End of record */
  269. #define MSG_WAITALL 0x100 /* Wait for a full request */
  270. #define MSG_FIN 0x200
  271. #define MSG_SYN 0x400
  272. #define MSG_CONFIRM 0x800 /* Confirm path validity */
  273. #define MSG_RST 0x1000
  274. #define MSG_ERRQUEUE 0x2000 /* Fetch message from error queue */
  275. #define MSG_NOSIGNAL 0x4000 /* Do not generate SIGPIPE */
  276. #define MSG_MORE 0x8000 /* Sender will send more */
  277. #define MSG_WAITFORONE 0x10000 /* recvmmsg(): block until 1+ packets avail */
  278. #define MSG_SENDPAGE_NOPOLICY 0x10000 /* sendpage() internal : do no apply policy */
  279. #define MSG_SENDPAGE_NOTLAST 0x20000 /* sendpage() internal : not the last page */
  280. #define MSG_BATCH 0x40000 /* sendmmsg(): more messages coming */
  281. #define MSG_EOF MSG_FIN
  282. #define MSG_NO_SHARED_FRAGS 0x80000 /* sendpage() internal : page frags are not shared */
  283. #define MSG_SENDPAGE_DECRYPTED 0x100000 /* sendpage() internal : page may carry
  284. * plain text and require encryption
  285. */
  286. #define MSG_ZEROCOPY 0x4000000 /* Use user data in kernel path */
  287. #define MSG_FASTOPEN 0x20000000 /* Send data in TCP SYN */
  288. #define MSG_CMSG_CLOEXEC 0x40000000 /* Set close_on_exec for file
  289. descriptor received through
  290. SCM_RIGHTS */
  291. #if defined(CONFIG_COMPAT)
  292. #define MSG_CMSG_COMPAT 0x80000000 /* This message needs 32 bit fixups */
  293. #else
  294. #define MSG_CMSG_COMPAT 0 /* We never have 32 bit fixups */
  295. #endif
  296. /* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
  297. #define SOL_IP 0
  298. /* #define SOL_ICMP 1 No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
  299. #define SOL_TCP 6
  300. #define SOL_UDP 17
  301. #define SOL_IPV6 41
  302. #define SOL_ICMPV6 58
  303. #define SOL_SCTP 132
  304. #define SOL_UDPLITE 136 /* UDP-Lite (RFC 3828) */
  305. #define SOL_RAW 255
  306. #define SOL_IPX 256
  307. #define SOL_AX25 257
  308. #define SOL_ATALK 258
  309. #define SOL_NETROM 259
  310. #define SOL_ROSE 260
  311. #define SOL_DECNET 261
  312. #define SOL_X25 262
  313. #define SOL_PACKET 263
  314. #define SOL_ATM 264 /* ATM layer (cell level) */
  315. #define SOL_AAL 265 /* ATM Adaption Layer (packet level) */
  316. #define SOL_IRDA 266
  317. #define SOL_NETBEUI 267
  318. #define SOL_LLC 268
  319. #define SOL_DCCP 269
  320. #define SOL_NETLINK 270
  321. #define SOL_TIPC 271
  322. #define SOL_RXRPC 272
  323. #define SOL_PPPOL2TP 273
  324. #define SOL_BLUETOOTH 274
  325. #define SOL_PNPIPE 275
  326. #define SOL_RDS 276
  327. #define SOL_IUCV 277
  328. #define SOL_CAIF 278
  329. #define SOL_ALG 279
  330. #define SOL_NFC 280
  331. #define SOL_KCM 281
  332. #define SOL_TLS 282
  333. #define SOL_XDP 283
  334. #define SOL_MPTCP 284
  335. #define SOL_MCTP 285
  336. #define SOL_SMC 286
  337. #define SOL_VSOCK 287
  338. /* IPX options */
  339. #define IPX_TYPE 1
  340. extern int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr_storage *kaddr);
  341. extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
  342. struct timespec64;
  343. struct __kernel_timespec;
  344. struct old_timespec32;
  345. struct scm_timestamping_internal {
  346. struct timespec64 ts[3];
  347. };
  348. extern void put_cmsg_scm_timestamping64(struct msghdr *msg, struct scm_timestamping_internal *tss);
  349. extern void put_cmsg_scm_timestamping(struct msghdr *msg, struct scm_timestamping_internal *tss);
  350. /* The __sys_...msg variants allow MSG_CMSG_COMPAT iff
  351. * forbid_cmsg_compat==false
  352. */
  353. extern long __sys_recvmsg(int fd, struct user_msghdr __user *msg,
  354. unsigned int flags, bool forbid_cmsg_compat);
  355. extern long __sys_sendmsg(int fd, struct user_msghdr __user *msg,
  356. unsigned int flags, bool forbid_cmsg_compat);
  357. extern int __sys_recvmmsg(int fd, struct mmsghdr __user *mmsg,
  358. unsigned int vlen, unsigned int flags,
  359. struct __kernel_timespec __user *timeout,
  360. struct old_timespec32 __user *timeout32);
  361. extern int __sys_sendmmsg(int fd, struct mmsghdr __user *mmsg,
  362. unsigned int vlen, unsigned int flags,
  363. bool forbid_cmsg_compat);
  364. extern long __sys_sendmsg_sock(struct socket *sock, struct msghdr *msg,
  365. unsigned int flags);
  366. extern long __sys_recvmsg_sock(struct socket *sock, struct msghdr *msg,
  367. struct user_msghdr __user *umsg,
  368. struct sockaddr __user *uaddr,
  369. unsigned int flags);
  370. extern int sendmsg_copy_msghdr(struct msghdr *msg,
  371. struct user_msghdr __user *umsg, unsigned flags,
  372. struct iovec **iov);
  373. extern int recvmsg_copy_msghdr(struct msghdr *msg,
  374. struct user_msghdr __user *umsg, unsigned flags,
  375. struct sockaddr __user **uaddr,
  376. struct iovec **iov);
  377. extern int __copy_msghdr(struct msghdr *kmsg,
  378. struct user_msghdr *umsg,
  379. struct sockaddr __user **save_addr);
  380. /* helpers which do the actual work for syscalls */
  381. extern int __sys_recvfrom(int fd, void __user *ubuf, size_t size,
  382. unsigned int flags, struct sockaddr __user *addr,
  383. int __user *addr_len);
  384. extern int __sys_sendto(int fd, void __user *buff, size_t len,
  385. unsigned int flags, struct sockaddr __user *addr,
  386. int addr_len);
  387. extern struct file *do_accept(struct file *file, unsigned file_flags,
  388. struct sockaddr __user *upeer_sockaddr,
  389. int __user *upeer_addrlen, int flags);
  390. extern int __sys_accept4(int fd, struct sockaddr __user *upeer_sockaddr,
  391. int __user *upeer_addrlen, int flags);
  392. extern int __sys_socket(int family, int type, int protocol);
  393. extern struct file *__sys_socket_file(int family, int type, int protocol);
  394. extern int __sys_bind(int fd, struct sockaddr __user *umyaddr, int addrlen);
  395. extern int __sys_connect_file(struct file *file, struct sockaddr_storage *addr,
  396. int addrlen, int file_flags);
  397. extern int __sys_connect(int fd, struct sockaddr __user *uservaddr,
  398. int addrlen);
  399. extern int __sys_listen(int fd, int backlog);
  400. extern int __sys_getsockname(int fd, struct sockaddr __user *usockaddr,
  401. int __user *usockaddr_len);
  402. extern int __sys_getpeername(int fd, struct sockaddr __user *usockaddr,
  403. int __user *usockaddr_len);
  404. extern int __sys_socketpair(int family, int type, int protocol,
  405. int __user *usockvec);
  406. extern int __sys_shutdown_sock(struct socket *sock, int how);
  407. extern int __sys_shutdown(int fd, int how);
  408. #endif /* _LINUX_SOCKET_H */