Socket Instrumentation

Collaboration diagram for Socket Instrumentation:

Classes
struct	st_mysql_socket

Macros
#define	mysql_socket_register(P1, P2, P3)   do {} while (0)
#define	MYSQL_INVALID_SOCKET   mysql_socket_invalid()
#define	MYSQL_SOCKET_WAIT_VARIABLES(LOCKER, STATE)
#define	MYSQL_START_SOCKET_WAIT(LOCKER, STATE, SOCKET, OP, COUNT)   do {} while (0)
#define	MYSQL_END_SOCKET_WAIT(LOCKER, COUNT)   do {} while (0)
#define	MYSQL_SOCKET_SET_STATE(SOCKET, STATE)   do {} while (0)
#define	mysql_socket_socket(K, D, T, P)   inline_mysql_socket_socket(D, T, P)
#define	mysql_socket_bind(FD, AP, L)   inline_mysql_socket_bind(FD, AP, L)
#define	mysql_socket_getsockname(FD, AP, LP)   inline_mysql_socket_getsockname(FD, AP, LP)
#define	mysql_socket_connect(FD, AP, L)   inline_mysql_socket_connect(FD, AP, L)
#define	mysql_socket_getpeername(FD, AP, LP)   inline_mysql_socket_getpeername(FD, AP, LP)
#define	mysql_socket_send(FD, B, N, FL)   inline_mysql_socket_send(FD, B, N, FL)
#define	mysql_socket_recv(FD, B, N, FL)   inline_mysql_socket_recv(FD, B, N, FL)
#define	mysql_socket_sendto(FD, B, N, FL, AP, L)   inline_mysql_socket_sendto(FD, B, N, FL, AP, L)
#define	mysql_socket_recvfrom(FD, B, N, FL, AP, LP)   inline_mysql_socket_recvfrom(FD, B, N, FL, AP, LP)
#define	mysql_socket_getsockopt(FD, LV, ON, OP, OL)   inline_mysql_socket_getsockopt(FD, LV, ON, OP, OL)
#define	mysql_socket_setsockopt(FD, LV, ON, OP, OL)   inline_mysql_socket_setsockopt(FD, LV, ON, OP, OL)
#define	mysql_socket_listen(FD, N)   inline_mysql_socket_listen(FD, N)
#define	mysql_socket_accept(K, FD, AP, LP)   inline_mysql_socket_accept(FD, AP, LP)
#define	mysql_socket_close(FD)   inline_mysql_socket_close(FD)
#define	mysql_socket_shutdown(FD, H)   inline_mysql_socket_shutdown(FD, H)

Typedefs
typedef struct st_mysql_socket	MYSQL_SOCKET

Detailed Description

Macro Definition Documentation

#define MYSQL_END_SOCKET_WAIT	(		LOCKER,
			COUNT
	)		do {} while (0)

Instrumentation helper for socket waits. This instrumentation marks the end of a wait event.

Parameters

LOCKER	locker
COUNT	actual bytes written/read, or -1

See Also

MYSQL_START_SOCKET_WAIT.

Definition at line 224 of file mysql_socket.h.

#define MYSQL_INVALID_SOCKET   mysql_socket_invalid()

MYSQL_SOCKET initial value.

Definition at line 88 of file mysql_socket.h.

#define mysql_socket_accept	(		K,
			FD,
			AP,
			LP
	)		inline_mysql_socket_accept(FD, AP, LP)

Accept a connection from any remote host; TCP only. mysql_socket_accept is a replacement for accept.

Parameters

K	PSI_socket_key for this instrumented socket
FD	Instrumented socket descriptor, bound and placed in a listen state
AP	Pointer to sockaddr structure with returned IP address and port of connected host
LP	Pointer to length of valid information in AP

Definition at line 502 of file mysql_socket.h.

#define mysql_socket_bind	(		FD,
			AP,
			L
	)		inline_mysql_socket_bind(FD, AP, L)

Bind a socket to a local port number and IP address mysql_socket_bind is a replacement for bind.

Parameters

FD	Instrumented socket descriptor returned by socket()
AP	Pointer to local port number and IP address in sockaddr structure
L	Length of sockaddr structure

Definition at line 314 of file mysql_socket.h.

#define mysql_socket_close

(

FD

)

inline_mysql_socket_close(FD)

Close a socket and sever any connections. mysql_socket_close is a replacement for close.

Parameters

FD	Instrumented socket descriptor returned by socket() or accept()

Definition at line 516 of file mysql_socket.h.

#define mysql_socket_connect	(		FD,
			AP,
			L
	)		inline_mysql_socket_connect(FD, AP, L)

Establish a connection to a remote host. mysql_socket_connect is a replacement for connect.

Parameters

FD	Instrumented socket descriptor returned by socket()
AP	Pointer to target address in sockaddr structure
L	Length of sockaddr structure

Definition at line 346 of file mysql_socket.h.

#define mysql_socket_getpeername	(		FD,
			AP,
			LP
	)		inline_mysql_socket_getpeername(FD, AP, LP)

Get port number and IP address of remote host that a socket is connected to. mysql_socket_getpeername is a replacement for getpeername.

Parameters

FD	Instrumented socket descriptor returned by socket() or accept()
AP	Pointer to returned address of remote host in sockaddr structure
LP	Pointer to length of sockaddr structure

Definition at line 362 of file mysql_socket.h.

#define mysql_socket_getsockname	(		FD,
			AP,
			LP
	)		inline_mysql_socket_getsockname(FD, AP, LP)

Return port number and IP address of the local host mysql_socket_getsockname is a replacement for getsockname.

Parameters

