cs-etm-decoder.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562
  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. #include <linux/err.h>
  9. #include <linux/list.h>
  10. #include <stdlib.h>
  11. #include <opencsd/c_api/opencsd_c_api.h>
  12. #include <opencsd/etmv4/trc_pkt_types_etmv4.h>
  13. #include <opencsd/ocsd_if_types.h>
  14. #include "cs-etm.h"
  15. #include "cs-etm-decoder.h"
  16. #include "intlist.h"
  17. #include "util.h"
  18. #define MAX_BUFFER 1024
  19. /* use raw logging */
  20. #ifdef CS_DEBUG_RAW
  21. #define CS_LOG_RAW_FRAMES
  22. #ifdef CS_RAW_PACKED
  23. #define CS_RAW_DEBUG_FLAGS (OCSD_DFRMTR_UNPACKED_RAW_OUT | \
  24. OCSD_DFRMTR_PACKED_RAW_OUT)
  25. #else
  26. #define CS_RAW_DEBUG_FLAGS (OCSD_DFRMTR_UNPACKED_RAW_OUT)
  27. #endif
  28. #endif
  29. #define CS_ETM_INVAL_ADDR 0xdeadbeefdeadbeefUL
  30. struct cs_etm_decoder {
  31. void *data;
  32. void (*packet_printer)(const char *msg);
  33. bool trace_on;
  34. dcd_tree_handle_t dcd_tree;
  35. cs_etm_mem_cb_type mem_access;
  36. ocsd_datapath_resp_t prev_return;
  37. u32 packet_count;
  38. u32 head;
  39. u32 tail;
  40. struct cs_etm_packet packet_buffer[MAX_BUFFER];
  41. };
  42. static u32
  43. cs_etm_decoder__mem_access(const void *context,
  44. const ocsd_vaddr_t address,
  45. const ocsd_mem_space_acc_t mem_space __maybe_unused,
  46. const u32 req_size,
  47. u8 *buffer)
  48. {
  49. struct cs_etm_decoder *decoder = (struct cs_etm_decoder *) context;
  50. return decoder->mem_access(decoder->data,
  51. address,
  52. req_size,
  53. buffer);
  54. }
  55. int cs_etm_decoder__add_mem_access_cb(struct cs_etm_decoder *decoder,
  56. u64 start, u64 end,
  57. cs_etm_mem_cb_type cb_func)
  58. {
  59. decoder->mem_access = cb_func;
  60. if (ocsd_dt_add_callback_mem_acc(decoder->dcd_tree, start, end,
  61. OCSD_MEM_SPACE_ANY,
  62. cs_etm_decoder__mem_access, decoder))
  63. return -1;
  64. return 0;
  65. }
  66. int cs_etm_decoder__reset(struct cs_etm_decoder *decoder)
  67. {
  68. ocsd_datapath_resp_t dp_ret;
  69. decoder->prev_return = OCSD_RESP_CONT;
  70. dp_ret = ocsd_dt_process_data(decoder->dcd_tree, OCSD_OP_RESET,
  71. 0, 0, NULL, NULL);
  72. if (OCSD_DATA_RESP_IS_FATAL(dp_ret))
  73. return -1;
  74. return 0;
  75. }
  76. int cs_etm_decoder__get_packet(struct cs_etm_decoder *decoder,
  77. struct cs_etm_packet *packet)
  78. {
  79. if (!decoder || !packet)
  80. return -EINVAL;
  81. /* Nothing to do, might as well just return */
  82. if (decoder->packet_count == 0)
  83. return 0;
  84. /*
  85. * The queueing process in function cs_etm_decoder__buffer_packet()
  86. * increments the tail *before* using it. This is somewhat counter
  87. * intuitive but it has the advantage of centralizing tail management
  88. * at a single location. Because of that we need to follow the same
  89. * heuristic with the head, i.e we increment it before using its
  90. * value. Otherwise the first element of the packet queue is not
  91. * used.
  92. */
  93. decoder->head = (decoder->head + 1) & (MAX_BUFFER - 1);
  94. *packet = decoder->packet_buffer[decoder->head];
  95. decoder->packet_count--;
  96. return 1;
  97. }
  98. static void cs_etm_decoder__gen_etmv4_config(struct cs_etm_trace_params *params,
  99. ocsd_etmv4_cfg *config)
  100. {
  101. config->reg_configr = params->etmv4.reg_configr;
  102. config->reg_traceidr = params->etmv4.reg_traceidr;
  103. config->reg_idr0 = params->etmv4.reg_idr0;
  104. config->reg_idr1 = params->etmv4.reg_idr1;
  105. config->reg_idr2 = params->etmv4.reg_idr2;
  106. config->reg_idr8 = params->etmv4.reg_idr8;
  107. config->reg_idr9 = 0;
  108. config->reg_idr10 = 0;
  109. config->reg_idr11 = 0;
  110. config->reg_idr12 = 0;
  111. config->reg_idr13 = 0;
  112. config->arch_ver = ARCH_V8;
  113. config->core_prof = profile_CortexA;
  114. }
  115. static void cs_etm_decoder__print_str_cb(const void *p_context,
  116. const char *msg,
  117. const int str_len)
  118. {
  119. if (p_context && str_len)
  120. ((struct cs_etm_decoder *)p_context)->packet_printer(msg);
  121. }
  122. static int
  123. cs_etm_decoder__init_def_logger_printing(struct cs_etm_decoder_params *d_params,
  124. struct cs_etm_decoder *decoder)
  125. {
  126. int ret = 0;
  127. if (d_params->packet_printer == NULL)
  128. return -1;
  129. decoder->packet_printer = d_params->packet_printer;
  130. /*
  131. * Set up a library default logger to process any printers
  132. * (packet/raw frame) we add later.
  133. */
  134. ret = ocsd_def_errlog_init(OCSD_ERR_SEV_ERROR, 1);
  135. if (ret != 0)
  136. return -1;
  137. /* no stdout / err / file output */
  138. ret = ocsd_def_errlog_config_output(C_API_MSGLOGOUT_FLG_NONE, NULL);
  139. if (ret != 0)
  140. return -1;
  141. /*
  142. * Set the string CB for the default logger, passes strings to
  143. * perf print logger.
  144. */
  145. ret = ocsd_def_errlog_set_strprint_cb(decoder->dcd_tree,
  146. (void *)decoder,
  147. cs_etm_decoder__print_str_cb);
  148. if (ret != 0)
  149. ret = -1;
  150. return 0;
  151. }
  152. #ifdef CS_LOG_RAW_FRAMES
  153. static void
  154. cs_etm_decoder__init_raw_frame_logging(struct cs_etm_decoder_params *d_params,
  155. struct cs_etm_decoder *decoder)
  156. {
  157. /* Only log these during a --dump operation */
  158. if (d_params->operation == CS_ETM_OPERATION_PRINT) {
  159. /* set up a library default logger to process the
  160. * raw frame printer we add later
  161. */
  162. ocsd_def_errlog_init(OCSD_ERR_SEV_ERROR, 1);
  163. /* no stdout / err / file output */
  164. ocsd_def_errlog_config_output(C_API_MSGLOGOUT_FLG_NONE, NULL);
  165. /* set the string CB for the default logger,
  166. * passes strings to perf print logger.
  167. */
  168. ocsd_def_errlog_set_strprint_cb(decoder->dcd_tree,
  169. (void *)decoder,
  170. cs_etm_decoder__print_str_cb);
  171. /* use the built in library printer for the raw frames */
  172. ocsd_dt_set_raw_frame_printer(decoder->dcd_tree,
  173. CS_RAW_DEBUG_FLAGS);
  174. }
  175. }
  176. #else
  177. static void
  178. cs_etm_decoder__init_raw_frame_logging(
  179. struct cs_etm_decoder_params *d_params __maybe_unused,
  180. struct cs_etm_decoder *decoder __maybe_unused)
  181. {
  182. }
  183. #endif
  184. static int cs_etm_decoder__create_packet_printer(struct cs_etm_decoder *decoder,
  185. const char *decoder_name,
  186. void *trace_config)
  187. {
  188. u8 csid;
  189. if (ocsd_dt_create_decoder(decoder->dcd_tree, decoder_name,
  190. OCSD_CREATE_FLG_PACKET_PROC,
  191. trace_config, &csid))
  192. return -1;
  193. if (ocsd_dt_set_pkt_protocol_printer(decoder->dcd_tree, csid, 0))
  194. return -1;
  195. return 0;
  196. }
  197. static int
  198. cs_etm_decoder__create_etm_packet_printer(struct cs_etm_trace_params *t_params,
  199. struct cs_etm_decoder *decoder)
  200. {
  201. const char *decoder_name;
  202. ocsd_etmv4_cfg trace_config_etmv4;
  203. void *trace_config;
  204. switch (t_params->protocol) {
  205. case CS_ETM_PROTO_ETMV4i:
  206. cs_etm_decoder__gen_etmv4_config(t_params, &trace_config_etmv4);
  207. decoder_name = OCSD_BUILTIN_DCD_ETMV4I;
  208. trace_config = &trace_config_etmv4;
  209. break;
  210. default:
  211. return -1;
  212. }
  213. return cs_etm_decoder__create_packet_printer(decoder,
  214. decoder_name,
  215. trace_config);
  216. }
  217. static void cs_etm_decoder__clear_buffer(struct cs_etm_decoder *decoder)
  218. {
  219. int i;
  220. decoder->head = 0;
  221. decoder->tail = 0;
  222. decoder->packet_count = 0;
  223. for (i = 0; i < MAX_BUFFER; i++) {
  224. decoder->packet_buffer[i].start_addr = CS_ETM_INVAL_ADDR;
  225. decoder->packet_buffer[i].end_addr = CS_ETM_INVAL_ADDR;
  226. decoder->packet_buffer[i].last_instr_taken_branch = false;
  227. decoder->packet_buffer[i].exc = false;
  228. decoder->packet_buffer[i].exc_ret = false;
  229. decoder->packet_buffer[i].cpu = INT_MIN;
  230. }
  231. }
  232. static ocsd_datapath_resp_t
  233. cs_etm_decoder__buffer_packet(struct cs_etm_decoder *decoder,
  234. const u8 trace_chan_id,
  235. enum cs_etm_sample_type sample_type)
  236. {
  237. u32 et = 0;
  238. int cpu;
  239. if (decoder->packet_count >= MAX_BUFFER - 1)
  240. return OCSD_RESP_FATAL_SYS_ERR;
  241. if (cs_etm__get_cpu(trace_chan_id, &cpu) < 0)
  242. return OCSD_RESP_FATAL_SYS_ERR;
  243. et = decoder->tail;
  244. et = (et + 1) & (MAX_BUFFER - 1);
  245. decoder->tail = et;
  246. decoder->packet_count++;
  247. decoder->packet_buffer[et].sample_type = sample_type;
  248. decoder->packet_buffer[et].exc = false;
  249. decoder->packet_buffer[et].exc_ret = false;
  250. decoder->packet_buffer[et].cpu = cpu;
  251. decoder->packet_buffer[et].start_addr = CS_ETM_INVAL_ADDR;
  252. decoder->packet_buffer[et].end_addr = CS_ETM_INVAL_ADDR;
  253. if (decoder->packet_count == MAX_BUFFER - 1)
  254. return OCSD_RESP_WAIT;
  255. return OCSD_RESP_CONT;
  256. }
  257. static ocsd_datapath_resp_t
  258. cs_etm_decoder__buffer_range(struct cs_etm_decoder *decoder,
  259. const ocsd_generic_trace_elem *elem,
  260. const uint8_t trace_chan_id)
  261. {
  262. int ret = 0;
  263. struct cs_etm_packet *packet;
  264. ret = cs_etm_decoder__buffer_packet(decoder, trace_chan_id,
  265. CS_ETM_RANGE);
  266. if (ret != OCSD_RESP_CONT && ret != OCSD_RESP_WAIT)
  267. return ret;
  268. packet = &decoder->packet_buffer[decoder->tail];
  269. packet->start_addr = elem->st_addr;
  270. packet->end_addr = elem->en_addr;
  271. switch (elem->last_i_type) {
  272. case OCSD_INSTR_BR:
  273. case OCSD_INSTR_BR_INDIRECT:
  274. packet->last_instr_taken_branch = elem->last_instr_exec;
  275. break;
  276. case OCSD_INSTR_ISB:
  277. case OCSD_INSTR_DSB_DMB:
  278. case OCSD_INSTR_OTHER:
  279. default:
  280. packet->last_instr_taken_branch = false;
  281. break;
  282. }
  283. return ret;
  284. }
  285. static ocsd_datapath_resp_t
  286. cs_etm_decoder__buffer_trace_on(struct cs_etm_decoder *decoder,
  287. const uint8_t trace_chan_id)
  288. {
  289. return cs_etm_decoder__buffer_packet(decoder, trace_chan_id,
  290. CS_ETM_TRACE_ON);
  291. }
  292. static ocsd_datapath_resp_t cs_etm_decoder__gen_trace_elem_printer(
  293. const void *context,
  294. const ocsd_trc_index_t indx __maybe_unused,
  295. const u8 trace_chan_id __maybe_unused,
  296. const ocsd_generic_trace_elem *elem)
  297. {
  298. ocsd_datapath_resp_t resp = OCSD_RESP_CONT;
  299. struct cs_etm_decoder *decoder = (struct cs_etm_decoder *) context;
  300. switch (elem->elem_type) {
  301. case OCSD_GEN_TRC_ELEM_UNKNOWN:
  302. break;
  303. case OCSD_GEN_TRC_ELEM_NO_SYNC:
  304. decoder->trace_on = false;
  305. break;
  306. case OCSD_GEN_TRC_ELEM_TRACE_ON:
  307. resp = cs_etm_decoder__buffer_trace_on(decoder,
  308. trace_chan_id);
  309. decoder->trace_on = true;
  310. break;
  311. case OCSD_GEN_TRC_ELEM_INSTR_RANGE:
  312. resp = cs_etm_decoder__buffer_range(decoder, elem,
  313. trace_chan_id);
  314. break;
  315. case OCSD_GEN_TRC_ELEM_EXCEPTION:
  316. decoder->packet_buffer[decoder->tail].exc = true;
  317. break;
  318. case OCSD_GEN_TRC_ELEM_EXCEPTION_RET:
  319. decoder->packet_buffer[decoder->tail].exc_ret = true;
  320. break;
  321. case OCSD_GEN_TRC_ELEM_PE_CONTEXT:
  322. case OCSD_GEN_TRC_ELEM_EO_TRACE:
  323. case OCSD_GEN_TRC_ELEM_ADDR_NACC:
  324. case OCSD_GEN_TRC_ELEM_TIMESTAMP:
  325. case OCSD_GEN_TRC_ELEM_CYCLE_COUNT:
  326. case OCSD_GEN_TRC_ELEM_ADDR_UNKNOWN:
  327. case OCSD_GEN_TRC_ELEM_EVENT:
  328. case OCSD_GEN_TRC_ELEM_SWTRACE:
  329. case OCSD_GEN_TRC_ELEM_CUSTOM:
  330. default:
  331. break;
  332. }
  333. return resp;
  334. }
  335. static int cs_etm_decoder__create_etm_packet_decoder(
  336. struct cs_etm_trace_params *t_params,
  337. struct cs_etm_decoder *decoder)
  338. {
  339. const char *decoder_name;
  340. ocsd_etmv4_cfg trace_config_etmv4;
  341. void *trace_config;
  342. u8 csid;
  343. switch (t_params->protocol) {
  344. case CS_ETM_PROTO_ETMV4i:
  345. cs_etm_decoder__gen_etmv4_config(t_params, &trace_config_etmv4);
  346. decoder_name = OCSD_BUILTIN_DCD_ETMV4I;
  347. trace_config = &trace_config_etmv4;
  348. break;
  349. default:
  350. return -1;
  351. }
  352. if (ocsd_dt_create_decoder(decoder->dcd_tree,
  353. decoder_name,
  354. OCSD_CREATE_FLG_FULL_DECODER,
  355. trace_config, &csid))
  356. return -1;
  357. if (ocsd_dt_set_gen_elem_outfn(decoder->dcd_tree,
  358. cs_etm_decoder__gen_trace_elem_printer,
  359. decoder))
  360. return -1;
  361. return 0;
  362. }
  363. static int
  364. cs_etm_decoder__create_etm_decoder(struct cs_etm_decoder_params *d_params,
  365. struct cs_etm_trace_params *t_params,
  366. struct cs_etm_decoder *decoder)
  367. {
  368. if (d_params->operation == CS_ETM_OPERATION_PRINT)
  369. return cs_etm_decoder__create_etm_packet_printer(t_params,
  370. decoder);
  371. else if (d_params->operation == CS_ETM_OPERATION_DECODE)
  372. return cs_etm_decoder__create_etm_packet_decoder(t_params,
  373. decoder);
  374. return -1;
  375. }
  376. struct cs_etm_decoder *
  377. cs_etm_decoder__new(int num_cpu, struct cs_etm_decoder_params *d_params,
  378. struct cs_etm_trace_params t_params[])
  379. {
  380. struct cs_etm_decoder *decoder;
  381. ocsd_dcd_tree_src_t format;
  382. u32 flags;
  383. int i, ret;
  384. if ((!t_params) || (!d_params))
  385. return NULL;
  386. decoder = zalloc(sizeof(*decoder));
  387. if (!decoder)
  388. return NULL;
  389. decoder->data = d_params->data;
  390. decoder->prev_return = OCSD_RESP_CONT;
  391. cs_etm_decoder__clear_buffer(decoder);
  392. format = (d_params->formatted ? OCSD_TRC_SRC_FRAME_FORMATTED :
  393. OCSD_TRC_SRC_SINGLE);
  394. flags = 0;
  395. flags |= (d_params->fsyncs ? OCSD_DFRMTR_HAS_FSYNCS : 0);
  396. flags |= (d_params->hsyncs ? OCSD_DFRMTR_HAS_HSYNCS : 0);
  397. flags |= (d_params->frame_aligned ? OCSD_DFRMTR_FRAME_MEM_ALIGN : 0);
  398. /*
  399. * Drivers may add barrier frames when used with perf, set up to
  400. * handle this. Barriers const of FSYNC packet repeated 4 times.
  401. */
  402. flags |= OCSD_DFRMTR_RESET_ON_4X_FSYNC;
  403. /* Create decode tree for the data source */
  404. decoder->dcd_tree = ocsd_create_dcd_tree(format, flags);
  405. if (decoder->dcd_tree == 0)
  406. goto err_free_decoder;
  407. /* init library print logging support */
  408. ret = cs_etm_decoder__init_def_logger_printing(d_params, decoder);
  409. if (ret != 0)
  410. goto err_free_decoder_tree;
  411. /* init raw frame logging if required */
  412. cs_etm_decoder__init_raw_frame_logging(d_params, decoder);
  413. for (i = 0; i < num_cpu; i++) {
  414. ret = cs_etm_decoder__create_etm_decoder(d_params,
  415. &t_params[i],
  416. decoder);
  417. if (ret != 0)
  418. goto err_free_decoder_tree;
  419. }
  420. return decoder;
  421. err_free_decoder_tree:
  422. ocsd_destroy_dcd_tree(decoder->dcd_tree);
  423. err_free_decoder:
  424. free(decoder);
  425. return NULL;
  426. }
  427. int cs_etm_decoder__process_data_block(struct cs_etm_decoder *decoder,
  428. u64 indx, const u8 *buf,
  429. size_t len, size_t *consumed)
  430. {
  431. int ret = 0;
  432. ocsd_datapath_resp_t cur = OCSD_RESP_CONT;
  433. ocsd_datapath_resp_t prev_return = decoder->prev_return;
  434. size_t processed = 0;
  435. u32 count;
  436. while (processed < len) {
  437. if (OCSD_DATA_RESP_IS_WAIT(prev_return)) {
  438. cur = ocsd_dt_process_data(decoder->dcd_tree,
  439. OCSD_OP_FLUSH,
  440. 0,
  441. 0,
  442. NULL,
  443. NULL);
  444. } else if (OCSD_DATA_RESP_IS_CONT(prev_return)) {
  445. cur = ocsd_dt_process_data(decoder->dcd_tree,
  446. OCSD_OP_DATA,
  447. indx + processed,
  448. len - processed,
  449. &buf[processed],
  450. &count);
  451. processed += count;
  452. } else {
  453. ret = -EINVAL;
  454. break;
  455. }
  456. /*
  457. * Return to the input code if the packet buffer is full.
  458. * Flushing will get done once the packet buffer has been
  459. * processed.
  460. */
  461. if (OCSD_DATA_RESP_IS_WAIT(cur))
  462. break;
  463. prev_return = cur;
  464. }
  465. decoder->prev_return = cur;
  466. *consumed = processed;
  467. return ret;
  468. }
  469. void cs_etm_decoder__free(struct cs_etm_decoder *decoder)
  470. {
  471. if (!decoder)
  472. return;
  473. ocsd_destroy_dcd_tree(decoder->dcd_tree);
  474. decoder->dcd_tree = NULL;
  475. free(decoder);
  476. }