otp_socket.c

Include dependency graph for otp_socket.c:

Defines

TAG "otp_socket"

CLOSED_FD 0

ADDR_ATOM globalcontext_make_atom(global, addr_atom)

CLOSE_INTERNAL_ATOM globalcontext_make_atom(global, close_internal_atom)

ACCEPT_ATOM globalcontext_make_atom(global, accept_atom)

RECV_ATOM globalcontext_make_atom(global, recv_atom)

DEFAULT_BUFFER_SIZE 512

MIN(A, B) (((A) < (B)) ? (A) : (B))

Enums

enum ShutdownHow

Values:

enumerator SHUT_RD

enumerator SHUT_WR

enumerator SHUT_RDWR

enum SocketProtocol

Values:

enumerator IPPROTO_IP

enumerator IPPROTO_TCP

enumerator IPPROTO_UDP

enum SocketDomain

Values:

enumerator PF_INET

enum SocketType

Values:

enumerator SOCK_STREAM

enumerator SOCK_DGRAM

enum SocketState

Values:

enumerator SocketStateClosed = 0

enumerator SocketStateUDP = 1 << 1

enumerator SocketStateTCP = 1 << 2

enumerator SocketStateSelectingRead = 1 << 3

enumerator SocketStateConnected = 1 << 4

enumerator SocketStateListening = 1 << 5

enumerator SocketStateUDPIdle = SocketStateUDP

enumerator SocketStateUDPSelectingRead = SocketStateUDP | SocketStateSelectingRead

enumerator SocketStateTCPNew = SocketStateTCP

enumerator SocketStateTCPConnected = SocketStateTCP | SocketStateConnected

enumerator SocketStateTCPSelectingRead = SocketStateTCPConnected | SocketStateSelectingRead

enumerator SocketStateTCPListening = SocketStateTCP | SocketStateListening

enumerator SocketStateTCPSelectingAccept = SocketStateTCPListening | SocketStateSelectingRead

enum otp_socket_shutdown_direction

Values:

enumerator OtpSocketInvalidShutdownDirection = 0

enumerator OtpSocketReadShutdownDirection

enumerator OtpSocketWriteShutdownDirection

enumerator OtpSocketReadWriteShutdownDirection

enum otp_socket_setopt_level

Values:

enumerator OtpSocketInvalidSetoptLevel = 0

enumerator OtpSocketSetoptLevelSocket

enumerator OtpSocketSetoptLevelOTP

Functions

static err_t tcp_recv_cb(void *arg, struct tcp_pcb *tpcb, struct pbuf *p, err_t err)

static void udp_recv_cb(void *arg, struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *addr, u16_t port)

static void socket_dtor(ErlNifEnv *caller_env, void *obj)

static void socket_down(ErlNifEnv *caller_env, void *obj, ErlNifPid *pid, ErlNifMonitor *mon)

static void select_event_send_notification_from_nif(struct SocketResource *rsrc_obj, Context *locked_ctx)

static void select_event_send_notification_from_handler(struct SocketResource *rsrc_obj, int32_t process_id)

void otp_socket_init(GlobalContext *global)

static inline int get_domain(GlobalContext *global, term domain_term, bool *ok)

static inline int get_type(GlobalContext *global, term type_term, bool *ok)

static inline int get_protocol(GlobalContext *global, term protocol_term, bool *ok)

static inline term make_error_tuple(term reason, Context *ctx)

Allocate memory on ctx and make and return an error tuple from immediate term reason.

This function is meant to be called from a nif that should return its result directly, to allow for further processing of a possible out of memory exception.

Parameters:

• reason – the reason, should be an immediate (atom or integer)

• ctx – the current context

Returns:

a term

static term make_lwip_err_tuple(err_t err, Context *ctx)

static term nif_socket_open(Context *ctx, int argc, term argv[])

bool term_to_otp_socket(term socket_term, struct SocketResource **rsrc_obj, Context *ctx)

Get the resource object associated with a socket term.

Parameters:

• socket_term – the term with the socket

• otp_socket – on output, the socket resource

• ctx – the current context

Returns:

true in case of success

bool term_is_otp_socket(term socket_term)

Determine if a term is a socket term.

Parameters:

• socket_term – the term to test

Returns:

true if it is a term

static int send_closed_notification(Context *ctx, term socket_term, int32_t selecting_process_id, struct SocketResource *rsrc_obj)

static void finalize_close_hander(struct LWIPEvent *event)

static term nif_socket_close(Context *ctx, int argc, term argv[])

static struct SocketResource *make_accepted_socket_resource(struct tcp_pcb *newpcb)

static void tcp_accept_handler(struct LWIPEvent *event)

static err_t tcp_accept_cb(void *arg, struct tcp_pcb *newpcb, err_t err)

static void tcp_recv_handler(struct LWIPEvent *event)

static void udp_recv_handler(struct LWIPEvent *event)

static term nif_socket_select_read(Context *ctx, int argc, term argv[])

static term nif_socket_select_stop(Context *ctx, int argc, term argv[])

static term nif_socket_getopt(Context *ctx, int argc, term argv[])

static term nif_socket_setopt(Context *ctx, int argc, term argv[])

static term nif_socket_sockname(Context *ctx, int argc, term argv[])

static term nif_socket_peername(Context *ctx, int argc, term argv[])

static term nif_socket_bind(Context *ctx, int argc, term argv[])

static term nif_socket_listen(Context *ctx, int argc, term argv[])

static term make_accepted_socket_term(Context *ctx, struct SocketResource *conn_rsrc_obj)

static term nif_socket_accept(Context *ctx, int argc, term argv[])

static size_t copy_pbuf_data(struct pbuf *src, size_t offset, size_t count, uint8_t *dst)

