core/sys/freebsd package | Odin Programming Language

Platform-specific package target: freebsd_amd64

Collection Info

Collection: core
Path: sys/freebsd
Entries: 125

Constants 30

FD_CLOEXEC RTM_VERSION STDERR_FILENO STDIN_FILENO STDOUT_FILENO SYS__umtx_op SYS_accept SYS_accept4 SYS_bind SYS_close SYS_connect SYS_fcntl SYS_fsync SYS_getpeername SYS_getpid SYS_getsockname +14 more

Types 54

Jump to Types

Address_Family Errno Fd File_Control_Command File_Lock File_Seal_Index File_Seals File_Status_Flag File_Status_Flags File_Status_Index in_addr_t in_port_t Interface_Address_Message_Header_Len Interface_Data Interface_Message_Header_Len Interface_Type +38 more

Procedures 39

Jump to Procedures

accept_nil accept_T accept4_nil accept4_T bind close connect fcntl fcntl_add_seals fcntl_dupfd fcntl_get_seals fcntl_getfd fcntl_getfl fcntl_getlk fcntl_getown fcntl_setfd +23 more

Procedure Groups 2

Jump to Procedure Groups

accept accept4

Variables 0

Source Files

Constants

FD_CLOEXEC #

Source

FD_CLOEXEC :: 1

file descriptor flags (F_GETFD, F_SETFD)

RTM_VERSION #

Source

RTM_VERSION :: 5

Up the ante and ignore older versions

STDERR_FILENO #

Source

STDERR_FILENO :: Fd(2)

Standard error file descriptor

STDIN_FILENO #

Source

STDIN_FILENO :: Fd(0)

Standard input file descriptor

STDOUT_FILENO #

Source

STDOUT_FILENO :: Fd(1)

Standard output file descriptor

SYS__umtx_op #

Source

SYS__umtx_op :: 454

SYS_accept #

Source

SYS_accept :: 30

SYS_accept4 #

Source

SYS_accept4 :: 541

SYS_bind #

Source

SYS_bind :: 104

SYS_close #

Source

SYS_close :: 6

SYS_connect #

Source

SYS_connect :: 98

SYS_fcntl #

Source

SYS_fcntl :: 92

SYS_fsync #

Source

SYS_fsync :: 95

SYS_getpeername #

Source

SYS_getpeername :: 31

SYS_getpid #

Source

SYS_getpid :: 20

SYS_getsockname #

Source

SYS_getsockname :: 32

SYS_ioctl #

Source

SYS_ioctl :: 54

SYS_listen #

Source

SYS_listen :: 106

SYS_open #

Source

SYS_open :: 5

SYS_pread #

Source

SYS_pread :: 475

SYS_pwrite #

Source

SYS_pwrite :: 476

SYS_read #

Source

SYS_read :: 3

SYS_recvfrom #

Source

SYS_recvfrom :: 29

SYS_sendto #

Source

SYS_sendto :: 133

SYS_setsockopt #

Source

SYS_setsockopt :: 105

SYS_shutdown #

Source

SYS_shutdown :: 134

SYS_socket #

Source

SYS_socket :: 97

SYS_sysctl #

Source

SYS_sysctl :: 202

SYS_write #

Source

SYS_write :: 4

TIOCGWINSZ #

Source

TIOCGWINSZ :: 0x40087468

Get window size

Types

Address_Family #

Source

Address_Family :: Address_Family

#define AF_*

Errno #

Source

Errno :: Errno

Fd #

Source

Fd :: distinct Fd

File_Control_Command #

Source

File_Control_Command :: File_Control_Command

command values #define F_*

File_Lock #

Source

File_Lock :: File_Lock

struct flock

File_Seal_Index #

Source

File_Seal_Index :: File_Seal_Index

Seals (F_ADD_SEALS, F_GET_SEALS). #define F_SEAL_*

File_Seals #

Source

File_Seals :: bit_set[File_Seal_Index]

File_Status_Flag #

Source

File_Status_Flag :: File_Status_Flag

* File status flags: these are used by open(2), fcntl(2). * They are also used (indirectly) in the kernel file structure f_flags, * which is a superset of the open/fcntl flags. Open flags and f_flags * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). * Open/fcntl flags begin with O_; kernel-internal flags begin with F.

File_Status_Flags #

Source

File_Status_Flags :: bit_set[File_Status_Index]

File_Status_Index #

Source

File_Status_Index :: File_Status_Index

in_addr_t #

Source

in_addr_t :: distinct in_addr_t

in_port_t #

Source

in_port_t :: distinct in_port_t

Interface_Address_Message_Header_Len #

Source

Interface_Address_Message_Header_Len :: Interface_Address_Message_Header_Len

