Moved BPF program into own file

jnidzwetzki · Jan 22, 2023 · 9533f4e · 9533f4e
1 parent 5f21d8e
commit 9533f4e
Show file tree

Hide file tree

Showing 2 changed files with 118 additions and 121 deletions.
diff --git a/src/pg_lock_tracer/bpf/pg_lw_lock_tracer.c b/src/pg_lock_tracer/bpf/pg_lw_lock_tracer.c
@@ -0,0 +1,116 @@
+// https://github.com/postgres/postgres/blob/a4adc31f6902f6fc29d74868e8969412fc590da9/src/include/storage/lwlock.h#L110
+
+typedef enum LWLockMode {
+  LW_EXCLUSIVE,
+  LW_SHARED,
+  LW_WAIT_UNTIL_FREE /* A special mode used in PGPROC->lwWaitMode,
+                      * when waiting for lock to become free. Not
+                      * to be used as LWLockAcquire argument */
+} LWLockMode;
+
+/* Placeholder for auto generated defines */
+__DEFINES__
+
+typedef struct LockEvent_t {
+  u32 pid;
+  u64 timestamp;
+  u32 event_type;
+
+  /* LWLock tranche name (see T_NAME / GetLWTrancheName()
+   * in lwlock.c) */
+  char tranche[255];
+
+  /* LWLockMode */
+  u32 mode;
+} LockEvent;
+
+BPF_PERF_OUTPUT(lockevents);
+
+static void fill_and_submit(struct pt_regs *ctx, LockEvent *event,
+                            uint64_t tranche_addr) {
+  bpf_probe_read_user_str(event->tranche, sizeof(event->tranche),
+                          (void *)tranche_addr);
+  event->pid = bpf_get_current_pid_tgid();
+  event->timestamp = bpf_ktime_get_ns();
+
+  // sudo cat /sys/kernel/debug/tracing/trace_pipe
+  // bpf_trace_printk("LW lock event for trance: %s\\n", tranche);
+
+  lockevents.perf_submit(ctx, event, sizeof(LockEvent));
+}
+
+/*
+ * Acquire a LW Lock
+ * Arguments: TRACE_POSTGRESQL_LWLOCK_ACQUIRE(T_NAME(lock), mode)
+ */
+int lwlock_acquire(struct pt_regs *ctx) {
+  uint64_t tranche_addr = 0;
+  LWLockMode mode;
+
+  LockEvent event = {.event_type = EVENT_LOCK};
+
+  // The usdt does not support using bpf_usdt_readarg outside the main probe
+  // function See: https://github.com/iovisor/bcc/issues/2265
+  bpf_usdt_readarg(1, ctx, &tranche_addr);
+  bpf_usdt_readarg(2, ctx, &mode);
+
+  event.mode = mode;
+
+  fill_and_submit(ctx, &event, tranche_addr);
+  return 0;
+}
+
+/*
+ * Release a LW Lock
+ * Arguments: TRACE_POSTGRESQL_LWLOCK_RELEASE(T_NAME(lock))
+ */
+int lwlock_release(struct pt_regs *ctx) {
+  uint64_t tranche_addr = 0;
+
+  LockEvent event = {.event_type = EVENT_UNLOCK};
+
+  bpf_usdt_readarg(1, ctx, &tranche_addr);
+
+  fill_and_submit(ctx, &event, tranche_addr);
+  return 0;
+}
+
+/*
+ * Wait for a LW Lock
+ * Arguments: TRACE_POSTGRESQL_LWLOCK_WAIT_START(T_NAME(lock), mode)
+ */
+int lwlock_wait_start(struct pt_regs *ctx) {
+  uint64_t tranche_addr = 0;
+  LWLockMode mode;
+
+  LockEvent event = {.event_type = EVENT_WAIT_START};
+
+  // The usdt does not support using bpf_usdt_readarg outside the main probe
+  // function. See: https://github.com/iovisor/bcc/issues/2265
+  bpf_usdt_readarg(1, ctx, &tranche_addr);
+  bpf_usdt_readarg(2, ctx, &mode);
+
+  event.mode = mode;
+
+  fill_and_submit(ctx, &event, tranche_addr);
+  return 0;
+}
+
+/*
+ * Wait for a LW Lock is done
+ * Arguments: TRACE_POSTGRESQL_LWLOCK_WAIT_DONE(T_NAME(lock), mode)
+ */
+int lwlock_wait_done(struct pt_regs *ctx) {
+  uint64_t tranche_addr = 0;
+  LWLockMode mode;
+
+  LockEvent event = {.event_type = EVENT_WAIT_DONE};
+
+  bpf_usdt_readarg(1, ctx, &tranche_addr);
+  bpf_usdt_readarg(2, ctx, &mode);
+
+  event.mode = mode;
+
+  fill_and_submit(ctx, &event, tranche_addr);
+  return 0;
+}
diff --git a/src/pg_lock_tracer/pg_lw_lock_tracer.py b/src/pg_lock_tracer/pg_lw_lock_tracer.py
@@ -57,126 +57,6 @@
 )
 parser.add_argument("--statistics", action="store_true", help="print lock statistics")
 
