Skip to content

L
linux
Commit fb99146a authored by Arnaldo Carvalho de Melo's avatar Arnaldo Carvalho de Melo
Browse files
Options

o linux/net.h: CodingStyle changes and kerneldoc style structs documentation

parent 71258ac5
Hide whitespace changes
Inline Side-by-side
Showing with 82 additions and 62 deletions
include/linux/net.h
View file @ fb99146a
...@@ -27,7 +27,6 @@ struct inode; ...@@ -27,7 +27,6 @@ struct inode;
#define NPROTO 32 /* should be enough for now.. */ #define NPROTO 32 /* should be enough for now.. */
#define SYS_SOCKET 1 /* sys_socket(2) */ #define SYS_SOCKET 1 /* sys_socket(2) */
#define SYS_BIND 2 /* sys_bind(2) */ #define SYS_BIND 2 /* sys_bind(2) */
#define SYS_CONNECT 3 /* sys_connect(2) */ #define SYS_CONNECT 3 /* sys_connect(2) */
...@@ -46,16 +45,15 @@ struct inode; ...@@ -46,16 +45,15 @@ struct inode;
#define SYS_SENDMSG 16 /* sys_sendmsg(2) */ #define SYS_SENDMSG 16 /* sys_sendmsg(2) */
#define SYS_RECVMSG 17 /* sys_recvmsg(2) */ #define SYS_RECVMSG 17 /* sys_recvmsg(2) */
typedef enum { typedef enum {
SS_FREE = 0, /* not allocated */ SS_FREE = 0, /* not allocated */
SS_UNCONNECTED, /* unconnected to any socket */ SS_UNCONNECTED, /* unconnected to any socket */
SS_CONNECTING, /* in process of connecting */ SS_CONNECTING, /* in process of connecting */
SS_CONNECTED, /* connected to socket */ SS_CONNECTED, /* connected to socket */
SS_DISCONNECTING /* in process of disconnecting */ SS_DISCONNECTING /* in process of disconnecting */
} socket_state; } socket_state;
#define __SO_ACCEPTCON (1<<16) /* performed a listen */ #define __SO_ACCEPTCON (1 << 16) /* performed a listen */
#ifdef __KERNEL__ #ifdef __KERNEL__
...@@ -63,17 +61,26 @@ typedef enum { ...@@ -63,17 +61,26 @@ typedef enum {
#define SOCK_ASYNC_WAITDATA 1 #define SOCK_ASYNC_WAITDATA 1
#define SOCK_NOSPACE 2 #define SOCK_NOSPACE 2
struct socket /**
{ * struct socket - general BSD socket
* @state - socket state (%SS_CONNECTED, etc)
* @flags - socket flags (%SOCK_ASYNC_NOSPACE, etc)
* @ops - protocol specific socket operations
* @fasync_list - Asynchronous wake up list
* @file - File back pointer for gc
* @sk - internal networking protocol agnostic socket representation
* @wait - wait queue for several uses
* @type - socket type (%SOCK_STREAM, etc)
* @passcred - credentials (used only in Unix Sockets (aka PF_LOCAL))
*/
struct socket {
socket_state state; socket_state state;
unsigned long flags; unsigned long flags;
struct proto_ops *ops; struct proto_ops *ops;
struct fasync_struct *fasync_list; /* Asynchronous wake up list */ struct fasync_struct *fasync_list;
struct file *file; /* File back pointer for gc */ struct file *file;
struct sock *sk; struct sock *sk;
wait_queue_head_t wait; wait_queue_head_t wait;
short type; short type;
unsigned char passcred; unsigned char passcred;
}; };
...@@ -83,37 +90,43 @@ struct page; ...@@ -83,37 +90,43 @@ struct page;
struct kiocb; struct kiocb;
struct proto_ops { struct proto_ops {
int family; int family;
int (*release) (struct socket *sock);
int (*release) (struct socket *sock); int (*bind) (struct socket *sock,
int (*bind) (struct socket *sock, struct sockaddr *umyaddr, struct sockaddr *umyaddr,
int sockaddr_len); int sockaddr_len);
int (*connect) (struct socket *sock, struct sockaddr *uservaddr, int (*connect) (struct socket *sock,
int sockaddr_len, int flags); struct sockaddr *uservaddr,
int (*socketpair) (struct socket *sock1, struct socket *sock2); int sockaddr_len, int flags);
int (*accept) (struct socket *sock, struct socket *newsock, int (*socketpair)(struct socket *sock1,
int flags); struct socket *sock2);
int (*getname) (struct socket *sock, struct sockaddr *uaddr, int (*accept) (struct socket *sock,
int *usockaddr_len, int peer); struct socket *newsock, int flags);
unsigned int (*poll) (struct file *file, struct socket *sock, struct poll_table_struct *wait); int (*getname) (struct socket *sock,
int (*ioctl) (struct socket *sock, unsigned int cmd, struct sockaddr *uaddr,
unsigned long arg); int *usockaddr_len, int peer);
int (*listen) (struct socket *sock, int len); unsigned int (*poll) (struct file *file, struct socket *sock,
int (*shutdown) (struct socket *sock, int flags); struct poll_table_struct *wait);
int (*setsockopt) (struct socket *sock, int level, int optname, int (*ioctl) (struct socket *sock, unsigned int cmd,
char *optval, int optlen); unsigned long arg);
int (*getsockopt) (struct socket *sock, int level, int optname, int (*listen) (struct socket *sock, int len);
char *optval, int *optlen); int (*shutdown) (struct socket *sock, int flags);
int (*sendmsg) (struct kiocb *iocb, struct socket *sock, int (*setsockopt)(struct socket *sock, int level,
struct msghdr *m, int total_len); int optname, char *optval, int optlen);
int (*recvmsg) (struct kiocb *iocb, struct socket *sock, int (*getsockopt)(struct socket *sock, int level,
struct msghdr *m, int total_len, int flags); int optname, char *optval, int *optlen);
int (*mmap) (struct file *file, struct socket *sock, struct vm_area_struct * vma); int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
ssize_t (*sendpage) (struct socket *sock, struct page *page, int offset, size_t size, int flags); struct msghdr *m, int total_len);
int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
struct msghdr *m, int total_len,
int flags);
int (*mmap) (struct file *file, struct socket *sock,
struct vm_area_struct * vma);
ssize_t (*sendpage) (struct socket *sock, struct page *page,
int offset, size_t size, int flags);
}; };
struct net_proto_family struct net_proto_family {
{
int family; int family;
int (*create)(struct socket *sock, int protocol); int (*create)(struct socket *sock, int protocol);
/* These are counters for the number of different methods of /* These are counters for the number of different methods of
...@@ -123,30 +136,37 @@ struct net_proto_family ...@@ -123,30 +136,37 @@ struct net_proto_family
short encrypt_net; short encrypt_net;
}; };
struct net_proto /**
{ * struct socket - network interface with the file system
const char *name; /* Protocol name */ * @name - Protocol name
void (*init_func)(struct net_proto *); /* Bootstrap */ * @init_func - Bootstrap
*/
struct net_proto {
const char *name;
void (*init_func)(struct net_proto *pro);
}; };
extern int sock_wake_async(struct socket *sk, int how, int band); extern int sock_wake_async(struct socket *sk, int how, int band);
extern int sock_register(struct net_proto_family *fam); extern int sock_register(struct net_proto_family *fam);
extern int sock_unregister(int family); extern int sock_unregister(int family);
extern struct socket *sock_alloc(void); extern struct socket *sock_alloc(void);
extern int sock_create(int family, int type, int proto, struct socket **); extern int sock_create(int family, int type, int proto,
extern void sock_release(struct socket *); struct socket **res);
extern int sock_sendmsg(struct socket *, struct msghdr *m, int len); extern void sock_release(struct socket *sock);
extern int sock_recvmsg(struct socket *, struct msghdr *m, int len, int flags); extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
extern int sock_readv_writev(int type, struct inode * inode, struct file * file, int len);
const struct iovec * iov, long count, long size); extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
extern int sock_map_fd(struct socket *sock); int size, int flags);
extern int sock_readv_writev(int type, struct inode *inode,
struct file *file,
const struct iovec *iov, long count,
long size);
extern int sock_map_fd(struct socket *sock);
extern struct socket *sockfd_lookup(int fd, int *err); extern struct socket *sockfd_lookup(int fd, int *err);
#define sockfd_put(sock) fput(sock->file) #define sockfd_put(sock) fput(sock->file)
extern int net_ratelimit(void);
extern int net_ratelimit(void);
extern unsigned long net_random(void); extern unsigned long net_random(void);
extern void net_srandom(unsigned long); extern void net_srandom(unsigned long);
#ifndef CONFIG_SMP #ifndef CONFIG_SMP
#define SOCKOPS_WRAPPED(name) name #define SOCKOPS_WRAPPED(name) name
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7