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
7 * Version: @(#)net.h 1.0.3 05/25/93
9 * Authors: Orest Zborowski, <obz@Kodak.COM>
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
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.
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/jump_label.h>
28 #include <uapi/linux/net.h>
30 struct poll_table_struct
;
31 struct pipe_inode_info
;
36 #define SOCK_ASYNC_NOSPACE 0
37 #define SOCK_ASYNC_WAITDATA 1
38 #define SOCK_NOSPACE 2
39 #define SOCK_PASSCRED 3
40 #define SOCK_PASSSEC 4
41 #define SOCK_EXTERNALLY_ALLOCATED 5
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 */
82 enum sock_shutdown_cmd
{
89 /* Note: wait MUST be first field of socket_wq */
90 wait_queue_head_t wait
;
91 struct fasync_struct
*fasync_list
;
93 } ____cacheline_aligned_in_smp
;
96 * struct socket - general BSD socket
97 * @state: socket state (%SS_CONNECTED, etc)
98 * @type: socket type (%SOCK_STREAM, etc)
99 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
100 * @ops: protocol specific socket operations
101 * @file: File back pointer for gc
102 * @sk: internal networking protocol agnostic socket representation
103 * @wq: wait queue for several uses
108 kmemcheck_bitfield_begin(type
);
110 kmemcheck_bitfield_end(type
);
114 struct socket_wq __rcu
*wq
;
118 const struct proto_ops
*ops
;
121 struct vm_area_struct
;
130 struct module
*owner
;
131 int (*release
) (struct socket
*sock
);
132 int (*bind
) (struct socket
*sock
,
133 struct sockaddr
*myaddr
,
135 int (*connect
) (struct socket
*sock
,
136 struct sockaddr
*vaddr
,
137 int sockaddr_len
, int flags
);
138 int (*socketpair
)(struct socket
*sock1
,
139 struct socket
*sock2
);
140 int (*accept
) (struct socket
*sock
,
141 struct socket
*newsock
, int flags
);
142 int (*getname
) (struct socket
*sock
,
143 struct sockaddr
*addr
,
144 int *sockaddr_len
, int peer
);
145 unsigned int (*poll
) (struct file
*file
, struct socket
*sock
,
146 struct poll_table_struct
*wait
);
147 int (*ioctl
) (struct socket
*sock
, unsigned int cmd
,
150 int (*compat_ioctl
) (struct socket
*sock
, unsigned int cmd
,
153 int (*listen
) (struct socket
*sock
, int len
);
154 int (*shutdown
) (struct socket
*sock
, int flags
);
155 int (*setsockopt
)(struct socket
*sock
, int level
,
156 int optname
, char __user
*optval
, unsigned int optlen
);
157 int (*getsockopt
)(struct socket
*sock
, int level
,
158 int optname
, char __user
*optval
, int __user
*optlen
);
160 int (*compat_setsockopt
)(struct socket
*sock
, int level
,
161 int optname
, char __user
*optval
, unsigned int optlen
);
162 int (*compat_getsockopt
)(struct socket
*sock
, int level
,
163 int optname
, char __user
*optval
, int __user
*optlen
);
165 int (*sendmsg
) (struct kiocb
*iocb
, struct socket
*sock
,
166 struct msghdr
*m
, size_t total_len
);
167 /* Notes for implementing recvmsg:
168 * ===============================
169 * msg->msg_namelen should get updated by the recvmsg handlers
170 * iff msg_name != NULL. It is by default 0 to prevent
171 * returning uninitialized memory to user space. The recvfrom
172 * handlers can assume that msg.msg_name is either NULL or has
173 * a minimum size of sizeof(struct sockaddr_storage).
175 int (*recvmsg
) (struct kiocb
*iocb
, struct socket
*sock
,
176 struct msghdr
*m
, size_t total_len
,
178 int (*mmap
) (struct file
*file
, struct socket
*sock
,
179 struct vm_area_struct
* vma
);
180 ssize_t (*sendpage
) (struct socket
*sock
, struct page
*page
,
181 int offset
, size_t size
, int flags
);
182 ssize_t (*splice_read
)(struct socket
*sock
, loff_t
*ppos
,
183 struct pipe_inode_info
*pipe
, size_t len
, unsigned int flags
);
184 int (*set_peek_off
)(struct sock
*sk
, int val
);
187 #define DECLARE_SOCKADDR(type, dst, src) \
188 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
190 struct net_proto_family
{
192 int (*create
)(struct net
*net
, struct socket
*sock
,
193 int protocol
, int kern
);
194 struct module
*owner
;
207 int sock_wake_async(struct socket
*sk
, int how
, int band
);
208 int sock_register(const struct net_proto_family
*fam
);
209 void sock_unregister(int family
);
210 int __sock_create(struct net
*net
, int family
, int type
, int proto
,
211 struct socket
**res
, int kern
);
212 int sock_create(int family
, int type
, int proto
, struct socket
**res
);
213 int sock_create_kern(int family
, int type
, int proto
, struct socket
**res
);
214 int sock_create_lite(int family
, int type
, int proto
, struct socket
**res
);
215 void sock_release(struct socket
*sock
);
216 int sock_sendmsg(struct socket
*sock
, struct msghdr
*msg
, size_t len
);
217 int sock_recvmsg(struct socket
*sock
, struct msghdr
*msg
, size_t size
,
219 struct file
*sock_alloc_file(struct socket
*sock
, int flags
, const char *dname
);
220 struct socket
*sockfd_lookup(int fd
, int *err
);
221 struct socket
*sock_from_file(struct file
*file
, int *err
);
222 #define sockfd_put(sock) fput(sock->file)
223 int net_ratelimit(void);
225 #define net_ratelimited_function(function, ...) \
227 if (net_ratelimit()) \
228 function(__VA_ARGS__); \
231 #define net_emerg_ratelimited(fmt, ...) \
232 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
233 #define net_alert_ratelimited(fmt, ...) \
234 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
235 #define net_crit_ratelimited(fmt, ...) \
236 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
237 #define net_err_ratelimited(fmt, ...) \
238 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
239 #define net_notice_ratelimited(fmt, ...) \
240 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
241 #define net_warn_ratelimited(fmt, ...) \
242 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
243 #define net_info_ratelimited(fmt, ...) \
244 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
245 #define net_dbg_ratelimited(fmt, ...) \
246 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
248 bool __net_get_random_once(void *buf
, int nbytes
, bool *done
,
249 struct static_key
*done_key
);
251 #define net_get_random_once(buf, nbytes) \
253 bool ___ret = false; \
254 static bool ___done = false; \
255 static struct static_key ___once_key = \
256 STATIC_KEY_INIT_TRUE; \
257 if (static_key_true(&___once_key)) \
258 ___ret = __net_get_random_once(buf, \
265 int kernel_sendmsg(struct socket
*sock
, struct msghdr
*msg
, struct kvec
*vec
,
266 size_t num
, size_t len
);
267 int kernel_recvmsg(struct socket
*sock
, struct msghdr
*msg
, struct kvec
*vec
,
268 size_t num
, size_t len
, int flags
);
270 int kernel_bind(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
);
271 int kernel_listen(struct socket
*sock
, int backlog
);
272 int kernel_accept(struct socket
*sock
, struct socket
**newsock
, int flags
);
273 int kernel_connect(struct socket
*sock
, struct sockaddr
*addr
, int addrlen
,
275 int kernel_getsockname(struct socket
*sock
, struct sockaddr
*addr
,
277 int kernel_getpeername(struct socket
*sock
, struct sockaddr
*addr
,
279 int kernel_getsockopt(struct socket
*sock
, int level
, int optname
, char *optval
,
281 int kernel_setsockopt(struct socket
*sock
, int level
, int optname
, char *optval
,
282 unsigned int optlen
);
283 int kernel_sendpage(struct socket
*sock
, struct page
*page
, int offset
,
284 size_t size
, int flags
);
285 int kernel_sock_ioctl(struct socket
*sock
, int cmd
, unsigned long arg
);
286 int kernel_sock_shutdown(struct socket
*sock
, enum sock_shutdown_cmd how
);
288 #define MODULE_ALIAS_NETPROTO(proto) \
289 MODULE_ALIAS("net-pf-" __stringify(proto))
291 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
292 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
294 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
295 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
296 "-type-" __stringify(type))
298 #define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
299 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
301 #endif /* _LINUX_NET_H */