~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/net.h

Version: ~ [ linux-5.2 ] ~ [ linux-5.1.16 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.57 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.132 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.184 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.184 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.69 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp