net.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. /*
  2. * NET An implementation of the SOCKET network access protocol.
  3. * This is the master header file for the Linux NET layer,
  4. * or, in plain English: the networking handling part of the
  5. * kernel.
  6. *
  7. * Version: @(#)net.h 1.0.3 05/25/93
  8. *
  9. * Authors: Orest Zborowski, <obz@Kodak.COM>
  10. * Ross Biro
  11. * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12. *
  13. * This program is free software; you can redistribute it and/or
  14. * modify it under the terms of the GNU General Public License
  15. * as published by the Free Software Foundation; either version
  16. * 2 of the License, or (at your option) any later version.
  17. */
  18. #ifndef _LINUX_NET_H
  19. #define _LINUX_NET_H
  20. #include <linux/socket.h>
  21. #include <linux/sched.h>
  22. #include <asm/socket.h>
  23. #define NPROTO AF_MAX
  24. #define SYS_SOCKET 1 /* sys_socket(2) */
  25. #define SYS_BIND 2 /* sys_bind(2) */
  26. #define SYS_CONNECT 3 /* sys_connect(2) */
  27. #define SYS_LISTEN 4 /* sys_listen(2) */
  28. #define SYS_ACCEPT 5 /* sys_accept(2) */
  29. #define SYS_GETSOCKNAME 6 /* sys_getsockname(2) */
  30. #define SYS_GETPEERNAME 7 /* sys_getpeername(2) */
  31. #define SYS_SOCKETPAIR 8 /* sys_socketpair(2) */
  32. #define SYS_SEND 9 /* sys_send(2) */
  33. #define SYS_RECV 10 /* sys_recv(2) */
  34. #define SYS_SENDTO 11 /* sys_sendto(2) */
  35. #define SYS_RECVFROM 12 /* sys_recvfrom(2) */
  36. #define SYS_SHUTDOWN 13 /* sys_shutdown(2) */
  37. #define SYS_SETSOCKOPT 14 /* sys_setsockopt(2) */
  38. #define SYS_GETSOCKOPT 15 /* sys_getsockopt(2) */
  39. #define SYS_SENDMSG 16 /* sys_sendmsg(2) */
  40. #define SYS_RECVMSG 17 /* sys_recvmsg(2) */
  41. #define SYS_ACCEPT4 18 /* sys_accept4(2) */
  42. #define SYS_RECVMMSG 19 /* sys_recvmmsg(2) */
  43. #define SYS_SENDMMSG 20 /* sys_sendmmsg(2) */
  44. typedef enum {
  45. SS_FREE = 0, /* not allocated */
  46. SS_UNCONNECTED, /* unconnected to any socket */
  47. SS_CONNECTING, /* in process of connecting */
  48. SS_CONNECTED, /* connected to socket */
  49. SS_DISCONNECTING /* in process of disconnecting */
  50. } socket_state;
  51. #define __SO_ACCEPTCON (1 << 16) /* performed a listen */
  52. #ifdef __KERNEL__
  53. #include <linux/stringify.h>
  54. #include <linux/random.h>
  55. #include <linux/wait.h>
  56. #include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
  57. #include <linux/kmemcheck.h>
  58. #include <linux/rcupdate.h>
  59. struct poll_table_struct;
  60. struct pipe_inode_info;
  61. struct inode;
  62. struct net;
  63. #define SOCK_ASYNC_NOSPACE 0
  64. #define SOCK_ASYNC_WAITDATA 1
  65. #define SOCK_NOSPACE 2
  66. #define SOCK_PASSCRED 3
  67. #define SOCK_PASSSEC 4
  68. #define SOCK_EXTERNALLY_ALLOCATED 5
  69. #ifndef ARCH_HAS_SOCKET_TYPES
  70. /**
  71. * enum sock_type - Socket types
  72. * @SOCK_STREAM: stream (connection) socket
  73. * @SOCK_DGRAM: datagram (conn.less) socket
  74. * @SOCK_RAW: raw socket
  75. * @SOCK_RDM: reliably-delivered message
  76. * @SOCK_SEQPACKET: sequential packet socket
  77. * @SOCK_DCCP: Datagram Congestion Control Protocol socket
  78. * @SOCK_PACKET: linux specific way of getting packets at the dev level.
  79. * For writing rarp and other similar things on the user level.
  80. *
  81. * When adding some new socket type please
  82. * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
  83. * overrides this enum for binary compat reasons.
  84. */
  85. enum sock_type {
  86. SOCK_STREAM = 1,
  87. SOCK_DGRAM = 2,
  88. SOCK_RAW = 3,
  89. SOCK_RDM = 4,
  90. SOCK_SEQPACKET = 5,
  91. SOCK_DCCP = 6,
  92. SOCK_PACKET = 10,
  93. };
  94. #define SOCK_MAX (SOCK_PACKET + 1)
  95. /* Mask which covers at least up to SOCK_MASK-1. The
  96. * remaining bits are used as flags. */
  97. #define SOCK_TYPE_MASK 0xf
  98. /* Flags for socket, socketpair, accept4 */
  99. #define SOCK_CLOEXEC O_CLOEXEC
  100. #ifndef SOCK_NONBLOCK
  101. #define SOCK_NONBLOCK O_NONBLOCK
  102. #endif
  103. #endif /* ARCH_HAS_SOCKET_TYPES */
  104. enum sock_shutdown_cmd {
  105. SHUT_RD = 0,
  106. SHUT_WR = 1,
  107. SHUT_RDWR = 2,
  108. };
  109. struct socket_wq {
  110. /* Note: wait MUST be first field of socket_wq */
  111. wait_queue_head_t wait;
  112. struct fasync_struct *fasync_list;
  113. struct rcu_head rcu;
  114. } ____cacheline_aligned_in_smp;
  115. /**
  116. * struct socket - general BSD socket
  117. * @state: socket state (%SS_CONNECTED, etc)
  118. * @type: socket type (%SOCK_STREAM, etc)
  119. * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
  120. * @ops: protocol specific socket operations
  121. * @file: File back pointer for gc
  122. * @sk: internal networking protocol agnostic socket representation
  123. * @wq: wait queue for several uses
  124. */
  125. struct socket {
  126. socket_state state;
  127. kmemcheck_bitfield_begin(type);
  128. short type;
  129. kmemcheck_bitfield_end(type);
  130. unsigned long flags;
  131. struct socket_wq __rcu *wq;
  132. struct file *file;
  133. struct sock *sk;
  134. const struct proto_ops *ops;
  135. };
  136. struct vm_area_struct;
  137. struct page;
  138. struct kiocb;
  139. struct sockaddr;
  140. struct msghdr;
  141. struct module;
  142. struct proto_ops {
  143. int family;
  144. struct module *owner;
  145. int (*release) (struct socket *sock);
  146. int (*bind) (struct socket *sock,
  147. struct sockaddr *myaddr,
  148. int sockaddr_len);
  149. int (*connect) (struct socket *sock,
  150. struct sockaddr *vaddr,
  151. int sockaddr_len, int flags);
  152. int (*socketpair)(struct socket *sock1,
  153. struct socket *sock2);
  154. int (*accept) (struct socket *sock,
  155. struct socket *newsock, int flags);
  156. int (*getname) (struct socket *sock,
  157. struct sockaddr *addr,
  158. int *sockaddr_len, int peer);
  159. unsigned int (*poll) (struct file *file, struct socket *sock,
  160. struct poll_table_struct *wait);
  161. int (*ioctl) (struct socket *sock, unsigned int cmd,
  162. unsigned long arg);
  163. #ifdef CONFIG_COMPAT
  164. int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
  165. unsigned long arg);
  166. #endif
  167. int (*listen) (struct socket *sock, int len);
  168. int (*shutdown) (struct socket *sock, int flags);
  169. int (*setsockopt)(struct socket *sock, int level,
  170. int optname, char __user *optval, unsigned int optlen);
  171. int (*getsockopt)(struct socket *sock, int level,
  172. int optname, char __user *optval, int __user *optlen);
  173. #ifdef CONFIG_COMPAT
  174. int (*compat_setsockopt)(struct socket *sock, int level,
  175. int optname, char __user *optval, unsigned int optlen);
  176. int (*compat_getsockopt)(struct socket *sock, int level,
  177. int optname, char __user *optval, int __user *optlen);
  178. #endif
  179. int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
  180. struct msghdr *m, size_t total_len);
  181. /* Notes for implementing recvmsg:
  182. * ===============================
  183. * msg->msg_namelen should get updated by the recvmsg handlers
  184. * iff msg_name != NULL. It is by default 0 to prevent
  185. * returning uninitialized memory to user space. The recvfrom
  186. * handlers can assume that msg.msg_name is either NULL or has
  187. * a minimum size of sizeof(struct sockaddr_storage).
  188. */
  189. int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
  190. struct msghdr *m, size_t total_len,
  191. int flags);
  192. int (*mmap) (struct file *file, struct socket *sock,
  193. struct vm_area_struct * vma);
  194. ssize_t (*sendpage) (struct socket *sock, struct page *page,
  195. int offset, size_t size, int flags);
  196. ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
  197. struct pipe_inode_info *pipe, size_t len, unsigned int flags);
  198. int (*set_peek_off)(struct sock *sk, int val);
  199. };
  200. #define DECLARE_SOCKADDR(type, dst, src) \
  201. type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
  202. struct net_proto_family {
  203. int family;
  204. int (*create)(struct net *net, struct socket *sock,
  205. int protocol, int kern);
  206. struct module *owner;
  207. };
  208. struct iovec;
  209. struct kvec;
  210. enum {
  211. SOCK_WAKE_IO,
  212. SOCK_WAKE_WAITD,
  213. SOCK_WAKE_SPACE,
  214. SOCK_WAKE_URG,
  215. };
  216. extern int sock_wake_async(struct socket *sk, int how, int band);
  217. extern int sock_register(const struct net_proto_family *fam);
  218. extern void sock_unregister(int family);
  219. extern int __sock_create(struct net *net, int family, int type, int proto,
  220. struct socket **res, int kern);
  221. extern int sock_create(int family, int type, int proto,
  222. struct socket **res);
  223. extern int sock_create_kern(int family, int type, int proto,
  224. struct socket **res);
  225. extern int sock_create_lite(int family, int type, int proto,
  226. struct socket **res);
  227. extern void sock_release(struct socket *sock);
  228. extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
  229. size_t len);
  230. extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
  231. size_t size, int flags);
  232. extern int sock_map_fd(struct socket *sock, int flags);
  233. extern struct socket *sockfd_lookup(int fd, int *err);
  234. #define sockfd_put(sock) fput(sock->file)
  235. extern int net_ratelimit(void);
  236. #define net_ratelimited_function(function, ...) \
  237. do { \
  238. if (net_ratelimit()) \
  239. function(__VA_ARGS__); \
  240. } while (0)
  241. #define net_emerg_ratelimited(fmt, ...) \
  242. net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
  243. #define net_alert_ratelimited(fmt, ...) \
  244. net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
  245. #define net_crit_ratelimited(fmt, ...) \
  246. net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
  247. #define net_err_ratelimited(fmt, ...) \
  248. net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
  249. #define net_notice_ratelimited(fmt, ...) \
  250. net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
  251. #define net_warn_ratelimited(fmt, ...) \
  252. net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
  253. #define net_info_ratelimited(fmt, ...) \
  254. net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
  255. #define net_dbg_ratelimited(fmt, ...) \
  256. net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
  257. #define net_ratelimited_function(function, ...) \
  258. do { \
  259. if (net_ratelimit()) \
  260. function(__VA_ARGS__); \
  261. } while (0)
  262. #define net_emerg_ratelimited(fmt, ...) \
  263. net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
  264. #define net_alert_ratelimited(fmt, ...) \
  265. net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
  266. #define net_crit_ratelimited(fmt, ...) \
  267. net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
  268. #define net_err_ratelimited(fmt, ...) \
  269. net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
  270. #define net_notice_ratelimited(fmt, ...) \
  271. net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
  272. #define net_warn_ratelimited(fmt, ...) \
  273. net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
  274. #define net_info_ratelimited(fmt, ...) \
  275. net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
  276. #define net_dbg_ratelimited(fmt, ...) \
  277. net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
  278. #define net_random() random32()
  279. #define net_srandom(seed) srandom32((__force u32)seed)
  280. extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
  281. struct kvec *vec, size_t num, size_t len);
  282. extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
  283. struct kvec *vec, size_t num,
  284. size_t len, int flags);
  285. extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
  286. int addrlen);
  287. extern int kernel_listen(struct socket *sock, int backlog);
  288. extern int kernel_accept(struct socket *sock, struct socket **newsock,
  289. int flags);
  290. extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
  291. int addrlen, int flags);
  292. extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
  293. int *addrlen);
  294. extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
  295. int *addrlen);
  296. extern int kernel_getsockopt(struct socket *sock, int level, int optname,
  297. char *optval, int *optlen);
  298. extern int kernel_setsockopt(struct socket *sock, int level, int optname,
  299. char *optval, unsigned int optlen);
  300. extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
  301. size_t size, int flags);
  302. extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
  303. extern int kernel_sock_shutdown(struct socket *sock,
  304. enum sock_shutdown_cmd how);
  305. #define MODULE_ALIAS_NETPROTO(proto) \
  306. MODULE_ALIAS("net-pf-" __stringify(proto))
  307. #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
  308. MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
  309. #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
  310. MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
  311. "-type-" __stringify(type))
  312. #endif /* __KERNEL__ */
  313. #endif /* _LINUX_NET_H */