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