1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2017 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 #include "trace_internal.h" 13 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_file == NULL) { 27 return 0ULL; 28 } 29 30 return g_trace_file->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_file == 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_file->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_file == 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_file->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_file == 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_file == 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_file == 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_file == 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 #define LINE_PREFIX " " 196 #define ENTRY_SEPARATOR ", " 197 #define MAX_LINE_LENGTH 100 198 uint64_t prefix_len = strlen(LINE_PREFIX); 199 uint64_t separator_len = strlen(ENTRY_SEPARATOR); 200 const char *first_entry = "group_name - tracepoint group name for spdk trace buffers ("; 201 const char *last_entry = "all)."; 202 uint64_t curr_line_len; 203 uint64_t curr_entry_len; 204 struct spdk_trace_register_fn *register_fn; 205 206 fprintf(f, " %s, --tpoint-group <group-name>[:<tpoint_mask>]\n", tmask_arg); 207 fprintf(f, "%s%s", LINE_PREFIX, first_entry); 208 curr_line_len = prefix_len + strlen(first_entry); 209 210 register_fn = g_reg_fn_head; 211 while (register_fn) { 212 curr_entry_len = strlen(register_fn->name); 213 if ((curr_line_len + curr_entry_len + separator_len > MAX_LINE_LENGTH)) { 214 fprintf(f, "\n%s", LINE_PREFIX); 215 curr_line_len = prefix_len; 216 } 217 218 fprintf(f, "%s%s", register_fn->name, ENTRY_SEPARATOR); 219 curr_line_len += curr_entry_len + separator_len; 220 221 if (register_fn->next == NULL) { 222 if (curr_line_len + strlen(last_entry) > MAX_LINE_LENGTH) { 223 fprintf(f, " "); 224 } 225 fprintf(f, "%s\n", last_entry); 226 break; 227 } 228 229 register_fn = register_fn->next; 230 } 231 232 fprintf(f, "%stpoint_mask - tracepoint mask for enabling individual tpoints inside\n", 233 LINE_PREFIX); 234 fprintf(f, "%sa tracepoint group. First tpoint inside a group can be enabled by\n", 235 LINE_PREFIX); 236 fprintf(f, "%ssetting tpoint_mask to 1 (e.g. bdev:0x1). Groups and masks can be\n", 237 LINE_PREFIX); 238 fprintf(f, "%scombined (e.g. thread,bdev:0x1). All available tpoints can be found\n", 239 LINE_PREFIX); 240 fprintf(f, "%sin /include/spdk_internal/trace_defs.h\n", LINE_PREFIX); 241 } 242 243 void 244 spdk_trace_register_owner_type(uint8_t type, char id_prefix) 245 { 246 struct spdk_trace_owner_type *owner_type; 247 248 assert(type != OWNER_TYPE_NONE); 249 250 if (g_trace_file == NULL) { 251 SPDK_ERRLOG("trace is not initialized\n"); 252 return; 253 } 254 255 /* 'owner_type' has 256 entries and since 'type' is a uint8_t, it 256 * can't overrun the array. 257 */ 258 owner_type = &g_trace_file->owner_type[type]; 259 assert(owner_type->type == 0); 260 261 owner_type->type = type; 262 owner_type->id_prefix = id_prefix; 263 } 264 265 void 266 spdk_trace_register_object(uint8_t type, char id_prefix) 267 { 268 struct spdk_trace_object *object; 269 270 assert(type != OBJECT_NONE); 271 272 if (g_trace_file == NULL) { 273 SPDK_ERRLOG("trace is not initialized\n"); 274 return; 275 } 276 277 /* 'object' has 256 entries and since 'type' is a uint8_t, it 278 * can't overrun the array. 279 */ 280 object = &g_trace_file->object[type]; 281 assert(object->type == 0); 282 283 object->type = type; 284 object->id_prefix = id_prefix; 285 } 286 287 static void 288 trace_register_description(const struct spdk_trace_tpoint_opts *opts) 289 { 290 struct spdk_trace_tpoint *tpoint; 291 size_t i, max_name_length; 292 293 assert(opts->tpoint_id != 0); 294 assert(opts->tpoint_id < SPDK_TRACE_MAX_TPOINT_ID); 295 296 if (strnlen(opts->name, sizeof(tpoint->name)) == sizeof(tpoint->name)) { 297 SPDK_ERRLOG("name (%s) too long\n", opts->name); 298 } 299 300 tpoint = &g_trace_file->tpoint[opts->tpoint_id]; 301 assert(tpoint->tpoint_id == 0); 302 303 snprintf(tpoint->name, sizeof(tpoint->name), "%s", opts->name); 304 tpoint->tpoint_id = opts->tpoint_id; 305 tpoint->object_type = opts->object_type; 306 tpoint->owner_type = opts->owner_type; 307 tpoint->new_object = opts->new_object; 308 309 max_name_length = sizeof(tpoint->args[0].name); 310 for (i = 0; i < SPDK_TRACE_MAX_ARGS_COUNT; ++i) { 311 if (!opts->args[i].name || opts->args[i].name[0] == '\0') { 312 break; 313 } 314 315 switch (opts->args[i].type) { 316 case SPDK_TRACE_ARG_TYPE_INT: 317 case SPDK_TRACE_ARG_TYPE_PTR: 318 /* The integers and pointers have to be exactly 4 or 8 bytes */ 319 assert(opts->args[i].size == 4 || opts->args[i].size == 8); 320 break; 321 case SPDK_TRACE_ARG_TYPE_STR: 322 /* Strings need to have at least one byte for the NULL terminator */ 323 assert(opts->args[i].size > 0); 324 break; 325 default: 326 assert(0 && "invalid trace argument type"); 327 break; 328 } 329 330 if (strnlen(opts->args[i].name, max_name_length) == max_name_length) { 331 SPDK_ERRLOG("argument name (%s) is too long\n", opts->args[i].name); 332 } 333 334 snprintf(tpoint->args[i].name, sizeof(tpoint->args[i].name), 335 "%s", opts->args[i].name); 336 tpoint->args[i].type = opts->args[i].type; 337 tpoint->args[i].size = opts->args[i].size; 338 } 339 340 tpoint->num_args = i; 341 } 342 343 void 344 spdk_trace_register_description_ext(const struct spdk_trace_tpoint_opts *opts, size_t num_opts) 345 { 346 size_t i; 347 348 if (g_trace_file == NULL) { 349 SPDK_ERRLOG("trace is not initialized\n"); 350 return; 351 } 352 353 for (i = 0; i < num_opts; ++i) { 354 trace_register_description(&opts[i]); 355 } 356 } 357 358 void 359 spdk_trace_register_description(const char *name, uint16_t tpoint_id, uint8_t owner_type, 360 uint8_t object_type, uint8_t new_object, 361 uint8_t arg1_type, const char *arg1_name) 362 { 363 struct spdk_trace_tpoint_opts opts = { 364 .name = name, 365 .tpoint_id = tpoint_id, 366 .owner_type = owner_type, 367 .object_type = object_type, 368 .new_object = new_object, 369 .args = {{ 370 .name = arg1_name, 371 .type = arg1_type, 372 .size = sizeof(uint64_t) 373 } 374 } 375 }; 376 377 spdk_trace_register_description_ext(&opts, 1); 378 } 379 380 void 381 spdk_trace_tpoint_register_relation(uint16_t tpoint_id, uint8_t object_type, uint8_t arg_index) 382 { 383 struct spdk_trace_tpoint *tpoint; 384 uint16_t i; 385 386 assert(object_type != OBJECT_NONE); 387 assert(tpoint_id != OBJECT_NONE); 388 389 if (g_trace_file == NULL) { 390 SPDK_ERRLOG("trace is not initialized\n"); 391 return; 392 } 393 394 /* We do not check whether a tpoint_id exists here, because 395 * there is no order in which trace definitions are registered. 396 * This way we can create relations between tpoint and objects 397 * that will be declared later. */ 398 tpoint = &g_trace_file->tpoint[tpoint_id]; 399 for (i = 0; i < SPDK_COUNTOF(tpoint->related_objects); ++i) { 400 if (tpoint->related_objects[i].object_type == OBJECT_NONE) { 401 tpoint->related_objects[i].object_type = object_type; 402 tpoint->related_objects[i].arg_index = arg_index; 403 return; 404 } 405 } 406 SPDK_ERRLOG("Unable to register new relation for tpoint %" PRIu16 ", object %" PRIu8 "\n", 407 tpoint_id, object_type); 408 } 409 410 void 411 spdk_trace_add_register_fn(struct spdk_trace_register_fn *reg_fn) 412 { 413 struct spdk_trace_register_fn *_reg_fn; 414 415 if (reg_fn->name == NULL) { 416 SPDK_ERRLOG("missing name for registering spdk trace tpoint group\n"); 417 assert(false); 418 return; 419 } 420 421 if (strcmp(reg_fn->name, "all") == 0) { 422 SPDK_ERRLOG("illegal name (%s) for tpoint group\n", reg_fn->name); 423 assert(false); 424 return; 425 } 426 427 /* Ensure that no trace point group IDs and names are ever duplicated */ 428 for (_reg_fn = g_reg_fn_head; _reg_fn; _reg_fn = _reg_fn->next) { 429 if (reg_fn->tgroup_id == _reg_fn->tgroup_id) { 430 SPDK_ERRLOG("group %d, %s has duplicate tgroup_id with %s\n", 431 reg_fn->tgroup_id, reg_fn->name, _reg_fn->name); 432 assert(false); 433 return; 434 } 435 436 if (strcmp(reg_fn->name, _reg_fn->name) == 0) { 437 SPDK_ERRLOG("name %s is duplicated between groups with ids %d and %d\n", 438 reg_fn->name, reg_fn->tgroup_id, _reg_fn->tgroup_id); 439 assert(false); 440 return; 441 } 442 } 443 444 /* Arrange trace registration in order on tgroup_id */ 445 if (g_reg_fn_head == NULL || reg_fn->tgroup_id < g_reg_fn_head->tgroup_id) { 446 reg_fn->next = g_reg_fn_head; 447 g_reg_fn_head = reg_fn; 448 return; 449 } 450 451 for (_reg_fn = g_reg_fn_head; _reg_fn; _reg_fn = _reg_fn->next) { 452 if (_reg_fn->next == NULL || reg_fn->tgroup_id < _reg_fn->next->tgroup_id) { 453 reg_fn->next = _reg_fn->next; 454 _reg_fn->next = reg_fn; 455 return; 456 } 457 } 458 } 459 460 int 461 trace_flags_init(void) 462 { 463 struct spdk_trace_register_fn *reg_fn; 464 465 reg_fn = g_reg_fn_head; 466 while (reg_fn) { 467 reg_fn->reg_fn(); 468 reg_fn = reg_fn->next; 469 } 470 471 return 0; 472 } 473