1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/stdinc.h" 7 8 #include "spdk/env.h" 9 #include "spdk/trace.h" 10 #include "spdk/log.h" 11 #include "spdk/util.h" 12 13 struct spdk_trace_flags *g_trace_flags = NULL; 14 static struct spdk_trace_register_fn *g_reg_fn_head = NULL; 15 16 SPDK_LOG_REGISTER_COMPONENT(trace) 17 18 uint64_t 19 spdk_trace_get_tpoint_mask(uint32_t group_id) 20 { 21 if (group_id >= SPDK_TRACE_MAX_GROUP_ID) { 22 SPDK_ERRLOG("invalid group ID %d\n", group_id); 23 return 0ULL; 24 } 25 26 if (g_trace_flags == NULL) { 27 return 0ULL; 28 } 29 30 return g_trace_flags->tpoint_mask[group_id]; 31 } 32 33 void 34 spdk_trace_set_tpoints(uint32_t group_id, uint64_t tpoint_mask) 35 { 36 if (g_trace_flags == NULL) { 37 SPDK_ERRLOG("trace is not initialized\n"); 38 return; 39 } 40 41 if (group_id >= SPDK_TRACE_MAX_GROUP_ID) { 42 SPDK_ERRLOG("invalid group ID %d\n", group_id); 43 return; 44 } 45 46 g_trace_flags->tpoint_mask[group_id] |= tpoint_mask; 47 } 48 49 void 50 spdk_trace_clear_tpoints(uint32_t group_id, uint64_t tpoint_mask) 51 { 52 if (g_trace_flags == NULL) { 53 SPDK_ERRLOG("trace is not initialized\n"); 54 return; 55 } 56 57 if (group_id >= SPDK_TRACE_MAX_GROUP_ID) { 58 SPDK_ERRLOG("invalid group ID %d\n", group_id); 59 return; 60 } 61 62 g_trace_flags->tpoint_mask[group_id] &= ~tpoint_mask; 63 } 64 65 uint64_t 66 spdk_trace_get_tpoint_group_mask(void) 67 { 68 uint64_t mask = 0x0; 69 int i; 70 71 for (i = 0; i < SPDK_TRACE_MAX_GROUP_ID; i++) { 72 if (spdk_trace_get_tpoint_mask(i) != 0) { 73 mask |= (1ULL << i); 74 } 75 } 76 77 return mask; 78 } 79 80 void 81 spdk_trace_set_tpoint_group_mask(uint64_t tpoint_group_mask) 82 { 83 int i; 84 85 if (g_trace_flags == NULL) { 86 SPDK_ERRLOG("trace is not initialized\n"); 87 return; 88 } 89 90 for (i = 0; i < SPDK_TRACE_MAX_GROUP_ID; i++) { 91 if (tpoint_group_mask & (1ULL << i)) { 92 spdk_trace_set_tpoints(i, -1ULL); 93 } 94 } 95 } 96 97 void 98 spdk_trace_clear_tpoint_group_mask(uint64_t tpoint_group_mask) 99 { 100 int i; 101 102 if (g_trace_flags == NULL) { 103 SPDK_ERRLOG("trace is not initialized\n"); 104 return; 105 } 106 107 for (i = 0; i < SPDK_TRACE_MAX_GROUP_ID; i++) { 108 if (tpoint_group_mask & (1ULL << i)) { 109 spdk_trace_clear_tpoints(i, -1ULL); 110 } 111 } 112 } 113 114 struct spdk_trace_register_fn * 115 spdk_trace_get_first_register_fn(void) 116 { 117 return g_reg_fn_head; 118 } 119 120 struct spdk_trace_register_fn * 121 spdk_trace_get_next_register_fn(struct spdk_trace_register_fn *register_fn) 122 { 123 return register_fn->next; 124 } 125 126 uint64_t 127 spdk_trace_create_tpoint_group_mask(const char *group_name) 128 { 129 uint64_t tpoint_group_mask = 0; 130 struct spdk_trace_register_fn *register_fn; 131 132 register_fn = spdk_trace_get_first_register_fn(); 133 if (strcmp(group_name, "all") == 0) { 134 while (register_fn) { 135 tpoint_group_mask |= (1UL << register_fn->tgroup_id); 136 137 register_fn = spdk_trace_get_next_register_fn(register_fn); 138 } 139 } else { 140 while (register_fn) { 141 if (strcmp(group_name, register_fn->name) == 0) { 142 break; 143 } 144 145 register_fn = spdk_trace_get_next_register_fn(register_fn); 146 } 147 148 if (register_fn != NULL) { 149 tpoint_group_mask |= (1UL << register_fn->tgroup_id); 150 } 151 } 152 153 return tpoint_group_mask; 154 } 155 156 int 157 spdk_trace_enable_tpoint_group(const char *group_name) 158 { 159 uint64_t tpoint_group_mask = 0; 160 161 if (g_trace_flags == NULL) { 162 return -1; 163 } 164 165 tpoint_group_mask = spdk_trace_create_tpoint_group_mask(group_name); 166 if (tpoint_group_mask == 0) { 167 return -1; 168 } 169 170 spdk_trace_set_tpoint_group_mask(tpoint_group_mask); 171 return 0; 172 } 173 174 int 175 spdk_trace_disable_tpoint_group(const char *group_name) 176 { 177 uint64_t tpoint_group_mask = 0; 178 179 if (g_trace_flags == NULL) { 180 return -1; 181 } 182 183 tpoint_group_mask = spdk_trace_create_tpoint_group_mask(group_name); 184 if (tpoint_group_mask == 0) { 185 return -1; 186 } 187 188 spdk_trace_clear_tpoint_group_mask(tpoint_group_mask); 189 return 0; 190 } 191 192 void 193 spdk_trace_mask_usage(FILE *f, const char *tmask_arg) 194 { 195 struct spdk_trace_register_fn *register_fn; 196 197 fprintf(f, " %s, --tpoint-group-mask <group-mask>[:<tpoint_mask>]\n", tmask_arg); 198 fprintf(f, " group_mask - tracepoint group mask "); 199 fprintf(f, "for spdk trace buffers (default 0x0"); 200 201 register_fn = g_reg_fn_head; 202 while (register_fn) { 203 fprintf(f, ", %s 0x%x", register_fn->name, 1 << register_fn->tgroup_id); 204 register_fn = register_fn->next; 205 } 206 207 fprintf(f, ", all 0xffff)\n"); 208 fprintf(f, " tpoint_mask - tracepoint mask for enabling individual"); 209 fprintf(f, " tpoints inside a tracepoint group."); 210 fprintf(f, " First tpoint inside a group can be"); 211 fprintf(f, " enabled by setting tpoint_mask to 1 (e.g. 0x8:1).\n"); 212 fprintf(f, " Masks can be combined (e.g. 0x400,0x8:1).\n"); 213 fprintf(f, " All available tpoints can be found in"); 214 fprintf(f, " /include/spdk_internal/trace_defs.h\n"); 215 } 216 217 void 218 spdk_trace_register_owner(uint8_t type, char id_prefix) 219 { 220 struct spdk_trace_owner *owner; 221 222 assert(type != OWNER_NONE); 223 224 if (g_trace_flags == NULL) { 225 SPDK_ERRLOG("trace is not initialized\n"); 226 return; 227 } 228 229 /* 'owner' has 256 entries and since 'type' is a uint8_t, it 230 * can't overrun the array. 231 */ 232 owner = &g_trace_flags->owner[type]; 233 assert(owner->type == 0); 234 235 owner->type = type; 236 owner->id_prefix = id_prefix; 237 } 238 239 void 240 spdk_trace_register_object(uint8_t type, char id_prefix) 241 { 242 struct spdk_trace_object *object; 243 244 assert(type != OBJECT_NONE); 245 246 if (g_trace_flags == NULL) { 247 SPDK_ERRLOG("trace is not initialized\n"); 248 return; 249 } 250 251 /* 'object' has 256 entries and since 'type' is a uint8_t, it 252 * can't overrun the array. 253 */ 254 object = &g_trace_flags->object[type]; 255 assert(object->type == 0); 256 257 object->type = type; 258 object->id_prefix = id_prefix; 259 } 260 261 static void 262 trace_register_description(const struct spdk_trace_tpoint_opts *opts) 263 { 264 struct spdk_trace_tpoint *tpoint; 265 size_t i, max_name_length; 266 267 assert(opts->tpoint_id != 0); 268 assert(opts->tpoint_id < SPDK_TRACE_MAX_TPOINT_ID); 269 270 if (strnlen(opts->name, sizeof(tpoint->name)) == sizeof(tpoint->name)) { 271 SPDK_ERRLOG("name (%s) too long\n", opts->name); 272 } 273 274 tpoint = &g_trace_flags->tpoint[opts->tpoint_id]; 275 assert(tpoint->tpoint_id == 0); 276 277 snprintf(tpoint->name, sizeof(tpoint->name), "%s", opts->name); 278 tpoint->tpoint_id = opts->tpoint_id; 279 tpoint->object_type = opts->object_type; 280 tpoint->owner_type = opts->owner_type; 281 tpoint->new_object = opts->new_object; 282 283 max_name_length = sizeof(tpoint->args[0].name); 284 for (i = 0; i < SPDK_TRACE_MAX_ARGS_COUNT; ++i) { 285 if (!opts->args[i].name || opts->args[i].name[0] == '\0') { 286 break; 287 } 288 289 switch (opts->args[i].type) { 290 case SPDK_TRACE_ARG_TYPE_INT: 291 case SPDK_TRACE_ARG_TYPE_PTR: 292 /* The integers and pointers have to be exactly 64b long */ 293 assert(opts->args[i].size == sizeof(uint64_t)); 294 break; 295 case SPDK_TRACE_ARG_TYPE_STR: 296 /* Strings need to have at least one byte for the NULL terminator */ 297 assert(opts->args[i].size > 0); 298 break; 299 default: 300 assert(0 && "invalid trace argument type"); 301 break; 302 } 303 304 if (strnlen(opts->args[i].name, max_name_length) == max_name_length) { 305 SPDK_ERRLOG("argument name (%s) is too long\n", opts->args[i].name); 306 } 307 308 snprintf(tpoint->args[i].name, sizeof(tpoint->args[i].name), 309 "%s", opts->args[i].name); 310 tpoint->args[i].type = opts->args[i].type; 311 tpoint->args[i].size = opts->args[i].size; 312 } 313 314 tpoint->num_args = i; 315 } 316 317 void 318 spdk_trace_register_description_ext(const struct spdk_trace_tpoint_opts *opts, size_t num_opts) 319 { 320 size_t i; 321 322 if (g_trace_flags == NULL) { 323 SPDK_ERRLOG("trace is not initialized\n"); 324 return; 325 } 326 327 for (i = 0; i < num_opts; ++i) { 328 trace_register_description(&opts[i]); 329 } 330 } 331 332 void 333 spdk_trace_register_description(const char *name, uint16_t tpoint_id, uint8_t owner_type, 334 uint8_t object_type, uint8_t new_object, 335 uint8_t arg1_type, const char *arg1_name) 336 { 337 struct spdk_trace_tpoint_opts opts = { 338 .name = name, 339 .tpoint_id = tpoint_id, 340 .owner_type = owner_type, 341 .object_type = object_type, 342 .new_object = new_object, 343 .args = {{ 344 .name = arg1_name, 345 .type = arg1_type, 346 .size = sizeof(uint64_t) 347 } 348 } 349 }; 350 351 spdk_trace_register_description_ext(&opts, 1); 352 } 353 354 void 355 spdk_trace_tpoint_register_relation(uint16_t tpoint_id, uint8_t object_type, uint8_t arg_index) 356 { 357 struct spdk_trace_tpoint *tpoint; 358 uint16_t i; 359 360 assert(object_type != OBJECT_NONE); 361 assert(tpoint_id != OBJECT_NONE); 362 363 if (g_trace_flags == NULL) { 364 SPDK_ERRLOG("trace is not initialized\n"); 365 return; 366 } 367 368 /* We do not check whether a tpoint_id exists here, because 369 * there is no order in which trace definitions are registered. 370 * This way we can create relations between tpoint and objects 371 * that will be declared later. */ 372 tpoint = &g_trace_flags->tpoint[tpoint_id]; 373 for (i = 0; i < SPDK_COUNTOF(tpoint->related_objects); ++i) { 374 if (tpoint->related_objects[i].object_type == OBJECT_NONE) { 375 tpoint->related_objects[i].object_type = object_type; 376 tpoint->related_objects[i].arg_index = arg_index; 377 return; 378 } 379 } 380 SPDK_ERRLOG("Unable to register new relation for tpoint %" PRIu16 ", object %" PRIu8 "\n", 381 tpoint_id, object_type); 382 } 383 384 void 385 spdk_trace_add_register_fn(struct spdk_trace_register_fn *reg_fn) 386 { 387 struct spdk_trace_register_fn *_reg_fn; 388 389 if (reg_fn->name == NULL) { 390 SPDK_ERRLOG("missing name for registering spdk trace tpoint group\n"); 391 assert(false); 392 return; 393 } 394 395 if (strcmp(reg_fn->name, "all") == 0) { 396 SPDK_ERRLOG("illegal name (%s) for tpoint group\n", reg_fn->name); 397 assert(false); 398 return; 399 } 400 401 /* Ensure that no trace point group IDs and names are ever duplicated */ 402 for (_reg_fn = g_reg_fn_head; _reg_fn; _reg_fn = _reg_fn->next) { 403 if (reg_fn->tgroup_id == _reg_fn->tgroup_id) { 404 SPDK_ERRLOG("group %d, %s has duplicate tgroup_id with %s\n", 405 reg_fn->tgroup_id, reg_fn->name, _reg_fn->name); 406 assert(false); 407 return; 408 } 409 410 if (strcmp(reg_fn->name, _reg_fn->name) == 0) { 411 SPDK_ERRLOG("name %s is duplicated between groups with ids %d and %d\n", 412 reg_fn->name, reg_fn->tgroup_id, _reg_fn->tgroup_id); 413 assert(false); 414 return; 415 } 416 } 417 418 /* Arrange trace registration in order on tgroup_id */ 419 if (g_reg_fn_head == NULL || reg_fn->tgroup_id < g_reg_fn_head->tgroup_id) { 420 reg_fn->next = g_reg_fn_head; 421 g_reg_fn_head = reg_fn; 422 return; 423 } 424 425 for (_reg_fn = g_reg_fn_head; _reg_fn; _reg_fn = _reg_fn->next) { 426 if (_reg_fn->next == NULL || reg_fn->tgroup_id < _reg_fn->next->tgroup_id) { 427 reg_fn->next = _reg_fn->next; 428 _reg_fn->next = reg_fn; 429 return; 430 } 431 } 432 } 433 434 void 435 spdk_trace_flags_init(void) 436 { 437 struct spdk_trace_register_fn *reg_fn; 438 439 reg_fn = g_reg_fn_head; 440 while (reg_fn) { 441 reg_fn->reg_fn(); 442 reg_fn = reg_fn->next; 443 } 444 } 445