OSDN Git Service

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