1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright(C) 2015-2018 Linaro Limited. 4 * 5 * Author: Tor Jeremiassen <tor@ti.com> 6 * Author: Mathieu Poirier <mathieu.poirier@linaro.org> 7 */ 8 9 #include <linux/err.h> 10 #include <linux/list.h> 11 #include <stdlib.h> 12 #include <opencsd/c_api/opencsd_c_api.h> 13 #include <opencsd/etmv4/trc_pkt_types_etmv4.h> 14 #include <opencsd/ocsd_if_types.h> 15 16 #include "cs-etm.h" 17 #include "cs-etm-decoder.h" 18 #include "intlist.h" 19 #include "util.h" 20 21 #define MAX_BUFFER 1024 22 23 /* use raw logging */ 24 #ifdef CS_DEBUG_RAW 25 #define CS_LOG_RAW_FRAMES 26 #ifdef CS_RAW_PACKED 27 #define CS_RAW_DEBUG_FLAGS (OCSD_DFRMTR_UNPACKED_RAW_OUT | \ 28 OCSD_DFRMTR_PACKED_RAW_OUT) 29 #else 30 #define CS_RAW_DEBUG_FLAGS (OCSD_DFRMTR_UNPACKED_RAW_OUT) 31 #endif 32 #endif 33 34 #define CS_ETM_INVAL_ADDR 0xdeadbeefdeadbeefUL 35 36 struct cs_etm_decoder { 37 void *data; 38 void (*packet_printer)(const char *msg); 39 bool trace_on; 40 dcd_tree_handle_t dcd_tree; 41 cs_etm_mem_cb_type mem_access; 42 ocsd_datapath_resp_t prev_return; 43 u32 packet_count; 44 u32 head; 45 u32 tail; 46 struct cs_etm_packet packet_buffer[MAX_BUFFER]; 47 }; 48 49 static u32 50 cs_etm_decoder__mem_access(const void *context, 51 const ocsd_vaddr_t address, 52 const ocsd_mem_space_acc_t mem_space __maybe_unused, 53 const u32 req_size, 54 u8 *buffer) 55 { 56 struct cs_etm_decoder *decoder = (struct cs_etm_decoder *) context; 57 58 return decoder->mem_access(decoder->data, 59 address, 60 req_size, 61 buffer); 62 } 63 64 int cs_etm_decoder__add_mem_access_cb(struct cs_etm_decoder *decoder, 65 u64 start, u64 end, 66 cs_etm_mem_cb_type cb_func) 67 { 68 decoder->mem_access = cb_func; 69 70 if (ocsd_dt_add_callback_mem_acc(decoder->dcd_tree, start, end, 71 OCSD_MEM_SPACE_ANY, 72 cs_etm_decoder__mem_access, decoder)) 73 return -1; 74 75 return 0; 76 } 77 78 int cs_etm_decoder__reset(struct cs_etm_decoder *decoder) 79 { 80 ocsd_datapath_resp_t dp_ret; 81 82 decoder->prev_return = OCSD_RESP_CONT; 83 84 dp_ret = ocsd_dt_process_data(decoder->dcd_tree, OCSD_OP_RESET, 85 0, 0, NULL, NULL); 86 if (OCSD_DATA_RESP_IS_FATAL(dp_ret)) 87 return -1; 88 89 return 0; 90 } 91 92 int cs_etm_decoder__get_packet(struct cs_etm_decoder *decoder, 93 struct cs_etm_packet *packet) 94 { 95 if (!decoder || !packet) 96 return -EINVAL; 97 98 /* Nothing to do, might as well just return */ 99 if (decoder->packet_count == 0) 100 return 0; 101 /* 102 * The queueing process in function cs_etm_decoder__buffer_packet() 103 * increments the tail *before* using it. This is somewhat counter 104 * intuitive but it has the advantage of centralizing tail management 105 * at a single location. Because of that we need to follow the same 106 * heuristic with the head, i.e we increment it before using its 107 * value. Otherwise the first element of the packet queue is not 108 * used. 109 */ 110 decoder->head = (decoder->head + 1) & (MAX_BUFFER - 1); 111 112 *packet = decoder->packet_buffer[decoder->head]; 113 114 decoder->packet_count--; 115 116 return 1; 117 } 118 119 static int cs_etm_decoder__gen_etmv3_config(struct cs_etm_trace_params *params, 120 ocsd_etmv3_cfg *config) 121 { 122 config->reg_idr = params->etmv3.reg_idr; 123 config->reg_ctrl = params->etmv3.reg_ctrl; 124 config->reg_ccer = params->etmv3.reg_ccer; 125 config->reg_trc_id = params->etmv3.reg_trc_id; 126 config->arch_ver = ARCH_V7; 127 config->core_prof = profile_CortexA; 128 129 return 0; 130 } 131 132 static void cs_etm_decoder__gen_etmv4_config(struct cs_etm_trace_params *params, 133 ocsd_etmv4_cfg *config) 134 { 135 config->reg_configr = params->etmv4.reg_configr; 136 config->reg_traceidr = params->etmv4.reg_traceidr; 137 config->reg_idr0 = params->etmv4.reg_idr0; 138 config->reg_idr1 = params->etmv4.reg_idr1; 139 config->reg_idr2 = params->etmv4.reg_idr2; 140 config->reg_idr8 = params->etmv4.reg_idr8; 141 config->reg_idr9 = 0; 142 config->reg_idr10 = 0; 143 config->reg_idr11 = 0; 144 config->reg_idr12 = 0; 145 config->reg_idr13 = 0; 146 config->arch_ver = ARCH_V8; 147 config->core_prof = profile_CortexA; 148 } 149 150 static void cs_etm_decoder__print_str_cb(const void *p_context, 151 const char *msg, 152 const int str_len) 153 { 154 if (p_context && str_len) 155 ((struct cs_etm_decoder *)p_context)->packet_printer(msg); 156 } 157 158 static int 159 cs_etm_decoder__init_def_logger_printing(struct cs_etm_decoder_params *d_params, 160 struct cs_etm_decoder *decoder) 161 { 162 int ret = 0; 163 164 if (d_params->packet_printer == NULL) 165 return -1; 166 167 decoder->packet_printer = d_params->packet_printer; 168 169 /* 170 * Set up a library default logger to process any printers 171 * (packet/raw frame) we add later. 172 */ 173 ret = ocsd_def_errlog_init(OCSD_ERR_SEV_ERROR, 1); 174 if (ret != 0) 175 return -1; 176 177 /* no stdout / err / file output */ 178 ret = ocsd_def_errlog_config_output(C_API_MSGLOGOUT_FLG_NONE, NULL); 179 if (ret != 0) 180 return -1; 181 182 /* 183 * Set the string CB for the default logger, passes strings to 184 * perf print logger. 185 */ 186 ret = ocsd_def_errlog_set_strprint_cb(decoder->dcd_tree, 187 (void *)decoder, 188 cs_etm_decoder__print_str_cb); 189 if (ret != 0) 190 ret = -1; 191 192 return 0; 193 } 194 195 #ifdef CS_LOG_RAW_FRAMES 196 static void 197 cs_etm_decoder__init_raw_frame_logging(struct cs_etm_decoder_params *d_params, 198 struct cs_etm_decoder *decoder) 199 { 200 /* Only log these during a --dump operation */ 201 if (d_params->operation == CS_ETM_OPERATION_PRINT) { 202 /* set up a library default logger to process the 203 * raw frame printer we add later 204 */ 205 ocsd_def_errlog_init(OCSD_ERR_SEV_ERROR, 1); 206 207 /* no stdout / err / file output */ 208 ocsd_def_errlog_config_output(C_API_MSGLOGOUT_FLG_NONE, NULL); 209 210 /* set the string CB for the default logger, 211 * passes strings to perf print logger. 212 */ 213 ocsd_def_errlog_set_strprint_cb(decoder->dcd_tree, 214 (void *)decoder, 215 cs_etm_decoder__print_str_cb); 216 217 /* use the built in library printer for the raw frames */ 218 ocsd_dt_set_raw_frame_printer(decoder->dcd_tree, 219 CS_RAW_DEBUG_FLAGS); 220 } 221 } 222 #else 223 static void 224 cs_etm_decoder__init_raw_frame_logging( 225 struct cs_etm_decoder_params *d_params __maybe_unused, 226 struct cs_etm_decoder *decoder __maybe_unused) 227 { 228 } 229 #endif 230 231 static int cs_etm_decoder__create_packet_printer(struct cs_etm_decoder *decoder, 232 const char *decoder_name, 233 void *trace_config) 234 { 235 u8 csid; 236 237 if (ocsd_dt_create_decoder(decoder->dcd_tree, decoder_name, 238 OCSD_CREATE_FLG_PACKET_PROC, 239 trace_config, &csid)) 240 return -1; 241 242 if (ocsd_dt_set_pkt_protocol_printer(decoder->dcd_tree, csid, 0)) 243 return -1; 244 245 return 0; 246 } 247 248 static int 249 cs_etm_decoder__create_etm_packet_printer(struct cs_etm_trace_params *t_params, 250 struct cs_etm_decoder *decoder) 251 { 252 const char *decoder_name; 253 ocsd_etmv3_cfg config_etmv3; 254 ocsd_etmv4_cfg trace_config_etmv4; 255 void *trace_config; 256 257 switch (t_params->protocol) { 258 case CS_ETM_PROTO_ETMV3: 259 case CS_ETM_PROTO_PTM: 260 cs_etm_decoder__gen_etmv3_config(t_params, &config_etmv3); 261 decoder_name = (t_params->protocol == CS_ETM_PROTO_ETMV3) ? 262 OCSD_BUILTIN_DCD_ETMV3 : 263 OCSD_BUILTIN_DCD_PTM; 264 trace_config = &config_etmv3; 265 break; 266 case CS_ETM_PROTO_ETMV4i: 267 cs_etm_decoder__gen_etmv4_config(t_params, &trace_config_etmv4); 268 decoder_name = OCSD_BUILTIN_DCD_ETMV4I; 269 trace_config = &trace_config_etmv4; 270 break; 271 default: 272 return -1; 273 } 274 275 return cs_etm_decoder__create_packet_printer(decoder, 276 decoder_name, 277 trace_config); 278 } 279 280 static void cs_etm_decoder__clear_buffer(struct cs_etm_decoder *decoder) 281 { 282 int i; 283 284 decoder->head = 0; 285 decoder->tail = 0; 286 decoder->packet_count = 0; 287 for (i = 0; i < MAX_BUFFER; i++) { 288 decoder->packet_buffer[i].isa = CS_ETM_ISA_UNKNOWN; 289 decoder->packet_buffer[i].start_addr = CS_ETM_INVAL_ADDR; 290 decoder->packet_buffer[i].end_addr = CS_ETM_INVAL_ADDR; 291 decoder->packet_buffer[i].instr_count = 0; 292 decoder->packet_buffer[i].last_instr_taken_branch = false; 293 decoder->packet_buffer[i].last_instr_size = 0; 294 decoder->packet_buffer[i].exc = false; 295 decoder->packet_buffer[i].exc_ret = false; 296 decoder->packet_buffer[i].cpu = INT_MIN; 297 } 298 } 299 300 static ocsd_datapath_resp_t 301 cs_etm_decoder__buffer_packet(struct cs_etm_decoder *decoder, 302 const u8 trace_chan_id, 303 enum cs_etm_sample_type sample_type) 304 { 305 u32 et = 0; 306 struct int_node *inode = NULL; 307 308 if (decoder->packet_count >= MAX_BUFFER - 1) 309 return OCSD_RESP_FATAL_SYS_ERR; 310 311 /* Search the RB tree for the cpu associated with this traceID */ 312 inode = intlist__find(traceid_list, trace_chan_id); 313 if (!inode) 314 return OCSD_RESP_FATAL_SYS_ERR; 315 316 et = decoder->tail; 317 et = (et + 1) & (MAX_BUFFER - 1); 318 decoder->tail = et; 319 decoder->packet_count++; 320 321 decoder->packet_buffer[et].sample_type = sample_type; 322 decoder->packet_buffer[et].isa = CS_ETM_ISA_UNKNOWN; 323 decoder->packet_buffer[et].exc = false; 324 decoder->packet_buffer[et].exc_ret = false; 325 decoder->packet_buffer[et].cpu = *((int *)inode->priv); 326 decoder->packet_buffer[et].start_addr = CS_ETM_INVAL_ADDR; 327 decoder->packet_buffer[et].end_addr = CS_ETM_INVAL_ADDR; 328 decoder->packet_buffer[et].instr_count = 0; 329 decoder->packet_buffer[et].last_instr_taken_branch = false; 330 decoder->packet_buffer[et].last_instr_size = 0; 331 332 if (decoder->packet_count == MAX_BUFFER - 1) 333 return OCSD_RESP_WAIT; 334 335 return OCSD_RESP_CONT; 336 } 337 338 static ocsd_datapath_resp_t 339 cs_etm_decoder__buffer_range(struct cs_etm_decoder *decoder, 340 const ocsd_generic_trace_elem *elem, 341 const uint8_t trace_chan_id) 342 { 343 int ret = 0; 344 struct cs_etm_packet *packet; 345 346 ret = cs_etm_decoder__buffer_packet(decoder, trace_chan_id, 347 CS_ETM_RANGE); 348 if (ret != OCSD_RESP_CONT && ret != OCSD_RESP_WAIT) 349 return ret; 350 351 packet = &decoder->packet_buffer[decoder->tail]; 352 353 switch (elem->isa) { 354 case ocsd_isa_aarch64: 355 packet->isa = CS_ETM_ISA_A64; 356 break; 357 case ocsd_isa_arm: 358 packet->isa = CS_ETM_ISA_A32; 359 break; 360 case ocsd_isa_thumb2: 361 packet->isa = CS_ETM_ISA_T32; 362 break; 363 case ocsd_isa_tee: 364 case ocsd_isa_jazelle: 365 case ocsd_isa_custom: 366 case ocsd_isa_unknown: 367 default: 368 packet->isa = CS_ETM_ISA_UNKNOWN; 369 } 370 371 packet->start_addr = elem->st_addr; 372 packet->end_addr = elem->en_addr; 373 packet->instr_count = elem->num_instr_range; 374 375 switch (elem->last_i_type) { 376 case OCSD_INSTR_BR: 377 case OCSD_INSTR_BR_INDIRECT: 378 packet->last_instr_taken_branch = elem->last_instr_exec; 379 break; 380 case OCSD_INSTR_ISB: 381 case OCSD_INSTR_DSB_DMB: 382 case OCSD_INSTR_OTHER: 383 default: 384 packet->last_instr_taken_branch = false; 385 break; 386 } 387 388 packet->last_instr_size = elem->last_instr_sz; 389 390 return ret; 391 } 392 393 static ocsd_datapath_resp_t 394 cs_etm_decoder__buffer_trace_on(struct cs_etm_decoder *decoder, 395 const uint8_t trace_chan_id) 396 { 397 return cs_etm_decoder__buffer_packet(decoder, trace_chan_id, 398 CS_ETM_TRACE_ON); 399 } 400 401 static ocsd_datapath_resp_t cs_etm_decoder__gen_trace_elem_printer( 402 const void *context, 403 const ocsd_trc_index_t indx __maybe_unused, 404 const u8 trace_chan_id __maybe_unused, 405 const ocsd_generic_trace_elem *elem) 406 { 407 ocsd_datapath_resp_t resp = OCSD_RESP_CONT; 408 struct cs_etm_decoder *decoder = (struct cs_etm_decoder *) context; 409 410 switch (elem->elem_type) { 411 case OCSD_GEN_TRC_ELEM_UNKNOWN: 412 break; 413 case OCSD_GEN_TRC_ELEM_NO_SYNC: 414 decoder->trace_on = false; 415 break; 416 case OCSD_GEN_TRC_ELEM_TRACE_ON: 417 resp = cs_etm_decoder__buffer_trace_on(decoder, 418 trace_chan_id); 419 decoder->trace_on = true; 420 break; 421 case OCSD_GEN_TRC_ELEM_INSTR_RANGE: 422 resp = cs_etm_decoder__buffer_range(decoder, elem, 423 trace_chan_id); 424 break; 425 case OCSD_GEN_TRC_ELEM_EXCEPTION: 426 decoder->packet_buffer[decoder->tail].exc = true; 427 break; 428 case OCSD_GEN_TRC_ELEM_EXCEPTION_RET: 429 decoder->packet_buffer[decoder->tail].exc_ret = true; 430 break; 431 case OCSD_GEN_TRC_ELEM_PE_CONTEXT: 432 case OCSD_GEN_TRC_ELEM_EO_TRACE: 433 case OCSD_GEN_TRC_ELEM_ADDR_NACC: 434 case OCSD_GEN_TRC_ELEM_TIMESTAMP: 435 case OCSD_GEN_TRC_ELEM_CYCLE_COUNT: 436 case OCSD_GEN_TRC_ELEM_ADDR_UNKNOWN: 437 case OCSD_GEN_TRC_ELEM_EVENT: 438 case OCSD_GEN_TRC_ELEM_SWTRACE: 439 case OCSD_GEN_TRC_ELEM_CUSTOM: 440 default: 441 break; 442 } 443 444 return resp; 445 } 446 447 static int cs_etm_decoder__create_etm_packet_decoder( 448 struct cs_etm_trace_params *t_params, 449 struct cs_etm_decoder *decoder) 450 { 451 const char *decoder_name; 452 ocsd_etmv3_cfg config_etmv3; 453 ocsd_etmv4_cfg trace_config_etmv4; 454 void *trace_config; 455 u8 csid; 456 457 switch (t_params->protocol) { 458 case CS_ETM_PROTO_ETMV3: 459 case CS_ETM_PROTO_PTM: 460 cs_etm_decoder__gen_etmv3_config(t_params, &config_etmv3); 461 decoder_name = (t_params->protocol == CS_ETM_PROTO_ETMV3) ? 462 OCSD_BUILTIN_DCD_ETMV3 : 463 OCSD_BUILTIN_DCD_PTM; 464 trace_config = &config_etmv3; 465 break; 466 case CS_ETM_PROTO_ETMV4i: 467 cs_etm_decoder__gen_etmv4_config(t_params, &trace_config_etmv4); 468 decoder_name = OCSD_BUILTIN_DCD_ETMV4I; 469 trace_config = &trace_config_etmv4; 470 break; 471 default: 472 return -1; 473 } 474 475 if (ocsd_dt_create_decoder(decoder->dcd_tree, 476 decoder_name, 477 OCSD_CREATE_FLG_FULL_DECODER, 478 trace_config, &csid)) 479 return -1; 480 481 if (ocsd_dt_set_gen_elem_outfn(decoder->dcd_tree, 482 cs_etm_decoder__gen_trace_elem_printer, 483 decoder)) 484 return -1; 485 486 return 0; 487 } 488 489 static int 490 cs_etm_decoder__create_etm_decoder(struct cs_etm_decoder_params *d_params, 491 struct cs_etm_trace_params *t_params, 492 struct cs_etm_decoder *decoder) 493 { 494 if (d_params->operation == CS_ETM_OPERATION_PRINT) 495 return cs_etm_decoder__create_etm_packet_printer(t_params, 496 decoder); 497 else if (d_params->operation == CS_ETM_OPERATION_DECODE) 498 return cs_etm_decoder__create_etm_packet_decoder(t_params, 499 decoder); 500 501 return -1; 502 } 503 504 struct cs_etm_decoder * 505 cs_etm_decoder__new(int num_cpu, struct cs_etm_decoder_params *d_params, 506 struct cs_etm_trace_params t_params[]) 507 { 508 struct cs_etm_decoder *decoder; 509 ocsd_dcd_tree_src_t format; 510 u32 flags; 511 int i, ret; 512 513 if ((!t_params) || (!d_params)) 514 return NULL; 515 516 decoder = zalloc(sizeof(*decoder)); 517 518 if (!decoder) 519 return NULL; 520 521 decoder->data = d_params->data; 522 decoder->prev_return = OCSD_RESP_CONT; 523 cs_etm_decoder__clear_buffer(decoder); 524 format = (d_params->formatted ? OCSD_TRC_SRC_FRAME_FORMATTED : 525 OCSD_TRC_SRC_SINGLE); 526 flags = 0; 527 flags |= (d_params->fsyncs ? OCSD_DFRMTR_HAS_FSYNCS : 0); 528 flags |= (d_params->hsyncs ? OCSD_DFRMTR_HAS_HSYNCS : 0); 529 flags |= (d_params->frame_aligned ? OCSD_DFRMTR_FRAME_MEM_ALIGN : 0); 530 531 /* 532 * Drivers may add barrier frames when used with perf, set up to 533 * handle this. Barriers const of FSYNC packet repeated 4 times. 534 */ 535 flags |= OCSD_DFRMTR_RESET_ON_4X_FSYNC; 536 537 /* Create decode tree for the data source */ 538 decoder->dcd_tree = ocsd_create_dcd_tree(format, flags); 539 540 if (decoder->dcd_tree == 0) 541 goto err_free_decoder; 542 543 /* init library print logging support */ 544 ret = cs_etm_decoder__init_def_logger_printing(d_params, decoder); 545 if (ret != 0) 546 goto err_free_decoder_tree; 547 548 /* init raw frame logging if required */ 549 cs_etm_decoder__init_raw_frame_logging(d_params, decoder); 550 551 for (i = 0; i < num_cpu; i++) { 552 ret = cs_etm_decoder__create_etm_decoder(d_params, 553 &t_params[i], 554 decoder); 555 if (ret != 0) 556 goto err_free_decoder_tree; 557 } 558 559 return decoder; 560 561 err_free_decoder_tree: 562 ocsd_destroy_dcd_tree(decoder->dcd_tree); 563 err_free_decoder: 564 free(decoder); 565 return NULL; 566 } 567 568 int cs_etm_decoder__process_data_block(struct cs_etm_decoder *decoder, 569 u64 indx, const u8 *buf, 570 size_t len, size_t *consumed) 571 { 572 int ret = 0; 573 ocsd_datapath_resp_t cur = OCSD_RESP_CONT; 574 ocsd_datapath_resp_t prev_return = decoder->prev_return; 575 size_t processed = 0; 576 u32 count; 577 578 while (processed < len) { 579 if (OCSD_DATA_RESP_IS_WAIT(prev_return)) { 580 cur = ocsd_dt_process_data(decoder->dcd_tree, 581 OCSD_OP_FLUSH, 582 0, 583 0, 584 NULL, 585 NULL); 586 } else if (OCSD_DATA_RESP_IS_CONT(prev_return)) { 587 cur = ocsd_dt_process_data(decoder->dcd_tree, 588 OCSD_OP_DATA, 589 indx + processed, 590 len - processed, 591 &buf[processed], 592 &count); 593 processed += count; 594 } else { 595 ret = -EINVAL; 596 break; 597 } 598 599 /* 600 * Return to the input code if the packet buffer is full. 601 * Flushing will get done once the packet buffer has been 602 * processed. 603 */ 604 if (OCSD_DATA_RESP_IS_WAIT(cur)) 605 break; 606 607 prev_return = cur; 608 } 609 610 decoder->prev_return = cur; 611 *consumed = processed; 612 613 return ret; 614 } 615 616 void cs_etm_decoder__free(struct cs_etm_decoder *decoder) 617 { 618 if (!decoder) 619 return; 620 621 ocsd_destroy_dcd_tree(decoder->dcd_tree); 622 decoder->dcd_tree = NULL; 623 free(decoder); 624 } 625