1 #pragma once 2 3 // clang-format off 4 5 // Default constraint for the probe arguments as operands. 6 #ifndef TORCH_SDT_ARG_CONSTRAINT 7 #define TORCH_SDT_ARG_CONSTRAINT "nor" 8 #endif 9 10 // Instruction to emit for the probe. 11 #define TORCH_SDT_NOP nop 12 13 // Note section properties. 14 #define TORCH_SDT_NOTE_NAME "stapsdt" 15 #define TORCH_SDT_NOTE_TYPE 3 16 17 // Semaphore variables are put in this section 18 #define TORCH_SDT_SEMAPHORE_SECTION ".probes" 19 20 // Size of address depending on platform. 21 #ifdef __LP64__ 22 #define TORCH_SDT_ASM_ADDR .8byte 23 #else 24 #define TORCH_SDT_ASM_ADDR .4byte 25 #endif 26 27 // Assembler helper Macros. 28 #define TORCH_SDT_S(x) #x 29 #define TORCH_SDT_ASM_1(x) TORCH_SDT_S(x) "\n" 30 #define TORCH_SDT_ASM_2(a, b) TORCH_SDT_S(a) "," TORCH_SDT_S(b) "\n" 31 #define TORCH_SDT_ASM_3(a, b, c) TORCH_SDT_S(a) "," TORCH_SDT_S(b) "," \ 32 TORCH_SDT_S(c) "\n" 33 #define TORCH_SDT_ASM_STRING(x) TORCH_SDT_ASM_1(.asciz TORCH_SDT_S(x)) 34 35 // Helper to determine the size of an argument. 36 #define TORCH_SDT_IS_ARRAY_POINTER(x) ((__builtin_classify_type(x) == 14) || \ 37 (__builtin_classify_type(x) == 5)) 38 #define TORCH_SDT_ARGSIZE(x) (TORCH_SDT_IS_ARRAY_POINTER(x) \ 39 ? sizeof(void*) \ 40 : sizeof(x)) 41 42 // Format of each probe arguments as operand. 43 // Size of the argument tagged with TORCH_SDT_Sn, with "n" constraint. 44 // Value of the argument tagged with TORCH_SDT_An, with configured constraint. 45 #define TORCH_SDT_ARG(n, x) \ 46 [TORCH_SDT_S##n] "n" ((size_t)TORCH_SDT_ARGSIZE(x)), \ 47 [TORCH_SDT_A##n] TORCH_SDT_ARG_CONSTRAINT (x) 48 49 // Templates to append arguments as operands. 50 #define TORCH_SDT_OPERANDS_0() [__sdt_dummy] "g" (0) 51 #define TORCH_SDT_OPERANDS_1(_1) TORCH_SDT_ARG(1, _1) 52 #define TORCH_SDT_OPERANDS_2(_1, _2) \ 53 TORCH_SDT_OPERANDS_1(_1), TORCH_SDT_ARG(2, _2) 54 #define TORCH_SDT_OPERANDS_3(_1, _2, _3) \ 55 TORCH_SDT_OPERANDS_2(_1, _2), TORCH_SDT_ARG(3, _3) 56 #define TORCH_SDT_OPERANDS_4(_1, _2, _3, _4) \ 57 TORCH_SDT_OPERANDS_3(_1, _2, _3), TORCH_SDT_ARG(4, _4) 58 #define TORCH_SDT_OPERANDS_5(_1, _2, _3, _4, _5) \ 59 TORCH_SDT_OPERANDS_4(_1, _2, _3, _4), TORCH_SDT_ARG(5, _5) 60 #define TORCH_SDT_OPERANDS_6(_1, _2, _3, _4, _5, _6) \ 61 TORCH_SDT_OPERANDS_5(_1, _2, _3, _4, _5), TORCH_SDT_ARG(6, _6) 62 #define TORCH_SDT_OPERANDS_7(_1, _2, _3, _4, _5, _6, _7) \ 63 TORCH_SDT_OPERANDS_6(_1, _2, _3, _4, _5, _6), TORCH_SDT_ARG(7, _7) 64 #define TORCH_SDT_OPERANDS_8(_1, _2, _3, _4, _5, _6, _7, _8) \ 65 TORCH_SDT_OPERANDS_7(_1, _2, _3, _4, _5, _6, _7), TORCH_SDT_ARG(8, _8) 66 #define TORCH_SDT_OPERANDS_9(_1, _2, _3, _4, _5, _6, _7, _8, _9) \ 67 TORCH_SDT_OPERANDS_8(_1, _2, _3, _4, _5, _6, _7, _8), TORCH_SDT_ARG(9, _9) 68 69 // Templates to reference the arguments from operands in note section. 70 #define TORCH_SDT_ARGFMT(no) %n[TORCH_SDT_S##no]@%[TORCH_SDT_A##no] 71 #define TORCH_SDT_ARG_TEMPLATE_0 /*No arguments*/ 72 #define TORCH_SDT_ARG_TEMPLATE_1 TORCH_SDT_ARGFMT(1) 73 #define TORCH_SDT_ARG_TEMPLATE_2 TORCH_SDT_ARG_TEMPLATE_1 TORCH_SDT_ARGFMT(2) 74 #define TORCH_SDT_ARG_TEMPLATE_3 TORCH_SDT_ARG_TEMPLATE_2 TORCH_SDT_ARGFMT(3) 75 #define TORCH_SDT_ARG_TEMPLATE_4 TORCH_SDT_ARG_TEMPLATE_3 TORCH_SDT_ARGFMT(4) 76 #define TORCH_SDT_ARG_TEMPLATE_5 TORCH_SDT_ARG_TEMPLATE_4 TORCH_SDT_ARGFMT(5) 77 #define TORCH_SDT_ARG_TEMPLATE_6 TORCH_SDT_ARG_TEMPLATE_5 TORCH_SDT_ARGFMT(6) 78 #define TORCH_SDT_ARG_TEMPLATE_7 TORCH_SDT_ARG_TEMPLATE_6 TORCH_SDT_ARGFMT(7) 79 #define TORCH_SDT_ARG_TEMPLATE_8 TORCH_SDT_ARG_TEMPLATE_7 TORCH_SDT_ARGFMT(8) 80 #define TORCH_SDT_ARG_TEMPLATE_9 TORCH_SDT_ARG_TEMPLATE_8 TORCH_SDT_ARGFMT(9) 81 82 // Semaphore define, declare and probe note format 83 84 #define TORCH_SDT_SEMAPHORE(provider, name) \ 85 torch_sdt_semaphore_##provider##_##name 86 87 #define TORCH_SDT_DEFINE_SEMAPHORE(name) \ 88 extern "C" { \ 89 volatile unsigned short TORCH_SDT_SEMAPHORE(pytorch, name) \ 90 __attribute__((section(TORCH_SDT_SEMAPHORE_SECTION), used)) = 0; \ 91 } 92 93 #define TORCH_SDT_DECLARE_SEMAPHORE(name) \ 94 extern "C" volatile unsigned short TORCH_SDT_SEMAPHORE(pytorch, name) 95 96 #define TORCH_SDT_SEMAPHORE_NOTE_0(provider, name) \ 97 TORCH_SDT_ASM_1( TORCH_SDT_ASM_ADDR 0) /*No Semaphore*/ \ 98 99 #define TORCH_SDT_SEMAPHORE_NOTE_1(provider, name) \ 100 TORCH_SDT_ASM_1(TORCH_SDT_ASM_ADDR TORCH_SDT_SEMAPHORE(provider, name)) 101 102 // Structure of note section for the probe. 103 #define TORCH_SDT_NOTE_CONTENT(provider, name, has_semaphore, arg_template) \ 104 TORCH_SDT_ASM_1(990: TORCH_SDT_NOP) \ 105 TORCH_SDT_ASM_3( .pushsection .note.stapsdt,"","note") \ 106 TORCH_SDT_ASM_1( .balign 4) \ 107 TORCH_SDT_ASM_3( .4byte 992f-991f, 994f-993f, TORCH_SDT_NOTE_TYPE) \ 108 TORCH_SDT_ASM_1(991: .asciz TORCH_SDT_NOTE_NAME) \ 109 TORCH_SDT_ASM_1(992: .balign 4) \ 110 TORCH_SDT_ASM_1(993: TORCH_SDT_ASM_ADDR 990b) \ 111 TORCH_SDT_ASM_1( TORCH_SDT_ASM_ADDR 0) /*Reserved for Base Address*/ \ 112 TORCH_SDT_SEMAPHORE_NOTE_##has_semaphore(provider, name) \ 113 TORCH_SDT_ASM_STRING(provider) \ 114 TORCH_SDT_ASM_STRING(name) \ 115 TORCH_SDT_ASM_STRING(arg_template) \ 116 TORCH_SDT_ASM_1(994: .balign 4) \ 117 TORCH_SDT_ASM_1( .popsection) 118 119 // Main probe Macro. 120 #define TORCH_SDT_PROBE(provider, name, has_semaphore, n, arglist) \ 121 __asm__ __volatile__ ( \ 122 TORCH_SDT_NOTE_CONTENT( \ 123 provider, name, has_semaphore, TORCH_SDT_ARG_TEMPLATE_##n) \ 124 :: TORCH_SDT_OPERANDS_##n arglist \ 125 ) \ 126 127 // Helper Macros to handle variadic arguments. 128 #define TORCH_SDT_NARG_(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, N, ...) N 129 #define TORCH_SDT_NARG(...) \ 130 TORCH_SDT_NARG_(__VA_ARGS__, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0) 131 #define TORCH_SDT_PROBE_N(provider, name, has_semaphore, N, ...) \ 132 TORCH_SDT_PROBE(provider, name, has_semaphore, N, (__VA_ARGS__)) 133