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/socket.h>
22 #include <asm/socket.h>
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) */
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 */
55 #define __SO_ACCEPTCON (1 << 16) /* performed a listen */
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>
65 struct poll_table_struct
;
66 struct pipe_inode_info
;
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
76 #ifndef ARCH_HAS_SOCKET_TYPES
78 * enum sock_type - Socket types
79 * @SOCK_STREAM: stream (connection) socket
80 * @SOCK_DGRAM: datagram (conn.less) socket
81 * @SOCK_RAW: raw socket
82 * @SOCK_RDM: reliably-delivered message
83 * @SOCK_SEQPACKET: sequential packet socket
84 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
85 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
86 * For writing rarp and other similar things on the user level.
88 * When adding some new socket type please
89 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
90 * overrides this enum for binary compat reasons.
102 #define SOCK_MAX (SOCK_PACKET + 1)
103 /* Mask which covers at least up to SOCK_MASK-1. The
104 * remaining bits are used as flags. */
105 #define SOCK_TYPE_MASK 0xf
107 /* Flags for socket, socketpair, accept4 */
108 #define SOCK_CLOEXEC O_CLOEXEC
109 #ifndef SOCK_NONBLOCK
110 #define SOCK_NONBLOCK O_NONBLOCK
113 #endif /* ARCH_HAS_SOCKET_TYPES */
115 enum sock_shutdown_cmd
{
122 /* Note: wait MUST be first field of socket_wq */
123 wait_queue_head_t wait
;
124 struct fasync_struct
*fasync_list
;
126 } ____cacheline_aligned_in_smp
;
129 * struct socket - general BSD socket
130 * @state: socket state (%SS_CONNECTED, etc)
131 * @type: socket type (%SOCK_STREAM, etc)
132 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
133 * @ops: protocol specific socket operations
134 * @file: File back pointer for gc
135 * @sk: internal networking protocol agnostic socket representation
136 * @wq: wait queue for several uses
141 kmemcheck_bitfield_begin(type
);
143 kmemcheck_bitfield_end(type
);
147 struct socket_wq __rcu
*wq
;
151 const struct proto_ops
*ops
;
154 struct vm_area_struct
;
163 struct module
*owner
;
164 int (*release
) (struct socket
*sock
);
165 int (*bind
) (struct socket
*sock
,
166 struct sockaddr
*myaddr
,
168 int (*connect
) (struct socket
*sock
,
169 struct sockaddr
*vaddr
,
170 int sockaddr_len
, int flags
);
171 int (*socketpair
)(struct socket
*sock1
,
172 struct socket
*sock2
);
173 int (*accept
) (struct socket
*sock
,
174 struct socket
*newsock
, int flags
);
175 int (*getname
) (struct socket
*sock
,
176 struct sockaddr
*addr
,
177 int *sockaddr_len
, int peer
);
178 unsigned int (*poll
) (struct file
*file
, struct socket
*sock
,
179 struct poll_table_struct
*wait
);
180 int (*ioctl
) (struct socket
*sock
, unsigned int cmd
,
183 int (*compat_ioctl
) (struct socket
*sock
, unsigned int cmd
,
186 int (*listen
) (struct socket
*sock
, int len
);
187 int (*shutdown
) (struct socket
*sock
, int flags
);
188 int (*setsockopt
)(struct socket
*sock
, int level
,
189 int optname
, char __user
*optval
, unsigned int optlen
);
190 int (*getsockopt
)(struct socket
*sock
, int level
,
191 int optname
, char __user
*optval
, int __user
*optlen
);
193 int (*compat_setsockopt
)(struct socket
*sock
, int level
,
194 int optname
, char __user
*optval
, unsigned int optlen
);
195 int (*compat_getsockopt
)(struct socket
*sock
, int level
,
196 int optname
, char __user
*optval
, int __user
*optlen
);
198 int (*sendmsg
) (struct kiocb
*iocb
, struct socket
*sock
,
199 struct msghdr
*m
, size_t total_len
);
200 int (*recvmsg
) (struct kiocb
*iocb
, struct socket
*sock
,
201 struct msghdr
*m
, size_t total_len
,
203 int (*mmap
) (struct file
*file
, struct socket
*sock
,
204 struct vm_area_struct
* vma
);
205 ssize_t (*sendpage
) (struct socket
*sock
, struct page
*page
,
206 int offset
, size_t size
, int flags
);
207 ssize_t (*splice_read
)(struct socket
*sock
, loff_t
*ppos
,
208 struct pipe_inode_info
*pipe
, size_t len
, unsigned int flags
);
209 void (*set_peek_off
)(struct sock
*sk
, int val
);
212 #define DECLARE_SOCKADDR(type, dst, src) \
213 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
215 struct net_proto_family
{
217 int (*create
)(struct net
*net
, struct socket
*sock
,
218 int protocol
, int kern
);
219 struct module
*owner
;
232 extern int sock_wake_async(struct socket
*sk
, int how
, int band
);
233 extern int sock_register(const struct net_proto_family
*fam
);
234 extern void sock_unregister(int family
);
235 extern int __sock_create(struct net
*net
, int family
, int type
, int proto
,
236 struct socket
**res
, int kern
);
237 extern int sock_create(int family
, int type
, int proto
,
238 struct socket
**res
);
239 extern int sock_create_kern(int family
, int type
, int proto
,
240 struct socket
**res
);
241 extern int sock_create_lite(int family
, int type
, int proto
,
242 struct socket
**res
);
243 extern void sock_release(struct socket
*sock
);
244 extern int sock_sendmsg(struct socket
*sock
, struct msghdr
*msg
,
246 extern int sock_recvmsg(struct socket
*sock
, struct msghdr
*msg
,
247 size_t size
, int flags
);
248 extern int sock_map_fd(struct socket
*sock
, int flags
);
249 extern struct socket
*sockfd_lookup(int fd
, int *err
);
250 #define sockfd_put(sock) fput(sock->file)
251 extern int net_ratelimit(void);
253 #define net_ratelimited_function(function, ...) \
255 if (net_ratelimit()) \
256 function(__VA_ARGS__); \
259 #define net_emerg_ratelimited(fmt, ...) \
260 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
261 #define net_alert_ratelimited(fmt, ...) \
262 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
263 #define net_crit_ratelimited(fmt, ...) \
264 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
265 #define net_err_ratelimited(fmt, ...) \
266 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
267 #define net_notice_ratelimited(fmt, ...) \
268 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
269 #define net_warn_ratelimited(fmt, ...) \
270 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
271 #define net_info_ratelimited(fmt, ...) \
272 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
273 #define net_dbg_ratelimited(fmt, ...) \
274 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
276 #define net_random() random32()
277 #define net_srandom(seed) srandom32((__force u32)seed)
279 extern int kernel_sendmsg(struct socket
*sock
, struct msghdr
*msg
,
280 struct kvec
*vec
, size_t num
, size_t len
);
281 extern int kernel_recvmsg(struct socket
*sock
, struct msghdr
*msg
,
282 struct kvec
*vec
, size_t num
,
283 size_t len
, int flags
);
285 extern int kernel_bind(struct socket
*sock
, struct sockaddr
*addr
,
287 extern int kernel_listen(struct socket
*sock
, int backlog
);
288 extern int kernel_accept(struct socket
*sock
, struct socket
**newsock
,
290 extern int kernel_connect(struct socket
*sock
, struct sockaddr
*addr
,
291 int addrlen
, int flags
);
292 extern int kernel_getsockname(struct socket
*sock
, struct sockaddr
*addr
,
294 extern int kernel_getpeername(struct socket
*sock
, struct sockaddr
*addr
,
296 extern int kernel_getsockopt(struct socket
*sock
, int level
, int optname
,
297 char *optval
, int *optlen
);
298 extern int kernel_setsockopt(struct socket
*sock
, int level
, int optname
,
299 char *optval
, unsigned int optlen
);
300 extern int kernel_sendpage(struct socket
*sock
, struct page
*page
, int offset
,
301 size_t size
, int flags
);
302 extern int kernel_sock_ioctl(struct socket
*sock
, int cmd
, unsigned long arg
);
303 extern int kernel_sock_shutdown(struct socket
*sock
,
304 enum sock_shutdown_cmd how
);
306 #define MODULE_ALIAS_NETPROTO(proto) \
307 MODULE_ALIAS("net-pf-" __stringify(proto))
309 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
310 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
312 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
313 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
314 "-type-" __stringify(type))
316 #define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
317 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
319 #endif /* __KERNEL__ */
320 #endif /* _LINUX_NET_H */