proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-05-29 07:35:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Format highlighted syntax properly for Systemtap examples

Browse Source 
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
This commit is contained in:
Donatas Abraitis 2021-02-23 14:31:41 +02:00
parent 68009c04f3
commit ccc1af3998
1 changed files with 54 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
doc/developer/tracing.rst
View File

@ -175,73 +175,74 @@ the ``lttng_ust_tracelog:*`` event class.
To see available SystemTap USDT probes, run:: To see available SystemTap USDT probes, run::
stap -L 'process("/usr/lib/frr/bgpd").mark("*")' stap -L 'process("/usr/lib/frr/bgpd").mark("*")'
Example:: Example::
root@host ~> stap -L 'process("/usr/lib/frr/bgpd").mark("*")'
process("/usr/lib/frr/bgpd").mark("capability_process") $arg1:long $arg2:long root@host ~> stap -L 'process("/usr/lib/frr/bgpd").mark("*")'
process("/usr/lib/frr/bgpd").mark("input_filter") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long process("/usr/lib/frr/bgpd").mark("capability_process") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("keepalive_process") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("input_filter") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long
process("/usr/lib/frr/bgpd").mark("notification_process") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("keepalive_process") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("open_process") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("notification_process") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("output_filter") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long process("/usr/lib/frr/bgpd").mark("open_process") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("packet_read") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("output_filter") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long
process("/usr/lib/frr/bgpd").mark("process_update") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long $arg6:long process("/usr/lib/frr/bgpd").mark("packet_read") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("refresh_process") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("process_update") $arg1:long $arg2:long $arg3:long $arg4:long $arg5:long $arg6:long
process("/usr/lib/frr/bgpd").mark("update_process") $arg1:long $arg2:long process("/usr/lib/frr/bgpd").mark("refresh_process") $arg1:long $arg2:long
process("/usr/lib/frr/bgpd").mark("update_process") $arg1:long $arg2:long
When using SystemTap, you can also easily attach to an existing function:: When using SystemTap, you can also easily attach to an existing function::
stap -L 'process("/usr/lib/frr/bgpd").function("bgp_update_receive")' stap -L 'process("/usr/lib/frr/bgpd").function("bgp_update_receive")'
Example: Example::
root@host ~> stap -L 'process("/usr/lib/frr/bgpd").function("bgp_update_receive")' root@host ~> stap -L 'process("/usr/lib/frr/bgpd").function("bgp_update_receive")'
process("/usr/lib/frr/bgpd").function("bgp_update_receive@bgpd/bgp_packet.c:1531") $peer:struct peer* $size:bgp_size_t $attr:struct attr $restart:_Bool $nlris:struct bgp_nlri[] $__func__:char const[] const process("/usr/lib/frr/bgpd").function("bgp_update_receive@bgpd/bgp_packet.c:1531") $peer:struct peer* $size:bgp_size_t $attr:struct attr $restart:_Bool $nlris:struct bgp_nlri[] $__func__:char const[] const
Complete ``bgp.stp`` example using SystemTap to show BGP peer, prefix and aspath Complete ``bgp.stp`` example using SystemTap to show BGP peer, prefix and aspath
using ``process_update`` USDT:: using ``process_update`` USDT::
global pkt_size; global pkt_size;
probe begin probe begin
{ {
ansi_clear_screen(); ansi_clear_screen();
println("Starting..."); println("Starting...");
} }
probe process("/usr/lib/frr/bgpd").function("bgp_update_receive") probe process("/usr/lib/frr/bgpd").function("bgp_update_receive")
{ {
pkt_size <<< $size; pkt_size <<< $size;
} }
probe process("/usr/lib/frr/bgpd").mark("process_update") probe process("/usr/lib/frr/bgpd").mark("process_update")
{ {
aspath = @cast($arg6, "attr")->aspath; aspath = @cast($arg6, "attr")->aspath;
printf("> %s via %s (%s)\n", printf("> %s via %s (%s)\n",
user_string($arg2), user_string($arg2),
user_string(@cast($arg1, "peer")->host), user_string(@cast($arg1, "peer")->host),
user_string(@cast(aspath, "aspath")->str)); user_string(@cast(aspath, "aspath")->str));
} }
probe end probe end
{ {
if (@count(pkt_size)) if (@count(pkt_size))
print(@hist_linear(pkt_size, 0, 20, 2)); print(@hist_linear(pkt_size, 0, 20, 2));
} }
Output:: Output::
Starting... Starting...
> 192.168.0.0/24 via 192.168.0.1 (65534) > 192.168.0.0/24 via 192.168.0.1 (65534)
> 192.168.100.1/32 via 192.168.0.1 (65534) > 192.168.100.1/32 via 192.168.0.1 (65534)
> 172.16.16.1/32 via 192.168.0.1 (65534 65030) > 172.16.16.1/32 via 192.168.0.1 (65534 65030)
^Cvalue |-------------------------------------------------- count ^Cvalue |-------------------------------------------------- count
0 | 0 0 | 0
2 | 0 2 | 0
4 |@ 1 4 |@ 1
6 | 0 6 | 0
8 | 0 8 | 0
~ ~
18 | 0 18 | 0
20 | 0 20 | 0
>20 |@@@@@ 5 >20 |@@@@@ 5
Concepts Concepts