It contains the following probe points:
</para>
!Itapset/socket.stp
+ </chapter>
+ <chapter id="snmp.stp">
+ <title>SNMP Information Tapset</title>
+ <para>
+ This family of probe points is used to probe socket activities to
+ provide SNMP type information. It contains the following functions
+ and probe points:
+ </para>
+!Itapset/ipmib.stp
+!Itapset/tcpmib.stp
+!Itapset/linuxmib.stp
</chapter>
<chapter id="kprocess.stp">
<title>Kernel Process Tapset</title>
// global OutBcastPkts
/**
- * sfunction ipmib_remote_addr - Get the remote ip address.
- *
- * Returns the remote ip address from an sk_buff.
- * @skb: Pointer to a struct sk_buff.
+ * sfunction ipmib_remote_addr - Get the remote ip address
+ * @skb: pointer to a struct sk_buff
+ * @SourceIsLocal: flag to indicate whether local operation
*
+ * Returns the remote ip address from @skb.
*/
function ipmib_remote_addr:long (skb:long, SourceIsLocal:long)
{
}
/**
- * sfunction ipmib_local_addr - Get the local ip address.
- *
- * Returns the local ip address from an sk_buff.
- * @skb: Pointer to a struct sk_buff.
+ * sfunction ipmib_local_addr - Get the local ip address
+ * @skb: pointer to a struct sk_buff
+ * @SourceIsLocal: flag to indicate whether local operation
*
+ * Returns the local ip address @skb.
*/
function ipmib_local_addr:long (skb:long, SourceIsLocal:long)
{
}
/**
- * sfunction ipmib_tcp_remote_port - Get the remote tcp port.
- *
- * Returns the remote tcp port from an sk_buff.
- * @skb: Pointer to a struct sk_buff.
+ * sfunction ipmib_tcp_remote_port - Get the remote tcp port
+ * @skb: pointer to a struct sk_buff
+ * @SourceIsLocal: flag to indicate whether local operation
*
+ * Returns the remote tcp port from @skb.
*/
function ipmib_tcp_remote_port:long (skb:long, SourceIsLocal:long)
{
}
/**
- * sfunction ipmib_tcp_local_port - Get the local tcp port.
- *
- * Returns the local tcp port from an sk_buff.
- * @skb: Pointer to a struct sk_buff.
+ * sfunction ipmib_tcp_local_port - Get the local tcp port
+ * @skb: pointer to a struct sk_buff
+ * @SourceIsLocal: flag to indicate whether local operation
*
+ * Returns the local tcp port from @skb.
*/
function ipmib_tcp_local_port:long (skb:long, SourceIsLocal:long)
{
/**
* sfunction ipmib_get_proto - Get the protocol value
+ * @skb: pointer to a struct sk_buff
*
- * Returns the protocol value from ip header.
- * @skb: Pointer to a struct sk_buff.
- *
+ * Returns the protocol value from @skb.
*/
function ipmib_get_proto:long (skb:long)
{
%}
/**
- * probe ipmib.InReceives - Count an arriving packet.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InReceives
- * MIB: IPSTATS_MIB_INRECEIVES
- *
+ * probe ipmib.InReceives - Count an arriving packet
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @InReceives (equivalent to SNMP's MIB
+ * IPSTATS_MIB_INRECEIVES)
*/
probe ipmib.InReceives=kernel.function("ip_rcv")
{
}
/**
- * probe ipmib.InNoRoutes - Count an arriving packet with no matching socket.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InNoRoutes
- * MIB: IPSTATS_MIB_INNOROUTES
- *
+ * probe ipmib.InNoRoutes - Count an arriving packet with no matching socket
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @InNoRoutes (equivalent to SNMP's MIB
+ * IPSTATS_MIB_INNOROUTES)
*/
probe ipmib.InNoRoutes=kernel.function("ip_route_input_common").return!,
kernel.function("ip_route_input").return
}
/**
- * probe ipmib.InAddrErrors - Count arriving packets with an incorrect address.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InAddrErrors
- * MIB: IPSTATS_MIB_INADDRERRORS
- *
+ * probe ipmib.InAddrErrors - Count arriving packets with an incorrect address
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @InAddrErrors (equivalent to SNMP's MIB
+ * IPSTATS_MIB_INADDRERRORS)
*/
probe ipmib.InAddrErrors=kernel.function("ip_route_input_common").return!,
kernel.function("ip_route_input").return
}
/**
- * probe ipmib.InUnknownProtos - Count arriving packets with an unbound proto.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InUnknownProtos
- * MIB: IPSTATS_MIB_INUNKNOWNPROTOS
- *
+ * probe ipmib.InUnknownProtos - Count arriving packets with an unbound proto
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @InUnknownProtos (equivalent to SNMP's MIB
+ * IPSTATS_MIB_INUNKNOWNPROTOS)
*/
-
/* icmp_send() is called by ip_local_deliver_finish() */
probe ipmib.InUnknownProtos=kernel.function("icmp_send")
{
}
/**
- * probe ipmib.InDiscards - Count discarded inbound packets.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InDiscards
- * MIB: STATS_MIB_INDISCARDS
- *
+ * probe ipmib.InDiscards - Count discarded inbound packets
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @InDiscards (equivalent to SNMP's MIB
+ * STATS_MIB_INDISCARDS)
*/
/*
}
/**
- * probe ipmib.ForwDatagrams
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ForwDatagrams
- * MIB: IPSTATS_MIB_OUTFORWDATAGRAMS
- *
+ * probe ipmib.ForwDatagrams - Count forwarded packet
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ForwDatagrams (equivalent to SNMP's MIB
+ * IPSTATS_MIB_OUTFORWDATAGRAMS)
*/
%( kernel_v >= "2.6.24" %?
probe ipmib.ForwDatagrams=kernel.function("ip_forward_finish")
%)
/**
- * probe ipmib.OutRequests - Count a request to send a packet.
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: OutRequests
- * MIB: IPSTATS_MIB_OUTREQUESTS
- *
+ * probe ipmib.OutRequests - Count a request to send a packet
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @OutRequests (equivalent to SNMP's MIB
+ * IPSTATS_MIB_OUTREQUESTS)
*/
probe ipmib.OutRequests=kernel.function("ip_output"),
kernel.function("ip_mc_output")
}
/**
- * probe ipmib.ReasmTimeout
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ReasmTimeout
- * MIB: IPSTATS_MIB_REASMTIMEOUT
- *
+ * probe ipmib.ReasmTimeout - Count Reassembly Timeouts
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ReasmTimeout (equivalent to SNMP's MIB
+ * IPSTATS_MIB_REASMTIMEOUT)
*/
probe ipmib.ReasmTimeout=kernel.function("icmp_send")
{
}
/**
- * probe ipmib.ReasmReqds
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ReasmReqds
- * MIB: IPSTATS_MIB_REASMREQDS
- *
+ * probe ipmib.ReasmReqds - Count number of packet fragments reassembly requests
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ReasmReqds (equivalent to SNMP's MIB
+ * IPSTATS_MIB_REASMREQDS)
*/
probe ipmib.ReasmReqds=kernel.function("ip_defrag")
{
}
/**
- * probe ipmib.FragOKs
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: FragOKs
- * MIB: IPSTATS_MIB_FRAGOKS
- *
+ * probe ipmib.FragOKs - Count datagram fragmented successfully
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @FragOKs (equivalent to SNMP's MIB
+ * IPSTATS_MIB_FRAGOKS)
*/
probe ipmib.FragOKs=kernel.function("ip_fragment").return
{
}
/**
- * probe ipmib.FragFails
- * @skb: Pointer to the struct sk_buff being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: FragFails
- * MIB: IPSTATS_MIB_FRAGFAILS
- *
+ * probe ipmib.FragFails - Count datagram fragmented unsuccessfully
+ * @skb: pointer to the struct sk_buff being acted on
+ * @op: Value to be added to the counter (default value of 1)
+ *
+ * The packet pointed to by @skb is filtered by the function
+ * ipmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @FragFails (equivalent to SNMP's MIB
+ * IPSTATS_MIB_FRAGFAILS)
*/
probe ipmib.FragFails=kernel.function("ip_fragment").return
{
global TCPMemoryPressures /* LINUX_MIB_TCPMEMORYPRESSURES */
/**
- * probe linuxmib.DelayedACKs - Count of delayed acks.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: DelayedACKs
- * MIB: LINUX_MIB_DELAYEDACKS
+ * probe linuxmib.DelayedACKs - Count of delayed acks
+ * @sk: Pointer to the struct sock being acted on
+ * @op: Value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * linuxmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @DelayedACKs (equivalent to SNMP's MIB
+ * LINUX_MIB_DELAYEDACKS)
*/
global indelack_timer
probe linuxmib.DelayedACKs = _linuxmib.DelayedACKs.* {}
/**
* probe linuxmib.ListenOverflows - Count of times a listen queue overflowed
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ListenOverflows
- * MIB: LINUX_MIB_LISTENOVERFLOWS
+ * @sk: Pointer to the struct sock being acted on
+ * @op: Value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * linuxmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ListenOverflows (equivalent to SNMP's MIB
+ * LINUX_MIB_LISTENOVERFLOWS)
*/
probe linuxmib.ListenOverflows=kernel.function("tcp_v4_syn_recv_sock").return
{
}
/**
- * probe linuxmib.ListenDrops - Count of times conn request that were dropped.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ListenDrops
- * MIB: LINUX_MIB_LISTENDROPS
+ * probe linuxmib.ListenDrops - Count of times conn request that were dropped
+ * @sk: Pointer to the struct sock being acted on
+ * @op: Value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * linuxmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ListenDrops (equivalent to SNMP's MIB
+ * LINUX_MIB_LISTENDROPS)
*/
probe linuxmib.ListenDrops=kernel.function("tcp_v4_syn_recv_sock").return
{
}
/**
- * probe linuxmib.TCPMemoryPressures - Count of times memory pressure was used.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: TCPMemoryPressures
- * MIB: LINUX_MIB_TCPMEMORYPRESSURES
+ * probe linuxmib.TCPMemoryPressures - Count of times memory pressure was used
+ * @sk: Pointer to the struct sock being acted on
+ * @op: Value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * linuxmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @TCPMemoryPressures (equivalent to SNMP's MIB
+ * LINUX_MIB_TCPMEMORYPRESSURES)
*/
probe linuxmib.TCPMemoryPressures=kernel.function("tcp_enter_memory_pressure")
{
global RetransSegs
/**
- * sfunction tcpmib_get_state - Get a socket's state.
+ * sfunction tcpmib_get_state - Get a socket's state
+ * @sk: pointer to a struct sock
*
* Returns the sk_state from a struct sock.
- * @sk: Pointer to a struct sock.
- *
*/
function tcpmib_get_state:long (sk:long)
{
}
/**
- * sfunction tcpmib_local_addr - Get the source address.
+ * sfunction tcpmib_local_addr - Get the source address
+ * @sk: pointer to a struct inet_sock
*
* Returns the saddr from a struct inet_sock in host order.
- * @sk: Pointer to a struct inet_sock.
- *
*/
function tcpmib_local_addr:long(sk:long)
{
}
/**
- * sfunction tcpmib_remote_addr - Get the remote address.
+ * sfunction tcpmib_remote_addr - Get the remote address
+ * @sk: pointer to a struct inet_sock
*
* Returns the daddr from a struct inet_sock in host order.
- * @sk: Pointer to a struct inet_sock.
- *
*/
function tcpmib_remote_addr:long(sk:long)
{
}
/**
- * sfunction tcpmib_local_port - Get the local port.
+ * sfunction tcpmib_local_port - Get the local port
+ * @sk: pointer to a struct inet_sock
*
* Returns the sport from a struct inet_sock in host order.
- * @sk: Pointer to a struct inet_sock.
- *
*/
function tcpmib_local_port:long(sk:long)
{
}
/**
- * sfunction tcpmib_remote_port - Get the remote port.
+ * sfunction tcpmib_remote_port - Get the remote port
+ * @sk: pointer to a struct inet_sock
*
* Returns the dport from a struct inet_sock in host order.
- * @sk: Pointer to a struct inet_sock.
- *
*/
function tcpmib_remote_port:long(sk:long)
{
}
/**
- * probe tcpmib.ActiveOpens - Count an active opening of a socket.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: ActiveOpens
- * MIB: TCP_MIB_ACTIVEOPENS
+ * probe tcpmib.ActiveOpens - Count an active opening of a socket
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @ActiveOpens (equivalent to SNMP's MIB
+ * TCP_MIB_ACTIVEOPENS)
*/
probe
tcpmib.ActiveOpens = kernel.function("tcp_connect").return
}
/**
- * probe tcpmib.AttemptFails - Count a failed attempt to open a socket.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: AttemptFails
- * MIB: TCP_MIB_ATTEMPTFAILS
+ * probe tcpmib.AttemptFails - Count a failed attempt to open a socket
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @AttemptFails (equivalent to SNMP's MIB
+ * TCP_MIB_ATTEMPTFAILS)
*/
probe
tcpmib.AttemptFails = kernel.function("tcp_done").call ?
}
/**
- * probe tcpmib.CurrEstab - Update the count of open sockets.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: CurrEstab
- * MIB: TCP_MIB_CURRESTAB
+ * probe tcpmib.CurrEstab - Update the count of open sockets
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @CurrEstab (equivalent to SNMP's MIB
+ * TCP_MIB_CURRESTAB)
*/
probe
tcpmib.CurrEstab = kernel.function("tcp_set_state").call ?
}
/**
- * probe tcpmib.EstabResets - Count the reset of a socket.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: EstabResets
- * MIB: TCP_MIB_ESTABRESETS
+ * probe tcpmib.EstabResets - Count the reset of a socket
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @EstabResets (equivalent to SNMP's MIB
+ * TCP_MIB_ESTABRESETS)
*/
probe
tcpmib.EstabResets = kernel.function("tcp_set_state").call ?
}
/**
- * probe tcpmib.InSegs - Count an incomming tcp segment.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: InSegs
- * MIB: TCP_MIB_INSEGS
+ * probe tcpmib.InSegs - Count an incomming tcp segment
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key() (or ipmib_filter_key() for tcp v4).
+ * If the packet passes the filter is is
+ * counted in the global @InSegs (equivalent to SNMP's MIB
+ * TCP_MIB_INSEGS)
*/
probe
tcpmib.InSegs =
}
/**
- * probe tcpmib.OutRsts - Count the sending of a reset packet.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: OutRsts
- * MIB: TCP_MIB_OUTRSTS
+ * probe tcpmib.OutRsts - Count the sending of a reset packet
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @OutRsts (equivalent to SNMP's MIB
+ * TCP_MIB_OUTRSTS)
*/
probe
tcpmib.OutRsts = __tcpmib.OutRsts.*
}
/**
- * probe tcpmib.OutSegs - Count the sending of a TCP segment.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: OutSegs
- * MIB: TCP_MIB_OUTSEGS
+ * probe tcpmib.OutSegs - Count the sending of a TCP segment
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @OutSegs (equivalent to SNMP's MIB
+ * TCP_MIB_OUTSEGS)
*/
probe
tcpmib.OutSegs=kernel.function("ip_queue_xmit").return
}
/**
- * probe tcpmib.PassiveOpens - Count the passive creation of a socket.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: PassiveOpens
- * MIB: TCP_MIB_PASSIVEOPENS
+ * probe tcpmib.PassiveOpens - Count the passive creation of a socket
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @PassiveOpens (equivalent to SNMP's MIB
+ * TCP_MIB_PASSIVEOPENS)
*/
probe
tcpmib.PassiveOpens=kernel.function("tcp_v4_syn_recv_sock").return
}
/**
- * probe tcpmib.RetransSegs - Count the retransmission of a TCP segment.
- * @sk: Pointer to the struct sock being acted on.
- * @op: Value to be added to the counter (Operation).
- *
- * Counter Name: RetransSegs
- * MIB: TCP_MIB_RETRANSSEGS
+ * probe tcpmib.RetransSegs - Count the retransmission of a TCP segment
+ * @sk: pointer to the struct sock being acted on
+ * @op: value to be added to the counter (default value of 1)
*
+ * The packet pointed to by @skb is filtered by the function
+ * tcpmib_filter_key(). If the packet passes the filter is is
+ * counted in the global @RetransSegs (equivalent to SNMP's MIB
+ * TCP_MIB_RETRANSSEGS)
*/
probe
tcpmib.RetransSegs=kernel.function("tcp_retransmit_skb").return
git://sourceware.org / systemtap.git / commitdiff