Fix formatting (indent) for bpf_get_stack() helper documentation, so that the doc is rendered correctly with the Python script.
Showing the changes to include/uapi/linux (1 of 1 file). Show all
Unified · Split
| @@ -1770,33 +1770,33 @@ union bpf_attr { · 1769 unmodified lines | |||
| 1770 | * | 1770 | * |
| 1771 | * int bpf_get_stack(struct pt_regs *regs, void *buf, u32 size, u64 flags) | 1771 | * int bpf_get_stack(struct pt_regs *regs, void *buf, u32 size, u64 flags) |
| 1772 | * Description | 1772 | * Description |
| 1773 | * Return a user or a kernel stack in bpf program provided buffer. | 1773 | * Return a user or a kernel stack in bpf program provided buffer. |
| 1774 | * To achieve this, the helper needs *ctx*, which is a pointer | 1774 | * To achieve this, the helper needs *ctx*, which is a pointer |
| 1775 | * to the context on which the tracing program is executed. | 1775 | * to the context on which the tracing program is executed. |
| 1776 | * To store the stacktrace, the bpf program provides *buf* with | 1776 | * To store the stacktrace, the bpf program provides *buf* with |
| 1777 | * a nonnegative *size*. | 1777 | * a nonnegative *size*. |
| 1778 | * | 1778 | * |
| 1779 | * The last argument, *flags*, holds the number of stack frames to | 1779 | * The last argument, *flags*, holds the number of stack frames to |
| 1780 | * skip (from 0 to 255), masked with | 1780 | * skip (from 0 to 255), masked with |
| 1781 | * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set | 1781 | * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set |
| 1782 | * the following flags: | 1782 | * the following flags: |
| 1783 | * | 1783 | * |
| 1784 | * **BPF_F_USER_STACK** | 1784 | * **BPF_F_USER_STACK** |
| 1785 | * Collect a user space stack instead of a kernel stack. | 1785 | * Collect a user space stack instead of a kernel stack. |
| 1786 | * **BPF_F_USER_BUILD_ID** | 1786 | * **BPF_F_USER_BUILD_ID** |
| 1787 | * Collect buildid+offset instead of ips for user stack, | 1787 | * Collect buildid+offset instead of ips for user stack, |
| 1788 | * only valid if **BPF_F_USER_STACK** is also specified. | 1788 | * only valid if **BPF_F_USER_STACK** is also specified. |
| 1789 | * | 1789 | * |
| 1790 | * **bpf_get_stack**\ () can collect up to | 1790 | * **bpf_get_stack**\ () can collect up to |
| 1791 | * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject | 1791 | * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject |
| 1792 | * to sufficient large buffer size. Note that | 1792 | * to sufficient large buffer size. Note that |
| 1793 | * this limit can be controlled with the **sysctl** program, and | 1793 | * this limit can be controlled with the **sysctl** program, and |
| 1794 | * that it should be manually increased in order to profile long | 1794 | * that it should be manually increased in order to profile long |
| 1795 | * user stacks (such as stacks for Java programs). To do so, use: | 1795 | * user stacks (such as stacks for Java programs). To do so, use: |
| 1796 | * | 1796 | * |
| 1797 | * :: | 1797 | * :: |
| 1798 | * | 1798 | * |
| 1799 | * # sysctl kernel.perf_event_max_stack=<new value> | 1799 | * # sysctl kernel.perf_event_max_stack=<new value> |
| 1800 | * | 1800 | * |
| 1801 | * Return | 1801 | * Return |
| 1802 | * a non-negative value equal to or less than size on success, or | 1802 | * a non-negative value equal to or less than size on success, or |