tipc: enable tracepoints in tipc

As for the sake of debugging/tracing, the commit enables tracepoints in
TIPC along with some general trace_events as shown below. It also
defines some 'tipc_*_dump()' functions that allow to dump TIPC object
data whenever needed, that is, for general debug purposes, ie. not just
for the trace_events.

The following trace_events are now available:

- trace_tipc_skb_dump(): allows to trace and dump TIPC msg & skb data,
  e.g. message type, user, droppable, skb truesize, cloned skb, etc.

- trace_tipc_list_dump(): allows to trace and dump any TIPC buffers or
  queues, e.g. TIPC link transmq, socket receive queue, etc.

- trace_tipc_sk_dump(): allows to trace and dump TIPC socket data, e.g.
  sk state, sk type, connection type, rmem_alloc, socket queues, etc.

- trace_tipc_link_dump(): allows to trace and dump TIPC link data, e.g.
  link state, silent_intv_cnt, gap, bc_gap, link queues, etc.

- trace_tipc_node_dump(): allows to trace and dump TIPC node data, e.g.
  node state, active links, capabilities, link entries, etc.

How to use:
Put the trace functions at any places where we want to dump TIPC data
or events.

Note:
a) The dump functions will generate raw data only, that is, to offload
the trace event's processing, it can require a tool or script to parse
the data but this should be simple.

b) The trace_tipc_*_dump() should be reserved for a failure cases only
(e.g. the retransmission failure case) or where we do not expect to
happen too often, then we can consider enabling these events by default
since they will almost not take any effects under normal conditions,
but once the rare condition or failure occurs, we get the dumped data
fully for post-analysis.

For other trace purposes, we can reuse these trace classes as template
but different events.

c) A trace_event is only effective when we enable it. To enable the
TIPC trace_events, echo 1 to 'enable' files in the events/tipc/
directory in the 'debugfs' file system. Normally, they are located at:

/sys/kernel/debug/tracing/events/tipc/

For example:

To enable the tipc_link_dump event:

echo 1 > /sys/kernel/debug/tracing/events/tipc/tipc_link_dump/enable

To enable all the TIPC trace_events:

echo 1 > /sys/kernel/debug/tracing/events/tipc/enable

To collect the trace data:

cat trace

or

cat trace_pipe > /trace.out &

To disable all the TIPC trace_events:

echo 0 > /sys/kernel/debug/tracing/events/tipc/enable

To clear the trace buffer:

echo > trace

d) Like the other trace_events, the feature like 'filter' or 'trigger'
is also usable for the tipc trace_events.
For more details, have a look at:

Documentation/trace/ftrace.txt

MAINTAINERS | add two new files 'trace.h' & 'trace.c' in tipc

Acked-by: Ying Xue <ying.xue@windriver.com>
Tested-by: Ying Xue <ying.xue@windriver.com>
Acked-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: Tuong Lien <tuong.t.lien@dektech.com.au>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 90 insertions, 0 deletions

diff --git a/net/tipc/socket.c b/net/tipc/socket.c
index b57b1be7252b..b6b2a94eb54e 100644
--- a/net/tipc/socket.c
+++ b/net/tipc/socket.c
@@ -46,6 +46,7 @@
 #include "bcast.h"
 #include "netlink.h"
 #include "group.h"
+#include "trace.h"
 
 #define CONN_TIMEOUT_DEFAULT    8000    /* default connect timeout = 8s */
 #define CONN_PROBING_INTV       msecs_to_jiffies(3600000)  /* [ms] => 1 h */
@@ -3564,3 +3565,92 @@ int tipc_nl_publ_dump(struct sk_buff *skb, struct netlink_callback *cb)
 
         return skb->len;
 }