* The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is * extensible after ifam_metric or within ifam_data. Both the ifa_msghdrl and * if_data now have a member field detailing the struct length in addition to * the routing message length. Macros are provided to find the start of * ifm_data and the start of the socket address strucutres immediately following * struct ifa_msghdrl given a pointer to struct ifa_msghdrl. struct ifa_msghdrl

Interface_Data #

Source

Interface_Data :: Interface_Data

* Structure describing information about an interface * which may be of interest to management entities. struct if_data

Interface_Message_Header_Len #

Source

Interface_Message_Header_Len :: Interface_Message_Header_Len

* The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL. It is * extensible after ifm_data_off or within ifm_data. Both the if_msghdr and * if_data now have a member field detailing the struct length in addition to * the routing message length. Macros are provided to find the start of * ifm_data and the start of the socket address strucutres immediately following * struct if_msghdrl given a pointer to struct if_msghdrl. struct if_msghdrl

Interface_Type #

Source

Interface_Type :: Interface_Type

enum ifType

IP4_Address #

Source

IP4_Address :: IP4_Address

Internet address (a structure for historical reasons). struct in_addr

IP6_Address #

Source

IP6_Address :: IP6_Address

* IPv6 address struct in6_addr

Link_State #

Source

Link_State :: Link_State

* Values for if_link_state. #define LINK_STATE_*

Message_Flag #

Source

Message_Flag :: Message_Flag

#define MSG_*

MIB_Identifier #

Source

MIB_Identifier :: MIB_Identifier

MIB, or Management Information Base. Used in sysctl().

off_t #

Source

off_t :: distinct off_t

pid_t #

Source

pid_t :: distinct pid_t

Protocol #

Source

Protocol :: Protocol

Protocol_Family #

Source

Protocol_Family :: Protocol_Family

#define PF_*

Record_Lock_Flag #

Source

Record_Lock_Flag :: Record_Lock_Flag

record locking flags (F_GETLK, F_SETLK, F_SETLKW) #define F_*

Recv_Flags #

Source

Recv_Flags :: Recv_Flags

Specific subset of `MSG_*` defines that are only for `recv*`.

Route_Address_Flag #

Source

Route_Address_Flag :: Route_Address_Flag

* Bitmask values for rtm_addrs. #define RTA_*

Route_Address_Flags #

Source

Route_Address_Flags :: bit_set[Route_Address_Index]

The value stored in rtm_addrs and similar (ifm_addrs, etc.)

Route_Address_Index #

Source

Route_Address_Index :: Route_Address_Index

* Index offsets for sockaddr array for alternate internal encoding. #define RTAX_*

Route_Message_Header #

Source

Route_Message_Header :: Route_Message_Header

struct rt_msghdr

Route_Message_Type #

Source

Route_Message_Type :: Route_Message_Type

* Message types. * * The format for each message is annotated below using the following * identifiers: * * (1) struct rt_msghdr * (2) struct ifa_msghdr * (3) struct if_msghdr * (4) struct ifma_msghdr * (5) struct if_announcemsghdr * #define RTM_*

Route_Metrics #

Source

Route_Metrics :: Route_Metrics

struct rt_metrics

sa_family_t #

Source

sa_family_t :: distinct sa_family_t

Send_Flags #

Source

Send_Flags :: Send_Flags

Specific subset of `MSG_*` defines that are only for `send*`.

Shutdown_Method #

Source

Shutdown_Method :: Shutdown_Method

* howto arguments for shutdown(2), specified by Posix.1g. #define SHUT_*

Socket_Address_Basic #

Source

Socket_Address_Basic :: Socket_Address_Basic

struct sockaddr

Socket_Address_Data_Link #

Source

Socket_Address_Data_Link :: Socket_Address_Data_Link

* Structure of a Link-Level sockaddr: struct sockaddr_dl

Socket_Address_Header #

Source

Socket_Address_Header :: Socket_Address_Header

Socket address struct header without protocol-specific data. Inherit from this if you want a custom socket address datatype for use with bind(), listen(), et cetera.

Socket_Address_Internet #

Source

Socket_Address_Internet :: Socket_Address_Internet

Socket address, internet style. struct sockaddr_in

Socket_Address_Internet6 #

Source

Socket_Address_Internet6 :: Socket_Address_Internet6

* Socket address for IPv6 struct sockaddr_in6

Socket_Address_Storage #

Source

Socket_Address_Storage :: Socket_Address_Storage

* RFC 2553: protocol-independent placeholder for socket addresses struct sockaddr_storage

Socket_Flag_Index #

Source

Socket_Flag_Index :: Socket_Flag_Index

Socket_Flags #

Source

Socket_Flags :: bit_set[Socket_Flag_Index]

Socket_Option #

Source