static ssize_t do_socket_recv(struct SocketResource *rsrc_obj, uint8_t *buf, size_t len, int flags, term *from, Heap *heap)

ssize_t socket_recv(struct SocketResource *rsrc_obj, uint8_t *buf, size_t len, int flags, term *from, Heap *heap)

Read data from a socket.

Parameters:

• socket – the socket resource

• buf – buffer to store data

• len – number of bytes

• flags – flags passed to recvfrom

• from – filled with origin address using recvfrom (can be NULL)

• heap – heap to build the origin address term (can be NULL if from is NULL)

Returns:

the number of read bytes or a value from SocketErrors

static term nif_socket_recv_lwip(Context *ctx, term resource_term, struct SocketResource *rsrc_obj, size_t len, bool is_recvfrom)

static term nif_socket_recv_internal(Context *ctx, term argv[], bool is_recvfrom)

static term nif_socket_recv(Context *ctx, int argc, term argv[])

static term nif_socket_recvfrom(Context *ctx, int argc, term argv[])

static ssize_t do_socket_send(struct SocketResource *rsrc_obj, const uint8_t *buf, size_t len, term dest)

ssize_t socket_send(struct SocketResource *rsrc_obj, const uint8_t *buf, size_t len, term dest)

Send data to a socket (without blocking)

Parameters:

• socket – the socket resource

• buf – buffer to send

• len – number of bytes

• dest – destination address or invalid term for sendto/send

Returns:

the number of written bytes or a value from SocketErrors

static term nif_socket_send_internal(Context *ctx, int argc, term argv[], bool is_sendto)

static term nif_socket_send(Context *ctx, int argc, term argv[])

static term nif_socket_sendto(Context *ctx, int argc, term argv[])

static void trap_answer_ok(struct LWIPEvent *event)

static void trap_answer_closed(struct LWIPEvent *event)

static err_t tcp_connected_cb(void *arg, struct tcp_pcb *tpcb, err_t err)

static term nif_socket_connect(Context *ctx, int argc, term argv[])

static term nif_socket_shutdown(Context *ctx, int argc, term argv[])

const struct Nif *otp_socket_nif_get_nif(const char *nifname)

Variables

static const char *const addr_atom = ATOM_STR("\x4", "addr")

static const char *const any_atom = ATOM_STR("\x3", "any")

static const char *const invalid_option_atom = ATOM_STR("\xE", "invalid_option")

static const char *const invalid_value_atom = ATOM_STR("\xD", "invalid_value")

static const char *const linger_atom = ATOM_STR("\x6", "linger")

static const char *const loopback_atom = ATOM_STR("\x8", "loopback")

static const char *const onoff_atom = ATOM_STR("\x5", "onoff")

static const char *const port_atom = ATOM_STR("\x4", "port")

static const char *const rcvbuf_atom = ATOM_STR("\x6", "rcvbuf")

static const char *const reuseaddr_atom = ATOM_STR("\x9", "reuseaddr")

static const char *const type_atom = ATOM_STR("\x4", "type")

static const AtomStringIntPair otp_socket_shutdown_direction_table [] = {{ATOM_STR("\x4", "read"), OtpSocketReadShutdownDirection },{ATOM_STR("\x5", "write"), OtpSocketWriteShutdownDirection },{ATOM_STR("\xA", "read_write"), OtpSocketReadWriteShutdownDirection },}

static const AtomStringIntPair otp_socket_setopt_level_table [] = {{ATOM_STR("\x6", "socket"), OtpSocketSetoptLevelSocket },{ATOM_STR("\x3", "otp"), OtpSocketSetoptLevelOTP },}

static ErlNifResourceType *socket_resource_type

static const ErlNifResourceTypeInit SocketResourceTypeInit = {.members = 3, .dtor = socket_dtor, .stop = NULL, .down = socket_down,}

static const struct Nif socket_open_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_open}

static const struct Nif socket_close_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_close}

static const struct Nif socket_select_stop_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_select_stop}

static const struct Nif socket_getopt_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_getopt}

static const struct Nif socket_setopt_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_setopt}

static const struct Nif socket_bind_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_bind}

static const struct Nif socket_listen_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_listen}

static const struct Nif socket_sockname_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_sockname}

static const struct Nif socket_peername_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_peername}

static const struct Nif socket_select_read_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_select_read}

static const struct Nif socket_accept_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_accept}

static const struct Nif socket_recv_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_recv}

static const struct Nif socket_recvfrom_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_recvfrom}

static const struct Nif socket_send_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_send}

static const struct Nif socket_sendto_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_sendto}

static const struct Nif socket_connect_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_connect}

static const struct Nif socket_shutdown_nif = {.base.type = NIFFunctionType, .nif_ptr = nif_socket_shutdown}

struct TCPAcceptedItem

Collaboration diagram for TCPAcceptedItem:

Public Members

struct ListHead list_head

struct tcp_pcb *newpcb

struct TCPReceivedItem

Collaboration diagram for TCPReceivedItem:

Public Members

struct ListHead list_head

struct pbuf *buf

err_t err

struct UDPReceivedItem

Collaboration diagram for UDPReceivedItem:

Public Members

struct ListHead list_head

struct pbuf *buf

uint32_t addr

uint16_t port

struct SocketResource

Collaboration diagram for SocketResource:

Public Members

enum SocketState socket_state

struct tcp_pcb *tcp_pcb

struct udp_pcb *udp_pcb

union SocketResource.[anonymous] [anonymous]

uint64_t ref_ticks

int32_t selecting_process_id

ErlNifMonitor selecting_process_monitor

bool linger_on

int linger_sec

size_t pos

struct ListHead received_list

size_t buf_size

RWLock *socket_lock