1TAPSET::SOCKET(3stap) TAPSET::SOCKET(3stap)
2
6 tapset::socket - systemtap socket probe points
7
11 This family of probe points is used to probe socket activities. It
12 contains the following probe points:
13 socket.send
16 Fires at the conclusion of sending a message on a socket. This
18 probe alias includes the socket.sendmsg.return,
19 socket.aio_write.return and socket.writev.return probes (these
20 probes should catch all messages sent on sockets). The argu‐
21 ments supplied at the beginning of the send are cached and made
22 available in this probe.
23 Context:
25 The message sender.
27 Arguments:
29 name
31 Name of this probe.
32 size
34 Size of message sent (in bytes) or error code if success ==
35 0
36 protocol
38 Protocol used on the socket. Use sock_prot_num2str(protocol)
39 to convert to a string.
40 Common values include:
42 0 - IP (Internet Protocol, local interprocess communi‐
43 cations)
44 6 - TCP (Transmission Control Protocol)
45 17 - UDP (User Datagram Protocol)
46 132 - SCTP (Stream Control Transmission Protocol)
47 Refer to /etc/protocols for a complete list of possible
49 values.
50 family
52 Protocol family of the socket (from include/linux/socket.h).
53 Use sock_fam_num2str(family) to convert to a string.
54 Possible values are:
56 0 - UNSPEC (Unspecified)
57 1 - LOCAL (Unix domain/local sockets)
58 2 - INET (Internet Protocol (IP))
59 3 - AX25 (Amateur Radio AX.25)
60 4 - IPX (Novell IPX)
61 5 - APPLETALK (AppleTalk DDP)
62 6 - NETROM (Amateur Radio NET/ROM)
63 7 - BRIDGE (Multiprotocol bridge)
64 8 - ATMPVC (ATM PVCs)
65 9 - X25 (X.25)
66 10 - INET6 (IP version 6)
67 11 - ROSE (Amateur Radio X.25 PLP)
68 12 - DECNET (Reserved for DECnet project)
69 13 - NETBEUI (Reserved for 802.2LLC project)
70 14 - SECURITY (Security callback pseudo AF)
71 15 - KEY (key management API)
72 16 - NETLINK (Netlink protocol)
73 17 - PACKET (Packet family)
74 18 - ASH (Ash)
75 19 - ECONET (Acorn Econet)
76 20 - ATMSVC (ATM SVCs)
77 22 - SNA (Linux SNA Project)
78 23 - IRDA (IRDA sockets)
79 24 - PPP0X (PPPoX sockets)
80 25 - WANPIPE (Wanpipe API Sockets)
81 26 - LLC (Linux LLC)
82 30 - TIPC (TIPC sockets)
83 31 - BLUETOOTH (Bluetooth sockets)
84 state
86 State of the socket. Use sock_state_num2str(state) to con‐
87 vert
88 to a string.
89 Possible values are:
91 0 - FREE (not allocated)
92 1 - UNCONNECTED (unconnected to any socket)
93 2 - CONNECTING (in the process of connecting)
94 3 - CONNECTED (connected to a socket)
95 4 - DISCONNECTING (in the process of disconnecting)
96 flags
98 Socket flags. Use sock_flags_num2str(flags) to convert
99 to a string.
100 Possible values are:
102 0 - ASYNC_NOSPACE
103 1 - ASYNC_WAITDATA
104 2 - NOSPACE
105 3 - PASSCRED
106 4 - PASSSEC
107 type
109 Socket type. Use sock_type_num2str(type) to convert
110 to a string.
111 Possible values are:
113 1 - STREAM (stream connection socket)
114 2 - DGRAM (datagram connectionless socket)
115 3 - RAW (raw socket)
116 4 - RDM (reliably-deliverd message)
117 5 - SEQPACKET (sequential packet socket)
118 6 - DCCP (datagram congestion control protocol socket)
119 10 - PACKET (Linux-specific way of getting packets at
120 device level)
121 success
123 Was send successful?
124 Possible values are:
126 1 - Yes
127 0 - No
128 socket.receive
131 Fires at the conclusion of receiving a message on a socket.
133 This probe alias includes the socket.recvmsg.return,
134 socket.aio_read.return and socket.readv.return probes (these
135 probes should catch all messages received on sockets). The
136 arguments supplied at the beginning of the receive are cached
137 and made available in this probe.
138 Context:
140 The message receiver.
142 Arguments:
144 Same as socket.send.
146 socket.sendmsg
149 Fires when the sock_sendmsg() kernel function is entered.
151 Context:
153 The message sender.
155 Arguments:
157 Same as socket.send, with the following exceptions:
159 size
161 Size of message being sent (in bytes).
163 success
165 Not used.
167 socket.sendmsg.return
170 Fires when the sock_sendmsg() kernel function returns.
172 Context:
174 The message sender.
176 Arguments:
178 Same as socket.send
180 socket.recvmsg
183 Fires when the sock_recvmsg() kernel function is entered.
185 Context:
187 The message receiver.
189 Arguments:
191 Same as socket.receive, with the following exceptions:
193 size
195 Size of message being received (in bytes).
197 success
199 Not used.
201 socket.recvmsg.return
204 Fires when the sock_recvmsg() kernel function returns.
206 Context:
208 The message receiver.
210 Arguments:
212 Same as socket.receive.
214 socket.aio_write
222 Fires when the sock_aio_write() kernel function is entered.
224 Context:
226 The message sender.
228 Arguments:
230 Same as socket.send, with the following exceptions:
232 size
234 Size of message being sent (in bytes).
236 success
238 Not used.
240 socket.aio_write.return
243 Fires when the sock_aio_write() kernel function returns.
245 Context:
247 The message sender.
249 Arguments:
251 Same as socket.send.
253 socket.aio_read
256 Fires when the sock_aio_read() kernel function is entered.
258 Context:
260 The message receiver.
262 Arguments:
264 Same as socket.receive, with the following exceptions:
266 size
268 Size of message being received (in bytes).
270 success
272 Not used.
274 socket.aio_read.return
277 Fires when the sock_aio_read() kernel function returns.
279 Context:
281 The message receiver.
283 Arguments:
285 Same as socket.receive.
287 socket.writev
290 Fires when the sock_writev() kernel function is entered.
292 Context:
294 The message sender.
296 Arguments:
298 Same as socket.send, with the following exceptions:
300 size
302 Size of message being sent (in bytes).
304 success
306 Not used.
308 socket.writev.return
311 Fires when the sock_writev() kernel function returns.
313 Context:
315 The message sender.
317 Arguments:
319 Same as socket.send.
321 socket.readv
324 Fires when the sock_readv() kernel function is entered.
326 Context:
328 The message receiver.
330 Arguments:
332 Same as socket.receive, with the following exceptions:
334 size
336 Size of message being received (in bytes).
338 success
340 Not used.
342 socket.readv.return
345 Fires when the sock_readv() kernel function returns.
347 Context:
349 The message receiver.
351 Arguments:
353 Same as socket.receive.
355 socket.create
358 Fires at the beginning of creating a socket.
360 Context:
362 The socket creator.
364 Arguments:
366 name
368 protocol
369 family
370 type
371 See socket.send.
372 requester
374 Requester type.
375 Possible values are:
377 1 - kernel
378 0 - user
379 socket.create.return
382 Fires at the end of creating a socket.
384 Context:
386 The socket creator.
388 Arguments:
390 Same as socket.create, plus:
392 err
394 Return code.
395 Possible values are:
397 0 - success
398 < 0 - error
399 success
401 Was the socket created successfully?
402 Possible values are:
404 1 - Yes
405 0 - No
406 socket.close
408 Fires at the beginning of closing a socket.
410 Context:
412 The socket closer.
414 Arguments:
416 name
418 protocol
419 family
420 state
421 flags
422 type
423 See socket.send.
424 socket.close.return
427 Fires at the end of closing a socket.
429 Context:
431 The socket closer.
433 Arguments:
435 name
437 Name of this probe.
438
441 stap(1), stapprobes(3stap), stapfuncs(3stap)
442IBM TAPSET::SOCKET(3stap)