Socket_Option :: Socket_Option

* Option flags per-socket. #define SO_*

Socket_Option_Level #

Source

Socket_Option_Level :: Socket_Option_Level

* Level number for (get/set)sockopt() to apply to socket itself. #define SOL_*

Socket_Type #

Source

Socket_Type :: Socket_Type

* Types #define SOCK_*

socklen_t #

Source

socklen_t :: distinct socklen_t

suseconds_t #

Source

suseconds_t :: distinct suseconds_t

microseconds (signed)

time_t #

Source

time_t :: distinct time_t

timespec #

Source

timespec :: timespec

timeval #

Source

timeval :: timeval

Userland_Mutex_Operation #

Source

Userland_Mutex_Operation :: Userland_Mutex_Operation

op code for _umtx_op #define UMTX_OP_*

Valid_Socket_Option_Level #

Source

Valid_Socket_Option_Level :: Valid_Socket_Option_Level

Procedures

accept_nil #

Source

accept_nil :: proc "contextless" (s: Fd) -> (Fd, Errno) {…}

Accept a connection on a socket. The accept() system call appeared in 4.2BSD.

accept_T #

Source

accept_T :: proc "contextless" (s: Fd, sockaddr: ^$T) -> (Fd, Errno) {…}

Accept a connection on a socket. The accept() system call appeared in 4.2BSD.

accept4_nil #

Source

accept4_nil :: proc "contextless" (s: Fd, flags: bit_set[Socket_Flag_Index] = {}) -> (Fd, Errno) {…}

Accept a connection on a socket. The accept4() system call appeared in FreeBSD 10.0.

accept4_T #

Source

accept4_T :: proc "contextless" (s: Fd, sockaddr: ^$T, flags: bit_set[Socket_Flag_Index] = {}) -> (Fd, Errno) {…}

Accept a connection on a socket. The accept4() system call appeared in FreeBSD 10.0.

bind #

Source

bind :: proc "contextless" (s: Fd, sockaddr: ^$T, addrlen: socklen_t) -> Errno {…}

Assign a local protocol address to a socket. The bind() system call appeared in 4.2BSD.

close #

Source

close :: proc "contextless" (fd: Fd) -> Errno {…}

Delete a descriptor. The open() function appeared in Version 1 AT&T UNIX.

connect #

Source

connect :: proc "contextless" (fd: Fd, sockaddr: ^$T, addrlen: socklen_t) -> Errno {…}

Initiate a connection on a socket. The connect() system call appeared in 4.2BSD.

fcntl #

Source

fcntl :: proc "contextless" (fd: Fd, cmd: File_Control_Command, arg: i32) -> (int, Errno) {…}

File control. The fcntl() system call appeared in 4.2BSD. The F_DUP2FD constant first appeared in FreeBSD 7.1. NOTE: If you know at compile-time what command you're calling, use one of the `fcntl_*` procedures instead to preserve type safety.

fcntl_add_seals #

Source

fcntl_add_seals :: proc "contextless" (fd: Fd, seals: bit_set[File_Seal_Index]) -> Errno {…}

fcntl_dupfd #

Source

fcntl_dupfd :: proc "contextless" (fd: Fd, newfd: Fd) -> (Fd, Errno) {…}

fcntl_get_seals #

Source

fcntl_get_seals :: proc "contextless" (fd: Fd) -> (bit_set[File_Seal_Index], Errno) {…}

fcntl_getfd #

Source

fcntl_getfd :: proc "contextless" (fd: Fd) -> (bool, Errno) {…}

fcntl_getfl #

Source

fcntl_getfl :: proc "contextless" (fd: Fd) -> (bit_set[File_Status_Index], Errno) {…}

fcntl_getlk #

Source

fcntl_getlk :: proc "contextless" (fd: Fd, flock: ^File_Lock) -> Errno {…}

fcntl_getown #

Source

fcntl_getown :: proc "contextless" (fd: Fd) -> (pid_t, Errno) {…}

fcntl_setfd #

Source

fcntl_setfd :: proc "contextless" (fd: Fd, close_on_exec: bool) -> Errno {…}

fcntl_setfl #

Source

fcntl_setfl :: proc "contextless" (fd: Fd, flags: bit_set[File_Status_Index]) -> Errno {…}

fcntl_setlk #

Source

fcntl_setlk :: proc "contextless" (fd: Fd, flock: ^File_Lock) -> Errno {…}

fcntl_setown #

Source

fcntl_setown :: proc "contextless" (fd: Fd, pid: pid_t) -> Errno {…}

fsync #

Source

fsync :: proc "contextless" (fd: Fd) -> Errno {…}

Synchronize changes to a file. The fsync() system call appeared in 4.2BSD.

getpeername #

Source

