socket.h File Reference

#include <core/system.h>
#include <fs/vfs.h>
#include <fs/iobuf.h>
#include <aquila/socket.h>

Go to the source code of this file.

Data Structures
struct	socket
	A socket. More...
struct	sock_ops
	A domain's socket operations. More...

Macros
#define	FILE_SOCKET   0x80000000

Functions
int	socket_create (struct file *file, int domain, int type, int protocol)
	Makes a socket of a domain in an open file, for socket().
int	socket_bind (struct file *file, const struct sockaddr *addr, socklen_t len)
	Gives a socket its local address, for bind().
int	socket_accept (struct file *file, struct file *conn, const struct sockaddr *addr, socklen_t *len)
	Accepts a connection on a listening socket, for accept().
int	socket_connect (struct file *file, const struct sockaddr *addr, socklen_t len)
	Connects a socket to a peer, for connect().
int	socket_listen (struct file *file, int backlog)
	Makes a socket listen for connections, for listen().
ssize_t	socket_send (struct file *file, struct iobuf *io, int flags, const struct sockaddr *to, socklen_t tolen)
	Sends data on a socket, for send(), sendto() and write().
ssize_t	socket_recv (struct file *file, struct iobuf *io, int flags, struct sockaddr *from, socklen_t *fromlen)
	Receives data from a socket, for recv(), recvfrom() and read().
int	socket_getname (struct file *file, struct sockaddr *addr, socklen_t *len, int peer)
	Gets a socket's local address, or its peer's, for getsockname() and getpeername().
int	socket_getsockopt (struct file *file, int level, int name, void *val, socklen_t *len)
	Reads a socket option, for getsockopt().
int	socket_setsockopt (struct file *file, int level, int name, const void *val, socklen_t len)
	Sets a socket option, for setsockopt().
int	socket_ioctl (struct file *file, int request, void *argp)
	Handles an ioctl() on a socket, by passing it to the protocol.
int	socket_can_read (struct file *file, size_t len)
	Says whether a socket has something to read, for select() and poll().
int	socket_can_write (struct file *file, size_t len)
	Says whether a socket has room to write, for select() and poll().
struct waitq *	socket_wait_queue (struct file *file, int write)
	Finds the wait queue that a socket's readers (or writers) sleep on, for select() and poll() to register.
int	socket_shutdown (struct file *file, int how)
	Releases a socket when its open file is closed (its last descriptor went).
int	socket_shutdown_dir (struct file *file, int how)
	Shuts down reading, writing or both on a socket, for shutdown().
int	socket_unix_create (struct file *file, int domain, int type, int protocol)
	Makes an AF_UNIX socket, for socket().
int	socket_inet_create (struct file *file, int domain, int type, int protocol)
	Makes an AF_INET socket: a TCP, UDP or ping socket.
int	socket_tcp_create (struct file *file, int domain, int type, int protocol)
	Makes a TCP socket, with its connection, CLOSED.

Macro Definition Documentation

FILE_SOCKET

#define FILE_SOCKET   0x80000000

Definition at line 70 of file socket.h.

Referenced by at_uio(), fd_vnode(), socket_accept(), socket_bind(), socket_can_read(), socket_can_write(), socket_connect(), socket_getname(), socket_getsockopt(), socket_inet_create(), socket_ioctl(), socket_listen(), socket_recv(), socket_send(), socket_setsockopt(), socket_shutdown(), socket_shutdown_dir(), socket_tcp_accept(), socket_tcp_create(), socket_unix_accept(), socket_unix_create(), sys_fchdir(), sys_fcntl(), sys_fstat(), sys_ioctl(), sys_isatty(), sys_lseek(), sys_mmap(), sys_readdir(), vfs_file_can_read(), vfs_file_can_write(), vfs_file_close(), vfs_file_flock(), vfs_file_read(), vfs_file_trunc(), vfs_file_wait_queue(), and vfs_file_write().

Function Documentation

socket_accept()

int socket_accept	(	struct file *	file,
		struct file *	conn,
		const struct sockaddr *	addr,
		socklen_t *	len )

Accepts a connection on a listening socket, for accept().

Parameters

file	the listening socket
conn	the open file that becomes the connection's socket
addr	where to put the peer's address, in user memory, or NULL
len	its size, in user memory

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 59 of file socket.c.

References FILE_SOCKET, file::flags, and socket_accept().

Referenced by socket_accept(), and sys_accept().

socket_bind()

int socket_bind	(	struct file *	file,
		const struct sockaddr *	addr,
		socklen_t	len )

Gives a socket its local address, for bind().

Parameters

file	the socket
addr	the address, in the kernel's memory
len	its size

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 83 of file socket.c.

References FILE_SOCKET, file::flags, and socket_bind().

Referenced by socket_bind(), and sys_bind().

socket_can_read()

