1 /* SPDX-License-Identifier: GPL-2.0-or-later */
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
8 * Version: @(#)net.h 1.0.3 05/25/93
10 * Authors: Orest Zborowski, <obz@Kodak.COM>
12 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
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>
25 #include <uapi/linux/net.h>
27 struct poll_table_struct;
28 struct pipe_inode_info;
33 /* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located
34 * in sock->flags, but moved into sk->sk_wq->flags to be RCU protected.
35 * Eventually all flags will be in sk->sk_wq->flags.
37 #define SOCKWQ_ASYNC_NOSPACE 0
38 #define SOCKWQ_ASYNC_WAITDATA 1
39 #define SOCK_NOSPACE 2
40 #define SOCK_PASSCRED 3
41 #define SOCK_PASSSEC 4
43 #ifndef ARCH_HAS_SOCKET_TYPES
45 * enum sock_type - Socket types
46 * @SOCK_STREAM: stream (connection) socket
47 * @SOCK_DGRAM: datagram (conn.less) socket
48 * @SOCK_RAW: raw socket
49 * @SOCK_RDM: reliably-delivered message
50 * @SOCK_SEQPACKET: sequential packet socket
51 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
52 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
53 * For writing rarp and other similar things on the user level.
55 * When adding some new socket type please
56 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
57 * overrides this enum for binary compat reasons.
69 #define SOCK_MAX (SOCK_PACKET + 1)
70 /* Mask which covers at least up to SOCK_MASK-1. The
71 * remaining bits are used as flags. */
72 #define SOCK_TYPE_MASK 0xf
74 /* Flags for socket, socketpair, accept4 */
75 #define SOCK_CLOEXEC O_CLOEXEC
77 #define SOCK_NONBLOCK O_NONBLOCK
80 #endif /* ARCH_HAS_SOCKET_TYPES */
83 * enum sock_shutdown_cmd - Shutdown types
84 * @SHUT_RD: shutdown receptions
85 * @SHUT_WR: shutdown transmissions
86 * @SHUT_RDWR: shutdown receptions/transmissions
88 enum sock_shutdown_cmd {
95 /* Note: wait MUST be first field of socket_wq */
96 wait_queue_head_t wait;
97 struct fasync_struct *fasync_list;
98 unsigned long flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */
100 } ____cacheline_aligned_in_smp;
103 * struct socket - general BSD socket
104 * @state: socket state (%SS_CONNECTED, etc)
105 * @type: socket type (%SOCK_STREAM, etc)
106 * @flags: socket flags (%SOCK_NOSPACE, etc)
107 * @ops: protocol specific socket operations
108 * @file: File back pointer for gc
109 * @sk: internal networking protocol agnostic socket representation
110 * @wq: wait queue for several uses
121 const struct proto_ops *ops;
126 struct vm_area_struct;
132 typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
133 unsigned int, size_t);
137 struct module *owner;
138 int (*release) (struct socket *sock);
139 int (*bind) (struct socket *sock,
140 struct sockaddr *myaddr,
142 int (*connect) (struct socket *sock,
143 struct sockaddr *vaddr,
144 int sockaddr_len, int flags);
145 int (*socketpair)(struct socket *sock1,
146 struct socket *sock2);
147 int (*accept) (struct socket *sock,
148 struct socket *newsock, int flags, bool kern);
149 int (*getname) (struct socket *sock,
150 struct sockaddr *addr,
152 __poll_t (*poll) (struct file *file, struct socket *sock,
153 struct poll_table_struct *wait);
154 int (*ioctl) (struct socket *sock, unsigned int cmd,
157 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
160 int (*gettstamp) (struct socket *sock, void __user *userstamp,
161 bool timeval, bool time32);
162 int (*listen) (struct socket *sock, int len);
163 int (*shutdown) (struct socket *sock, int flags);
164 int (*setsockopt)(struct socket *sock, int level,
165 int optname, char __user *optval, unsigned int optlen);
166 int (*getsockopt)(struct socket *sock, int level,
167 int optname, char __user *optval, int __user *optlen);
168 void (*show_fdinfo)(struct seq_file *m, struct socket *sock);
169 int (*sendmsg) (struct socket *sock, struct msghdr *m,
171 /* Notes for implementing recvmsg:
172 * ===============================
173 * msg->msg_namelen should get updated by the recvmsg handlers
174 * iff msg_name != NULL. It is by default 0 to prevent
175 * returning uninitialized memory to user space. The recvfrom
176 * handlers can assume that msg.msg_name is either NULL or has
177 * a minimum size of sizeof(struct sockaddr_storage).
179 int (*recvmsg) (struct socket *sock, struct msghdr *m,
180 size_t total_len, int flags);
181 int (*mmap) (struct file *file, struct socket *sock,
182 struct vm_area_struct * vma);
183 ssize_t (*sendpage) (struct socket *sock, struct page *page,
184 int offset, size_t size, int flags);
185 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
186 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
187 int (*set_peek_off)(struct sock *sk, int val);
188 int (*peek_len)(struct socket *sock);
190 /* The following functions are called internally by kernel with
191 * sock lock already held.
193 int (*read_sock)(struct sock *sk, read_descriptor_t *desc,
194 sk_read_actor_t recv_actor);
195 int (*sendpage_locked)(struct sock *sk, struct page *page,
196 int offset, size_t size, int flags);
197 int (*sendmsg_locked)(struct sock *sk, struct msghdr *msg,
199 int (*set_rcvlowat)(struct sock *sk, int val);
202 #define DECLARE_SOCKADDR(type, dst, src) \
203 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
205 struct net_proto_family {
207 int (*create)(struct net *net, struct socket *sock,
208 int protocol, int kern);
209 struct module *owner;
222 int sock_wake_async(struct socket_wq *sk_wq, int how, int band);
223 int sock_register(const struct net_proto_family *fam);
224 void sock_unregister(int family);
225 bool sock_is_registered(int family);
226 int __sock_create(struct net *net, int family, int type, int proto,
227 struct socket **res, int kern);
228 int sock_create(int family, int type, int proto, struct socket **res);
229 int sock_create_kern(struct net *net, int family, int type, int proto, struct socket **res);
230 int sock_create_lite(int family, int type, int proto, struct socket **res);
231 struct socket *sock_alloc(void);
232 void sock_release(struct socket *sock);
233 int sock_sendmsg(struct socket *sock, struct msghdr *msg);
234 int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags);
235 struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
236 struct socket *sockfd_lookup(int fd, int *err);
237 struct socket *sock_from_file(struct file *file, int *err);
238 #define sockfd_put(sock) fput(sock->file)
239 int net_ratelimit(void);
241 #define net_ratelimited_function(function, ...) \
243 if (net_ratelimit()) \
244 function(__VA_ARGS__); \
247 #define net_emerg_ratelimited(fmt, ...) \
248 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
249 #define net_alert_ratelimited(fmt, ...) \
250 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
251 #define net_crit_ratelimited(fmt, ...) \
252 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
253 #define net_err_ratelimited(fmt, ...) \
254 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
255 #define net_notice_ratelimited(fmt, ...) \
256 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
257 #define net_warn_ratelimited(fmt, ...) \
258 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
259 #define net_info_ratelimited(fmt, ...) \
260 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
261 #if defined(CONFIG_DYNAMIC_DEBUG) || \
262 (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
263 #define net_dbg_ratelimited(fmt, ...) \
265 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
266 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
268 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
272 #define net_dbg_ratelimited(fmt, ...) \
273 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
275 #define net_dbg_ratelimited(fmt, ...) \
278 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
282 #define net_get_random_once(buf, nbytes) \
283 get_random_once((buf), (nbytes))
284 #define net_get_random_once_wait(buf, nbytes) \
285 get_random_once_wait((buf), (nbytes))
287 int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
288 size_t num, size_t len);
289 int kernel_sendmsg_locked(struct sock *sk, struct msghdr *msg,
290 struct kvec *vec, size_t num, size_t len);
291 int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
292 size_t num, size_t len, int flags);
294 int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
295 int kernel_listen(struct socket *sock, int backlog);
296 int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
297 int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
299 int kernel_getsockname(struct socket *sock, struct sockaddr *addr);
300 int kernel_getpeername(struct socket *sock, struct sockaddr *addr);
301 int kernel_sendpage(struct socket *sock, struct page *page, int offset,
302 size_t size, int flags);
303 int kernel_sendpage_locked(struct sock *sk, struct page *page, int offset,
304 size_t size, int flags);
305 int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
307 /* Routine returns the IP overhead imposed by a (caller-protected) socket. */
308 u32 kernel_sock_ip_overhead(struct sock *sk);
310 #define MODULE_ALIAS_NETPROTO(proto) \
311 MODULE_ALIAS("net-pf-" __stringify(proto))
313 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
314 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
316 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
317 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
318 "-type-" __stringify(type))
320 #define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
321 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
323 #endif /* _LINUX_NET_H */