1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * NET An implementation of the SOCKET network access protocol. 4 * This is the master header file for the Linux NET layer, 5 * or, in plain English: the networking handling part of the 6 * kernel. 7 * 8 * Version: @(#)net.h 1.0.3 05/25/93 9 * 10 * Authors: Orest Zborowski, <[email protected]> 11 * Ross Biro 12 * Fred N. van Kempen, <[email protected]> 13 */ 14 #ifndef _LINUX_NET_H 15 #define _LINUX_NET_H 16 17 #include <linux/stringify.h> 18 #include <linux/random.h> 19 #include <linux/wait.h> 20 #include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */ 21 #include <linux/rcupdate.h> 22 #include <linux/once.h> 23 #include <linux/fs.h> 24 #include <linux/sockptr.h> 25 26 #include <uapi/linux/net.h> 27 28 struct poll_table_struct; 29 struct pipe_inode_info; 30 struct inode; 31 struct file; 32 struct net; 33 34 /* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located 35 * in sock->flags, but moved into sk->sk_wq->flags to be RCU protected. 36 * Eventually all flags will be in sk->sk_wq->flags. 37 */ 38 #define SOCKWQ_ASYNC_NOSPACE 0 39 #define SOCKWQ_ASYNC_WAITDATA 1 40 #define SOCK_NOSPACE 2 41 #define SOCK_PASSCRED 3 42 #define SOCK_PASSSEC 4 43 44 #define PROTO_CMSG_DATA_ONLY 0x0001 45 46 #ifndef ARCH_HAS_SOCKET_TYPES 47 /** 48 * enum sock_type - Socket types 49 * @SOCK_STREAM: stream (connection) socket 50 * @SOCK_DGRAM: datagram (conn.less) socket 51 * @SOCK_RAW: raw socket 52 * @SOCK_RDM: reliably-delivered message 53 * @SOCK_SEQPACKET: sequential packet socket 54 * @SOCK_DCCP: Datagram Congestion Control Protocol socket 55 * @SOCK_PACKET: linux specific way of getting packets at the dev level. 56 * For writing rarp and other similar things on the user level. 57 * 58 * When adding some new socket type please 59 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS 60 * overrides this enum for binary compat reasons. 61 */ 62 enum sock_type { 63 SOCK_STREAM = 1, 64 SOCK_DGRAM = 2, 65 SOCK_RAW = 3, 66 SOCK_RDM = 4, 67 SOCK_SEQPACKET = 5, 68 SOCK_DCCP = 6, 69 SOCK_PACKET = 10, 70 }; 71 72 #define SOCK_MAX (SOCK_PACKET + 1) 73 /* Mask which covers at least up to SOCK_MASK-1. The 74 * remaining bits are used as flags. */ 75 #define SOCK_TYPE_MASK 0xf 76 77 /* Flags for socket, socketpair, accept4 */ 78 #define SOCK_CLOEXEC O_CLOEXEC 79 #ifndef SOCK_NONBLOCK 80 #define SOCK_NONBLOCK O_NONBLOCK 81 #endif 82 83 #endif /* ARCH_HAS_SOCKET_TYPES */ 84 85 /** 86 * enum sock_shutdown_cmd - Shutdown types 87 * @SHUT_RD: shutdown receptions 88 * @SHUT_WR: shutdown transmissions 89 * @SHUT_RDWR: shutdown receptions/transmissions 90 */ 91 enum sock_shutdown_cmd { 92 SHUT_RD, 93 SHUT_WR, 94 SHUT_RDWR, 95 }; 96 97 struct socket_wq { 98 /* Note: wait MUST be first field of socket_wq */ 99 wait_queue_head_t wait; 100 struct fasync_struct *fasync_list; 101 unsigned long flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */ 102 struct rcu_head rcu; 103 } ____cacheline_aligned_in_smp; 104 105 /** 106 * struct socket - general BSD socket 107 * @state: socket state (%SS_CONNECTED, etc) 108 * @type: socket type (%SOCK_STREAM, etc) 109 * @flags: socket flags (%SOCK_NOSPACE, etc) 110 * @ops: protocol specific socket operations 111 * @file: File back pointer for gc 112 * @sk: internal networking protocol agnostic socket representation 113 * @wq: wait queue for several uses 114 */ 115 struct socket { 116 socket_state state; 117 118 short type; 119 120 unsigned long flags; 121 122 struct file *file; 123 struct sock *sk; 124 const struct proto_ops *ops; 125 126 struct socket_wq wq; 127 }; 128 129 struct vm_area_struct; 130 struct page; 131 struct sockaddr; 132 struct msghdr; 133 struct module; 134 struct sk_buff; 135 typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *, 136 unsigned int, size_t); 137 138 struct proto_ops { 139 int family; 140 unsigned int flags; 141 struct module *owner; 142 int (*release) (struct socket *sock); 143 int (*bind) (struct socket *sock, 144 struct sockaddr *myaddr, 145 int sockaddr_len); 146 int (*connect) (struct socket *sock, 147 struct sockaddr *vaddr, 148 int sockaddr_len, int flags); 149 int (*socketpair)(struct socket *sock1, 150 struct socket *sock2); 151 int (*accept) (struct socket *sock, 152 struct socket *newsock, int flags, bool kern); 153 int (*getname) (struct socket *sock, 154 struct sockaddr *addr, 155 int peer); 156 __poll_t (*poll) (struct file *file, struct socket *sock, 157 struct poll_table_struct *wait); 158 int (*ioctl) (struct socket *sock, unsigned int cmd, 159 unsigned long arg); 160 #ifdef CONFIG_COMPAT 161 int (*compat_ioctl) (struct socket *sock, unsigned int cmd, 162 unsigned long arg); 163 #endif 164 int (*gettstamp) (struct socket *sock, void __user *userstamp, 165 bool timeval, bool time32); 166 int (*listen) (struct socket *sock, int len); 167 int (*shutdown) (struct socket *sock, int flags); 168 int (*setsockopt)(struct socket *sock, int level, 169 int optname, sockptr_t optval, 170 unsigned int optlen); 171 int (*getsockopt)(struct socket *sock, int level, 172 int optname, char __user *optval, int __user *optlen); 173 void (*show_fdinfo)(struct seq_file *m, struct socket *sock); 174 int (*sendmsg) (struct socket *sock, struct msghdr *m, 175 size_t total_len); 176 /* Notes for implementing recvmsg: 177 * =============================== 178 * msg->msg_namelen should get updated by the recvmsg handlers 179 * iff msg_name != NULL. It is by default 0 to prevent 180 * returning uninitialized memory to user space. The recvfrom 181 * handlers can assume that msg.msg_name is either NULL or has 182 * a minimum size of sizeof(struct sockaddr_storage). 183 */ 184 int (*recvmsg) (struct socket *sock, struct msghdr *m, 185 size_t total_len, int flags); 186 int (*mmap) (struct file *file, struct socket *sock, 187 struct vm_area_struct * vma); 188 ssize_t (*sendpage) (struct socket *sock, struct page *page, 189 int offset, size_t size, int flags); 190 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos, 191 struct pipe_inode_info *pipe, size_t len, unsigned int flags); 192 int (*set_peek_off)(struct sock *sk, int val); 193 int (*peek_len)(struct socket *sock); 194 195 /* The following functions are called internally by kernel with 196 * sock lock already held. 197 */ 198 int (*read_sock)(struct sock *sk, read_descriptor_t *desc, 199 sk_read_actor_t recv_actor); 200 int (*sendpage_locked)(struct sock *sk, struct page *page, 201 int offset, size_t size, int flags); 202 int (*sendmsg_locked)(struct sock *sk, struct msghdr *msg, 203 size_t size); 204 int (*set_rcvlowat)(struct sock *sk, int val); 205 }; 206 207 #define DECLARE_SOCKADDR(type, dst, src) \ 208 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; }) 209 210 struct net_proto_family { 211 int family; 212 int (*create)(struct net *net, struct socket *sock, 213 int protocol, int kern); 214 struct module *owner; 215 }; 216 217 struct iovec; 218 struct kvec; 219 220 enum { 221 SOCK_WAKE_IO, 222 SOCK_WAKE_WAITD, 223 SOCK_WAKE_SPACE, 224 SOCK_WAKE_URG, 225 }; 226 227 int sock_wake_async(struct socket_wq *sk_wq, int how, int band); 228 int sock_register(const struct net_proto_family *fam); 229 void sock_unregister(int family); 230 bool sock_is_registered(int family); 231 int __sock_create(struct net *net, int family, int type, int proto, 232 struct socket **res, int kern); 233 int sock_create(int family, int type, int proto, struct socket **res); 234 int sock_create_kern(struct net *net, int family, int type, int proto, struct socket **res); 235 int sock_create_lite(int family, int type, int proto, struct socket **res); 236 struct socket *sock_alloc(void); 237 void sock_release(struct socket *sock); 238 int sock_sendmsg(struct socket *sock, struct msghdr *msg); 239 int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags); 240 struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname); 241 struct socket *sockfd_lookup(int fd, int *err); 242 struct socket *sock_from_file(struct file *file, int *err); 243 #define sockfd_put(sock) fput(sock->file) 244 int net_ratelimit(void); 245 246 #define net_ratelimited_function(function, ...) \ 247 do { \ 248 if (net_ratelimit()) \ 249 function(__VA_ARGS__); \ 250 } while (0) 251 252 #define net_emerg_ratelimited(fmt, ...) \ 253 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__) 254 #define net_alert_ratelimited(fmt, ...) \ 255 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__) 256 #define net_crit_ratelimited(fmt, ...) \ 257 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__) 258 #define net_err_ratelimited(fmt, ...) \ 259 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__) 260 #define net_notice_ratelimited(fmt, ...) \ 261 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__) 262 #define net_warn_ratelimited(fmt, ...) \ 263 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__) 264 #define net_info_ratelimited(fmt, ...) \ 265 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__) 266 #if defined(CONFIG_DYNAMIC_DEBUG) || \ 267 (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE)) 268 #define net_dbg_ratelimited(fmt, ...) \ 269 do { \ 270 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ 271 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \ 272 net_ratelimit()) \ 273 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \ 274 ##__VA_ARGS__); \ 275 } while (0) 276 #elif defined(DEBUG) 277 #define net_dbg_ratelimited(fmt, ...) \ 278 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__) 279 #else 280 #define net_dbg_ratelimited(fmt, ...) \ 281 do { \ 282 if (0) \ 283 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \ 284 } while (0) 285 #endif 286 287 #define net_get_random_once(buf, nbytes) \ 288 get_random_once((buf), (nbytes)) 289 #define net_get_random_once_wait(buf, nbytes) \ 290 get_random_once_wait((buf), (nbytes)) 291 292 int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec, 293 size_t num, size_t len); 294 int kernel_sendmsg_locked(struct sock *sk, struct msghdr *msg, 295 struct kvec *vec, size_t num, size_t len); 296 int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec, 297 size_t num, size_t len, int flags); 298 299 int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen); 300 int kernel_listen(struct socket *sock, int backlog); 301 int kernel_accept(struct socket *sock, struct socket **newsock, int flags); 302 int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen, 303 int flags); 304 int kernel_getsockname(struct socket *sock, struct sockaddr *addr); 305 int kernel_getpeername(struct socket *sock, struct sockaddr *addr); 306 int kernel_sendpage(struct socket *sock, struct page *page, int offset, 307 size_t size, int flags); 308 int kernel_sendpage_locked(struct sock *sk, struct page *page, int offset, 309 size_t size, int flags); 310 int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how); 311 312 /* Routine returns the IP overhead imposed by a (caller-protected) socket. */ 313 u32 kernel_sock_ip_overhead(struct sock *sk); 314 315 #define MODULE_ALIAS_NETPROTO(proto) \ 316 MODULE_ALIAS("net-pf-" __stringify(proto)) 317 318 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \ 319 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto)) 320 321 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \ 322 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \ 323 "-type-" __stringify(type)) 324 325 #define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \ 326 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \ 327 name) 328 #endif /* _LINUX_NET_H */ 329