int socket_can_read	(	struct file *	file,
		size_t	len )

Says whether a socket has something to read, for select() and poll().

Parameters

file	the socket
len	how much a read would want

Returns

non-zero if a read wouldn't wait, 0 if it would, or a negative errno

Definition at line 189 of file socket.c.

References FILE_SOCKET, file::flags, and socket_can_read().

Referenced by socket_can_read(), and vfs_file_can_read().

socket_can_write()

int socket_can_write	(	struct file *	file,
		size_t	len )

Says whether a socket has room to write, for select() and poll().

Parameters

file	the socket
len	how much a write would want

Returns

non-zero if a write wouldn't wait, 0 if it would, or a negative errno

Definition at line 225 of file socket.c.

References FILE_SOCKET, file::flags, and socket_can_write().

Referenced by socket_can_write(), and vfs_file_can_write().

socket_connect()

int socket_connect	(	struct file *	file,
		const struct sockaddr *	addr,
		socklen_t	len )

Connects a socket to a peer, for connect().

Parameters

file	the socket
addr	the peer's address, in the kernel's memory
len	its size

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 102 of file socket.c.

References FILE_SOCKET, file::flags, and socket_connect().

Referenced by socket_connect(), and sys_connect().

socket_create()

int socket_create	(	struct file *	file,
		int	domain,
		int	type,
		int	protocol )

Makes a socket of a domain in an open file, for socket().

Parameters

file	the open file that becomes the socket
domain	AF_UNIX or AF_INET
type	the socket's type (SOCK_STREAM, SOCK_DGRAM)
protocol	the protocol, or 0 for the type's default

Returns

0, -EAFNOSUPPORT for another domain, or the domain's error

Definition at line 27 of file socket.c.

References file::flags, socket_create(), socket_inet_create(), and socket_unix_create().

Referenced by socket_create(), and sys_socket().

socket_getname()

int socket_getname	(	struct file *	file,
		struct sockaddr *	addr,
		socklen_t *	len,
		int	peer )

Gets a socket's local address, or its peer's, for getsockname() and getpeername().

Parameters

file	the socket
addr	where to put the address, in the kernel's memory
len	its size, set to the address's
peer	0 for the local address, 1 for the peer's

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 289 of file socket.c.

References FILE_SOCKET, file::flags, and socket_getname().

Referenced by socket_getname(), and socket_name().

socket_getsockopt()

int socket_getsockopt	(	struct file *	file,
		int	level,
		int	name,
		void *	val,
		socklen_t *	len )

Reads a socket option, for getsockopt().

The protocol is asked first; SO_TYPE, and SO_ERROR for a protocol that keeps no errors, are answered here.

Parameters

file	the socket
level	SOL_SOCKET, or a protocol's level
name	the option
val	where to put its value, in the kernel's memory
len	its size, set to the value's

Returns

0, -ENOPROTOOPT for an unknown option, or another negative errno

Definition at line 325 of file socket.c.

References FILE_SOCKET, file::flags, sock_ops::getsockopt, socket_getsockopt(), and sockopt_int().

Referenced by socket_getsockopt(), and sys_getsockopt().

socket_inet_create()

int socket_inet_create	(	struct file *	file,
		int	domain,
		int	type,
		int	protocol )

Makes an AF_INET socket: a TCP, UDP or ping socket.

Parameters

file	the open file that becomes the socket
domain	AF_INET
type	SOCK_STREAM or SOCK_DGRAM
protocol	0, IPPROTO_TCP, IPPROTO_UDP or IPPROTO_ICMP

Returns

0, -EPROTONOSUPPORT, or -ENOMEM

Definition at line 230 of file socket.c.

References socket::domain, FILE_SOCKET, file::flags, IP_PROTO_ICMP, IP_PROTO_UDP, kfree(), kmalloc(), M_ZERO, socket::ops, socket::p, inet_sock::proto, socket::protocol, socket_inet_create(), socket_inet_ops, socket_tcp_create(), and socket::type.

Referenced by socket_create(), and socket_inet_create().

socket_ioctl()

int socket_ioctl	(	struct file *	file,
		int	request,
		void *	argp )

Handles an ioctl() on a socket, by passing it to the protocol.

Parameters

file	the socket
request	the request
argp	its argument, in user memory

Returns

what the protocol returns, or -ENOTTY if it has no ioctl()

Definition at line 399 of file socket.c.

References FILE_SOCKET, file::flags, and socket_ioctl().

Referenced by socket_ioctl(), and sys_ioctl().

socket_listen()

int socket_listen	(	struct file *	file,
		int	backlog )

Makes a socket listen for connections, for listen().

Parameters

file	the socket
backlog	how many connections may wait to be accepted

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 120 of file socket.c.

References FILE_SOCKET, file::flags, and socket_listen().

Referenced by socket_listen(), and sys_listen().

