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