getpeername :: proc "contextless" (s: Fd, sockaddr: ^$T) -> Errno {…}

Get name of connected peer The getpeername() system call appeared in 4.2BSD.

getpid #

Source

getpid :: proc "contextless" () -> pid_t {…}

Get parent or calling process identification. The getpid() function appeared in Version 7 AT&T UNIX.

getsockname #

Source

getsockname :: proc "contextless" (s: Fd, sockaddr: ^$T) -> Errno {…}

Get socket name. The getsockname() system call appeared in 4.2BSD.

getsockname_or_peername #

Source

getsockname_or_peername :: proc "contextless" (s: Fd, sockaddr: ^$T, is_peer: bool) -> Errno {…}

ioctl #

Source

ioctl :: proc "contextless" (fd: Fd, request: u64, arg: uintptr) -> (int, Errno) {…}

listen #

Source

listen :: proc "contextless" (s: Fd, backlog: int) -> Errno {…}

Listen for connections on a socket. The listen() system call appeared in 4.2BSD.

open #

Source

open :: proc "contextless" (path: string, flags: bit_set[File_Status_Index], mode: int = 0o000) -> (Fd, Errno) {…}

Open or create a file for reading, writing or executing. The open() function appeared in Version 1 AT&T UNIX. The openat() function was introduced in FreeBSD 8.0.

pread #

Source

pread :: proc "contextless" (fd: Fd, buf: []u8, offset: off_t) -> (int, Errno) {…}

Read input without modifying the file pointer. The pread() function appeared in AT&T System V Release 4 UNIX.

pwrite #

Source

pwrite :: proc "contextless" (fd: Fd, buf: []u8, offset: off_t) -> (int, Errno) {…}

Write output without modifying the file pointer. The pwrite() function appeared in AT&T System V Release 4 UNIX. BUGS The pwrite() system call appends the file without changing the file offset if O_APPEND is set, contrary to IEEE Std 1003.1-2008 (“POSIX.1”) where pwrite() writes into offset regardless of whether O_APPEND is set.

read #

Source

read :: proc "contextless" (fd: Fd, buf: []u8) -> (int, Errno) {…}

Read input. The read() function appeared in Version 1 AT&T UNIX.

recv #

Source

recv :: proc "contextless" (s: Fd, buf: []u8, flags: Recv_Flags) -> (int, Errno) {…}

Receive message(s) from a socket. The recv() function appeared in 4.2BSD. The recvmmsg() function appeared in FreeBSD 11.0.

recvfrom #

Source

recvfrom :: proc "contextless" (s: Fd, buf: []u8, flags: Recv_Flags, from: ^$T) -> (int, Errno) {…}

Receive message(s) from a socket. The recv() function appeared in 4.2BSD. The recvmmsg() function appeared in FreeBSD 11.0.

send #

Source

send :: proc "contextless" (s: Fd, msg: []u8, flags: Send_Flags) -> (int, Errno) {…}

Send message(s) from a socket. The send() function appeared in 4.2BSD. The sendmmsg() function appeared in FreeBSD 11.0.

sendto #

Source

sendto :: proc "contextless" (s: Fd, msg: []u8, flags: Send_Flags, to: ^$T) -> (int, Errno) {…}

Send message(s) from a socket. The send() function appeared in 4.2BSD. The sendmmsg() function appeared in FreeBSD 11.0.

setsockopt #

Source

setsockopt :: proc "contextless" (s: Fd, level: Valid_Socket_Option_Level, optname: Socket_Option, optval: rawptr, optlen: socklen_t) -> Errno {…}

Get and set options on sockets. The getsockopt() and setsockopt() system calls appeared in 4.2BSD.

shutdown #

Source

shutdown :: proc "contextless" (s: Fd, how: Shutdown_Method) -> Errno {…}

Disable sends and/or receives on a socket. The shutdown() system call appeared in 4.2BSD.

socket #

Source

socket :: proc "contextless" (domain: Protocol_Family, type: Socket_Type, protocol: Protocol) -> (Fd, Errno) {…}

Create an endpoint for communication. The socket() system call appeared in 4.2BSD.

sysctl #

Source

sysctl :: proc "contextless" (mib: []MIB_Identifier, oldp: rawptr, oldlenp: ^uint, newp: rawptr, newlen: uint) -> Errno {…}

Get or set system information. The sysctl() function first appeared in 4.4BSD.

write #

Source

write :: proc "contextless" (fd: Fd, buf: []u8) -> (int, Errno) {…}

Write output. The write() function appeared in Version 1 AT&T UNIX.

Procedure Groups

accept #

Source

accept :: proc{
	accept_T,
	accept_nil,
}

accept4 #

Source

accept4 :: proc{
	accept4_nil,
	accept4_T,
}