socket_recv()

ssize_t socket_recv	(	struct file *	file,
		struct iobuf *	io,
		int	flags,
		struct sockaddr *	from,
		socklen_t *	fromlen )

Receives data from a socket, for recv(), recvfrom() and read().

Parameters

file	the socket
io	where to put the data, in user memory
flags	MSG_* flags
from	where to put the sender's address, or NULL
fromlen	its size

Returns

how many bytes were received (0 at the end), or a negative errno

Definition at line 169 of file socket.c.

References FILE_SOCKET, file::flags, and socket_recv().

Referenced by socket_recv(), sys_recv(), and vfs_file_read().

socket_send()

ssize_t socket_send	(	struct file *	file,
		struct iobuf *	io,
		int	flags,
		const struct sockaddr *	to,
		socklen_t	tolen )

Sends data on a socket, for send(), sendto() and write().

Parameters

file	the socket
io	the data, in user memory
flags	MSG_* flags
to	the destination, for a datagram socket, or NULL
tolen	its size

Returns

how many bytes were sent, or a negative errno

Definition at line 141 of file socket.c.

References FILE_SOCKET, file::flags, and socket_send().

Referenced by socket_send(), sys_send(), and vfs_file_write().

socket_setsockopt()

int socket_setsockopt	(	struct file *	file,
		int	level,
		int	name,
		const void *	val,
		socklen_t	len )

Sets a socket option, for setsockopt().

The protocol is asked first; a few common SOL_SOCKET options are accepted here without effect.

Parameters

file	the socket
level	SOL_SOCKET, or a protocol's level
name	the option
val	its value, in the kernel's memory
len	its size

Returns

0, -ENOPROTOOPT for an unknown option, or another negative errno

Definition at line 361 of file socket.c.

References FILE_SOCKET, file::flags, sock_ops::setsockopt, and socket_setsockopt().

Referenced by socket_setsockopt(), and sys_setsockopt().

socket_shutdown()

int socket_shutdown	(	struct file *	file,
		int	how )

Releases a socket when its open file is closed (its last descriptor went).

Parameters

file	the socket
how	passed on to the protocol

Returns

0, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 267 of file socket.c.

References FILE_SOCKET, file::flags, and socket_shutdown().

Referenced by socket_shutdown(), and vfs_file_close().

socket_shutdown_dir()

int socket_shutdown_dir	(	struct file *	file,
		int	how )

Shuts down reading, writing or both on a socket, for shutdown().

The socket stays open.

Parameters

file	the socket
how	SHUT_RD, SHUT_WR or SHUT_RDWR

Returns

0, -EINVAL for a bad how, -ENOTSOCK, -EOPNOTSUPP, or the protocol's error

Definition at line 245 of file socket.c.

References FILE_SOCKET, file::flags, and socket_shutdown_dir().

Referenced by socket_shutdown_dir(), and sys_shutdown().

socket_tcp_create()

int socket_tcp_create	(	struct file *	file,
		int	domain,
		int	type,
		int	protocol )

Makes a TCP socket, with its connection, CLOSED.

Parameters

file	the open file that becomes the socket
domain	AF_INET
type	SOCK_STREAM
protocol	0 or IPPROTO_TCP

Returns

0, or -ENOMEM

Definition at line 490 of file tcp_socket.c.

References socket::domain, FILE_SOCKET, file::flags, kfree(), kmalloc(), M_ZERO, socket::ops, socket::p, socket::protocol, socket_tcp_create(), socket_tcp_ops, tcp_pcb_free(), tcp_pcb_new(), and socket::type.

Referenced by socket_inet_create(), and socket_tcp_create().

socket_unix_create()

int socket_unix_create	(	struct file *	file,
		int	domain,
		int	type,
		int	protocol )

Makes an AF_UNIX socket, for socket().

It is neither bound nor connected yet.

Parameters

file	the open file that becomes the socket
domain	AF_UNIX
type	SOCK_STREAM (the only one supported)
protocol	0

Returns

0, -EPROTONOSUPPORT, or -ENOMEM

Definition at line 68 of file unix.c.

References socket::domain, FILE_SOCKET, file::flags, kmalloc(), M_ZERO, NULL, socket::ops, socket::p, socket::protocol, socket_unix_create(), socket_unix_ops, and socket::type.

Referenced by socket_create(), and socket_unix_create().

socket_wait_queue()

struct waitq * socket_wait_queue	(	struct file *	file,
		int	write )

Finds the wait queue that a socket's readers (or writers) sleep on, for select() and poll() to register.

Parameters

file	the socket
write	0 for readers, 1 for writers

Returns

the wait queue, or NULL if the protocol can't say, in which case any wakeup counts

Definition at line 209 of file socket.c.

References NULL, and socket_wait_queue().

Referenced by socket_wait_queue(), and vfs_file_wait_queue().