+
+u32 tipc_sock_get_portid(struct sock *sk)
+{
+        return (sk) ? (tipc_sk(sk))->portid : 0;
+}
+
+/**
+ * tipc_sk_dump - dump TIPC socket
+ * @sk: tipc sk to be dumped
+ * @dqueues: bitmask to decide if any socket queue to be dumped?
+ *           - TIPC_DUMP_NONE: don't dump socket queues
+ *           - TIPC_DUMP_SK_SNDQ: dump socket send queue
+ *           - TIPC_DUMP_SK_RCVQ: dump socket rcv queue
+ *           - TIPC_DUMP_SK_BKLGQ: dump socket backlog queue
+ *           - TIPC_DUMP_ALL: dump all the socket queues above
+ * @buf: returned buffer of dump data in format
+ */
+int tipc_sk_dump(struct sock *sk, u16 dqueues, char *buf)
+{
+        int i = 0;
+        size_t sz = (dqueues) ? SK_LMAX : SK_LMIN;
+        struct tipc_sock *tsk;
+        struct publication *p;
+        bool tsk_connected;
+
+        if (!sk) {
+                i += scnprintf(buf, sz, "sk data: (null)\n");
+                return i;
+        }
+
+        tsk = tipc_sk(sk);
+        tsk_connected = !tipc_sk_type_connectionless(sk);
+
+        i += scnprintf(buf, sz, "sk data: %u", sk->sk_type);
+        i += scnprintf(buf + i, sz - i, " %d", sk->sk_state);
+        i += scnprintf(buf + i, sz - i, " %x", tsk_own_node(tsk));
+        i += scnprintf(buf + i, sz - i, " %u", tsk->portid);
+        i += scnprintf(buf + i, sz - i, " | %u", tsk_connected);
+        if (tsk_connected) {
+                i += scnprintf(buf + i, sz - i, " %x", tsk_peer_node(tsk));
+                i += scnprintf(buf + i, sz - i, " %u", tsk_peer_port(tsk));
+                i += scnprintf(buf + i, sz - i, " %u", tsk->conn_type);
+                i += scnprintf(buf + i, sz - i, " %u", tsk->conn_instance);
+        }
+        i += scnprintf(buf + i, sz - i, " | %u", tsk->published);
+        if (tsk->published) {
+                p = list_first_entry_or_null(&tsk->publications,
+                                             struct publication, binding_sock);
+                i += scnprintf(buf + i, sz - i, " %u", (p) ? p->type : 0);
+                i += scnprintf(buf + i, sz - i, " %u", (p) ? p->lower : 0);
+                i += scnprintf(buf + i, sz - i, " %u", (p) ? p->upper : 0);
+        }
+        i += scnprintf(buf + i, sz - i, " | %u", tsk->snd_win);
+        i += scnprintf(buf + i, sz - i, " %u", tsk->rcv_win);
+        i += scnprintf(buf + i, sz - i, " %u", tsk->max_pkt);
+        i += scnprintf(buf + i, sz - i, " %x", tsk->peer_caps);
+        i += scnprintf(buf + i, sz - i, " %u", tsk->cong_link_cnt);
+        i += scnprintf(buf + i, sz - i, " %u", tsk->snt_unacked);
+        i += scnprintf(buf + i, sz - i, " %u", tsk->rcv_unacked);
+        i += scnprintf(buf + i, sz - i, " %u", atomic_read(&tsk->dupl_rcvcnt));
+        i += scnprintf(buf + i, sz - i, " %u", sk->sk_shutdown);
+        i += scnprintf(buf + i, sz - i, " | %d", sk_wmem_alloc_get(sk));
+        i += scnprintf(buf + i, sz - i, " %d", sk->sk_sndbuf);
+        i += scnprintf(buf + i, sz - i, " | %d", sk_rmem_alloc_get(sk));
+        i += scnprintf(buf + i, sz - i, " %d", sk->sk_rcvbuf);
+        i += scnprintf(buf + i, sz - i, " | %d\n", sk->sk_backlog.len);
+
+        if (dqueues & TIPC_DUMP_SK_SNDQ) {
+                i += scnprintf(buf + i, sz - i, "sk_write_queue: ");
+                i += tipc_list_dump(&sk->sk_write_queue, false, buf + i);
+        }
+
+        if (dqueues & TIPC_DUMP_SK_RCVQ) {
+                i += scnprintf(buf + i, sz - i, "sk_receive_queue: ");
+                i += tipc_list_dump(&sk->sk_receive_queue, false, buf + i);
+        }
+
+        if (dqueues & TIPC_DUMP_SK_BKLGQ) {
+                i += scnprintf(buf + i, sz - i, "sk_backlog:\n  head ");
+                i += tipc_skb_dump(sk->sk_backlog.head, false, buf + i);
+                if (sk->sk_backlog.tail != sk->sk_backlog.head) {
+                        i += scnprintf(buf + i, sz - i, "  tail ");
+                        i += tipc_skb_dump(sk->sk_backlog.tail, false,
+                                           buf + i);
+                }
+        }
+
+        return i;
+}