Linux 內(nèi)核靜態(tài)追蹤技術(shù)的實現(xiàn)
前言：最近在探索 Node.js 調(diào)試和診斷方向的內(nèi)容，因為 Node.js 提供的能力有時候可能無法解決問題，比如堆內(nèi)存沒有變化，但是 rss 一直上漲。所以需要深入一點去了解更多的排查問題方式。而這些方向往往都涉及到底層的東西，所以就自然需要去了解內(nèi)核提供的一些技術(shù)，內(nèi)核提供的能力，經(jīng)過多年的發(fā)展，可謂是百花齊放，而且非常復雜。本文簡單分享一下內(nèi)核的靜態(tài)追蹤技術(shù)的實現(xiàn)。追蹤，其實就是收集代碼在執(zhí)行時的一些信息，以便協(xié)助排查問題。
1 Tracepoint
Tracepoints 是一種靜態(tài)插樁的技術(shù)，實現(xiàn)雖然復雜，但是概念上比較簡單。比如我們打日志的時候，就類似這種情況，我們在業(yè)務(wù)代碼里，寫了很多 log 用來記錄進程在運行時的信息。Tracepoints 則是內(nèi)核提供的一種基于鉤子的插樁技術(shù)。不過和打日志不一樣的是，我們想在哪里打就在哪里加對應(yīng)的代碼，而 Tracepoints 則幾乎是依賴于內(nèi)核決定哪里可以插樁，說幾乎是因為我們也可以寫內(nèi)核模塊注冊到內(nèi)核來通知插樁點。下面來通過一個例子看一下 Tracepoint 的使用和實現(xiàn)(例子來自內(nèi)核文檔 tracepoints.rst)。分析之前先看一下兩個非常重要的宏。第一個是 DECLARE_TRACE。
- #define DECLARE_TRACE(name, proto, args) \
- __DECLARE_TRACE(name, PARAMS(proto), PARAMS(args), \
- cpu_online(raw_smp_processor_id()), \
- PARAMS(void *__data, proto), \
- PARAMS(__data, args))
我們只需要關(guān)注主體的實現(xiàn)，而不需要關(guān)注參數(shù)，繼續(xù)展開。
- #define __DECLARE_TRACE(name, proto, args, cond, data_proto, data_args) \
- extern struct tracepoint __tracepoint_##name; \
- // 執(zhí)行鉤子函數(shù)
- static inline void trace_##name(proto) \
- { \
- if (static_key_false(&__tracepoint_##name.key)) \
- __DO_TRACE(&__tracepoint_##name, \
- TP_PROTO(data_proto), \
- TP_ARGS(data_args), \
- TP_CONDITION(cond), 0); \
- } \
- // 注冊鉤子函數(shù)
- static inline int \
- register_trace_##name(void (*probe)(data_proto), void *data) \
- { \
- return tracepoint_probe_register(&__tracepoint_##name, \
- (void *)probe, data); \
- } \
- // 注銷鉤子函數(shù)
- static inline int \
- unregister_trace_##name(void (*probe)(data_proto), void *data) \
- { \
- return tracepoint_probe_unregister(&__tracepoint_##name,\
- (void *)probe, data); \
- } \
- static inline bool \
- trace_##name##_enabled(void) \
- { \
- return static_key_false(&__tracepoint_##name.key); \
- }
__DECLARE_TRACE 主要是實現(xiàn)了幾個函數(shù)，我們只需要關(guān)注注冊鉤子和執(zhí)行鉤子函數(shù)(格式是 register_trace_${yourname} 和 trace_${yourame})。接下來看第二個宏 DEFINE_TRACE。
- #define DEFINE_TRACE_FN(name, reg, unreg) \
- struct tracepoint __tracepoint_##name#define DEFINE_TRACE(name) \
- DEFINE_TRACE_FN(name, NULL, NULL);
我省略了一些代碼，DEFINE_TRACE 主要是定義了一個 tracepoint 結(jié)構(gòu)體。了解了兩個宏之后，來看一下如何使用 Tracepoint。
1.1 使用
include/trace/events/subsys.h
- #include <linux/tracepoint.h>DECLARE_TRACE(subsys_eventname,
- TP_PROTO(int firstarg, struct task_struct *p),
- TP_ARGS(firstarg, p));
首先在頭文件里通過 DECLARE_TRACE 宏定義了一系列函數(shù)。subsys/file.c
- #include <trace/events/subsys.h>
- DEFINE_TRACE(subsys_eventname);void somefct(void){
- ...
- trace_subsys_eventname(arg, task);
- ...
- }
- // 實現(xiàn)自己的鉤子函數(shù)并注冊到內(nèi)核
- void callback(...) {}
- register_trace_subsys_eventname(callback);
然后在實現(xiàn)文件里通過 DEFINE_TRACE 定義一個 tracepoint 結(jié)構(gòu)體。接著調(diào)用 register_trace_subsys_eventname 函數(shù)把自定義的鉤子函數(shù)注冊到內(nèi)核，然后在需要收集信息的地方調(diào)用處理鉤子的函數(shù) trace_subsys_eventname。
1.2 實現(xiàn)
了解了使用之后，接下來看看實現(xiàn)。首先看一下注冊鉤子函數(shù)。
- int tracepoint_probe_register(struct tracepoint *tp, void *probe, void *data){
- return tracepoint_probe_register_prio(tp, probe, data, TRACEPOINT_DEFAULT_PRIO);
- }
- int tracepoint_probe_register_prio(struct tracepoint *tp, void *probe,
- void *data, int prio){
- struct tracepoint_func tp_func;
- int ret;
- mutex_lock(&tracepoints_mutex);
- tp_func.func = probe;
- tp_func.data = data;
- tp_func.prio = prio;
- ret = tracepoint_add_func(tp, &tp_func, prio);
- mutex_unlock(&tracepoints_mutex);
- return ret;
- }
tracepoint_probe_register_prio 中定義了一個 tracepoint_func 結(jié)構(gòu)體用于表示鉤子信息，然后調(diào)用 tracepoint_add_func，其中 tp 就剛才自定義的 tracepoint 結(jié)構(gòu)體。
- static int tracepoint_add_func(struct tracepoint *tp, struct tracepoint_func *func, int prio){
- struct tracepoint_func *old, *tp_funcs;
- int ret;
- // 拿到鉤子列表
- tp_funcs = rcu_dereference_protected(tp->funcs, lockdep_is_held(&tracepoints_mutex));
- // 插入新的鉤子到列表
- old = func_add(&tp_funcs, func, prio);
- rcu_assign_pointer(tp->funcs, tp_funcs);
- return 0;}static struct tracepoint_func * func_add(struct tracepoint_func **funcs, struct tracepoint_func *tp_func,
- int prio){
- struct tracepoint_func *new;
- int nr_probes = 0;
- int pos = -1;
- /* + 2 : one for new probe, one for NULL func */
- new = allocate_probes(nr_probes + 2);
- pos = 0;
- new[pos] = *tp_func;
- new[nr_probes + 1].func = NULL;
- *funcs = new;
- }
注冊函數(shù)的邏輯其實就是往自定義的結(jié)構(gòu)體的隊列里插入一個新的節(jié)點。接下來再看一下處理鉤子的邏輯。
- #define __DO_TRACE(tp, proto, args, cond, rcuidle) \
- do { \
- struct tracepoint_func *it_func_ptr; \
- void *it_func; \
- void *__data; \
- int __maybe_unused __idx = 0; \
- // 拿到隊列
- it_func_ptr = rcu_dereference_raw((tp)->funcs); \
- // 非空則執(zhí)行里面的節(jié)點的回調(diào)
- if (it_func_ptr) { \
- do { \
- it_func = (it_func_ptr)->func; \
- __data = (it_func_ptr)->data; \
- ((void(*)(proto))(it_func))(args); \
- } while ((++it_func_ptr)->func); \
- } \
- } while (0)
邏輯上和我們在應(yīng)用層的類似。在執(zhí)行鉤子，也就是我們的回調(diào)時，我們可以通過內(nèi)核接口把信息寫到 ring buffer，然后應(yīng)用層可以通過 debugfs 獲取到這個信息。
2 trace event
有了 Tracepoint 機制后，我們就可以寫模塊加載到內(nèi)核中實現(xiàn)自己的插樁點。但是內(nèi)核也為我們內(nèi)置提供了非常多的插樁點。具體是通過 trace event 來實現(xiàn)的。下面看一個例子。
- #define TRACE_EVENT(name, proto, args, struct, assign, print) \
- DECLARE_TRACE(name, PARAMS(proto), PARAMS(args))TRACE_EVENT(consume_skb,
- TP_PROTO(struct sk_buff *skb),
- TP_ARGS(skb),
- TP_STRUCT__entry(
- __field( void *, skbaddr )
- ),
- TP_fast_assign(
- __entry->skbaddr = skb;
- ),
- TP_printk("skbaddr=%p", __entry->skbaddr));
上面定義了一個宏 TRACE_EVENT，它本質(zhì)上是對 DECLARE_TRACE 的封裝，所以這里是定義了一系列的函數(shù)(注冊鉤子、處理鉤子)。然后在 consume_skb 函數(shù)中處理了注冊的鉤子。
- void consume_skb(struct sk_buff *skb){
- trace_consume_skb(skb);
- __kfree_skb(skb);
- }
3. 總結(jié)
內(nèi)核提供了非常豐富但是也非常復雜的機制，從而用戶可以通過內(nèi)核的能力獲取到更底層的數(shù)據(jù)，用以排查問題和做性能優(yōu)化。我們可以看到插樁的這種機制是一種靜態(tài)的機制，我們通常需要依賴當前版本的內(nèi)核所支持的樁，從而獲得對應(yīng)的信息，但其實內(nèi)核也提供了動態(tài)追蹤的能力，可以實現(xiàn)熱插拔獲取信息的能力。總的來說，Linux 下的追蹤技術(shù)多種多樣，雖然非常復雜，但是上層也提供了各種更方便的工具，這些能力是我們深入排查問題的利器。