-BPF_PROGRAM = """
-
-// https://github.com/postgres/postgres/blob/a4adc31f6902f6fc29d74868e8969412fc590da9/src/include/storage/lwlock.h#L110
-typedef enum LWLockMode
-{
-     LW_EXCLUSIVE,
-     LW_SHARED,
-     LW_WAIT_UNTIL_FREE          /* A special mode used in PGPROC->lwWaitMode,
-                                  * when waiting for lock to become free. Not
-                                  * to be used as LWLockAcquire argument */
-} LWLockMode;
-
-/* Placeholder for auto generated defines */
-__DEFINES__
-
-typedef struct LockEvent_t
-{
-        u32 pid;
-        u64 timestamp;
-        u32 event_type;
-
-        /* LWLock tranche name (see T_NAME / GetLWTrancheName() 
-         * in lwlock.c) */
-        char tranche[255];
-
-        /* LWLockMode */
-        u32 mode;
-} LockEvent;
-
-BPF_PERF_OUTPUT(lockevents);
-
-
-static void fill_and_submit(struct pt_regs *ctx, LockEvent *event, uint64_t tranche_addr) {
-    bpf_probe_read_user_str(event->tranche, sizeof(event->tranche), (void *)tranche_addr);
-    event->pid = bpf_get_current_pid_tgid();
-    event->timestamp = bpf_ktime_get_ns();
-
-    // sudo cat /sys/kernel/debug/tracing/trace_pipe
-    // bpf_trace_printk("LW lock event for trance: %s\\n", tranche);
-    
-    lockevents.perf_submit(ctx, event, sizeof(LockEvent));
-}
-
-/*
- * Acquire a LW Lock
- * Arguments: TRACE_POSTGRESQL_LWLOCK_ACQUIRE(T_NAME(lock), mode)
- */
-int lwlock_acquire(struct pt_regs *ctx) {
-    uint64_t tranche_addr = 0;
-    LWLockMode mode;
-
-    LockEvent event = {.event_type = EVENT_LOCK};
-
-    // The usdt does not support using bpf_usdt_readarg outside the main probe function
-    // See: https://github.com/iovisor/bcc/issues/2265
-    bpf_usdt_readarg(1, ctx, &tranche_addr);
-    bpf_usdt_readarg(2, ctx, &mode);
-
-    event.mode = mode;
-
-    fill_and_submit(ctx, &event, tranche_addr);
-    return 0;
-}
-
-/*
- * Release a LW Lock
- * Arguments: TRACE_POSTGRESQL_LWLOCK_RELEASE(T_NAME(lock))
- */
-int lwlock_release(struct pt_regs *ctx) {
-    uint64_t tranche_addr = 0;
-
-    LockEvent event = {.event_type = EVENT_UNLOCK};
-
-    bpf_usdt_readarg(1, ctx, &tranche_addr);
-
-    fill_and_submit(ctx, &event, tranche_addr);
-    return 0;
-}
-
-/*
- * Wait for a LW Lock
- * Arguments: TRACE_POSTGRESQL_LWLOCK_WAIT_START(T_NAME(lock), mode)
- */
-int lwlock_wait_start(struct pt_regs *ctx) {
-    uint64_t tranche_addr = 0;
-    LWLockMode mode;
-
-    LockEvent event = {.event_type = EVENT_WAIT_START};
-
-    // The usdt does not support using bpf_usdt_readarg outside the main probe function. 
-    // See: https://github.com/iovisor/bcc/issues/2265
-    bpf_usdt_readarg(1, ctx, &tranche_addr);
-    bpf_usdt_readarg(2, ctx, &mode);
-
-    event.mode = mode;
-
-    fill_and_submit(ctx, &event, tranche_addr);
-    return 0;
-}
-
-/*
- * Wait for a LW Lock is done
- * Arguments: TRACE_POSTGRESQL_LWLOCK_WAIT_DONE(T_NAME(lock), mode)
- */
-int lwlock_wait_done(struct pt_regs *ctx) {
-    uint64_t tranche_addr = 0;
-    LWLockMode mode;
-
-    LockEvent event = {.event_type = EVENT_WAIT_DONE};
-
-    bpf_usdt_readarg(1, ctx, &tranche_addr);
-    bpf_usdt_readarg(2, ctx, &mode);
-
-    event.mode = mode;
-
-    fill_and_submit(ctx, &event, tranche_addr);
-    return 0;
-}
-"""
-
 
 class Events(IntEnum):
     LOCK = 0
@@ -343,7 +223,8 @@ def init(self):
             print("=======")
 
         enum_defines = BPFHelper.enum_to_defines(Events, "EVENT")
-        bpf_program_final = BPF_PROGRAM.replace("__DEFINES__", enum_defines)
+        bpf_program = BPFHelper.read_bpf_program("pg_lw_lock_tracer.c")
+        bpf_program_final = bpf_program.replace("__DEFINES__", enum_defines)
 
         if self.prog_args.verbose:
             print(bpf_program_final)