1 /*
2 * \file ocsd_dcd_tree.cpp
3 * \brief OpenCSD :
4 *
5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
6 */
7
8
9 /*
10 * Redistribution and use in source and binary forms, with or without modification,
11 * are permitted provided that the following conditions are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 *
20 * 3. Neither the name of the copyright holder nor the names of its contributors
21 * may be used to endorse or promote products derived from this software without
22 * specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36 #include "common/ocsd_dcd_tree.h"
37 #include "common/ocsd_lib_dcd_register.h"
38 #include "mem_acc/trc_mem_acc_mapper.h"
39
40 /***************************************************************/
41 ITraceErrorLog *DecodeTree::s_i_error_logger = &DecodeTree::s_error_logger;
42 std::list<DecodeTree *> DecodeTree::s_trace_dcd_trees; /**< list of pointers to decode tree objects */
43 ocsdDefaultErrorLogger DecodeTree::s_error_logger; /**< The library default error logger */
44 TrcIDecode DecodeTree::s_instruction_decoder; /**< default instruction decode library */
45
CreateDecodeTree(const ocsd_dcd_tree_src_t src_type,uint32_t formatterCfgFlags)46 DecodeTree *DecodeTree::CreateDecodeTree(const ocsd_dcd_tree_src_t src_type, uint32_t formatterCfgFlags)
47 {
48 DecodeTree *dcd_tree = new (std::nothrow) DecodeTree();
49 if(dcd_tree != 0)
50 {
51 if(dcd_tree->initialise(src_type, formatterCfgFlags))
52 {
53 s_trace_dcd_trees.push_back(dcd_tree);
54 s_instruction_decoder.envSetAA64_errOnBadOpcode();
55 }
56 else
57 {
58 delete dcd_tree;
59 dcd_tree = 0;
60 }
61 }
62 return dcd_tree;
63 }
64
DestroyDecodeTree(DecodeTree * p_dcd_tree)65 void DecodeTree::DestroyDecodeTree(DecodeTree *p_dcd_tree)
66 {
67 std::list<DecodeTree *>::iterator it;
68 bool bDestroyed = false;
69 it = s_trace_dcd_trees.begin();
70 while(!bDestroyed && (it != s_trace_dcd_trees.end()))
71 {
72 if(*it == p_dcd_tree)
73 {
74 s_trace_dcd_trees.erase(it);
75 delete p_dcd_tree;
76 bDestroyed = true;
77 }
78 else
79 it++;
80 }
81 }
82
setAlternateErrorLogger(ITraceErrorLog * p_error_logger)83 void DecodeTree::setAlternateErrorLogger(ITraceErrorLog *p_error_logger)
84 {
85 if(p_error_logger)
86 s_i_error_logger = p_error_logger;
87 else
88 s_i_error_logger = &s_error_logger;
89 }
90
91 /***************************************************************/
92
DecodeTree()93 DecodeTree::DecodeTree() :
94 m_i_instr_decode(&s_instruction_decoder),
95 m_i_mem_access(0),
96 m_i_gen_elem_out(0),
97 m_i_decoder_root(0),
98 m_frame_deformatter_root(0),
99 m_decode_elem_iter(0),
100 m_default_mapper(0),
101 m_created_mapper(false)
102 {
103 for(int i = 0; i < 0x80; i++)
104 m_decode_elements[i] = 0;
105
106 // reset the global demux stats.
107 m_demux_stats.frame_bytes = 0;
108 m_demux_stats.no_id_bytes = 0;
109 m_demux_stats.valid_id_bytes = 0;
110 m_demux_stats.unknown_id_bytes = 0;
111 m_demux_stats.reserved_id_bytes = 0;
112 }
113
~DecodeTree()114 DecodeTree::~DecodeTree()
115 {
116 destroyMemAccMapper();
117 for(uint8_t i = 0; i < 0x80; i++)
118 {
119 destroyDecodeElement(i);
120 }
121 PktPrinterFact::destroyAllPrinters(m_printer_list);
122 delete m_frame_deformatter_root;
123 }
124
125
126
TraceDataIn(const ocsd_datapath_op_t op,const ocsd_trc_index_t index,const uint32_t dataBlockSize,const uint8_t * pDataBlock,uint32_t * numBytesProcessed)127 ocsd_datapath_resp_t DecodeTree::TraceDataIn( const ocsd_datapath_op_t op,
128 const ocsd_trc_index_t index,
129 const uint32_t dataBlockSize,
130 const uint8_t *pDataBlock,
131 uint32_t *numBytesProcessed)
132 {
133 if(m_i_decoder_root)
134 return m_i_decoder_root->TraceDataIn(op,index,dataBlockSize,pDataBlock,numBytesProcessed);
135 *numBytesProcessed = 0;
136 return OCSD_RESP_FATAL_NOT_INIT;
137 }
138
139 /* set key interfaces - attach / replace on any existing tree components */
setInstrDecoder(IInstrDecode * i_instr_decode)140 void DecodeTree::setInstrDecoder(IInstrDecode *i_instr_decode)
141 {
142 uint8_t elemID;
143 DecodeTreeElement *pElem = 0;
144
145 pElem = getFirstElement(elemID);
146 while(pElem != 0)
147 {
148 pElem->getDecoderMngr()->attachInstrDecoder(pElem->getDecoderHandle(),i_instr_decode);
149 pElem = getNextElement(elemID);
150 }
151 }
152
setMemAccessI(ITargetMemAccess * i_mem_access)153 void DecodeTree::setMemAccessI(ITargetMemAccess *i_mem_access)
154 {
155 uint8_t elemID;
156 DecodeTreeElement *pElem = 0;
157
158 pElem = getFirstElement(elemID);
159 while(pElem != 0)
160 {
161 pElem->getDecoderMngr()->attachMemAccessor(pElem->getDecoderHandle(),i_mem_access);
162 pElem = getNextElement(elemID);
163 }
164 m_i_mem_access = i_mem_access;
165 }
166
setGenTraceElemOutI(ITrcGenElemIn * i_gen_trace_elem)167 void DecodeTree::setGenTraceElemOutI(ITrcGenElemIn *i_gen_trace_elem)
168 {
169 uint8_t elemID;
170 DecodeTreeElement *pElem = 0;
171
172 pElem = getFirstElement(elemID);
173 while(pElem != 0)
174 {
175 pElem->getDecoderMngr()->attachOutputSink(pElem->getDecoderHandle(),i_gen_trace_elem);
176 pElem = getNextElement(elemID);
177 }
178 /* set local copy of interface to return in getGenTraceElemOutI */
179 m_i_gen_elem_out = i_gen_trace_elem;
180 }
181
createMemAccMapper(memacc_mapper_t type)182 ocsd_err_t DecodeTree::createMemAccMapper(memacc_mapper_t type /* = MEMACC_MAP_GLOBAL*/ )
183 {
184 // clean up any old one
185 destroyMemAccMapper();
186
187 // make a new one
188 switch(type)
189 {
190 default:
191 case MEMACC_MAP_GLOBAL:
192 m_default_mapper = new (std::nothrow) TrcMemAccMapGlobalSpace();
193 break;
194 }
195
196 // set the access interface
197 if(m_default_mapper)
198 {
199 bool enableCaching;
200 int cachePageSize, cachePageNum;
201
202
203 m_created_mapper = true;
204 setMemAccessI(m_default_mapper);
205 m_default_mapper->setErrorLog(s_i_error_logger);
206 TrcMemAccCache::getenvMemaccCacheSizes(enableCaching, cachePageSize, cachePageNum);
207 if ((m_default_mapper->setCacheSizes(cachePageSize, cachePageNum) != OCSD_OK) ||
208 (m_default_mapper->enableCaching(enableCaching) != OCSD_OK))
209 destroyMemAccMapper();
210 }
211
212 return (m_default_mapper != 0) ? OCSD_OK : OCSD_ERR_MEM;
213 }
214
setExternMemAccMapper(TrcMemAccMapper * pMapper)215 void DecodeTree::setExternMemAccMapper(TrcMemAccMapper* pMapper)
216 {
217 destroyMemAccMapper(); // destroy any existing mapper - if decode tree created it.
218 m_default_mapper = pMapper;
219 }
220
destroyMemAccMapper()221 void DecodeTree::destroyMemAccMapper()
222 {
223 if(m_default_mapper && m_created_mapper)
224 {
225 m_default_mapper->RemoveAllAccessors();
226 delete m_default_mapper;
227 m_default_mapper = 0;
228 m_created_mapper = false;
229 }
230 }
231
logMappedRanges()232 void DecodeTree::logMappedRanges()
233 {
234 if(m_default_mapper)
235 m_default_mapper->logMappedRanges();
236 }
237
238 /* Memory accessor creation - all on default mem accessor using the 0 CSID for global core space. */
addBufferMemAcc(const ocsd_vaddr_t address,const ocsd_mem_space_acc_t mem_space,const uint8_t * p_mem_buffer,const uint32_t mem_length)239 ocsd_err_t DecodeTree::addBufferMemAcc(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t *p_mem_buffer, const uint32_t mem_length)
240 {
241 if(!hasMemAccMapper())
242 return OCSD_ERR_NOT_INIT;
243
244 // need a valid memory buffer, and a least enough bytes for one opcode.
245 if((p_mem_buffer == 0) || (mem_length < 4))
246 return OCSD_ERR_INVALID_PARAM_VAL;
247
248 TrcMemAccessorBase *p_accessor;
249 ocsd_err_t err = TrcMemAccFactory::CreateBufferAccessor(&p_accessor, address, p_mem_buffer, mem_length);
250 if(err == OCSD_OK)
251 {
252 TrcMemAccBufPtr *pMBuffAcc = dynamic_cast<TrcMemAccBufPtr *>(p_accessor);
253 if(pMBuffAcc)
254 {
255 pMBuffAcc->setMemSpace(mem_space);
256 err = m_default_mapper->AddAccessor(p_accessor,0);
257 }
258 else
259 err = OCSD_ERR_MEM; // wrong type of object - treat as mem error
260
261 if(err != OCSD_OK)
262 TrcMemAccFactory::DestroyAccessor(p_accessor);
263 }
264 return err;
265 }
266
addBinFileMemAcc(const ocsd_vaddr_t address,const ocsd_mem_space_acc_t mem_space,const std::string & filepath)267 ocsd_err_t DecodeTree::addBinFileMemAcc(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const std::string &filepath)
268 {
269 if(!hasMemAccMapper())
270 return OCSD_ERR_NOT_INIT;
271
272 if(filepath.length() == 0)
273 return OCSD_ERR_INVALID_PARAM_VAL;
274
275 TrcMemAccessorBase *p_accessor;
276 ocsd_err_t err = TrcMemAccFactory::CreateFileAccessor(&p_accessor,filepath,address);
277
278 if(err == OCSD_OK)
279 {
280 TrcMemAccessorFile *pAcc = dynamic_cast<TrcMemAccessorFile *>(p_accessor);
281 if(pAcc)
282 {
283 pAcc->setMemSpace(mem_space);
284 err = m_default_mapper->AddAccessor(pAcc,0);
285 }
286 else
287 err = OCSD_ERR_MEM; // wrong type of object - treat as mem error
288
289 if(err != OCSD_OK)
290 TrcMemAccFactory::DestroyAccessor(p_accessor);
291 }
292 return err;
293
294 }
295
addBinFileRegionMemAcc(const ocsd_file_mem_region_t * region_array,const int num_regions,const ocsd_mem_space_acc_t mem_space,const std::string & filepath)296 ocsd_err_t DecodeTree::addBinFileRegionMemAcc(const ocsd_file_mem_region_t *region_array, const int num_regions, const ocsd_mem_space_acc_t mem_space, const std::string &filepath)
297 {
298 if(!hasMemAccMapper())
299 return OCSD_ERR_NOT_INIT;
300
301 if((region_array == 0) || (num_regions == 0) || (filepath.length() == 0))
302 return OCSD_ERR_INVALID_PARAM_VAL;
303
304 TrcMemAccessorBase *p_accessor;
305 int curr_region_idx = 0;
306
307 // add first region during the creation of the file accessor.
308 ocsd_err_t err = TrcMemAccFactory::CreateFileAccessor(&p_accessor,filepath,region_array[curr_region_idx].start_address,region_array[curr_region_idx].file_offset, region_array[curr_region_idx].region_size);
309 if(err == OCSD_OK)
310 {
311 TrcMemAccessorFile *pAcc = dynamic_cast<TrcMemAccessorFile *>(p_accessor);
312 if(pAcc)
313 {
314 // add additional regions to the file accessor.
315 curr_region_idx++;
316 while(curr_region_idx < num_regions)
317 {
318 pAcc->AddOffsetRange(region_array[curr_region_idx].start_address,
319 region_array[curr_region_idx].region_size,
320 region_array[curr_region_idx].file_offset);
321 curr_region_idx++;
322 }
323 pAcc->setMemSpace(mem_space);
324
325 // add the accessor to the map.
326 err = m_default_mapper->AddAccessor(pAcc,0);
327 }
328 else
329 err = OCSD_ERR_MEM; // wrong type of object - treat as mem error
330
331 if(err != OCSD_OK)
332 TrcMemAccFactory::DestroyAccessor(p_accessor);
333 }
334 return err;
335 }
336
updateBinFileRegionMemAcc(const ocsd_file_mem_region_t * region_array,const int num_regions,const ocsd_mem_space_acc_t mem_space,const std::string & filepath)337 ocsd_err_t DecodeTree::updateBinFileRegionMemAcc(const ocsd_file_mem_region_t *region_array, const int num_regions, const ocsd_mem_space_acc_t mem_space, const std::string &filepath)
338 {
339 if (!hasMemAccMapper())
340 return OCSD_ERR_NOT_INIT;
341
342 if ((region_array == 0) || (num_regions == 0) || (filepath.length() == 0))
343 return OCSD_ERR_INVALID_PARAM_VAL;
344
345 TrcMemAccessorFile *pAcc = TrcMemAccessorFile::getExistingFileAccessor(filepath);
346 if (!pAcc)
347 return OCSD_ERR_INVALID_PARAM_VAL;
348
349 int curr_region_idx = 0;
350 while (curr_region_idx < num_regions)
351 {
352 // check "new" range
353 if (!pAcc->addrStartOfRange(region_array[curr_region_idx].start_address))
354 {
355 // ensure adds cleanly
356 if (!pAcc->AddOffsetRange(region_array[curr_region_idx].start_address,
357 region_array[curr_region_idx].region_size,
358 region_array[curr_region_idx].file_offset))
359 return OCSD_ERR_INVALID_PARAM_VAL; // otherwise bail out
360 }
361 curr_region_idx++;
362 }
363 return OCSD_OK;
364 }
initCallbackMemAcc(const ocsd_vaddr_t st_address,const ocsd_vaddr_t en_address,const ocsd_mem_space_acc_t mem_space,void * p_cb_func,bool IDfn,const void * p_context)365 ocsd_err_t DecodeTree::initCallbackMemAcc(const ocsd_vaddr_t st_address, const ocsd_vaddr_t en_address,
366 const ocsd_mem_space_acc_t mem_space, void *p_cb_func, bool IDfn, const void *p_context)
367 {
368 if(!hasMemAccMapper())
369 return OCSD_ERR_NOT_INIT;
370
371 if(p_cb_func == 0)
372 return OCSD_ERR_INVALID_PARAM_VAL;
373
374 TrcMemAccessorBase *p_accessor;
375 ocsd_err_t err = TrcMemAccFactory::CreateCBAccessor(&p_accessor, st_address, en_address, mem_space);
376 if(err == OCSD_OK)
377 {
378 TrcMemAccCB *pCBAcc = dynamic_cast<TrcMemAccCB *>(p_accessor);
379 if(pCBAcc)
380 {
381 if (IDfn)
382 pCBAcc->setCBIDIfFn((Fn_MemAccID_CB)p_cb_func, p_context);
383 else
384 pCBAcc->setCBIfFn((Fn_MemAcc_CB)p_cb_func, p_context);
385
386 err = m_default_mapper->AddAccessor(p_accessor,0);
387 }
388 else
389 err = OCSD_ERR_MEM; // wrong type of object - treat as mem error
390
391 if(err != OCSD_OK)
392 TrcMemAccFactory::DestroyAccessor(p_accessor);
393 }
394 return err;
395 }
396
addCallbackMemAcc(const ocsd_vaddr_t st_address,const ocsd_vaddr_t en_address,const ocsd_mem_space_acc_t mem_space,Fn_MemAcc_CB p_cb_func,const void * p_context)397 ocsd_err_t DecodeTree::addCallbackMemAcc(const ocsd_vaddr_t st_address, const ocsd_vaddr_t en_address, const ocsd_mem_space_acc_t mem_space, Fn_MemAcc_CB p_cb_func, const void *p_context)
398 {
399 return initCallbackMemAcc(st_address, en_address, mem_space, (void *)p_cb_func, false, p_context);
400 }
401
addCallbackIDMemAcc(const ocsd_vaddr_t st_address,const ocsd_vaddr_t en_address,const ocsd_mem_space_acc_t mem_space,Fn_MemAccID_CB p_cb_func,const void * p_context)402 ocsd_err_t DecodeTree::addCallbackIDMemAcc(const ocsd_vaddr_t st_address, const ocsd_vaddr_t en_address, const ocsd_mem_space_acc_t mem_space, Fn_MemAccID_CB p_cb_func, const void *p_context)
403 {
404 return initCallbackMemAcc(st_address, en_address, mem_space, (void *)p_cb_func, true, p_context);
405 }
406
removeMemAccByAddress(const ocsd_vaddr_t address,const ocsd_mem_space_acc_t mem_space)407 ocsd_err_t DecodeTree::removeMemAccByAddress(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space)
408 {
409 if(!hasMemAccMapper())
410 return OCSD_ERR_NOT_INIT;
411 return m_default_mapper->RemoveAccessorByAddress(address,mem_space,0);
412 }
413
createDecoder(const std::string & decoderName,const int createFlags,const CSConfig * pConfig)414 ocsd_err_t DecodeTree::createDecoder(const std::string &decoderName, const int createFlags, const CSConfig *pConfig)
415 {
416 ocsd_err_t err = OCSD_OK;
417 IDecoderMngr *pDecoderMngr = 0;
418 TraceComponent *pTraceComp = 0;
419 int crtFlags = createFlags;
420
421 uint8_t CSID = 0; // default for single stream decoder (no deformatter) - we ignore the ID
422 if(usingFormatter())
423 {
424 CSID = pConfig->getTraceID();
425 crtFlags |= OCSD_CREATE_FLG_INST_ID;
426 }
427
428 // create the decode element to attach to the channel.
429 if((err = createDecodeElement(CSID)) != OCSD_OK)
430 return err;
431
432 // get the libary decoder register.
433 OcsdLibDcdRegister * lib_reg = OcsdLibDcdRegister::getDecoderRegister();
434 if(lib_reg == 0)
435 return OCSD_ERR_NOT_INIT;
436
437 // find the named decoder
438 if((err = lib_reg->getDecoderMngrByName(decoderName,&pDecoderMngr)) != OCSD_OK)
439 return err;
440
441 // got the decoder...
442 if((err = pDecoderMngr->createDecoder(crtFlags,(int)CSID,pConfig,&pTraceComp)) != OCSD_OK)
443 return err;
444
445 m_decode_elements[CSID]->SetDecoderElement(decoderName, pDecoderMngr, pTraceComp, true);
446
447 // always attach an error logger
448 if(err == OCSD_OK)
449 err = pDecoderMngr->attachErrorLogger(pTraceComp,DecodeTree::s_i_error_logger);
450
451 // if we created a packet decoder it may need additional components.
452 if(crtFlags & OCSD_CREATE_FLG_FULL_DECODER)
453 {
454 if(m_i_instr_decode && (err == OCSD_OK))
455 err = pDecoderMngr->attachInstrDecoder(pTraceComp,m_i_instr_decode);
456
457 if(err == OCSD_ERR_DCD_INTERFACE_UNUSED) // ignore if instruction decoder refused
458 err = OCSD_OK;
459
460 if(m_i_mem_access && (err == OCSD_OK))
461 err = pDecoderMngr->attachMemAccessor(pTraceComp,m_i_mem_access);
462
463 if(err == OCSD_ERR_DCD_INTERFACE_UNUSED) // ignore if mem accessor refused
464 err = OCSD_OK;
465
466 if( m_i_gen_elem_out && (err == OCSD_OK))
467 err = pDecoderMngr->attachOutputSink(pTraceComp,m_i_gen_elem_out);
468 }
469
470 // finally attach the packet processor input to the demux output channel
471 if(err == OCSD_OK)
472 {
473 ITrcDataIn *pDataIn = 0;
474 if((err = pDecoderMngr->getDataInputI(pTraceComp,&pDataIn)) == OCSD_OK)
475 {
476 // got the interface -> attach to demux, or direct to input of decode tree
477 if(usingFormatter())
478 err = m_frame_deformatter_root->getIDStreamAttachPt(CSID)->attach(pDataIn);
479 else
480 m_i_decoder_root = pDataIn;
481 }
482 }
483
484 if(err != OCSD_OK)
485 {
486 destroyDecodeElement(CSID); // will destroy decoder as well.
487 }
488 return err;
489 }
490
removeDecoder(const uint8_t CSID)491 ocsd_err_t DecodeTree::removeDecoder(const uint8_t CSID)
492 {
493 ocsd_err_t err = OCSD_OK;
494 uint8_t localID = CSID;
495 if(!usingFormatter())
496 localID = 0;
497
498 if(usingFormatter() && !OCSD_IS_VALID_CS_SRC_ID(CSID))
499 err = OCSD_ERR_INVALID_ID;
500 else
501 {
502 destroyDecodeElement(localID);
503 }
504 return err;
505 }
506
getDecoderStats(const uint8_t CSID,ocsd_decode_stats_t ** p_stats_block)507 ocsd_err_t DecodeTree::getDecoderStats(const uint8_t CSID, ocsd_decode_stats_t **p_stats_block)
508 {
509 ocsd_err_t err = OCSD_OK;
510 TrcPktProcI *pPktProc = getPktProcI(CSID);
511 if (!pPktProc)
512 return OCSD_ERR_INVALID_PARAM_VAL;
513 err = pPktProc->getStatsBlock(p_stats_block);
514 if (err == OCSD_OK) {
515 // copy in the global demux stats.
516 (*p_stats_block)->demux.frame_bytes = m_demux_stats.frame_bytes;
517 (*p_stats_block)->demux.no_id_bytes = m_demux_stats.no_id_bytes;
518 (*p_stats_block)->demux.valid_id_bytes = m_demux_stats.valid_id_bytes;
519 (*p_stats_block)->demux.unknown_id_bytes = m_demux_stats.unknown_id_bytes;
520 (*p_stats_block)->demux.reserved_id_bytes = m_demux_stats.reserved_id_bytes;
521 }
522 return err;
523 }
524
resetDecoderStats(const uint8_t CSID)525 ocsd_err_t DecodeTree::resetDecoderStats(const uint8_t CSID)
526 {
527 TrcPktProcI *pPktProc = getPktProcI(CSID);
528 if (!pPktProc)
529 return OCSD_ERR_INVALID_PARAM_VAL;
530 pPktProc->resetStats();
531
532 // reset the global demux stats.
533 m_demux_stats.frame_bytes = 0;
534 m_demux_stats.no_id_bytes = 0;
535 m_demux_stats.valid_id_bytes = 0;
536 m_demux_stats.unknown_id_bytes = 0;
537 m_demux_stats.reserved_id_bytes = 0;
538 return OCSD_OK;
539 }
540
getPktProcI(const uint8_t CSID)541 TrcPktProcI *DecodeTree::getPktProcI(const uint8_t CSID)
542 {
543 TrcPktProcI *pPktProc = 0;
544 TraceComponent *pComp, *pAssoc;
545 DecodeTreeElement *pElem = getDecoderElement(CSID);
546
547 if (pElem)
548 {
549 pComp = pElem->getDecoderHandle();
550 if (pComp)
551 {
552 /* if this is a full decoder then the associated component is the packet processor */
553 pAssoc = pComp->getAssocComponent();
554 if (pAssoc)
555 pPktProc = dynamic_cast<TrcPktProcI *>(pAssoc);
556 else
557 pPktProc = dynamic_cast<TrcPktProcI *>(pComp);
558 }
559 }
560 return pPktProc;
561 }
562
getDecoderElement(const uint8_t CSID) const563 DecodeTreeElement * DecodeTree::getDecoderElement(const uint8_t CSID) const
564 {
565 DecodeTreeElement *ret_elem = 0;
566 if(usingFormatter() && OCSD_IS_VALID_CS_SRC_ID(CSID))
567 {
568 ret_elem = m_decode_elements[CSID];
569 }
570 else
571 ret_elem = m_decode_elements[0]; // ID 0 is used if single leaf tree.
572 return ret_elem;
573 }
574
getFirstElement(uint8_t & elemID)575 DecodeTreeElement *DecodeTree::getFirstElement(uint8_t &elemID)
576 {
577 m_decode_elem_iter = 0;
578 return getNextElement(elemID);
579 }
580
getNextElement(uint8_t & elemID)581 DecodeTreeElement *DecodeTree::getNextElement(uint8_t &elemID)
582 {
583 DecodeTreeElement *ret_elem = 0;
584
585 if(m_decode_elem_iter < 0x80)
586 {
587 // find a none zero entry or end of range
588 while((m_decode_elem_iter < 0x80) && (m_decode_elements[m_decode_elem_iter] == 0))
589 m_decode_elem_iter++;
590
591 // return entry unless end of range
592 if(m_decode_elem_iter < 0x80)
593 {
594 ret_elem = m_decode_elements[m_decode_elem_iter];
595 elemID = m_decode_elem_iter;
596 m_decode_elem_iter++;
597 }
598 }
599 return ret_elem;
600 }
601
initialise(const ocsd_dcd_tree_src_t type,uint32_t formatterCfgFlags)602 bool DecodeTree::initialise(const ocsd_dcd_tree_src_t type, uint32_t formatterCfgFlags)
603 {
604 ocsd_err_t err;
605 m_dcd_tree_type = type;
606 if(type == OCSD_TRC_SRC_FRAME_FORMATTED)
607 {
608 // frame formatted - we want to create the deformatter and hook it up
609 m_frame_deformatter_root = new (std::nothrow) TraceFormatterFrameDecoder();
610 if(m_frame_deformatter_root)
611 {
612 if (m_frame_deformatter_root->Init() != OCSD_OK)
613 return false;
614 m_frame_deformatter_root->getErrLogAttachPt()->attach(DecodeTree::s_i_error_logger);
615 err = m_frame_deformatter_root->Configure(formatterCfgFlags);
616 if (err != OCSD_OK)
617 return false;
618 m_i_decoder_root = dynamic_cast<ITrcDataIn*>(m_frame_deformatter_root);
619 m_frame_deformatter_root->SetDemuxStatsBlock(&m_demux_stats);
620 }
621 else
622 return false;
623 }
624 return true;
625 }
626
setSingleRoot(TrcPktProcI * pComp)627 void DecodeTree::setSingleRoot(TrcPktProcI *pComp)
628 {
629 m_i_decoder_root = static_cast<ITrcDataIn*>(pComp);
630 }
631
createDecodeElement(const uint8_t CSID)632 ocsd_err_t DecodeTree::createDecodeElement(const uint8_t CSID)
633 {
634 ocsd_err_t err = OCSD_ERR_INVALID_ID;
635 if(CSID < 0x80)
636 {
637 if(m_decode_elements[CSID] == 0)
638 {
639 m_decode_elements[CSID] = new (std::nothrow) DecodeTreeElement();
640 if(m_decode_elements[CSID] == 0)
641 err = OCSD_ERR_MEM;
642 else
643 err = OCSD_OK;
644 }
645 else
646 err = OCSD_ERR_ATTACH_TOO_MANY;
647 }
648 return err;
649 }
650
destroyDecodeElement(const uint8_t CSID)651 void DecodeTree::destroyDecodeElement(const uint8_t CSID)
652 {
653 if(CSID < 0x80)
654 {
655 if(m_decode_elements[CSID] != 0)
656 {
657 m_decode_elements[CSID]->DestroyElem();
658 delete m_decode_elements[CSID];
659 m_decode_elements[CSID] = 0;
660 }
661 }
662 }
663
setIDFilter(std::vector<uint8_t> & ids)664 ocsd_err_t DecodeTree::setIDFilter(std::vector<uint8_t> &ids)
665 {
666 ocsd_err_t err = OCSD_ERR_DCDT_NO_FORMATTER;
667 if(usingFormatter())
668 {
669 err = m_frame_deformatter_root->OutputFilterAllIDs(false);
670 if(err == OCSD_OK)
671 err = m_frame_deformatter_root->OutputFilterIDs(ids,true);
672 }
673 return err;
674 }
675
clearIDFilter()676 ocsd_err_t DecodeTree::clearIDFilter()
677 {
678 ocsd_err_t err = OCSD_ERR_DCDT_NO_FORMATTER;
679 if(usingFormatter())
680 {
681 err = m_frame_deformatter_root->OutputFilterAllIDs(true);
682 }
683 return err;
684 }
685
686 /** add a protocol packet printer */
addPacketPrinter(uint8_t CSID,bool bMonitor,ItemPrinter ** ppPrinter)687 ocsd_err_t DecodeTree::addPacketPrinter(uint8_t CSID, bool bMonitor, ItemPrinter **ppPrinter)
688 {
689 ocsd_err_t err = OCSD_ERR_INVALID_PARAM_VAL;
690 DecodeTreeElement *pElement = getDecoderElement(CSID);
691 if (pElement)
692 {
693 ocsd_trace_protocol_t protocol = pElement->getProtocol();
694 ItemPrinter *pPrinter;
695
696 pPrinter = PktPrinterFact::createProtocolPrinter(getPrinterList(), protocol, CSID);
697 if (pPrinter)
698 {
699 pPrinter->setMessageLogger(getCurrentErrorLogI()->getOutputLogger());
700 switch (protocol)
701 {
702 case OCSD_PROTOCOL_ETMV4I:
703 case OCSD_PROTOCOL_ETE:
704 {
705 PacketPrinter<EtmV4ITrcPacket> *pTPrinter = dynamic_cast<PacketPrinter<EtmV4ITrcPacket> *>(pPrinter);
706 if (bMonitor)
707 err = pElement->getDecoderMngr()->attachPktMonitor(pElement->getDecoderHandle(), (IPktRawDataMon<EtmV4ITrcPacket> *)pTPrinter);
708 else
709 err = pElement->getDecoderMngr()->attachPktSink(pElement->getDecoderHandle(), (IPktDataIn<EtmV4ITrcPacket> *)pTPrinter);
710 }
711 break;
712
713 case OCSD_PROTOCOL_ETMV3:
714 {
715 PacketPrinter<EtmV3TrcPacket> *pTPrinter = dynamic_cast<PacketPrinter<EtmV3TrcPacket> *>(pPrinter);
716 if (bMonitor)
717 err = pElement->getDecoderMngr()->attachPktMonitor(pElement->getDecoderHandle(), (IPktRawDataMon<EtmV3TrcPacket> *)pTPrinter);
718 else
719 err = pElement->getDecoderMngr()->attachPktSink(pElement->getDecoderHandle(), (IPktDataIn<EtmV3TrcPacket> *)pTPrinter);
720 }
721 break;
722
723 case OCSD_PROTOCOL_PTM:
724 {
725 PacketPrinter<PtmTrcPacket> *pTPrinter = dynamic_cast<PacketPrinter<PtmTrcPacket> *>(pPrinter);
726 if (bMonitor)
727 err = pElement->getDecoderMngr()->attachPktMonitor(pElement->getDecoderHandle(), (IPktRawDataMon<PtmTrcPacket> *)pTPrinter);
728 else
729 err = pElement->getDecoderMngr()->attachPktSink(pElement->getDecoderHandle(), (IPktDataIn<PtmTrcPacket> *)pTPrinter);
730 }
731 break;
732
733 case OCSD_PROTOCOL_STM:
734 {
735 PacketPrinter<StmTrcPacket> *pTPrinter = dynamic_cast<PacketPrinter<StmTrcPacket> *>(pPrinter);
736 if (bMonitor)
737 err = pElement->getDecoderMngr()->attachPktMonitor(pElement->getDecoderHandle(), (IPktRawDataMon<StmTrcPacket> *)pTPrinter);
738 else
739 err = pElement->getDecoderMngr()->attachPktSink(pElement->getDecoderHandle(), (IPktDataIn<StmTrcPacket> *)pTPrinter);
740 }
741 break;
742
743 default:
744 err = OCSD_ERR_NO_PROTOCOL;
745 break;
746 }
747
748 if (err == OCSD_OK)
749 {
750 if (ppPrinter)
751 *ppPrinter = pPrinter;
752 }
753 else
754 PktPrinterFact::destroyPrinter(getPrinterList(), pPrinter);
755 }
756 }
757 return err;
758 }
759
760 /** add a raw frame printer */
addRawFramePrinter(RawFramePrinter ** ppPrinter,uint32_t flags)761 ocsd_err_t DecodeTree::addRawFramePrinter(RawFramePrinter **ppPrinter, uint32_t flags)
762 {
763 ocsd_err_t err = OCSD_ERR_MEM;
764 RawFramePrinter *pPrinter = PktPrinterFact::createRawFramePrinter(getPrinterList());
765 if (pPrinter)
766 {
767 pPrinter->setMessageLogger((DecodeTree::getCurrentErrorLogI()->getOutputLogger()));
768 TraceFormatterFrameDecoder *pFrameDecoder = getFrameDeformatter();
769 uint32_t cfgFlags = pFrameDecoder->getConfigFlags();
770 cfgFlags |= ((uint32_t)flags & (OCSD_DFRMTR_PACKED_RAW_OUT | OCSD_DFRMTR_UNPACKED_RAW_OUT));
771 pFrameDecoder->Configure(cfgFlags);
772 err = pFrameDecoder->getTrcRawFrameAttachPt()->attach(pPrinter);
773 if (ppPrinter && (err==OCSD_OK))
774 *ppPrinter = pPrinter;
775 }
776 return err;
777 }
778
779 /** add a generic element output printer */
addGenElemPrinter(TrcGenericElementPrinter ** ppPrinter)780 ocsd_err_t DecodeTree::addGenElemPrinter(TrcGenericElementPrinter **ppPrinter)
781 {
782 ocsd_err_t err = OCSD_ERR_MEM;
783 TrcGenericElementPrinter *pPrinter = PktPrinterFact::createGenElemPrinter(getPrinterList());
784 if (pPrinter)
785 {
786 pPrinter->setMessageLogger((DecodeTree::getCurrentErrorLogI()->getOutputLogger()));
787 setGenTraceElemOutI(pPrinter);
788 err = OCSD_OK;
789 if (ppPrinter)
790 *ppPrinter = pPrinter;
791 }
792 return err;
793
794 }
795
796 /* End of File ocsd_dcd_tree.cpp */
797