FD	Instrumented socket descriptor returned by socket()
A	Pointer to returned address of local host in sockaddr structure
L	Pointer to length of sockaddr structure

Definition at line 330 of file mysql_socket.h.

#define mysql_socket_getsockopt	(		FD,
			LV,
			ON,
			OP,
			OL
	)		inline_mysql_socket_getsockopt(FD, LV, ON, OP, OL)

Get a socket option for the specified socket. mysql_socket_getsockopt is a replacement for getsockopt.

Parameters

FD	Instrumented socket descriptor returned by socket()
LV	Protocol level
ON	Option to query
OP	Buffer which will contain the value for the requested option
OL	Pointer to length of OP

Definition at line 452 of file mysql_socket.h.

#define mysql_socket_listen	(		FD,
			N
	)		inline_mysql_socket_listen(FD, N)

Set socket state to listen for an incoming connection. mysql_socket_listen is a replacement for listen.

Parameters

FD	Instrumented socket descriptor, bound and connected
N	Maximum number of pending connections allowed.

Definition at line 485 of file mysql_socket.h.

#define mysql_socket_recv	(		FD,
			B,
			N,
			FL
	)		inline_mysql_socket_recv(FD, B, N, FL)

Receive data from a connected socket. mysql_socket_recv is a replacement for recv.

Parameters

FD	Instrumented socket descriptor returned by socket() or accept()
B	Buffer to receive to
N	Maximum bytes to receive
FL	Control flags

Definition at line 396 of file mysql_socket.h.

#define mysql_socket_recvfrom	(		FD,
			B,
			N,
			FL,
			AP,
			LP
	)		inline_mysql_socket_recvfrom(FD, B, N, FL, AP, LP)

Receive data from a socket and return source address information mysql_socket_recvfrom is a replacement for recvfrom.

Parameters

FD	Instrumented socket descriptor returned by socket()
B	Buffer to receive to
N	Maximum bytes to receive
FL	Control flags
AP	Pointer to source address in sockaddr_storage structure
L	Size of sockaddr_storage structure

Definition at line 434 of file mysql_socket.h.

#define mysql_socket_register	(		P1,
			P2,
			P3
	)		do {} while (0)

Socket registration.

Definition at line 59 of file mysql_socket.h.

#define mysql_socket_send	(		FD,
			B,
			N,
			FL
	)		inline_mysql_socket_send(FD, B, N, FL)

Send data from the buffer, B, to a connected socket. mysql_socket_send is a replacement for send.

Parameters

FD	Instrumented socket descriptor returned by socket() or accept()
B	Buffer to send
N	Number of bytes to send
FL	Control flags

Definition at line 379 of file mysql_socket.h.

#define mysql_socket_sendto	(		FD,
			B,
			N,
			FL,
			AP,
			L
	)		inline_mysql_socket_sendto(FD, B, N, FL, AP, L)

Send data to a socket at the specified address. mysql_socket_sendto is a replacement for sendto.

Parameters

FD	Instrumented socket descriptor returned by socket()
B	Buffer to send
N	Number of bytes to send
FL	Control flags
AP	Pointer to destination sockaddr structure
L	Size of sockaddr structure

Definition at line 415 of file mysql_socket.h.

#define mysql_socket_setsockopt	(		FD,
			LV,
			ON,
			OP,
			OL
	)		inline_mysql_socket_setsockopt(FD, LV, ON, OP, OL)

Set a socket option for the specified socket. mysql_socket_setsockopt is a replacement for setsockopt.

Parameters

FD	Instrumented socket descriptor returned by socket()
LV	Protocol level
ON	Option to modify
OP	Buffer containing the value for the specified option
OL	Pointer to length of OP

Definition at line 470 of file mysql_socket.h.

#define mysql_socket_shutdown	(		FD,
			H
	)		inline_mysql_socket_shutdown(FD, H)

Disable receives and/or sends on a socket. mysql_socket_shutdown is a replacement for shutdown.

Parameters

FD	Instrumented socket descriptor returned by socket() or accept()
H	Specifies which operations to shutdown

Definition at line 531 of file mysql_socket.h.

#define mysql_socket_socket	(		K,
			D,
			T,
			P
	)		inline_mysql_socket_socket(D, T, P)

Create a socket. mysql_socket_socket is a replacement for socket.

Parameters

K	PSI_socket_key for this instrumented socket
D	Socket domain
T	Protocol type
P	Transport protocol

Definition at line 298 of file mysql_socket.h.

#define MYSQL_SOCKET_WAIT_VARIABLES	(		LOCKER,
			STATE
	)

Instrumentation helper for socket waits. This instrumentation declares local variables. Do not use a ';' after this macro

Parameters

LOCKER	locker
STATE	locker state

See Also

MYSQL_START_SOCKET_WAIT.

MYSQL_END_SOCKET_WAIT.

Definition at line 188 of file mysql_socket.h.

#define MYSQL_START_SOCKET_WAIT	(		LOCKER,
			STATE,
			SOCKET,
			OP,
			COUNT
	)		do {} while (0)

Instrumentation helper for socket waits. This instrumentation marks the start of a wait event.

Parameters

LOCKER	locker
STATE	locker state
SOCKET	instrumented socket
OP	The socket operation to be performed
FLAGS	per-socket operation flags.
COUNT	bytes to be written/read

See Also

MYSQL_END_SOCKET_WAIT.

Definition at line 208 of file mysql_socket.h.

Typedef Documentation

typedef struct st_mysql_socket MYSQL_SOCKET

An instrumented socket. MYSQL_SOCKET is a replacement for my_socket.

Definition at line 80 of file mysql_socket.h.