Chapter 12. Socket Tapset

probe::socket.send — Message sent on a socket.
probe::socket.receive — Message received on a socket.
probe::socket.sendmsg — Message is currently being sent on a socket.
probe::socket.sendmsg.return — Return from socket.sendmsg.
probe::socket.recvmsg — Message being received on socket
probe::socket.recvmsg.return — Return from Message being received on socket
probe::socket.aio_write — Message send via sock_aio_write
probe::socket.aio_write.return — Conclusion of message send via sock_aio_write
probe::socket.aio_read — Receiving message via sock_aio_read
probe::socket.aio_read.return — Conclusion of message received via sock_aio_read
probe::socket.writev — Message sent via socket_writev
probe::socket.writev.return — Conclusion of message sent via socket_writev
probe::socket.readv — Receiving a message via sock_readv
probe::socket.readv.return — Conclusion of receiving a message via sock_readv
probe::socket.create — Creation of a socket
probe::socket.create.return — Return from Creation of a socket
probe::socket.close — Close a socket
probe::socket.close.return — Return from closing a socket
function::sock_prot_num2str — Given a protocol number, return a string representation.
function::sock_prot_str2num — Given a protocol name (string), return the corresponding protocol number.
function::sock_fam_num2str — Given a protocol family number, return a string representation.
function::sock_fam_str2num — Given a protocol family name (string), return the corresponding
function::sock_state_num2str — Given a socket state number, return a string representation.
function::sock_state_str2num — Given a socket state string, return the corresponding state number.

This family of probe points is used to probe socket activities. It contains the following probe points:

Name

probe::socket.send — Message sent on a socket.

Synopsis

socket.send

Values

success: Was send successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message sent (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message sender

Name

probe::socket.receive — Message received on a socket.

Synopsis

socket.receive

Values

success: Was send successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message received (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver

Name

probe::socket.sendmsg — Message is currently being sent on a socket.

Synopsis

socket.sendmsg

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message sender

Description

Fires at the beginning of sending a message on a socket via the sock_sendmsg function

Name

probe::socket.sendmsg.return — Return from socket.sendmsg.

Synopsis

socket.sendmsg.return

Values

success: Was send successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message sent (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message sender.

Description

Fires at the conclusion of sending a message on a socket via the sock_sendmsg function

Name

probe::socket.recvmsg — Message being received on socket

Synopsis

socket.recvmsg

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the beginning of receiving a message on a socket via the sock_recvmsg function

Name

probe::socket.recvmsg.return — Return from Message being received on socket

Synopsis

socket.recvmsg.return

Values

success: Was receive successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message received (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the conclusion of receiving a message on a socket via the sock_recvmsg function.

Name

probe::socket.aio_write — Message send via sock_aio_write

Synopsis

socket.aio_write

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message sender

Description

Fires at the beginning of sending a message on a socket via the sock_aio_write function

Name

probe::socket.aio_write.return — Conclusion of message send via sock_aio_write

Synopsis

socket.aio_write.return

Values

success: Was receive successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message received (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the conclusion of sending a message on a socket via the sock_aio_write function

Name

probe::socket.aio_read — Receiving message via sock_aio_read

Synopsis

socket.aio_read

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message sender

Description

Fires at the beginning of receiving a message on a socket via the sock_aio_read function

Name

probe::socket.aio_read.return — Conclusion of message received via sock_aio_read

Synopsis

socket.aio_read.return

Values

success: Was receive successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message received (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the conclusion of receiving a message on a socket via the sock_aio_read function

Name

probe::socket.writev — Message sent via socket_writev

Synopsis

socket.writev

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message sender

Description

Fires at the beginning of sending a message on a socket via the sock_writev function

Name

probe::socket.writev.return — Conclusion of message sent via socket_writev

Synopsis

socket.writev.return

Values

success: Was send successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message sent (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the conclusion of sending a message on a socket via the sock_writev function

Name

probe::socket.readv — Receiving a message via sock_readv

Synopsis

socket.readv

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Message size in bytes
type: Socket type value
family: Protocol family value

Context

The message sender

Description

Fires at the beginning of receiving a message on a socket via the sock_readv function

Name

probe::socket.readv.return — Conclusion of receiving a message via sock_readv

Synopsis

socket.readv.return

Values

success: Was receive successful? (1 = yes, 0 = no)
protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
size: Size of message received (in bytes) or error code if success = 0
type: Socket type value
family: Protocol family value

Context

The message receiver.

Description

Fires at the conclusion of receiving a message on a socket via the sock_readv function

Name

probe::socket.create — Creation of a socket

Synopsis

socket.create

Values

protocol: Protocol value
name: Name of this probe
requester: Requested by user process or the kernel (1 = kernel, 0 = user)
type: Socket type value
family: Protocol family value

Context

The requester (see requester variable)

Description

Fires at the beginning of creating a socket.

Name

probe::socket.create.return — Return from Creation of a socket

Synopsis

socket.create.return

Values

success: Was socket creation successful? (1 = yes, 0 = no)
protocol: Protocol value
err: Error code if success == 0
name: Name of this probe
requester: Requested by user process or the kernel (1 = kernel, 0 = user)
type: Socket type value
family: Protocol family value

Context

The requester (user process or kernel)

Description

Fires at the conclusion of creating a socket.

Name

probe::socket.close — Close a socket

Synopsis

socket.close

Values

protocol: Protocol value
flags: Socket flags value
name: Name of this probe
state: Socket state value
type: Socket type value
family: Protocol family value

Context

The requester (user process or kernel)

Description

Fires at the beginning of closing a socket.

Name

probe::socket.close.return — Return from closing a socket

Synopsis

socket.close.return

Values

name: Name of this probe

Context

The requester (user process or kernel)

Description

Fires at the conclusion of closing a socket.

Name

function::sock_prot_num2str — Given a protocol number, return a string representation.

Synopsis

function sock_prot_num2str:string(proto:long)

Arguments

proto: The protocol number.

Name

function::sock_prot_str2num — Given a protocol name (string), return the corresponding protocol number.

Synopsis

function sock_prot_str2num:long(proto:string)

Arguments

proto: The protocol name.

Name

function::sock_fam_num2str — Given a protocol family number, return a string representation.

Synopsis

function sock_fam_num2str:string(family:long)

Arguments

family: The family number.

Name

function::sock_fam_str2num — Given a protocol family name (string), return the corresponding

Synopsis

function sock_fam_str2num:long(family:string)

Arguments

family: The family name.

Description

protocol family number.

Name

function::sock_state_num2str — Given a socket state number, return a string representation.

Synopsis

function sock_state_num2str:string(state:long)

Arguments

state: The state number.

Name

function::sock_state_str2num — Given a socket state string, return the corresponding state number.

Synopsis

function sock_state_str2num:long(state:string)

Arguments

state: The state name.