forked from luck/tmp_suning_uos_patched
4dc3b16ba1
I have recompiled Linux kernel 2.6.11.5 documentation for me and our university students again. The documentation could be extended for more sources which are equipped by structured comments for recent 2.6 kernels. I have tried to proceed with that task. I have done that more times from 2.6.0 time and it gets boring to do same changes again and again. Linux kernel compiles after changes for i386 and ARM targets. I have added references to some more files into kernel-api book, I have added some section names as well. So please, check that changes do not break something and that categories are not too much skewed. I have changed kernel-doc to accept "fastcall" and "asmlinkage" words reserved by kernel convention. Most of the other changes are modifications in the comments to make kernel-doc happy, accept some parameters description and do not bail out on errors. Changed <pid> to @pid in the description, moved some #ifdef before comments to correct function to comments bindings, etc. You can see result of the modified documentation build at http://cmp.felk.cvut.cz/~pisa/linux/lkdb-2.6.11.tar.gz Some more sources are ready to be included into kernel-doc generated documentation. Sources has been added into kernel-api for now. Some more section names added and probably some more chaos introduced as result of quick cleanup work. Signed-off-by: Pavel Pisa <pisa@cmp.felk.cvut.cz> Signed-off-by: Martin Waitz <tali@admingilde.org> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
288 lines
10 KiB
C
288 lines
10 KiB
C
/*
|
|
* NET An implementation of the SOCKET network access protocol.
|
|
* This is the master header file for the Linux NET layer,
|
|
* or, in plain English: the networking handling part of the
|
|
* kernel.
|
|
*
|
|
* Version: @(#)net.h 1.0.3 05/25/93
|
|
*
|
|
* Authors: Orest Zborowski, <obz@Kodak.COM>
|
|
* Ross Biro, <bir7@leland.Stanford.Edu>
|
|
* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version
|
|
* 2 of the License, or (at your option) any later version.
|
|
*/
|
|
#ifndef _LINUX_NET_H
|
|
#define _LINUX_NET_H
|
|
|
|
#include <linux/config.h>
|
|
#include <linux/wait.h>
|
|
#include <linux/stringify.h>
|
|
#include <asm/socket.h>
|
|
|
|
struct poll_table_struct;
|
|
struct inode;
|
|
|
|
#define NPROTO 32 /* should be enough for now.. */
|
|
|
|
#define SYS_SOCKET 1 /* sys_socket(2) */
|
|
#define SYS_BIND 2 /* sys_bind(2) */
|
|
#define SYS_CONNECT 3 /* sys_connect(2) */
|
|
#define SYS_LISTEN 4 /* sys_listen(2) */
|
|
#define SYS_ACCEPT 5 /* sys_accept(2) */
|
|
#define SYS_GETSOCKNAME 6 /* sys_getsockname(2) */
|
|
#define SYS_GETPEERNAME 7 /* sys_getpeername(2) */
|
|
#define SYS_SOCKETPAIR 8 /* sys_socketpair(2) */
|
|
#define SYS_SEND 9 /* sys_send(2) */
|
|
#define SYS_RECV 10 /* sys_recv(2) */
|
|
#define SYS_SENDTO 11 /* sys_sendto(2) */
|
|
#define SYS_RECVFROM 12 /* sys_recvfrom(2) */
|
|
#define SYS_SHUTDOWN 13 /* sys_shutdown(2) */
|
|
#define SYS_SETSOCKOPT 14 /* sys_setsockopt(2) */
|
|
#define SYS_GETSOCKOPT 15 /* sys_getsockopt(2) */
|
|
#define SYS_SENDMSG 16 /* sys_sendmsg(2) */
|
|
#define SYS_RECVMSG 17 /* sys_recvmsg(2) */
|
|
|
|
typedef enum {
|
|
SS_FREE = 0, /* not allocated */
|
|
SS_UNCONNECTED, /* unconnected to any socket */
|
|
SS_CONNECTING, /* in process of connecting */
|
|
SS_CONNECTED, /* connected to socket */
|
|
SS_DISCONNECTING /* in process of disconnecting */
|
|
} socket_state;
|
|
|
|
#define __SO_ACCEPTCON (1 << 16) /* performed a listen */
|
|
|
|
#ifdef __KERNEL__
|
|
|
|
#define SOCK_ASYNC_NOSPACE 0
|
|
#define SOCK_ASYNC_WAITDATA 1
|
|
#define SOCK_NOSPACE 2
|
|
#define SOCK_PASSCRED 3
|
|
|
|
#ifndef ARCH_HAS_SOCKET_TYPES
|
|
/**
|
|
* enum sock_type - Socket types
|
|
* @SOCK_STREAM: stream (connection) socket
|
|
* @SOCK_DGRAM: datagram (conn.less) socket
|
|
* @SOCK_RAW: raw socket
|
|
* @SOCK_RDM: reliably-delivered message
|
|
* @SOCK_SEQPACKET: sequential packet socket
|
|
* @SOCK_PACKET: linux specific way of getting packets at the dev level.
|
|
* For writing rarp and other similar things on the user level.
|
|
*
|
|
* When adding some new socket type please
|
|
* grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
|
|
* overrides this enum for binary compat reasons.
|
|
*/
|
|
enum sock_type {
|
|
SOCK_STREAM = 1,
|
|
SOCK_DGRAM = 2,
|
|
SOCK_RAW = 3,
|
|
SOCK_RDM = 4,
|
|
SOCK_SEQPACKET = 5,
|
|
SOCK_PACKET = 10,
|
|
};
|
|
|
|
#define SOCK_MAX (SOCK_PACKET + 1)
|
|
|
|
#endif /* ARCH_HAS_SOCKET_TYPES */
|
|
|
|
/**
|
|
* 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;
|
|
unsigned long flags;
|
|
struct proto_ops *ops;
|
|
struct fasync_struct *fasync_list;
|
|
struct file *file;
|
|
struct sock *sk;
|
|
wait_queue_head_t wait;
|
|
short type;
|
|
};
|
|
|
|
struct vm_area_struct;
|
|
struct page;
|
|
struct kiocb;
|
|
struct sockaddr;
|
|
struct msghdr;
|
|
struct module;
|
|
|
|
struct proto_ops {
|
|
int family;
|
|
struct module *owner;
|
|
int (*release) (struct socket *sock);
|
|
int (*bind) (struct socket *sock,
|
|
struct sockaddr *myaddr,
|
|
int sockaddr_len);
|
|
int (*connect) (struct socket *sock,
|
|
struct sockaddr *vaddr,
|
|
int sockaddr_len, int flags);
|
|
int (*socketpair)(struct socket *sock1,
|
|
struct socket *sock2);
|
|
int (*accept) (struct socket *sock,
|
|
struct socket *newsock, int flags);
|
|
int (*getname) (struct socket *sock,
|
|
struct sockaddr *addr,
|
|
int *sockaddr_len, int peer);
|
|
unsigned int (*poll) (struct file *file, struct socket *sock,
|
|
struct poll_table_struct *wait);
|
|
int (*ioctl) (struct socket *sock, unsigned int cmd,
|
|
unsigned long arg);
|
|
int (*listen) (struct socket *sock, int len);
|
|
int (*shutdown) (struct socket *sock, int flags);
|
|
int (*setsockopt)(struct socket *sock, int level,
|
|
int optname, char __user *optval, int optlen);
|
|
int (*getsockopt)(struct socket *sock, int level,
|
|
int optname, char __user *optval, int __user *optlen);
|
|
int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
|
|
struct msghdr *m, size_t total_len);
|
|
int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
|
|
struct msghdr *m, size_t 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 {
|
|
int family;
|
|
int (*create)(struct socket *sock, int protocol);
|
|
/* These are counters for the number of different methods of
|
|
each we support */
|
|
short authentication;
|
|
short encryption;
|
|
short encrypt_net;
|
|
struct module *owner;
|
|
};
|
|
|
|
struct iovec;
|
|
struct kvec;
|
|
|
|
extern int sock_wake_async(struct socket *sk, int how, int band);
|
|
extern int sock_register(struct net_proto_family *fam);
|
|
extern int sock_unregister(int family);
|
|
extern int sock_create(int family, int type, int proto,
|
|
struct socket **res);
|
|
extern int sock_create_kern(int family, int type, int proto,
|
|
struct socket **res);
|
|
extern int sock_create_lite(int family, int type, int proto,
|
|
struct socket **res);
|
|
extern void sock_release(struct socket *sock);
|
|
extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
|
|
size_t len);
|
|
extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
|
|
size_t size, int flags);
|
|
extern int sock_map_fd(struct socket *sock);
|
|
extern struct socket *sockfd_lookup(int fd, int *err);
|
|
#define sockfd_put(sock) fput(sock->file)
|
|
extern int net_ratelimit(void);
|
|
extern unsigned long net_random(void);
|
|
extern void net_srandom(unsigned long);
|
|
extern void net_random_init(void);
|
|
|
|
extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
|
|
struct kvec *vec, size_t num, size_t len);
|
|
extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
|
|
struct kvec *vec, size_t num,
|
|
size_t len, int flags);
|
|
|
|
#ifndef CONFIG_SMP
|
|
#define SOCKOPS_WRAPPED(name) name
|
|
#define SOCKOPS_WRAP(name, fam)
|
|
#else
|
|
|
|
#define SOCKOPS_WRAPPED(name) __unlocked_##name
|
|
|
|
#define SOCKCALL_WRAP(name, call, parms, args) \
|
|
static int __lock_##name##_##call parms \
|
|
{ \
|
|
int ret; \
|
|
lock_kernel(); \
|
|
ret = __unlocked_##name##_ops.call args ;\
|
|
unlock_kernel(); \
|
|
return ret; \
|
|
}
|
|
|
|
#define SOCKCALL_UWRAP(name, call, parms, args) \
|
|
static unsigned int __lock_##name##_##call parms \
|
|
{ \
|
|
int ret; \
|
|
lock_kernel(); \
|
|
ret = __unlocked_##name##_ops.call args ;\
|
|
unlock_kernel(); \
|
|
return ret; \
|
|
}
|
|
|
|
|
|
#define SOCKOPS_WRAP(name, fam) \
|
|
SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
|
|
SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
|
|
(sock, uaddr, addr_len)) \
|
|
SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
|
|
int addr_len, int flags), \
|
|
(sock, uaddr, addr_len, flags)) \
|
|
SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
|
|
(sock1, sock2)) \
|
|
SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
|
|
int flags), (sock, newsock, flags)) \
|
|
SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
|
|
int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
|
|
SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
|
|
(file, sock, wait)) \
|
|
SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
|
|
unsigned long arg), (sock, cmd, arg)) \
|
|
SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
|
|
SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
|
|
SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
|
|
char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
|
|
SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
|
|
char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
|
|
SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
|
|
(iocb, sock, m, len)) \
|
|
SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
|
|
(iocb, sock, m, len, flags)) \
|
|
SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
|
|
(file, sock, vma)) \
|
|
\
|
|
static struct proto_ops name##_ops = { \
|
|
.family = fam, \
|
|
.owner = THIS_MODULE, \
|
|
.release = __lock_##name##_release, \
|
|
.bind = __lock_##name##_bind, \
|
|
.connect = __lock_##name##_connect, \
|
|
.socketpair = __lock_##name##_socketpair, \
|
|
.accept = __lock_##name##_accept, \
|
|
.getname = __lock_##name##_getname, \
|
|
.poll = __lock_##name##_poll, \
|
|
.ioctl = __lock_##name##_ioctl, \
|
|
.listen = __lock_##name##_listen, \
|
|
.shutdown = __lock_##name##_shutdown, \
|
|
.setsockopt = __lock_##name##_setsockopt, \
|
|
.getsockopt = __lock_##name##_getsockopt, \
|
|
.sendmsg = __lock_##name##_sendmsg, \
|
|
.recvmsg = __lock_##name##_recvmsg, \
|
|
.mmap = __lock_##name##_mmap, \
|
|
};
|
|
#endif
|
|
|
|
#define MODULE_ALIAS_NETPROTO(proto) \
|
|
MODULE_ALIAS("net-pf-" __stringify(proto))
|
|
|
|
#endif /* __KERNEL__ */
|
|
#endif /* _LINUX_NET_H */
|