Added bash scripts to setup build and test environment variables required when testing the library with perf report and perf script.

Updated HOWTO.md to describe the use of these scripts. Adjust for latest opencsd-perf branch.

Signed-off-by: Mike Leach mike.leach@linaro.org --- HOWTO.md | 70 ++++++++++++++++++---- .../tests/perf-test-scripts/perf-setup-env.bash | 42 +++++++++++++ .../tests/perf-test-scripts/perf-test-report.bash | 14 +++++ .../tests/perf-test-scripts/perf-test-script.bash | 11 ++++ 4 files changed, 124 insertions(+), 13 deletions(-) create mode 100755 decoder/tests/perf-test-scripts/perf-setup-env.bash create mode 100755 decoder/tests/perf-test-scripts/perf-test-report.bash create mode 100755 decoder/tests/perf-test-scripts/perf-test-script.bash

diff --git a/HOWTO.md b/HOWTO.md index ad19e9e..6d3cde3 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -8,7 +8,7 @@ library to collect and extract program flow traces generated by the CoreSight IP blocks on a Linux system. The examples have been generated using an aarch64 Juno-r0 platform. All information is considered accurate and tested using library branches `opencsd-0v002` and `opencsd-0v003` (decode library only) -and the latest perf branch `perf-opencsd-4.7-rc4` (decode library + perf tools) +and the latest perf branch `perf-opencsd-4.7` (decode library + perf tools) on the [OpenCSD github repository][1].

@@ -17,7 +17,7 @@ On Target Trace Acquisition - Perf Record

All the enhancement to the Perf tools that support the new `cs_etm` pmu have not been upstreamed yet. To get the required functionality branch -`perf-opencsd-4.7-rc4` needs to be downloaded to the target system where +`perf-opencsd-4.7` needs to be downloaded to the target system where traces are to be collected. This branch is an upstream v4.7-rc4 kernel supplemented with modifications to the CoreSight framework and drivers to be usable by the Perf core. The remaining out of tree patches are being @@ -163,14 +163,14 @@ the host's (which has nothing to do with the target) architecture: Off Target Perf Tools Compilation --------------------------------- As stated above not all the pieces of the solution have been upstreamed. To -get all the components branch `perf-opencsd-4.7-rc4` needs to be +get all the components branch `perf-opencsd-4.7` needs to be obtained:

- linaro@t430:~/linaro/coresight$ git clone -b perf-opencsd-4.7-rc4 https://github.com/Linaro/OpenCSD.git perf-opencsd-4.7-rc4 + linaro@t430:~/linaro/coresight$ git clone -b perf-opencsd-4.7 https://github.com/Linaro/OpenCSD.git perf-opencsd-4.7 ... ...

- linaro@t430:~/linaro/coresight$ ls perf-opencsd-4.7-rc4/ + linaro@t430:~/linaro/coresight$ ls perf-opencsd-4.7/ arch certs CREDITS Documentation firmware include ipc Kconfig lib Makefile net REPORTING-BUGS scripts sound usr block COPYING crypto drivers fs init Kbuild kernel MAINTAINERS mm README samples security tools virt

@@ -179,12 +179,14 @@ variable telling the build scripts where to find the library is needed. If the `CSTRACE_PATH` variable is not defined the compilation will still be successful, but handling of CoreSight trace data won't be supported.

- linaro@t430:~/linaro/coresight$ cd perf-opencsd-4.7-rc4 - linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ export CSTRACE_PATH=~/linaro/coresight/opencsd-0v003/decoder - linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ make -C tools/perf +**See perf-test-scripts below for assistance in creating a build and test enviroment.** + + linaro@t430:~/linaro/coresight$ cd perf-opencsd-4.7 + linaro@t430:~/linaro/coresight/perf-opencsd-4.7$ export CSTRACE_PATH=~/linaro/coresight/opencsd-0v003/decoder + linaro@t430:~/linaro/coresight/perf-opencsd-4.7$ make -C tools/perf ... ... - linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ ls -l tools/perf/perf + linaro@t430:~/linaro/coresight/perf-opencsd-4.7$ ls -l tools/perf/perf -rwxrwxr-x 1 linaro linaro 6276360 Mar 3 10:05 tools/perf/perf

@@ -224,7 +226,7 @@ to be sure everything is clean. linaro@t430:~/linaro/coresight/feb24$ rm -rf ~/.debug linaro@t430:~/linaro/coresight/feb24$ cp -dpR .debug ~/ linaro@t430:~/linaro/coresight/feb24$ export LD_LIBRARY_PATH=~/linaro/coresight/opencsd-0v003/decoder/lib/linux64/dbg/ - linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc4/tools/perf/perf report --stdio + linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7/tools/perf/perf report --stdio

# To display the perf.data header info, please use --header/--header-only options. # @@ -268,7 +270,7 @@ to be sure everything is clean.

Additional data can be obtained, which contains a dump of the trace packets received using the command

- mjl@ubuntu-vbox:./perf-opencsd-4.7-rc4/coresight/tools/perf/perf report --stdio --dump + mjl@ubuntu-vbox:./perf-opencsd-4.7/coresight/tools/perf/perf report --stdio --dump

resulting a large amount of data, trace looking like:-

@@ -317,10 +319,10 @@ Trace Decoding with Perf Script Working with perf scripts needs more command line options but yields interesting results.

- linaro@t430:~/linaro/coresight/feb24$ export EXEC_PATH=/home/linaro/coresight/perf-opencsd-4.7-rc4/tools/perf/ + linaro@t430:~/linaro/coresight/feb24$ export EXEC_PATH=/home/linaro/coresight/perf-opencsd-4.7/tools/perf/ linaro@t430:~/linaro/coresight/feb24$ export SCRIPT_PATH=$EXEC_PATH/scripts/python/ linaro@t430:~/linaro/coresight/feb24$ export XTOOL_PATH=/your/aarch64/toolchain/path/bin/ - linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc4/tools/perf/perf --exec-path=${EXEC_PATH} script --script=python:${SCRIPT_PATH}/cs-trace-disasm.py -- -d ${XTOOL_PATH}/aarch64-linux-gnu-objdump + linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7/tools/perf/perf --exec-path=${EXEC_PATH} script --script=python:${SCRIPT_PATH}/cs-trace-disasm.py -- -d ${XTOOL_PATH}/aarch64-linux-gnu-objdump

7f89f24d80: 910003e0 mov x0, sp 7f89f24d84: 94000d53 bl 7f89f282d0 <free@plt+0x3790> @@ -346,6 +348,48 @@ interesting results. 7f89f28304: eb01001f cmp x0, x1 7f89f28308: 54ffffc1 b.ne 7f89f28300 <free@plt+0x37c0>

+Perf Test Environment Scripts +----------------------------- + +The decoder library comes with a number of `bash` scripts that ease the setting up of the +offline build and test environment for perf, and executing tests. + +These scripts can be found in + + decoder/tests/perf-test-scripts + +There are three scripts provided: + +- `perf-setup-env.bash` : this sets up all the environment variables mentioned above. +- `perf-test-report.bash` : this runs `perf report` - using the environment setup by `perf-setup-env.bash` +- `perf-test-script.bash` : this runs `perf script` - using the environment setup by `perf-setup-env.bash` + +Use as follows:- + +1. Prior to building perf, edit `perf-setup-env.bash` to conform to your environment. There are four lines at the top of the file that will require editing. + +2. Execute the script using the command + + source perf-setup-env.bash + + This will set up all the environment variables mentioned in the sections on building and running + perf above, and these are used by the `perf-test...` scripts to run the tests. + +3. Build perf as described above. +4. Follow the instructions for downloading the test capture, or create a capture from your target. +5. Copy the `perf-test...` scripts into the capture data directory -> the one that contains `perf.data`. + +6. The scripts can now be run. No options are required for the default operation, but any command line options will be added to the perf report / perf script command line. + +e.g. + + ./perf-test-report.bash --dump + +will add the --dump option to the end of the command line and run + + ${PERF_EXEC_PATH}/perf report --stdio --dump + + The Linaro CoreSight Team ------------------------- - Mike Leach diff --git a/decoder/tests/perf-test-scripts/perf-setup-env.bash b/decoder/tests/perf-test-scripts/perf-setup-env.bash new file mode 100755 index 0000000..09431a7 --- /dev/null +++ b/decoder/tests/perf-test-scripts/perf-setup-env.bash @@ -0,0 +1,42 @@ +#!/bin/bash +# Script to set up the environment for testing perf with OpenCSD +# +# See HOWTO.md for details on how these environment variables should be set and used. +# +# to use this script:- +# +# source perf-setup-env.bash +# + +#------ User Edits Start ------- +# Edit as required for user system. + +# Root of the opencsd library project as cloned from github +export OPENCSD_ROOT=~/OpenCSD/opencsd-github/opencsd + +# the opencsd build library directory to use. +export OCSD_LIB_DIR=lib/linux64/rel + +# the root of the perf branch / perf dev-tree as checked out +export PERF_ROOT=~/work2/perf-opencsd/mp-4.7-rc4/coresight + +# the arm x-compiler toolchain path +export XTOOLS_PATH=~/work2/toolchain-aarch64/gcc-linaro-4.9-2015.05-1-rc1-x86_64_aarch64-linux-gnu/bin/ + +#------ User Edits End ------- + +# path to source/include root dir - used by perf build to +# include Opencsd decoder. +export CSTRACE_PATH=${OPENCSD_ROOT}/decoder + +# add library to lib path +if [ "${LD_LIBRARY_PATH}" == "" ]; then + export LD_LIBRARY_PATH=${CSTRACE_PATH}/${OCSD_LIB_DIR} +else + export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${CSTRACE_PATH}/${OCSD_LIB_DIR} +fi + +# perf script defines +export PERF_EXEC_PATH=${PERF_ROOT}/tools/perf +export PERF_SCRIPT_PATH=${PERF_EXEC_PATH}/scripts/python + diff --git a/decoder/tests/perf-test-scripts/perf-test-report.bash b/decoder/tests/perf-test-scripts/perf-test-report.bash new file mode 100755 index 0000000..f8d4e7e --- /dev/null +++ b/decoder/tests/perf-test-scripts/perf-test-report.bash @@ -0,0 +1,14 @@ +#!/bin/bash +# +# Script to run perf report +# +# Uses environment set up by perf-setup-env.bash. +# See HOWTO.md for further details. +# +# run from directory containing perf.data file. +# +# + +${PERF_EXEC_PATH}/perf report --stdio $* + + diff --git a/decoder/tests/perf-test-scripts/perf-test-script.bash b/decoder/tests/perf-test-scripts/perf-test-script.bash new file mode 100755 index 0000000..745e8b7 --- /dev/null +++ b/decoder/tests/perf-test-scripts/perf-test-script.bash @@ -0,0 +1,11 @@ +#!/bin/bash +# +# Script to run perf report +# +# Uses environment set up by perf-setup-env.bash. +# See HOWTO.md for further details. +# +# run from directory containing perf.data file. +# + +${PERF_EXEC_PATH}/perf --exec-path=${PERF_EXEC_PATH} script --script=python:${PERF_SCRIPT_PATH}/cs-trace-disasm.py -- -d ${XTOOLS_PATH}/aarch64-linux-gnu-objdump $*

Common base class added for all the trace component configuration classes. Allows for baseline features plus generic manipulation of configuration register objects.

Separate commit to prevent git errors in thinking this is a rename

ETMv3, PTM, STM and ETMv4 configuration register classes now use common base class.

C-API struct now a member, rather than a base of the classes to improve encapsulation / allow for common base.

Minor mods to decoder code where access functions were needed in place of previous direct struct manipulation.

Update handling of STM, ETMv4 and PTM config objects in test program to reflect the changes to this set of classes - config struct no longer a base.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/include/common/trc_cs_config.h | 56 +++++++++++ decoder/include/etmv3/trc_cmp_cfg_etmv3.h | 6 +- decoder/include/etmv4/trc_cmp_cfg_etmv4.h | 102 +++++++++++---------- decoder/include/ptm/trc_cmp_cfg_ptm.h | 51 +++++++---- decoder/include/stm/trc_cmp_cfg_stm.h | 55 +++++++---- decoder/source/etmv4/trc_cmp_cfg_etmv4.cpp | 34 +++---- decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp | 2 +- decoder/source/ptm/trc_cmp_cfg_ptm.cpp | 17 ++-- decoder/source/ptm/trc_pkt_decode_ptm.cpp | 4 +- .../snapshot_parser_lib/source/ss_to_dcdtree.cpp | 24 +++-- 10 files changed, 232 insertions(+), 119 deletions(-) create mode 100644 decoder/include/common/trc_cs_config.h

diff --git a/decoder/include/common/trc_cs_config.h b/decoder/include/common/trc_cs_config.h new file mode 100644 index 0000000..58398f7 --- /dev/null +++ b/decoder/include/common/trc_cs_config.h @@ -0,0 +1,56 @@ +/* + * \file trc_cs_config.h + * \brief OpenCSD : Trace component config base class. + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ +#ifndef ARM_TRC_CS_CONFIG_H_INCLUDED +#define ARM_TRC_CS_CONFIG_H_INCLUDED + + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/*! + * @class CSConfig : Base class for configuration data on CoreSight trace component. + * + * Defines common access functionality, common to all components. + * (e.g. trace ID). + * + */ +class CSConfig +{ +public: + CSConfig() {}; + virtual ~CSConfig() {}; + + virtual const uint8_t getTraceID() const = 0; //!< CoreSight Trace ID for this device. +}; + +#endif // ARM_TRC_CS_CONFIG_H_INCLUDED + +/* End of File trc_cs_config.h */ \ No newline at end of file diff --git a/decoder/include/etmv3/trc_cmp_cfg_etmv3.h b/decoder/include/etmv3/trc_cmp_cfg_etmv3.h index f2da178..509de20 100644 --- a/decoder/include/etmv3/trc_cmp_cfg_etmv3.h +++ b/decoder/include/etmv3/trc_cmp_cfg_etmv3.h @@ -37,6 +37,8 @@ #define ARM_TRC_CMP_CFG_ETMV3_H_INCLUDED

#include "trc_pkt_types_etmv3.h" +#include "common/trc_cs_config.h" +

/** @addtogroup ocsd_protocol_cfg @{*/ @@ -53,7 +55,7 @@ * Primarily inlined for efficient code. * */ -class EtmV3Config //: public ocsd_etmv3_cfg +class EtmV3Config : public CSConfig { public: EtmV3Config(); /**< Default constructor */ @@ -117,7 +119,7 @@ public: const bool isTSEnabled() const; //!< Timestamp trace is enabled. const bool TSPkt64() const; //!< timestamp packet is 64 bits in size.

- const uint8_t getTraceID() const; //!< CoreSight Trace ID for this device. + virtual const uint8_t getTraceID() const; //!< CoreSight Trace ID for this device.

const ocsd_arch_version_t getArchVersion() const; //!< architecture version const ocsd_core_profile_t getCoreProfile() const; //!< core profile. diff --git a/decoder/include/etmv4/trc_cmp_cfg_etmv4.h b/decoder/include/etmv4/trc_cmp_cfg_etmv4.h index 48bb1af..a3f8835 100644 --- a/decoder/include/etmv4/trc_cmp_cfg_etmv4.h +++ b/decoder/include/etmv4/trc_cmp_cfg_etmv4.h @@ -37,7 +37,7 @@ #define ARM_TRC_CMP_CFG_ETMV4_H_INCLUDED

#include "trc_pkt_types_etmv4.h" - +#include "common/trc_cs_config.h"

/** @addtogroup ocsd_protocol_cfg @@ -53,17 +53,25 @@ * Provides quick value interpretation methods for the ETMv4 config register values. * Primarily inlined for efficient code. */ -class EtmV4Config : public ocsd_etmv4_cfg +class EtmV4Config : public CSConfig // public ocsd_etmv4_cfg { public: EtmV4Config(); /**< Default constructor */ + EtmV4Config(const ocsd_etmv4_cfg *cfg_regs); ~EtmV4Config() {}; /**< Default destructor */

+// operations to convert to and from C-API structure + //! copy assignment operator for base structure into class. EtmV4Config & operator=(const ocsd_etmv4_cfg *p_cfg);

- const ocsd_core_profile_t &coreProfile() const { return core_prof; }; - const ocsd_arch_version_t &archVersion() const { return arch_ver; }; + //! cast operator returning struct const reference + operator const ocsd_etmv4_cfg &() const { return m_cfg; }; + //! cast operator returning struct const pointer + operator const ocsd_etmv4_cfg *() const { return &m_cfg; }; + + const ocsd_core_profile_t &coreProfile() const { return m_cfg.core_prof; }; + const ocsd_arch_version_t &archVersion() const { return m_cfg.arch_ver; };

/* idr 0 */ const bool LSasInstP0() const; @@ -120,7 +128,7 @@ public: const uint32_t CondKeyMaxIncr() const;

/* trace idr */ - const uint8_t getTraceID() const; + virtual const uint8_t getTraceID() const; //!< CoreSight Trace ID for this device.

/* config R */ const bool enabledDVTrace() const; @@ -171,47 +179,49 @@ private:

bool m_condTraceCalc; CondITrace_t m_CondTrace; + + ocsd_etmv4_cfg m_cfg; };

/* idr 0 */ inline const bool EtmV4Config::LSasInstP0() const { - return (bool)((reg_idr0 & 0x6) == 0x6); + return (bool)((m_cfg.reg_idr0 & 0x6) == 0x6); }

inline const bool EtmV4Config::hasDataTrace() const { - return (bool)((reg_idr0 & 0x18) == 0x18); + return (bool)((m_cfg.reg_idr0 & 0x18) == 0x18); }

inline const bool EtmV4Config::hasBranchBroadcast() const { - return (bool)((reg_idr0 & 0x20) == 0x20); + return (bool)((m_cfg.reg_idr0 & 0x20) == 0x20); }

inline const bool EtmV4Config::hasCondTrace() const { - return (bool)((reg_idr0 & 0x40) == 0x40); + return (bool)((m_cfg.reg_idr0 & 0x40) == 0x40); }

inline const bool EtmV4Config::hasCycleCountI() const { - return (bool)((reg_idr0 & 0x80) == 0x80); + return (bool)((m_cfg.reg_idr0 & 0x80) == 0x80); }

inline const bool EtmV4Config::hasRetStack() const { - return (bool)((reg_idr0 & 0x200) == 0x200); + return (bool)((m_cfg.reg_idr0 & 0x200) == 0x200); }

inline const uint8_t EtmV4Config::numEvents() const { - return ((reg_idr0 >> 10) & 0x3) + 1; + return ((m_cfg.reg_idr0 >> 10) & 0x3) + 1; }

inline const EtmV4Config::condType EtmV4Config::hasCondType() const { - return ((reg_idr0 & 0x3000) == 0x1000) ? EtmV4Config::COND_HAS_ASPR : EtmV4Config::COND_PASS_FAIL; + return ((m_cfg.reg_idr0 & 0x3000) == 0x1000) ? EtmV4Config::COND_HAS_ASPR : EtmV4Config::COND_PASS_FAIL; }

inline const EtmV4Config::QSuppType EtmV4Config::getQSuppType() @@ -234,12 +244,12 @@ inline const bool EtmV4Config::hasQFilter()

inline const bool EtmV4Config::hasTrcExcpData() const { - return (bool)((reg_idr0 & 0x20000) == 0x20000); + return (bool)((m_cfg.reg_idr0 & 0x20000) == 0x20000); }

inline const uint32_t EtmV4Config::TimeStampSize() const { - uint32_t tsSizeF = (reg_idr0 >> 24) & 0x1F; + uint32_t tsSizeF = (m_cfg.reg_idr0 >> 24) & 0x1F; if(tsSizeF == 0x6) return 48; if(tsSizeF == 0x8) @@ -249,30 +259,30 @@ inline const uint32_t EtmV4Config::TimeStampSize() const

inline const bool EtmV4Config::commitOpt1() const { - return (bool)((reg_idr0 & 0x20000000) == 0x20000000) && hasCycleCountI(); + return (bool)((m_cfg.reg_idr0 & 0x20000000) == 0x20000000) && hasCycleCountI(); }

/* idr 1 */ inline const uint8_t EtmV4Config::MajVersion() const { - return (uint8_t)((reg_idr1 >> 8) & 0xF); + return (uint8_t)((m_cfg.reg_idr1 >> 8) & 0xF); }

inline const uint8_t EtmV4Config::MinVersion() const { - return (uint8_t)((reg_idr1 >> 4) & 0xF); + return (uint8_t)((m_cfg.reg_idr1 >> 4) & 0xF); }

/* idr 2 */ inline const uint32_t EtmV4Config::iaSizeMax() const { - return ((reg_idr2 & 0x1F) == 0x8) ? 64 : 32; + return ((m_cfg.reg_idr2 & 0x1F) == 0x8) ? 64 : 32; }

inline const uint32_t EtmV4Config::cidSize() const { - return (((reg_idr2 >> 5) & 0x1F) == 0x4) ? 32 : 0; + return (((m_cfg.reg_idr2 >> 5) & 0x1F) == 0x4) ? 32 : 0; }

inline const uint32_t EtmV4Config::vmidSize() @@ -286,81 +296,81 @@ inline const uint32_t EtmV4Config::vmidSize()

inline const uint32_t EtmV4Config::daSize() const { - uint32_t daSizeF = ((reg_idr2 >> 15) & 0x1F); + uint32_t daSizeF = ((m_cfg.reg_idr2 >> 15) & 0x1F); if(daSizeF) - return (((reg_idr2 >> 15) & 0x1F) == 0x8) ? 64 : 32; + return (((m_cfg.reg_idr2 >> 15) & 0x1F) == 0x8) ? 64 : 32; return 0; }

inline const uint32_t EtmV4Config::dvSize() const { - uint32_t dvSizeF = ((reg_idr2 >> 20) & 0x1F); + uint32_t dvSizeF = ((m_cfg.reg_idr2 >> 20) & 0x1F); if(dvSizeF) - return (((reg_idr2 >> 20) & 0x1F) == 0x8) ? 64 : 32; + return (((m_cfg.reg_idr2 >> 20) & 0x1F) == 0x8) ? 64 : 32; return 0; }

inline const uint32_t EtmV4Config::ccSize() const { - return ((reg_idr2 >> 25) & 0xF) + 12; + return ((m_cfg.reg_idr2 >> 25) & 0xF) + 12; }

inline const bool EtmV4Config::vmidOpt() const { - return (bool)((reg_idr2 & 0x20000000) == 0x20000000) && (MinVersion() > 0); + return (bool)((m_cfg.reg_idr2 & 0x20000000) == 0x20000000) && (MinVersion() > 0); }

/* id regs 8-13*/

inline const uint32_t EtmV4Config::MaxSpecDepth() const { - return reg_idr8; + return m_cfg.reg_idr8; }

inline const uint32_t EtmV4Config::P0_Key_Max() const { - return (reg_idr9 == 0) ? 1 : reg_idr9; + return (m_cfg.reg_idr9 == 0) ? 1 : m_cfg.reg_idr9; }

inline const uint32_t EtmV4Config::P1_Key_Max() const { - return reg_idr10; + return m_cfg.reg_idr10; }

inline const uint32_t EtmV4Config::P1_Spcl_Key_Max() const { - return reg_idr11; + return m_cfg.reg_idr11; }

inline const uint32_t EtmV4Config::CondKeyMax() const { - return reg_idr12; + return m_cfg.reg_idr12; }

inline const uint32_t EtmV4Config::CondSpecKeyMax() const { - return reg_idr13; + return m_cfg.reg_idr13; }

inline const uint32_t EtmV4Config::CondKeyMaxIncr() const { - return reg_idr12 - reg_idr13; + return m_cfg.reg_idr12 - m_cfg.reg_idr13; }

inline const uint8_t EtmV4Config::getTraceID() const { - return (uint8_t)(reg_traceidr & 0x7F); + return (uint8_t)(m_cfg.reg_traceidr & 0x7F); }

/* config R */ inline const bool EtmV4Config::enabledDVTrace() const { - return hasDataTrace() && enabledLSP0Trace() && ((reg_configr & (0x1 << 17)) != 0); + return hasDataTrace() && enabledLSP0Trace() && ((m_cfg.reg_configr & (0x1 << 17)) != 0); }

inline const bool EtmV4Config::enabledDATrace() const { - return hasDataTrace() && enabledLSP0Trace() && ((reg_configr & (0x1 << 16)) != 0); + return hasDataTrace() && enabledLSP0Trace() && ((m_cfg.reg_configr & (0x1 << 16)) != 0); }

inline const bool EtmV4Config::enabledDataTrace() const @@ -370,39 +380,39 @@ inline const bool EtmV4Config::enabledDataTrace() const

inline const bool EtmV4Config::enabledLSP0Trace() const { - return ((reg_configr & 0x6) != 0); + return ((m_cfg.reg_configr & 0x6) != 0); }

inline const EtmV4Config::LSP0_t EtmV4Config::LSP0Type() const { - return (LSP0_t)((reg_configr & 0x6) >> 1); + return (LSP0_t)((m_cfg.reg_configr & 0x6) >> 1); }

inline const bool EtmV4Config::enabledBrBroad() const { - return ((reg_configr & (0x1 << 3)) != 0); + return ((m_cfg.reg_configr & (0x1 << 3)) != 0); }

inline const bool EtmV4Config::enabledCCI() const { - return ((reg_configr & (0x1 << 4)) != 0); + return ((m_cfg.reg_configr & (0x1 << 4)) != 0); }

inline const bool EtmV4Config::enabledCID() const { - return ((reg_configr & (0x1 << 6)) != 0); + return ((m_cfg.reg_configr & (0x1 << 6)) != 0); }

inline const bool EtmV4Config::enabledVMID() const { - return ((reg_configr & (0x1 << 7)) != 0); + return ((m_cfg.reg_configr & (0x1 << 7)) != 0); }

inline const EtmV4Config::CondITrace_t EtmV4Config::enabledCondITrace() { if(!m_condTraceCalc) { - switch((reg_configr >> 8) & 0x7) + switch((m_cfg.reg_configr >> 8) & 0x7) { default: case 0: m_CondTrace = COND_TR_DIS; break; @@ -418,17 +428,17 @@ inline const EtmV4Config::CondITrace_t EtmV4Config::enabledCondITrace()

inline const bool EtmV4Config::enabledTS() const { - return ((reg_configr & (0x1 << 11)) != 0); + return ((m_cfg.reg_configr & (0x1 << 11)) != 0); }

inline const bool EtmV4Config::enabledRetStack() const { - return ((reg_configr & (0x1 << 12)) != 0); + return ((m_cfg.reg_configr & (0x1 << 12)) != 0); }

inline const bool EtmV4Config::enabledQE() const { - return ((reg_configr & (0x3 << 13)) != 0); + return ((m_cfg.reg_configr & (0x3 << 13)) != 0); }

/** @}*/ diff --git a/decoder/include/ptm/trc_cmp_cfg_ptm.h b/decoder/include/ptm/trc_cmp_cfg_ptm.h index e77f6aa..5a4dae2 100644 --- a/decoder/include/ptm/trc_cmp_cfg_ptm.h +++ b/decoder/include/ptm/trc_cmp_cfg_ptm.h @@ -37,6 +37,7 @@ #define ARM_TRC_CMP_CFG_PTM_H_INCLUDED

#include "trc_pkt_types_ptm.h" +#include "common/trc_cs_config.h"

/** @defgroup ocsd_protocol_cfg OpenCSD Library : Protcol Generator Configuration.

@@ -58,10 +59,11 @@ * Provides quick value interpretation methods for the PTM config register values. * Primarily inlined for efficient code. */ -class PtmConfig : public ocsd_ptm_cfg +class PtmConfig : public CSConfig // public ocsd_ptm_cfg { public: PtmConfig(); /**< Default constructor */ + PtmConfig(const ocsd_ptm_cfg *cfg_regs); ~PtmConfig() {}; /**< Default destructor */

/* register bit constants. */ @@ -79,9 +81,18 @@ public: static const uint32_t CCER_TS_ENC_NAT = (0x1 << 28); static const uint32_t CCER_TS_64BIT = (0x1 << 29);

+// operations to convert to and from C-API structure + //! copy assignment operator for base structure into class. PtmConfig & operator=(const ocsd_ptm_cfg *p_cfg);

+ //! cast operator returning struct const reference + operator const ocsd_ptm_cfg &() const { return m_cfg; }; + //! cast operator returning struct const pointer + operator const ocsd_ptm_cfg *() const { return &m_cfg; }; + +// access functions + const bool enaBranchBCast() const; //!< Branch broadcast enabled. const bool enaCycleAcc() const; //!< cycle accurate tracing enabled.

@@ -102,7 +113,13 @@ public: const bool dmsbGenTS() const; //!< TS generated for DMB and DSB const bool dmsbWayPt() const; //!< DMB and DSB are waypoint instructions.

- const uint8_t getTraceID() const; //!< CoreSight Trace ID for this device. + virtual const uint8_t getTraceID() const; //!< CoreSight Trace ID for this device. + + const ocsd_core_profile_t &coreProfile() const { return m_cfg.core_prof; }; + const ocsd_arch_version_t &archVersion() const { return m_cfg.arch_ver; }; + +private: + ocsd_ptm_cfg m_cfg; };

/* inlines */ @@ -110,80 +127,80 @@ public: inline PtmConfig & PtmConfig::operator=(const ocsd_ptm_cfg *p_cfg) { // object of base class ocsd_ptm_cfg - *dynamic_cast<ocsd_ptm_cfg *>(this) = *p_cfg; + m_cfg = *p_cfg; return *this; }

inline const bool PtmConfig::enaBranchBCast() const { - return (bool)((reg_ctrl & CTRL_BRANCH_BCAST) != 0); + return (bool)((m_cfg.reg_ctrl & CTRL_BRANCH_BCAST) != 0); }

inline const bool PtmConfig::enaCycleAcc() const { - return (bool)((reg_ctrl & CTRL_CYCLEACC) != 0); + return (bool)((m_cfg.reg_ctrl & CTRL_CYCLEACC) != 0); }

inline const bool PtmConfig::enaRetStack() const { - return (bool)((reg_ctrl & CTRL_RETSTACK_ENA) != 0); + return (bool)((m_cfg.reg_ctrl & CTRL_RETSTACK_ENA) != 0); }

inline const bool PtmConfig::hasRetStack() const { - return (bool)((reg_ccer & CCER_RESTACK_IMPL) != 0); + return (bool)((m_cfg.reg_ccer & CCER_RESTACK_IMPL) != 0); }

inline const int PtmConfig::MinorRev() const { - return ((int)reg_idr & 0xF0) >> 4; + return ((int)m_cfg.reg_idr & 0xF0) >> 4; }

inline const bool PtmConfig::hasTS() const { - return (bool)((reg_ccer & CCER_TS_IMPL) != 0); + return (bool)((m_cfg.reg_ccer & CCER_TS_IMPL) != 0); }

inline const bool PtmConfig::enaTS() const { - return (bool)((reg_ctrl & CTRL_TS_ENA) != 0); + return (bool)((m_cfg.reg_ctrl & CTRL_TS_ENA) != 0); }

inline const bool PtmConfig::TSPkt64() const { if(MinorRev() == 0) return false; - return (bool)((reg_ccer & CCER_TS_64BIT) != 0); + return (bool)((m_cfg.reg_ccer & CCER_TS_64BIT) != 0); }

inline const bool PtmConfig::TSBinEnc() const { if(MinorRev() == 0) return false; - return (bool)((reg_ccer & CCER_TS_ENC_NAT) != 0); + return (bool)((m_cfg.reg_ccer & CCER_TS_ENC_NAT) != 0); }

inline const bool PtmConfig::hasVirtExt() const { - return (bool)((reg_ccer & CCER_VIRTEXT) != 0); + return (bool)((m_cfg.reg_ccer & CCER_VIRTEXT) != 0); }

inline const bool PtmConfig::enaVMID() const { - return (bool)((reg_ctrl & CTRL_VMID_ENA) != 0); + return (bool)((m_cfg.reg_ctrl & CTRL_VMID_ENA) != 0); }

inline const bool PtmConfig::dmsbGenTS() const { - return (bool)((reg_ccer & CCER_TS_DMSB) != 0); + return (bool)((m_cfg.reg_ccer & CCER_TS_DMSB) != 0); }

inline const bool PtmConfig::dmsbWayPt() const { - return (bool)((reg_ccer & CCER_DMSB_WPT) != 0); + return (bool)((m_cfg.reg_ccer & CCER_DMSB_WPT) != 0); }

inline const uint8_t PtmConfig::getTraceID() const { - return (uint8_t)(reg_trc_id & 0x7F); + return (uint8_t)(m_cfg.reg_trc_id & 0x7F); }

/** @}*/ diff --git a/decoder/include/stm/trc_cmp_cfg_stm.h b/decoder/include/stm/trc_cmp_cfg_stm.h index dbef0eb..41003ec 100644 --- a/decoder/include/stm/trc_cmp_cfg_stm.h +++ b/decoder/include/stm/trc_cmp_cfg_stm.h @@ -36,6 +36,7 @@ #define ARM_TRC_CMP_CFG_STM_H_INCLUDED

#include "trc_pkt_types_stm.h" +#include "common/trc_cs_config.h"

/** @addtogroup ocsd_protocol_cfg @{*/ @@ -56,17 +57,26 @@ * * Can also be initialised with a fully populated ocsd_stm_cfg structure. */ -class STMConfig : public ocsd_stm_cfg +class STMConfig : public CSConfig // public ocsd_stm_cfg { public: STMConfig(); //!< Constructor - creates a default configuration + STMConfig(const ocsd_stm_cfg *cfg_regs); ~STMConfig() {};

+// operations to convert to and from C-API structure + STMConfig & operator=(const ocsd_stm_cfg *p_cfg); //!< set from full configuration structure. + //! cast operator returning struct const reference + operator const ocsd_stm_cfg &() const { return m_cfg; }; + //! cast operator returning struct const pointer + operator const ocsd_stm_cfg *() const { return &m_cfg; }; + +// access functions void setTraceID(const uint8_t traceID); //!< Set the CoreSight trace ID. void setHWTraceFeat(const hw_event_feat_t hw_feat); //!< set usage of STM HW event trace.

- const uint8_t getTraceID() const; //!< Get the CoreSight trace ID. + virtual const uint8_t getTraceID() const; //!< Get the CoreSight trace ID. const uint8_t getMaxMasterIdx() const; //!< Get the maximum master index const uint16_t getMaxChannelIdx() const; //!< Get the maximum channel index. const uint16_t getHWTraceMasterIdx() const; //!< Get the master used for HW event trace. @@ -74,22 +84,29 @@ public:

private: bool m_bHWTraceEn; + ocsd_stm_cfg m_cfg; };

inline STMConfig::STMConfig() { - reg_tcsr = 0; - reg_devid = 0xFF; // default to 256 masters. - reg_feat3r = 0x10000; // default to 65536 channels. - reg_feat1r = 0x0; - reg_hwev_mast = 0; // default hwtrace master = 0; - hw_event = HwEvent_Unknown_Disabled; // default to not present / disabled. + m_cfg.reg_tcsr = 0; + m_cfg.reg_devid = 0xFF; // default to 256 masters. + m_cfg.reg_feat3r = 0x10000; // default to 65536 channels. + m_cfg.reg_feat1r = 0x0; + m_cfg.reg_hwev_mast = 0; // default hwtrace master = 0; + m_cfg.hw_event = HwEvent_Unknown_Disabled; // default to not present / disabled. m_bHWTraceEn = false; }

+inline STMConfig::STMConfig(const ocsd_stm_cfg *cfg_regs) +{ + m_cfg = *cfg_regs; + setHWTraceFeat(m_cfg.hw_event); +} + inline STMConfig & STMConfig::operator=(const ocsd_stm_cfg *p_cfg) { - *dynamic_cast<ocsd_stm_cfg *>(this) = *p_cfg; + m_cfg = *p_cfg; setHWTraceFeat(p_cfg->hw_event); return *this; } @@ -97,36 +114,36 @@ inline STMConfig & STMConfig::operator=(const ocsd_stm_cfg *p_cfg) inline void STMConfig::setTraceID(const uint8_t traceID) { uint32_t IDmask = 0x007F0000; - reg_tcsr &= ~IDmask; - reg_tcsr |= (((uint32_t)traceID) << 16) & IDmask; + m_cfg.reg_tcsr &= ~IDmask; + m_cfg.reg_tcsr |= (((uint32_t)traceID) << 16) & IDmask; }

inline void STMConfig::setHWTraceFeat(const hw_event_feat_t hw_feat) { - hw_event = hw_feat; - m_bHWTraceEn = (hw_event == HwEvent_Enabled); - if(hw_event == HwEvent_UseRegisters) - m_bHWTraceEn = (((reg_feat1r & 0xC0000) == 0x80000) && ((reg_tcsr & 0x8) == 0x8)); + m_cfg.hw_event = hw_feat; + m_bHWTraceEn = (m_cfg.hw_event == HwEvent_Enabled); + if(m_cfg.hw_event == HwEvent_UseRegisters) + m_bHWTraceEn = (((m_cfg.reg_feat1r & 0xC0000) == 0x80000) && ((m_cfg.reg_tcsr & 0x8) == 0x8)); }

inline const uint8_t STMConfig::getTraceID() const { - return (uint8_t)((reg_tcsr >> 16) & 0x7F); + return (uint8_t)((m_cfg.reg_tcsr >> 16) & 0x7F); }

inline const uint8_t STMConfig::getMaxMasterIdx() const { - return (uint8_t)(reg_devid & 0xFF); + return (uint8_t)(m_cfg.reg_devid & 0xFF); }

inline const uint16_t STMConfig::getMaxChannelIdx() const { - return (uint16_t)(reg_feat3r - 1); + return (uint16_t)(m_cfg.reg_feat3r - 1); }

inline const uint16_t STMConfig::getHWTraceMasterIdx() const { - return (uint16_t)(reg_hwev_mast & 0xFFFF); + return (uint16_t)(m_cfg.reg_hwev_mast & 0xFFFF); }

inline bool STMConfig::getHWTraceEn() const diff --git a/decoder/source/etmv4/trc_cmp_cfg_etmv4.cpp b/decoder/source/etmv4/trc_cmp_cfg_etmv4.cpp index 214d149..5703406 100644 --- a/decoder/source/etmv4/trc_cmp_cfg_etmv4.cpp +++ b/decoder/source/etmv4/trc_cmp_cfg_etmv4.cpp @@ -36,26 +36,26 @@

EtmV4Config::EtmV4Config() { - reg_idr0 = 0x28000EA1; - reg_idr1 = 0x4100F403; - reg_idr2 = 0x00000488; - reg_idr8 = 0; - reg_idr9 = 0; - reg_idr10 = 0; - reg_idr11 = 0; - reg_idr12 = 0; - reg_idr13 = 0; - reg_configr = 0xC1; - reg_traceidr = 0; - arch_ver = ARCH_V7; - core_prof = profile_CortexA; + m_cfg.reg_idr0 = 0x28000EA1; + m_cfg.reg_idr1 = 0x4100F403; + m_cfg.reg_idr2 = 0x00000488; + m_cfg.reg_idr8 = 0; + m_cfg.reg_idr9 = 0; + m_cfg.reg_idr10 = 0; + m_cfg.reg_idr11 = 0; + m_cfg.reg_idr12 = 0; + m_cfg.reg_idr13 = 0; + m_cfg.reg_configr = 0xC1; + m_cfg.reg_traceidr = 0; + m_cfg.arch_ver = ARCH_V7; + m_cfg.core_prof = profile_CortexA;

PrivateInit(); }

EtmV4Config & EtmV4Config::operator=(const ocsd_etmv4_cfg *p_cfg) { - *dynamic_cast<ocsd_etmv4_cfg *>(this) = *p_cfg; + m_cfg = *p_cfg; PrivateInit(); return *this; } @@ -79,15 +79,15 @@ void EtmV4Config::CalcQSupp() Q_NO_ICOUNT_ONLY, Q_FULL }; - uint8_t Qsupp = (reg_idr0 >> 15) & 0x3; + uint8_t Qsupp = (m_cfg.reg_idr0 >> 15) & 0x3; m_QSuppType = qtypes[Qsupp]; - m_QSuppFilter = (bool)((reg_idr0 & 0x4000) == 0x4000) && (m_QSuppType != Q_NONE); + m_QSuppFilter = (bool)((m_cfg.reg_idr0 & 0x4000) == 0x4000) && (m_QSuppType != Q_NONE); m_QSuppCalc = true; }

void EtmV4Config::CalcVMIDSize() { - uint32_t vmidszF = (reg_idr2 >> 10) & 0x1F; + uint32_t vmidszF = (m_cfg.reg_idr2 >> 10) & 0x1F; if(vmidszF == 1) m_VMIDSize = 8; else if(MinVersion() > 0) diff --git a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp index 0bc2e59..8966504 100644 --- a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp +++ b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp @@ -515,7 +515,7 @@ void EtmV4IPktProcImpl::iPktException() uint16_t excep_type = (m_currPacketData[1] >> 1) & 0x1F; uint8_t addr_interp = (m_currPacketData[1] & 0x40) >> 5 | (m_currPacketData[1] & 0x1); uint8_t m_fault_pending = 0; - uint8_t m_type = (m_config.core_prof == profile_CortexM) ? 1 : 0; + uint8_t m_type = (m_config.coreProfile() == profile_CortexM) ? 1 : 0;

// extended exception packet (probably M class); if(m_currPacketData[1] & 0x80) diff --git a/decoder/source/ptm/trc_cmp_cfg_ptm.cpp b/decoder/source/ptm/trc_cmp_cfg_ptm.cpp index 8f51c2f..8028683 100644 --- a/decoder/source/ptm/trc_cmp_cfg_ptm.cpp +++ b/decoder/source/ptm/trc_cmp_cfg_ptm.cpp @@ -37,17 +37,22 @@ PtmConfig::PtmConfig() { // defaults set ETMv1.1, V7A - arch_ver = ARCH_V7; - core_prof = profile_CortexA; - reg_ccer = 0; - reg_idr = 0x4100F310; - reg_ctrl = 0; + m_cfg.arch_ver = ARCH_V7; + m_cfg.core_prof = profile_CortexA; + m_cfg.reg_ccer = 0; + m_cfg.reg_idr = 0x4100F310; + m_cfg.reg_ctrl = 0; +} + +PtmConfig::PtmConfig(const ocsd_ptm_cfg *cfg_regs) +{ + m_cfg = *cfg_regs; }

const int PtmConfig::CtxtIDBytes() const { int ctxtIdsizes[] = { 0, 1, 2, 4 }; - return ctxtIdsizes[(reg_ctrl >> 14) & 0x3]; + return ctxtIdsizes[(m_cfg.reg_ctrl >> 14) & 0x3]; }

diff --git a/decoder/source/ptm/trc_pkt_decode_ptm.cpp b/decoder/source/ptm/trc_pkt_decode_ptm.cpp index 9c5b16d..5381086 100644 --- a/decoder/source/ptm/trc_pkt_decode_ptm.cpp +++ b/decoder/source/ptm/trc_pkt_decode_ptm.cpp @@ -165,8 +165,8 @@ ocsd_err_t TrcPktDecodePtm::onProtocolConfig() m_CSID = m_config->getTraceID();

// config options affecting decode - m_instr_info.pe_type.profile = m_config->core_prof; - m_instr_info.pe_type.arch = m_config->arch_ver; + m_instr_info.pe_type.profile = m_config->coreProfile(); + m_instr_info.pe_type.arch = m_config->archVersion(); m_instr_info.dsb_dmb_waypoints = m_config->dmsbWayPt() ? 1 : 0; return err; } diff --git a/decoder/tests/snapshot_parser_lib/source/ss_to_dcdtree.cpp b/decoder/tests/snapshot_parser_lib/source/ss_to_dcdtree.cpp index 271b83b..0a31edd 100644 --- a/decoder/tests/snapshot_parser_lib/source/ss_to_dcdtree.cpp +++ b/decoder/tests/snapshot_parser_lib/source/ss_to_dcdtree.cpp @@ -243,7 +243,7 @@ bool CreateDcdTreeFromSnapShot::createETMv4Decoder(const std::string &coreName, bool configOK = true;

// generate the config data from the device data. - EtmV4Config config; + ocsd_etmv4_cfg config;

regs_to_access_t regs_to_access[] = { { ETMv4RegCfg, true, &config.reg_configr, 0 }, @@ -270,16 +270,18 @@ bool CreateDcdTreeFromSnapShot::createETMv4Decoder(const std::string &coreName, if(configOK) { ocsd_err_t err = OCSD_OK; + EtmV4Config configObj(&config); + if(m_bPacketProcOnly) { if(bDataChannel) - err = m_pDecodeTree->createETMv4DPktProcessor(&config); + err = m_pDecodeTree->createETMv4DPktProcessor(&configObj); else - err = m_pDecodeTree->createETMv4IPktProcessor(&config); + err = m_pDecodeTree->createETMv4IPktProcessor(&configObj); } else { - err = m_pDecodeTree->createETMv4Decoder(&config,bDataChannel); + err = m_pDecodeTree->createETMv4Decoder(&configObj,bDataChannel); } if(err == OCSD_OK) createdDecoder = true; @@ -337,7 +339,8 @@ bool CreateDcdTreeFromSnapShot::createPTMDecoder(const std::string &coreName, Pa bool configOK = true;

// generate the config data from the device data. - PtmConfig config; + + ocsd_ptm_cfg config;

regs_to_access_t regs_to_access[] = { { ETMv3PTMRegIDR, true, &config.reg_idr, 0 }, @@ -356,11 +359,12 @@ bool CreateDcdTreeFromSnapShot::createPTMDecoder(const std::string &coreName, Pa // good config - generate the decoder on the tree. if(configOK) { + PtmConfig configObj(&config); ocsd_err_t err = OCSD_OK; if(m_bPacketProcOnly) - err = m_pDecodeTree->createPTMPktProcessor(&config); + err = m_pDecodeTree->createPTMPktProcessor(&configObj); else - err = m_pDecodeTree->createPTMDecoder(&config); + err = m_pDecodeTree->createPTMDecoder(&configObj);

if(err == OCSD_OK) createdDecoder = true; @@ -395,7 +399,8 @@ bool CreateDcdTreeFromSnapShot::createSTMDecoder(Parser::Parsed *devSrc) bool configOK = true;

// generate the config data from the device data. - STMConfig config; + + ocsd_stm_cfg config;

regs_to_access_t regs_to_access[] = { { STMRegTCSR, true, &config.reg_tcsr, 0 } @@ -405,8 +410,9 @@ bool CreateDcdTreeFromSnapShot::createSTMDecoder(Parser::Parsed *devSrc) if(configOK) { ocsd_err_t err = OCSD_OK; + STMConfig configObj(&config); if(m_bPacketProcOnly) - err = m_pDecodeTree->createSTMPktProcessor(&config); + err = m_pDecodeTree->createSTMPktProcessor(&configObj); else err = OCSD_ERR_TEST_SS_TO_DECODER;

From: Mike Leach mike.leach@arm.com

OcsdLibDcdRegister: class to manage the registration and access of named decoders in the library. Creates list of decoder managers

IDecoderMngr: Abstract interface to allow creation, interconnection and clean-up of protocol / type specific macros.

DecoderMngrBase: templated base class to implement generic version of the IDecoderMngr functionality. Type specific decoder managers specialise this with only default constructors/desctructors required making adding new decoder into the mechanism very easy

Signed-off-by: Mike Leach mike.leach@linaro.org --- .../ref_trace_decode_lib.vcxproj | 10 + .../ref_trace_decode_lib.vcxproj.filters | 30 ++ decoder/include/common/ocsd_dcd_mngr.h | 362 +++++++++++++++++++++ decoder/include/common/ocsd_dcd_mngr_i.h | 92 ++++++ decoder/include/common/ocsd_lib_dcd_register.h | 117 +++++++ decoder/include/etmv3/trc_dcd_mngr_etmv3.h | 56 ++++ decoder/include/etmv4/trc_dcd_mngr_etmv4i.h | 30 ++ decoder/include/ocsd_if_types.h | 52 ++- decoder/include/ptm/trc_dcd_mngr_ptm.h | 56 ++++ decoder/include/stm/trc_dcd_mngr_stm.h | 54 +++ decoder/source/ocsd_lib_dcd_register.cpp | 147 +++++++++ 11 files changed, 993 insertions(+), 13 deletions(-) create mode 100644 decoder/include/common/ocsd_dcd_mngr.h create mode 100644 decoder/include/common/ocsd_dcd_mngr_i.h create mode 100644 decoder/include/common/ocsd_lib_dcd_register.h create mode 100644 decoder/include/etmv3/trc_dcd_mngr_etmv3.h create mode 100644 decoder/include/etmv4/trc_dcd_mngr_etmv4i.h create mode 100644 decoder/include/ptm/trc_dcd_mngr_ptm.h create mode 100644 decoder/include/stm/trc_dcd_mngr_stm.h create mode 100644 decoder/source/ocsd_lib_dcd_register.cpp

diff --git a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj index 929df5a..fa1a912 100644 --- a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj +++ b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj @@ -305,16 +305,20 @@ <ClInclude Include="..\..\..\include\common\comp_attach_notifier_i.h" /> <ClInclude Include="..\..\..\include\common\comp_attach_pt_t.h" /> <ClInclude Include="..\..\..\include\common\ocsd_code_follower.h" /> + <ClInclude Include="..\..\..\include\common\ocsd_dcd_mngr.h" /> + <ClInclude Include="..\..\..\include\common\ocsd_dcd_mngr_i.h" /> <ClInclude Include="..\..\..\include\common\ocsd_dcd_tree.h" /> <ClInclude Include="..\..\..\include\common\ocsd_dcd_tree_elem.h" /> <ClInclude Include="..\..\..\include\common\ocsd_error.h" /> <ClInclude Include="..\..\..\include\common\ocsd_error_logger.h" /> <ClInclude Include="..\..\..\include\common\ocsd_gen_elem_list.h" /> + <ClInclude Include="..\..\..\include\common\ocsd_lib_dcd_register.h" /> <ClInclude Include="..\..\..\include\common\ocsd_msg_logger.h" /> <ClInclude Include="..\..\..\include\common\ocsd_pe_context.h" /> <ClInclude Include="..\..\..\include\common\ocsd_version.h" /> <ClInclude Include="..\..\..\include\common\trc_component.h" /> <ClInclude Include="..\..\..\include\common\trc_core_arch_map.h" /> + <ClInclude Include="..\..\..\include\common\trc_cs_config.h" /> <ClInclude Include="..\..\..\include\common\trc_frame_deformatter.h" /> <ClInclude Include="..\..\..\include\common\trc_gen_elem.h" /> <ClInclude Include="..\..\..\include\common\trc_pkt_decode_base.h" /> @@ -322,17 +326,20 @@ <ClInclude Include="..\..\..\include\common\trc_printable_elem.h" /> <ClInclude Include="..\..\..\include\etmv3\etmv3_decoder.h" /> <ClInclude Include="..\..\..\include\etmv3\trc_cmp_cfg_etmv3.h" /> + <ClInclude Include="..\..\..\include\etmv3\trc_dcd_mngr_etmv3.h" /> <ClInclude Include="..\..\..\include\etmv3\trc_pkt_decode_etmv3.h" /> <ClInclude Include="..\..\..\include\etmv3\trc_pkt_elem_etmv3.h" /> <ClInclude Include="..\..\..\include\etmv3\trc_pkt_proc_etmv3.h" /> <ClInclude Include="..\..\..\include\etmv3\trc_pkt_types_etmv3.h" /> <ClInclude Include="..\..\..\include\etmv4\etmv4_decoder.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_cmp_cfg_etmv4.h" /> + <ClInclude Include="..\..\..\include\etmv4\trc_dcd_mngr_etmv4i.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_pkt_decode_etmv4i.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_pkt_elem_etmv4d.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_pkt_elem_etmv4i.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_pkt_proc_etmv4.h" /> <ClInclude Include="..\..\..\include\etmv4\trc_pkt_types_etmv4.h" /> + <ClInclude Include="..\..\..\include\interfaces\trc_abs_typed_base_i.h" /> <ClInclude Include="..\..\..\include\interfaces\trc_data_rawframe_in_i.h" /> <ClInclude Include="..\..\..\include\interfaces\trc_data_raw_in_i.h" /> <ClInclude Include="..\..\..\include\interfaces\trc_error_log_i.h" /> @@ -356,12 +363,14 @@ <ClInclude Include="..\..\..\include\opencsd.h" /> <ClInclude Include="..\..\..\include\ptm\ptm_decoder.h" /> <ClInclude Include="..\..\..\include\ptm\trc_cmp_cfg_ptm.h" /> + <ClInclude Include="..\..\..\include\ptm\trc_dcd_mngr_ptm.h" /> <ClInclude Include="..\..\..\include\ptm\trc_pkt_decode_ptm.h" /> <ClInclude Include="..\..\..\include\ptm\trc_pkt_elem_ptm.h" /> <ClInclude Include="..\..\..\include\ptm\trc_pkt_proc_ptm.h" /> <ClInclude Include="..\..\..\include\ptm\trc_pkt_types_ptm.h" /> <ClInclude Include="..\..\..\include\stm\stm_decoder.h" /> <ClInclude Include="..\..\..\include\stm\trc_cmp_cfg_stm.h" /> + <ClInclude Include="..\..\..\include\stm\trc_dcd_mngr_stm.h" /> <ClInclude Include="..\..\..\include\stm\trc_pkt_elem_stm.h" /> <ClInclude Include="..\..\..\include\stm\trc_pkt_proc_stm.h" /> <ClInclude Include="..\..\..\include\stm\trc_pkt_types_stm.h" /> @@ -397,6 +406,7 @@ <ClCompile Include="..\..\..\source\ocsd_error.cpp" /> <ClCompile Include="..\..\..\source\ocsd_error_logger.cpp" /> <ClCompile Include="..\..\..\source\ocsd_gen_elem_list.cpp" /> + <ClCompile Include="..\..\..\source\ocsd_lib_dcd_register.cpp" /> <ClCompile Include="..\..\..\source\ocsd_msg_logger.cpp" /> <ClCompile Include="..\..\..\source\ocsd_version.cpp" /> <ClCompile Include="..\..\..\source\ptm\trc_cmp_cfg_ptm.cpp" /> diff --git a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj.filters b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj.filters index efb3183..d267c31 100644 --- a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj.filters +++ b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.vcxproj.filters @@ -290,6 +290,33 @@ <ClInclude Include="..\..\..\include\common\ocsd_gen_elem_list.h"> <Filter>Header Files\common</Filter> </ClInclude> + <ClInclude Include="..\..\..\include\common\trc_cs_config.h"> + <Filter>Header Files\common</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\common\ocsd_dcd_mngr.h"> + <Filter>Header Files\common</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\common\ocsd_dcd_mngr_i.h"> + <Filter>Header Files\common</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\common\ocsd_lib_dcd_register.h"> + <Filter>Header Files\common</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\interfaces\trc_abs_typed_base_i.h"> + <Filter>interfaces</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\etmv4\trc_dcd_mngr_etmv4i.h"> + <Filter>Header Files\etmv4</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\etmv3\trc_dcd_mngr_etmv3.h"> + <Filter>Source Files\etmv3</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\ptm\trc_dcd_mngr_ptm.h"> + <Filter>Header Files\ptm</Filter> + </ClInclude> + <ClInclude Include="..\..\..\include\stm\trc_dcd_mngr_stm.h"> + <Filter>Header Files\stm</Filter> + </ClInclude> </ItemGroup> <ItemGroup> <ClCompile Include="..\..\..\source\trc_component.cpp"> @@ -400,5 +427,8 @@ <ClCompile Include="..\..\..\source\ocsd_gen_elem_list.cpp"> <Filter>Source Files</Filter> </ClCompile> + <ClCompile Include="..\..\..\source\ocsd_lib_dcd_register.cpp"> + <Filter>Source Files</Filter> + </ClCompile> </ItemGroup> </Project> \ No newline at end of file diff --git a/decoder/include/common/ocsd_dcd_mngr.h b/decoder/include/common/ocsd_dcd_mngr.h new file mode 100644 index 0000000..3b58e60 --- /dev/null +++ b/decoder/include/common/ocsd_dcd_mngr.h @@ -0,0 +1,362 @@ +/* + * \file ocsd_dcd_mngr.h + * \brief OpenCSD : Decoder manager base class. + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef ARM_OCSD_DCD_MNGR_H_INCLUDED +#define ARM_OCSD_DCD_MNGR_H_INCLUDED + +#include "ocsd_if_types.h" +#include "common/ocsd_dcd_mngr_i.h" +#include "common/ocsd_lib_dcd_register.h" +#include "common/trc_pkt_decode_base.h" + + +template <class P, class Pt, class Pc> +class DecoderMngrBase : public IDecoderMngr +{ +public: + DecoderMngrBase(const std::string &decoderTypeName); + virtual ~DecoderMngrBase() {}; + + // create decoder interface. + virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **p_component); + virtual ocsd_err_t destroyDecoder(TraceComponent *p_component); + +// common + virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog); + +// pkt decoder + virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec); + virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor); + virtual ocsd_err_t attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink); + +// pkt processor + virtual ocsd_err_t attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon); + virtual ocsd_err_t attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer); + virtual ocsd_err_t attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink); + +// data input connection interface + virtual ocsd_err_t getDataInputI(TraceComponent *pComponent, ITrcDataIn **ppDataIn); + +// implemented by decoder handler derived classes + virtual TraceComponent *createPktProc(const bool useInstID, const int instID) = 0; + virtual TraceComponent *createPktDecode(const bool useInstID, const int instID) { return 0; }; +}; + +template <class P, class Pt, class Pc> +DecoderMngrBase<P,Pt,Pc>::DecoderMngrBase(const std::string &decoderTypeName) +{ + OcsdLibDcdRegister *pDcdReg = OcsdLibDcdRegister::getDecoderRegister(); + if(pDcdReg) + pDcdReg->registerDecoderTypeByName(decoderTypeName,this); +} + + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::createDecoder(const int create_flags, const int instID, const CSConfig *pConfig, TraceComponent **ppTrcComp) +{ + ocsd_err_t err = OCSD_OK; + TraceComponent *pkt_proc = 0; + TraceComponent *pkt_dcd = 0; + bool bUseInstID = (create_flags & OCSD_CREATE_FLG_INST_ID) != 0; + bool bDecoder = (create_flags & OCSD_CREATE_FLG_FULL_DECODER) != 0; + bool bUnConfigured = (pConfig == 0); + + const Pc *pConf = dynamic_cast< const Pc * >(pConfig); + + // check inputs valid... + if((pConf == 0) && !bUnConfigured) + return OCSD_ERR_INVALID_PARAM_TYPE; + + if((create_flags & (OCSD_CREATE_FLG_PACKET_PROC | OCSD_CREATE_FLG_FULL_DECODER)) == 0) + return OCSD_ERR_INVALID_PARAM_VAL; + + // always need a packet processor + pkt_proc = createPktProc(bUseInstID, instID); + if(!pkt_proc) + return OCSD_ERR_MEM; + + // set the configuration + TrcPktProcBase<P,Pt,Pc> *pProcBase = dynamic_cast< TrcPktProcBase<P,Pt,Pc> *>(pkt_proc); + if(pProcBase == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + if(!bUnConfigured) + pProcBase->setProtocolConfig(pConf); + + *ppTrcComp = pkt_proc; + + // may need a packet decoder + if(bDecoder) + { + // create the decoder + pkt_dcd = createPktDecode(bUseInstID, instID); + if(!pkt_dcd) + return OCSD_ERR_MEM; + + // get the decoder base + TrcPktDecodeBase<P,Pc> *pBase = dynamic_cast< TrcPktDecodeBase<P,Pc> *>(pkt_dcd); + if(pBase == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + if(!bUnConfigured) + pBase->setProtocolConfig(pConf); + + // associate decoder with packet processor + // -> this means a TraceComponent with an associated component is a packet decoder. + // the associated component is the connected packet processor. + pkt_dcd->setAssocComponent(pkt_proc); + + // connect packet processor and decoder + pProcBase->getPacketOutAttachPt()->attach(pBase); + + *ppTrcComp = pkt_dcd; + } + return OCSD_OK; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::destroyDecoder(TraceComponent *pComponent) +{ + if(pComponent->getAssocComponent() != 0) + delete pComponent->getAssocComponent(); + delete pComponent; + return OCSD_OK; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog) +{ + return pComponent->getErrorLogAttachPt()->replace_first(pIErrorLog); +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec) +{ + ocsd_err_t err = OCSD_ERR_DCD_INTERFACE_UNUSED; + + if(pComponent->getAssocComponent() == 0) // no associated component - so this is a packet processor + return OCSD_ERR_INVALID_PARAM_TYPE; + + TrcPktDecodeI *pDcdI = dynamic_cast< TrcPktDecodeI * >(pComponent); + if(pDcdI == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + if(pDcdI->getUsesIDecode()) + err = pDcdI->getInstrDecodeAttachPt()->replace_first(pIInstrDec); + + return err; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor) +{ + ocsd_err_t err = OCSD_ERR_DCD_INTERFACE_UNUSED; + + if(pComponent->getAssocComponent() == 0) // no associated component - so this is a packet processor + return OCSD_ERR_INVALID_PARAM_TYPE; + + TrcPktDecodeI *pDcdI = dynamic_cast< TrcPktDecodeI * >(pComponent); + if(pDcdI == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + if(pDcdI->getUsesMemAccess()) + err = pDcdI->getMemoryAccessAttachPt()->replace_first(pMemAccessor); + + return err; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink) +{ + ocsd_err_t err = OCSD_ERR_INVALID_PARAM_TYPE; + + if(pComponent->getAssocComponent() == 0) // no associated component - so this is a packet processor + return err; + + TrcPktDecodeI *pDcdI = dynamic_cast< TrcPktDecodeI * >(pComponent); + if(pDcdI == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + err = pDcdI->getTraceElemOutAttachPt()->replace_first(pOutSink); + + return err; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::getDataInputI(TraceComponent *pComponent, ITrcDataIn **ppDataIn) +{ + // find the packet processor + TraceComponent *pPktProc = pComponent; + if(pComponent->getAssocComponent() != 0) + pPktProc = pComponent->getAssocComponent(); + + TrcPktProcI *pPPI = dynamic_cast< TrcPktProcI * >(pPktProc); + if(pPPI == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + *ppDataIn = pPPI; + + return OCSD_OK; +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon) +{ + // find the packet processor + TraceComponent *pPktProc = pComponent; + if(pComponent->getAssocComponent() != 0) + pPktProc = pComponent->getAssocComponent(); + + // get the packet processor + TrcPktProcBase<P,Pt,Pc> *pPktProcBase = dynamic_cast< TrcPktProcBase<P,Pt,Pc> * >(pPktProc); + if(pPktProcBase == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + // get the interface + IPktRawDataMon<P> *p_If = dynamic_cast< IPktRawDataMon<P> * >(pPktRawDataMon); + if(p_If == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + return pPktProcBase->getRawPacketMonAttachPt()->replace_first(p_If); +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer) +{ + // find the packet processor + TraceComponent *pPktProc = pComponent; + if(pComponent->getAssocComponent() != 0) + pPktProc = pComponent->getAssocComponent(); + + // get the packet processor + TrcPktProcBase<P,Pt,Pc> *pPktProcBase = dynamic_cast< TrcPktProcBase<P,Pt,Pc> * >(pPktProc); + if(pPktProcBase == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + // get the interface + ITrcPktIndexer<Pt> *p_If = dynamic_cast< ITrcPktIndexer<Pt> * >(pPktIndexer); + if(p_If == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + return pPktProcBase->getTraceIDIndexerAttachPt()->replace_first(p_If); +} + +template <class P, class Pt, class Pc> +ocsd_err_t DecoderMngrBase<P,Pt,Pc>::attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink) +{ + // must be solo packet processor + if(pComponent->getAssocComponent() != 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + // interface must be the correct one. + IPktDataIn<P> *pkt_in_i = dynamic_cast< IPktDataIn<P> * >(pPktDataInSink); + if(pkt_in_i == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + // get the packet processor + TrcPktProcBase<P,Pt,Pc> *pPktProcBase = dynamic_cast< TrcPktProcBase<P,Pt,Pc> * >(pComponent); + if(pPktProcBase == 0) + return OCSD_ERR_INVALID_PARAM_TYPE; + + // attach + return pPktProcBase->getPacketOutAttachPt()->replace_first(pkt_in_i); +} + + +/****************************************************************************************************/ +/* Full decoder / packet process pair, templated base for creating decoder objects */ +/****************************************************************************************************/ + +template< class P, // Packet class. + class Pt, // Packet enum type ID. + class Pc, // Processor config class. + class PktProc, // Packet processor class. + class PktDcd> // Packet decoder class. +class DecodeMngrFullDcd : public DecoderMngrBase<P,Pt,Pc> +{ +public: + DecodeMngrFullDcd (const std::string &name) : DecoderMngrBase(name) {}; + virtual ~DecodeMngrFullDcd() {}; + + virtual TraceComponent *createPktProc(const bool useInstID, const int instID) + { + TraceComponent *pComp; + if(useInstID) + pComp = new (std::nothrow) PktProc(instID); + else + pComp = new (std::nothrow) PktProc(); + return pComp; + } + + virtual TraceComponent *createPktDecode(const bool useInstID, const int instID) + { + TraceComponent *pComp; + if(useInstID) + pComp = new (std::nothrow)PktDcd(instID); + else + pComp = new (std::nothrow)PktDcd(); + return pComp; + } +}; + +/****************************************************************************************************/ +/* Packet processor only, templated base for creating decoder objects */ +/****************************************************************************************************/ + +template< class P, // Packet class. + class Pt, // Packet enum type ID. + class Pc, // Processor config class. + class PktProc> // Packet processor class. +class DecodeMngrPktProc : public DecoderMngrBase<P,Pt,Pc> +{ +public: + DecodeMngrPktProc (const std::string &name) : DecoderMngrBase(name) {}; + virtual ~DecodeMngrPktProc() {}; + + virtual TraceComponent *createPktProc(const bool useInstID, const int instID) + { + TraceComponent *pComp; + if(useInstID) + pComp = new (std::nothrow) PktProc(instID); + else + pComp = new (std::nothrow) PktProc(); + return pComp; + } +}; + + + +#endif // ARM_OCSD_DCD_MNGR_H_INCLUDED + +/* End of File ocsd_dcd_mngr.h */ diff --git a/decoder/include/common/ocsd_dcd_mngr_i.h b/decoder/include/common/ocsd_dcd_mngr_i.h new file mode 100644 index 0000000..f7a6720 --- /dev/null +++ b/decoder/include/common/ocsd_dcd_mngr_i.h @@ -0,0 +1,92 @@ +/* + * \file ocsd_dcd_mngr_i.h + * \brief OpenCSD : Decoder manager interface. + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef ARM_OCSD_DCD_MNGR_I_H_INCLUDED +#define ARM_OCSD_DCD_MNGR_I_H_INCLUDED + +#include "ocsd_if_types.h" +#include "common/trc_cs_config.h" +#include "common/trc_component.h" + +#include "interfaces/trc_error_log_i.h" +#include "interfaces/trc_data_raw_in_i.h" +#include "interfaces/trc_instr_decode_i.h" +#include "interfaces/trc_tgt_mem_access_i.h" +#include "interfaces/trc_gen_elem_in_i.h" +#include "interfaces/trc_abs_typed_base_i.h" + +class IDecoderMngr +{ +public: + IDecoderMngr() {}; + virtual ~IDecoderMngr() {}; + +// create and destroy decoders + virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **ppComponent) = 0; + virtual ocsd_err_t destroyDecoder(TraceComponent *pComponent) = 0; + +// connect decoders to other components - (replace current / 0 pointer value to detach ); +// compatible with all decoders + //!attach error logger to ptk-processor, or both of pkt processor and pkt decoder pair + virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog) = 0; + +// pkt decoder only + //! attach instruction decoder to pkt decoder + virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec) = 0; + + //! attach memory accessor to pkt decoder + virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor) = 0; + + //! attach generic output interface to pkt decoder + virtual ocsd_err_t attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink) = 0; + +// pkt processor only + //! attach a raw packet monitor to pkt processor (solo pkt processor, or pkt processor part of pair) + virtual ocsd_err_t attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon) = 0; + + //! attach a packet indexer to pkt processor (solo pkt processor, or pkt processor part of pair) + virtual ocsd_err_t attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer) = 0; + + //! attach a packet data sink to pkt processor output (solo pkt processor only - instead of decoder when pkt processor only created.) + virtual ocsd_err_t attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink) = 0; + +// data input connection interface + //! get raw data input interface from packet processor + virtual ocsd_err_t getDataInputI(TraceComponent *pComponent, ITrcDataIn **ppDataIn) = 0; + +}; + +#endif // ARM_OCSD_DCD_MNGR_I_H_INCLUDED + +/* End of File ocsd_dcd_mngr.h */ \ No newline at end of file diff --git a/decoder/include/common/ocsd_lib_dcd_register.h b/decoder/include/common/ocsd_lib_dcd_register.h new file mode 100644 index 0000000..dc5fd42 --- /dev/null +++ b/decoder/include/common/ocsd_lib_dcd_register.h @@ -0,0 +1,117 @@ +/* + * \file ocsd_lib_dcd_register.h + * \brief OpenCSD : Library decoder registration and management. + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +#ifndef ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED +#define ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED + + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include <map> + +#include "ocsd_if_types.h" +#include "common/ocsd_dcd_mngr_i.h" + +/*! + * @class OcsdLibDcdRegister : Registers decoders with the library + * + * library decoder register class allows decoders to be registered by name, and the register allows clients to access + * the list of names of registerd decoders. + * + * The decoders in the library are accessed through the decoder manager interface. This provides a set of functions to allow + * the creation, manipulation and destruction of registered decoders + * + */ +class OcsdLibDcdRegister +{ +public: + static OcsdLibDcdRegister *getDecoderRegister(); + + static void deregisterAllDecoders(); //!< library cleanup - deregisters decoder managers and destroys the register object. + + const ocsd_err_t registerDecoderTypeByName(const std::string &name, IDecoderMngr *p_decoder_fact); //!< register a decoder manager interface + const ocsd_err_t getDecoderMngrByName(const std::string &name, IDecoderMngr **p_decoder_mngr); + + const bool isRegisteredDecoder(const std::string &name); + const bool getFirstNamedDecoder(std::string &name); + const bool getNextNamedDecoder(std::string &name); + +private: + void registerBuiltInDecoders(); //!< register the list of build in decoder managers on first access of getDecoderMngrByName. + + std::map<const std::string, IDecoderMngr *> m_decoder_mngrs; //!< map linking names to decoder manager interfaces. + std::map<const std::string, IDecoderMngr *>::const_iterator m_iter; //!< iterator for name search. + + // singleton pattern - need just one of these in the library - ensure all default constructors are private. + OcsdLibDcdRegister(); + OcsdLibDcdRegister(OcsdLibDcdRegister const &) {}; + OcsdLibDcdRegister& operator=(OcsdLibDcdRegister const &){}; + ~OcsdLibDcdRegister(); + + static OcsdLibDcdRegister *m_p_libMngr; + static bool m_b_registeredBuiltins; +}; + +/*! + * Typedef of function signature to create a decoder manager. + * + * @param *name : Registered name of the decoder. + */ +typedef IDecoderMngr *(*CreateMngr)(const std::string &name); + +/*! + * Template function to create a specific decoder manager class object. + * + * @param &name : Registered name of the decoder. + * + * @return IDecoderMngr * : pointer to the decoder manager base class interface. + */ +template <typename T> IDecoderMngr *createManagerInst(const std::string &name) +{ + return new (std::nothrow)T(name); +} + +/*! Structure to contain the information needed to create and register a builtin decoder + * manager with the library + */ +typedef struct built_in_decoder_info { + IDecoderMngr *pMngr; //!< pointer to created decoder manager + CreateMngr PFn; //!< function to create the decoder manager. + const char *name; //!< registered name of the decoder. +} built_in_decoder_info_t; + +//! Define to use to fill in an array of built_in_decoder_info_t structures. +#define CREATE_BUILTIN_ENTRY(C,N) { 0, createManagerInst<C>, N } + +#endif // ARM_OCSD_LIB_DCD_REGISTER_H_INCLUDED + +/* End of File ocsd_lib_dcd_register.h */ diff --git a/decoder/include/etmv3/trc_dcd_mngr_etmv3.h b/decoder/include/etmv3/trc_dcd_mngr_etmv3.h new file mode 100644 index 0000000..cbd1182 --- /dev/null +++ b/decoder/include/etmv3/trc_dcd_mngr_etmv3.h @@ -0,0 +1,56 @@ +/* + * \file trc_dcd_mngr_etmv3.h + * \brief OpenCSD : ETMv3 decoder manager / handler specialisation + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef ARM_TRC_DCD_MNGR_ETMV3_H_INCLUDED +#define ARM_TRC_DCD_MNGR_ETMV3_H_INCLUDED + +#include "common/ocsd_dcd_mngr.h" +#include "trc_pkt_decode_etmv3.h" +#include "trc_pkt_proc_etmv3.h" +#include "trc_cmp_cfg_etmv3.h" +#include "trc_pkt_types_etmv3.h" + +class DecoderMngrEtmV3 : public DecodeMngrFullDcd< EtmV3TrcPacket, + ocsd_etmv3_pkt_type, + EtmV3Config, + TrcPktProcEtmV3, + TrcPktDecodeEtmV3> +{ +public: + DecoderMngrEtmV3(const std::string &name) : DecodeMngrFullDcd(name) {}; + virtual ~DecoderMngrEtmV3() {}; +}; + +#endif // ARM_TRC_DCD_MNGR_ETMV3_H_INCLUDED + +/* End of File trc_dcd_mngr_etmv3.h */ diff --git a/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h b/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h new file mode 100644 index 0000000..3aef842 --- /dev/null +++ b/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h @@ -0,0 +1,30 @@ +/* + * \file trc_dcd_mngr_etmv4i.h + * \brief Reference CoreSight Trace Decoder : + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +#ifndef ARM_TRC_DCD_MNGR_ETMV4I_H_INCLUDED +#define ARM_TRC_DCD_MNGR_ETMV4I_H_INCLUDED + +#include "common/ocsd_dcd_mngr.h" +#include "trc_pkt_decode_etmv4i.h" +#include "trc_pkt_proc_etmv4.h" +#include "trc_cmp_cfg_etmv4.h" +#include "trc_pkt_types_etmv4.h" + +class DecoderMngrEtmV4I : public DecodeMngrFullDcd< EtmV4ITrcPacket, + ocsd_etmv4_i_pkt_type, + EtmV4Config, + TrcPktProcEtmV4I, + TrcPktDecodeEtmV4I> +{ +public: + DecoderMngrEtmV4I(const std::string &name) : DecodeMngrFullDcd(name) {}; + virtual ~DecoderMngrEtmV4I() {}; +}; + +#endif // ARM_TRC_DCD_MNGR_ETMV4I_H_INCLUDED + +/* End of File trc_dcd_mngr_etmv4i.h */ diff --git a/decoder/include/ocsd_if_types.h b/decoder/include/ocsd_if_types.h index 4fb428d..d214f76 100644 --- a/decoder/include/ocsd_if_types.h +++ b/decoder/include/ocsd_if_types.h @@ -86,6 +86,7 @@ typedef enum _ocsd_err_t { OCSD_ERR_INVALID_ID, /**< Invalid CoreSight Trace Source ID. */ OCSD_ERR_BAD_HANDLE, /**< Invalid handle passed to component. */ OCSD_ERR_INVALID_PARAM_VAL, /**< Invalid value parameter passed to component. */ + OCSD_ERR_INVALID_PARAM_TYPE, /**< Type mismatch on abstract interface */ OCSD_ERR_FILE_ERROR, /**< File access error */ OCSD_ERR_NO_PROTOCOL, /**< Trace protocol unsupported */ /* attachment point errors */ @@ -123,6 +124,11 @@ typedef enum _ocsd_err_t { OCSD_ERR_TEST_SNAPSHOT_PARSE_INFO, /**< test snapshot file parse information */ OCSD_ERR_TEST_SNAPSHOT_READ, /**< test snapshot reader error */ OCSD_ERR_TEST_SS_TO_DECODER, /**< test snapshot to decode tree conversion error */ + /* decoder registration */ + OCSD_ERR_DCDREG_NAME_REPEAT, /**< attempted to register a decoder with the same name as another one */ + OCSD_ERR_DCDREG_NAME_UNKNOWN, /**< attempted to find a decoder with a name that is not known in the library */ + /* decoder config */ + OCSD_ERR_DCD_INTERFACE_UNUSED, /**< Attempt to connect or use and inteface not supported by this decoder. */ /* end marker*/ OCSD_ERR_LAST } ocsd_err_t; @@ -202,19 +208,6 @@ typedef enum _ocsd_datapath_resp_t { /** @name Trace Decode component types @{*/

-/*! Trace Protocol Types - used to create appropriate decoder. - */ -typedef enum _ocsd_trace_protocol_t { - OCSD_PROTOCOL_EXTERN, /**< Custom external decoder attached to the decode tree - protocol unknown */ - OCSD_PROTOCOL_ETMV3, /**< ETMV3 instruction and data trace protocol decoder. */ - OCSD_PROTOCOL_ETMV4I, /**< ETMV4 instruction trace protocol decoder. */ - OCSD_PROTOCOL_ETMV4D, /**< ETMV4 data trace protocol decoder. */ - OCSD_PROTOCOL_PTM, /**< PTM program flow instruction trace protocol decoder. */ - OCSD_PROTOCOL_STM, /**< STM system trace protocol decoder. */ - /* others to be added here */ - OCSD_PROTOCOL_END /**< Invalid protocol - protocol types end marker */ -} ocsd_trace_protocol_t; -

/** Raw frame element data types Data blocks types output from ITrcRawFrameIn. @@ -474,6 +467,39 @@ typedef uint32_t (* Fn_MemAcc_CB)(const void *p_context, const ocsd_vaddr_t add

/** @}*/

+/** @name Decoder creation information + + Flags to use when creating decoders by name + + Builtin decoder names. + + Protocol type enum +@{*/ + +#define OCSD_CREATE_FLG_PACKET_PROC 0x01 /**< Create packet processor only. */ +#define OCSD_CREATE_FLG_FULL_DECODER 0x02 /**< Create packet processor + decoder pair */ +#define OCSD_CREATE_FLG_INST_ID 0x04 /**< Use instance ID in decoder instance name */ + +#define OCSD_BUILTIN_DCD_STM "STM" /**< STM decoder */ +#define OCSD_BUILTIN_DCD_ETMV3 "ETMV3" /**< ETMv3 decoder */ +#define OCSD_BUILTIN_DCD_ETMV4I "ETMV4I" /**< ETMv4 instruction decoder */ +#define OCSD_BUILTIN_DCD_ETMV4D "ETMV4D" /**< ETMv4 data decoder */ +#define OCSD_BUILTIN_DCD_PTM "PTM" /**< PTM decoder */ + +/*! Trace Protocol Builtin Types + extern + */ +typedef enum _ocsd_trace_protocol_t { + OCSD_PROTOCOL_EXTERN, /**< Custom external decoder attached to the decode tree - protocol unknown */ + OCSD_PROTOCOL_ETMV3, /**< ETMV3 instruction and data trace protocol decoder. */ + OCSD_PROTOCOL_ETMV4I, /**< ETMV4 instruction trace protocol decoder. */ + OCSD_PROTOCOL_ETMV4D, /**< ETMV4 data trace protocol decoder. */ + OCSD_PROTOCOL_PTM, /**< PTM program flow instruction trace protocol decoder. */ + OCSD_PROTOCOL_STM, /**< STM system trace protocol decoder. */ + /* others to be added here */ + OCSD_PROTOCOL_END /**< Invalid protocol - protocol types end marker */ +} ocsd_trace_protocol_t; + +/** @}*/

/** @}*/ #endif // ARM_OCSD_IF_TYPES_H_INCLUDED diff --git a/decoder/include/ptm/trc_dcd_mngr_ptm.h b/decoder/include/ptm/trc_dcd_mngr_ptm.h new file mode 100644 index 0000000..27fb270 --- /dev/null +++ b/decoder/include/ptm/trc_dcd_mngr_ptm.h @@ -0,0 +1,56 @@ +/* + * \file trc_dcd_mngr_ptm.h + * \brief OpenCSD : PTM decoder manager / handler specialisation + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef ARM_TRC_DCD_MNGR_PTM_H_INCLUDED +#define ARM_TRC_DCD_MNGR_PTM_H_INCLUDED + +#include "common/ocsd_dcd_mngr.h" +#include "trc_pkt_decode_ptm.h" +#include "trc_pkt_proc_ptm.h" +#include "trc_cmp_cfg_ptm.h" +#include "trc_pkt_types_ptm.h" + +class DecoderMngrPtm : public DecodeMngrFullDcd< PtmTrcPacket, + ocsd_ptm_pkt_type, + PtmConfig, + TrcPktProcPtm, + TrcPktDecodePtm> +{ +public: + DecoderMngrPtm(const std::string &name) : DecodeMngrFullDcd(name) {}; + virtual ~DecoderMngrPtm() {}; +}; + +#endif // ARM_TRC_DCD_MNGR_PTM_H_INCLUDED + +/* End of File trc_dcd_mngr_ptm.h */ diff --git a/decoder/include/stm/trc_dcd_mngr_stm.h b/decoder/include/stm/trc_dcd_mngr_stm.h new file mode 100644 index 0000000..356ed72 --- /dev/null +++ b/decoder/include/stm/trc_dcd_mngr_stm.h @@ -0,0 +1,54 @@ +/* + * \file trc_dcd_mngr_stm.h + * \brief OpenCSD : STM decoder manager / handler specialisation + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef ARM_TRC_DCD_MNGR_STM_H_INCLUDED +#define ARM_TRC_DCD_MNGR_STM_H_INCLUDED + +#include "common/ocsd_dcd_mngr.h" +#include "trc_pkt_proc_stm.h" +#include "trc_cmp_cfg_stm.h" +#include "trc_pkt_types_stm.h" + +class DecoderMngrStm : public DecodeMngrPktProc< StmTrcPacket, + ocsd_stm_pkt_type, + STMConfig, + TrcPktProcStm> +{ +public: + DecoderMngrStm(const std::string &name) : DecodeMngrPktProc(name) {}; + virtual ~DecoderMngrStm() {}; +}; + +#endif // ARM_TRC_DCD_MNGR_STM_H_INCLUDED + +/* End of File trc_dcd_mngr_stm.h */ diff --git a/decoder/source/ocsd_lib_dcd_register.cpp b/decoder/source/ocsd_lib_dcd_register.cpp new file mode 100644 index 0000000..053f256 --- /dev/null +++ b/decoder/source/ocsd_lib_dcd_register.cpp @@ -0,0 +1,147 @@ +/* + * \file ocsd_lib_dcd_register.cpp + * \brief OpenCSD : Library decoder register object + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include "common/ocsd_lib_dcd_register.h" + +// include built-in decode manager headers +#include "etmv4/trc_dcd_mngr_etmv4i.h" +#include "etmv3/trc_dcd_mngr_etmv3.h" +#include "ptm/trc_dcd_mngr_ptm.h" +#include "stm/trc_dcd_mngr_stm.h" + +// create array of built-in decoders to register with library +static built_in_decoder_info_t sBuiltInArray[] = { + CREATE_BUILTIN_ENTRY(DecoderMngrEtmV4I,OCSD_BUILTIN_DCD_ETMV4I), + CREATE_BUILTIN_ENTRY(DecoderMngrEtmV3, OCSD_BUILTIN_DCD_ETMV3), + CREATE_BUILTIN_ENTRY(DecoderMngrPtm, OCSD_BUILTIN_DCD_PTM), + CREATE_BUILTIN_ENTRY(DecoderMngrStm, OCSD_BUILTIN_DCD_STM) + //{ 0, 0, 0} +}; + +#define NUM_BUILTINS sizeof(sBuiltInArray) / sizeof(built_in_decoder_info_t) + + +OcsdLibDcdRegister *OcsdLibDcdRegister::m_p_libMngr = 0; +bool OcsdLibDcdRegister::m_b_registeredBuiltins = false; + +OcsdLibDcdRegister *OcsdLibDcdRegister::getDecoderRegister() +{ + if(m_p_libMngr == 0) + m_p_libMngr = new (std::nothrow) OcsdLibDcdRegister(); + return m_p_libMngr; +} + +OcsdLibDcdRegister::OcsdLibDcdRegister() +{ + m_iter = m_decoder_mngrs.begin(); +} + +OcsdLibDcdRegister::~OcsdLibDcdRegister() +{ + m_decoder_mngrs.clear(); +} + + +const ocsd_err_t OcsdLibDcdRegister::registerDecoderTypeByName(const std::string &name, IDecoderMngr *p_decoder_fact) +{ + if(isRegisteredDecoder(name)) + return OCSD_ERR_DCDREG_NAME_REPEAT; + m_decoder_mngrs.emplace(std::pair<const std::string, IDecoderMngr *>(name,p_decoder_fact)); + return OCSD_OK; +} + +void OcsdLibDcdRegister::registerBuiltInDecoders() +{ + bool memFail = false; + for(int i = 0; i < NUM_BUILTINS; i++) + { + if(sBuiltInArray[i].PFn) + { + sBuiltInArray[i].pMngr = sBuiltInArray[i].PFn( sBuiltInArray[i].name); + if(!sBuiltInArray[i].pMngr) + memFail=true; + } + } + m_b_registeredBuiltins = !memFail; +} + +void OcsdLibDcdRegister::deregisterAllDecoders() +{ + for(int i = 0; i < NUM_BUILTINS; i++) + delete sBuiltInArray[i].pMngr; + m_b_registeredBuiltins = false; + delete m_p_libMngr; + m_p_libMngr = 0; +} + +const ocsd_err_t OcsdLibDcdRegister::getDecoderMngrByName(const std::string &name, IDecoderMngr **p_decoder_mngr) +{ + if(!m_b_registeredBuiltins) + { + registerBuiltInDecoders(); + if(!m_b_registeredBuiltins) + return OCSD_ERR_MEM; + } + + std::map<const std::string, IDecoderMngr *>::const_iterator iter = m_decoder_mngrs.find(name); + if(iter == m_decoder_mngrs.end()) + return OCSD_ERR_DCDREG_NAME_UNKNOWN; + *p_decoder_mngr = iter->second; + return OCSD_OK; +} + +const bool OcsdLibDcdRegister::isRegisteredDecoder(const std::string &name) +{ + std::map<const std::string, IDecoderMngr *>::const_iterator iter = m_decoder_mngrs.find(name); + if(iter != m_decoder_mngrs.end()) + return true; + return false; +} + +const bool OcsdLibDcdRegister::getFirstNamedDecoder(std::string &name) +{ + m_iter = m_decoder_mngrs.begin(); + return getNextNamedDecoder(name); +} + +const bool OcsdLibDcdRegister::getNextNamedDecoder(std::string &name) +{ + if(m_iter == m_decoder_mngrs.end()) + return false; + name = m_iter->first; + m_iter++; + return true; +} + +/* End of File ocsd_lib_dcd_register.cpp */

From: Mike Leach mike.leach@arm.com

Add in the enum type describing the trace protocol to decoder managers and interface. Covers ARM built in decoders, with external / none ARM covered by external tag.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/include/common/ocsd_dcd_mngr.h | 21 +++++++++++++++------ decoder/include/common/ocsd_dcd_mngr_i.h | 3 +++ decoder/include/etmv3/trc_dcd_mngr_etmv3.h | 2 +- decoder/include/etmv4/trc_dcd_mngr_etmv4i.h | 2 +- decoder/include/ptm/trc_dcd_mngr_ptm.h | 2 +- decoder/include/stm/trc_dcd_mngr_stm.h | 2 +- 6 files changed, 22 insertions(+), 10 deletions(-)

diff --git a/decoder/include/common/ocsd_dcd_mngr.h b/decoder/include/common/ocsd_dcd_mngr.h index 3b58e60..0e6222a 100644 --- a/decoder/include/common/ocsd_dcd_mngr.h +++ b/decoder/include/common/ocsd_dcd_mngr.h @@ -45,16 +45,18 @@ template <class P, class Pt, class Pc> class DecoderMngrBase : public IDecoderMngr { public: - DecoderMngrBase(const std::string &decoderTypeName); + DecoderMngrBase(const std::string &decoderTypeName, ocsd_trace_protocol_t builtInProtocol); virtual ~DecoderMngrBase() {};

// create decoder interface. virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **p_component); virtual ocsd_err_t destroyDecoder(TraceComponent *p_component);

+ virtual const ocsd_trace_protocol_t getProtocolType() const { return m_builtInProtocol; } + // common virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog); - + // pkt decoder virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec); virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor); @@ -71,17 +73,20 @@ public: // implemented by decoder handler derived classes virtual TraceComponent *createPktProc(const bool useInstID, const int instID) = 0; virtual TraceComponent *createPktDecode(const bool useInstID, const int instID) { return 0; }; + +private: + ocsd_trace_protocol_t m_builtInProtocol; //!< Protocol ID if built in type. };

template <class P, class Pt, class Pc> -DecoderMngrBase<P,Pt,Pc>::DecoderMngrBase(const std::string &decoderTypeName) +DecoderMngrBase<P,Pt,Pc>::DecoderMngrBase(const std::string &decoderTypeName, ocsd_trace_protocol_t builtInProtocol) { OcsdLibDcdRegister *pDcdReg = OcsdLibDcdRegister::getDecoderRegister(); if(pDcdReg) pDcdReg->registerDecoderTypeByName(decoderTypeName,this); + m_builtInProtocol = builtInProtocol; }

- template <class P, class Pt, class Pc> ocsd_err_t DecoderMngrBase<P,Pt,Pc>::createDecoder(const int create_flags, const int instID, const CSConfig *pConfig, TraceComponent **ppTrcComp) { @@ -306,7 +311,9 @@ template< class P, // Packet class. class DecodeMngrFullDcd : public DecoderMngrBase<P,Pt,Pc> { public: - DecodeMngrFullDcd (const std::string &name) : DecoderMngrBase(name) {}; + DecodeMngrFullDcd (const std::string &name, ocsd_trace_protocol_t builtInProtocol) + : DecoderMngrBase(name,builtInProtocol) {}; + virtual ~DecodeMngrFullDcd() {};

virtual TraceComponent *createPktProc(const bool useInstID, const int instID) @@ -341,7 +348,9 @@ template< class P, // Packet class. class DecodeMngrPktProc : public DecoderMngrBase<P,Pt,Pc> { public: - DecodeMngrPktProc (const std::string &name) : DecoderMngrBase(name) {}; + DecodeMngrPktProc (const std::string &name, ocsd_trace_protocol_t builtInProtocol) + : DecoderMngrBase(name,builtInProtocol) {}; + virtual ~DecodeMngrPktProc() {};

virtual TraceComponent *createPktProc(const bool useInstID, const int instID) diff --git a/decoder/include/common/ocsd_dcd_mngr_i.h b/decoder/include/common/ocsd_dcd_mngr_i.h index f7a6720..3e6abe2 100644 --- a/decoder/include/common/ocsd_dcd_mngr_i.h +++ b/decoder/include/common/ocsd_dcd_mngr_i.h @@ -56,6 +56,9 @@ public: virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **ppComponent) = 0; virtual ocsd_err_t destroyDecoder(TraceComponent *pComponent) = 0;

+ //! Get the built in protocol type ID managed by this instance - extern for custom decoders + virtual const ocsd_trace_protocol_t getProtocolType() const = 0; + // connect decoders to other components - (replace current / 0 pointer value to detach ); // compatible with all decoders //!attach error logger to ptk-processor, or both of pkt processor and pkt decoder pair diff --git a/decoder/include/etmv3/trc_dcd_mngr_etmv3.h b/decoder/include/etmv3/trc_dcd_mngr_etmv3.h index cbd1182..3ace535 100644 --- a/decoder/include/etmv3/trc_dcd_mngr_etmv3.h +++ b/decoder/include/etmv3/trc_dcd_mngr_etmv3.h @@ -47,7 +47,7 @@ class DecoderMngrEtmV3 : public DecodeMngrFullDcd< EtmV3TrcPacket, TrcPktDecodeEtmV3> { public: - DecoderMngrEtmV3(const std::string &name) : DecodeMngrFullDcd(name) {}; + DecoderMngrEtmV3(const std::string &name) : DecodeMngrFullDcd(name,OCSD_PROTOCOL_ETMV3) {}; virtual ~DecoderMngrEtmV3() {}; };

diff --git a/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h b/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h index 3aef842..7c4802f 100644 --- a/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h +++ b/decoder/include/etmv4/trc_dcd_mngr_etmv4i.h @@ -21,7 +21,7 @@ class DecoderMngrEtmV4I : public DecodeMngrFullDcd< EtmV4ITrcPacket, TrcPktDecodeEtmV4I> { public: - DecoderMngrEtmV4I(const std::string &name) : DecodeMngrFullDcd(name) {}; + DecoderMngrEtmV4I(const std::string &name) : DecodeMngrFullDcd(name,OCSD_PROTOCOL_ETMV4I) {}; virtual ~DecoderMngrEtmV4I() {}; };

diff --git a/decoder/include/ptm/trc_dcd_mngr_ptm.h b/decoder/include/ptm/trc_dcd_mngr_ptm.h index 27fb270..121edfd 100644 --- a/decoder/include/ptm/trc_dcd_mngr_ptm.h +++ b/decoder/include/ptm/trc_dcd_mngr_ptm.h @@ -47,7 +47,7 @@ class DecoderMngrPtm : public DecodeMngrFullDcd< PtmTrcPacket, TrcPktDecodePtm> { public: - DecoderMngrPtm(const std::string &name) : DecodeMngrFullDcd(name) {}; + DecoderMngrPtm(const std::string &name) : DecodeMngrFullDcd(name,OCSD_PROTOCOL_PTM) {}; virtual ~DecoderMngrPtm() {}; };

diff --git a/decoder/include/stm/trc_dcd_mngr_stm.h b/decoder/include/stm/trc_dcd_mngr_stm.h index 356ed72..7705d3c 100644 --- a/decoder/include/stm/trc_dcd_mngr_stm.h +++ b/decoder/include/stm/trc_dcd_mngr_stm.h @@ -45,7 +45,7 @@ class DecoderMngrStm : public DecodeMngrPktProc< StmTrcPacket, TrcPktProcStm> { public: - DecoderMngrStm(const std::string &name) : DecodeMngrPktProc(name) {}; + DecoderMngrStm(const std::string &name) : DecodeMngrPktProc(name,OCSD_PROTOCOL_STM) {}; virtual ~DecoderMngrStm() {}; };

ETMv4 Instruction packet processor had potential indexing issue if the payload control packet had continuation bytes.

Spec allows for these but no known implementation uses them.

Fix ensures that indexing into the packet for payload sections is correct. Some additional code simplification.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp | 68 +++++++++++------------ decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.h | 22 +++++--- 2 files changed, 49 insertions(+), 41 deletions(-)

diff --git a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp index 8966504..0125788 100644 --- a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp +++ b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp @@ -375,67 +375,66 @@ void EtmV4IPktProcImpl::iPktASync() void EtmV4IPktProcImpl::iPktTraceInfo() { uint8_t lastByte = m_currPacketData.back(); - if(m_currPacketData.size() == 1) + if(m_currPacketData.size() == 1) // header { //clear flags - m_ctrlSect = m_infoSect = m_keySect = m_specSect = m_cyctSect = false; + m_tinfo_sections.sectFlags = 0; // mark all sections as incomplete. + m_tinfo_sections.ctrlBytes = 1; // assume only a single control section byte for now + } - else if(m_currPacketData.size() == 2) + else if(m_currPacketData.size() == 2) // first payload control byte { - // figure out which sections are absent and set to true; - m_infoSect = (bool)((lastByte & 0x1) == 0x0); - m_keySect = (bool)((lastByte & 0x2) == 0x0); - m_specSect = (bool)((lastByte & 0x4) == 0x0); - m_cyctSect = (bool)((lastByte & 0x8) == 0x0); + // figure out which sections are absent and set to true - opposite of bitfeild in byte; + m_tinfo_sections.sectFlags = (~lastByte) & TINFO_ALL_SECT;

// see if there is an extended control section, otherwise this byte is it. - m_ctrlSect = (bool)((lastByte & 0x80) == 0x0); + if((lastByte & 0x80) == 0x0) + m_tinfo_sections.sectFlags |= TINFO_CTRL; + } else { - if(!m_ctrlSect) - m_ctrlSect = (bool)((lastByte & 0x80) == 0x0); - else if(!m_infoSect) - m_infoSect = (bool)((lastByte & 0x80) == 0x0); - else if(!m_keySect) - m_keySect = (bool)((lastByte & 0x80) == 0x0); - else if(!m_specSect) - m_specSect = (bool)((lastByte & 0x80) == 0x0); - else if(!m_cyctSect) - m_cyctSect = (bool)((lastByte & 0x80) == 0x0); + if(!(m_tinfo_sections.sectFlags & TINFO_CTRL)) + { + m_tinfo_sections.sectFlags |= (lastByte & 0x80) ? 0 : TINFO_CTRL; + m_tinfo_sections.ctrlBytes++; + } + else if(!(m_tinfo_sections.sectFlags & TINFO_INFO_SECT)) + m_tinfo_sections.sectFlags |= (lastByte & 0x80) ? 0 : TINFO_INFO_SECT; + else if(!(m_tinfo_sections.sectFlags & TINFO_KEY_SECT)) + m_tinfo_sections.sectFlags |= (lastByte & 0x80) ? 0 : TINFO_KEY_SECT; + else if(!(m_tinfo_sections.sectFlags & TINFO_SPEC_SECT)) + m_tinfo_sections.sectFlags |= (lastByte & 0x80) ? 0 : TINFO_SPEC_SECT; + else if(!(m_tinfo_sections.sectFlags & TINFO_CYCT_SECT)) + m_tinfo_sections.sectFlags |= (lastByte & 0x80) ? 0 : TINFO_CYCT_SECT; }

// all sections accounted for? - if(m_ctrlSect && m_infoSect && m_keySect && m_specSect && m_cyctSect) + if(m_tinfo_sections.sectFlags == TINFO_ALL) { - unsigned idx = 2; + // index of first section is number of payload control bytes + 1 for header byte + unsigned idx = m_tinfo_sections.ctrlBytes + 1; uint32_t fieldVal = 0; - - // now need to know which sections to look for, so re-examine the flags byte... - lastByte = m_currPacketData[1]; - m_infoSect = (bool)((lastByte & 0x1) == 0x1); - m_keySect = (bool)((lastByte & 0x2) == 0x2); - m_specSect = (bool)((lastByte & 0x4) == 0x4); - m_cyctSect = (bool)((lastByte & 0x8) == 0x8); + uint8_t presSect = m_currPacketData[1] & TINFO_ALL_SECT; // first payload control byte

m_curr_packet.clearTraceInfo();

- if(m_infoSect && (idx < m_currPacketData.size())) + if((presSect & TINFO_INFO_SECT) && (idx < m_currPacketData.size())) { - m_curr_packet.setTraceInfo((uint32_t)m_currPacketData[idx]); - idx++; + idx += extractContField(m_currPacketData,idx,fieldVal); + m_curr_packet.setTraceInfo(fieldVal); } - if(m_keySect && (idx < m_currPacketData.size())) + if((presSect & TINFO_KEY_SECT) && (idx < m_currPacketData.size())) { idx += extractContField(m_currPacketData,idx,fieldVal); m_curr_packet.setTraceInfoKey(fieldVal); } - if(m_specSect && (idx < m_currPacketData.size())) + if((presSect & TINFO_SPEC_SECT) && (idx < m_currPacketData.size())) { idx += extractContField(m_currPacketData,idx,fieldVal); m_curr_packet.setTraceInfoSpec(fieldVal); } - if(m_cyctSect && (idx < m_currPacketData.size())) + if((presSect & TINFO_CYCT_SECT) && (idx < m_currPacketData.size())) { idx += extractContField(m_currPacketData,idx,fieldVal); m_curr_packet.setTraceInfoCyct(fieldVal); @@ -443,6 +442,7 @@ void EtmV4IPktProcImpl::iPktTraceInfo() m_process_state = SEND_PKT; m_first_trace_info = true; } + }

void EtmV4IPktProcImpl::iPktTimestamp() diff --git a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.h b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.h index 0a0d1ca..7ccaa43 100644 --- a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.h +++ b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.h @@ -1,6 +1,6 @@ /* * \file trc_pkt_proc_etmv4i_impl.h - * \brief OpenCSD : + * \brief OpenCSD : Implementation of ETMv4 packet processing * * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. */ @@ -100,12 +100,20 @@ private: // current processing state data - counts and flags to determine if a packet is complete.

// TraceInfo Packet - // flags to indicate processing for these sections is complete. - bool m_ctrlSect; - bool m_infoSect; - bool m_keySect; - bool m_specSect; - bool m_cyctSect; + // flags to indicate processing progress for these sections is complete. + struct _t_info_pkt_prog { + uint8_t sectFlags; + uint8_t ctrlBytes; + } m_tinfo_sections; + + #define TINFO_INFO_SECT 0x01 + #define TINFO_KEY_SECT 0x02 + #define TINFO_SPEC_SECT 0x04 + #define TINFO_CYCT_SECT 0x08 + #define TINFO_CTRL 0x10 + #define TINFO_ALL_SECT 0x0F + #define TINFO_ALL 0x1F +

// address and context packets int m_addrBytes;

Adds new create by name functions to C API, using the new decoder name register API.

Removes the protocol specific decoder create functions from the main API.

Allow previous protocol specific functions be used as a deprecated API on compile time #define to allow for regression testing.

test program: re-write to simplify and use the new create-by-name functionality. Add -help command to print available command line options.

Signed-off-by: Mike Leach mike.leach@linaro.org --- .../win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj | 2 + .../rctdl_c_api_lib.vcxproj.filters | 6 + .../ref_trace_decode_lib/ref_trace_decode_lib.sln | 25 +- decoder/include/c_api/ocsd_c_api_deprc_fn.h | 175 +++++ decoder/include/c_api/ocsd_c_api_types.h | 26 +- decoder/include/c_api/opencsd_c_api.h | 172 ++--- decoder/source/c_api/ocsd_c_api.cpp | 443 ++++------- decoder/source/c_api/ocsd_c_api_deprc_fn.cpp | 200 +++++ decoder/source/c_api/ocsd_c_api_obj.h | 57 ++ .../c_api_pkt_print_test.vcxproj | 325 ++++++++ .../c_api_pkt_print_test.vcxproj.filters | 22 + decoder/tests/source/c_api_pkt_print_test.c | 825 +++++++++++++++++++++ decoder/tests/source/simple_pkt_c_api.c | 1 + 13 files changed, 1839 insertions(+), 440 deletions(-) create mode 100644 decoder/include/c_api/ocsd_c_api_deprc_fn.h create mode 100644 decoder/source/c_api/ocsd_c_api_deprc_fn.cpp create mode 100644 decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj create mode 100644 decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj.filters create mode 100644 decoder/tests/source/c_api_pkt_print_test.c

diff --git a/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj b/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj index ec0f0b7..f1019c1 100644 --- a/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj +++ b/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj @@ -296,6 +296,7 @@ </Link> </ItemDefinitionGroup> <ItemGroup> + <ClInclude Include="..\..\..\include\c_api\ocsd_c_api_deprc_fn.h" /> <ClInclude Include="..\..\..\include\c_api\ocsd_c_api_types.h" /> <ClInclude Include="..\..\..\include\c_api\opencsd_c_api.h" /> <ClInclude Include="..\..\..\source\c_api\ocsd_c_api_obj.h" /> @@ -307,6 +308,7 @@ </ItemGroup> <ItemGroup> <ClCompile Include="..\..\..\source\c_api\ocsd_c_api.cpp" /> + <ClCompile Include="..\..\..\source\c_api\ocsd_c_api_deprc_fn.cpp" /> </ItemGroup> <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" /> <ImportGroup Label="ExtensionTargets"> diff --git a/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj.filters b/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj.filters index b75f980..6b0484c 100644 --- a/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj.filters +++ b/decoder/build/win/rctdl_c_api_lib/rctdl_c_api_lib.vcxproj.filters @@ -24,10 +24,16 @@ <ClInclude Include="..\..\..\source\c_api\ocsd_c_api_obj.h"> <Filter>Source Files</Filter> </ClInclude> + <ClInclude Include="..\..\..\include\c_api\ocsd_c_api_deprc_fn.h"> + <Filter>Header Files</Filter> + </ClInclude> </ItemGroup> <ItemGroup> <ClCompile Include="..\..\..\source\c_api\ocsd_c_api.cpp"> <Filter>Source Files</Filter> </ClCompile> + <ClCompile Include="..\..\..\source\c_api\ocsd_c_api_deprc_fn.cpp"> + <Filter>Source Files</Filter> + </ClCompile> </ItemGroup> </Project> \ No newline at end of file diff --git a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.sln b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.sln index 9795338..fbeae9b 100644 --- a/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.sln +++ b/decoder/build/win/ref_trace_decode_lib/ref_trace_decode_lib.sln @@ -1,9 +1,9 @@  Microsoft Visual Studio Solution File, Format Version 11.00 # Visual Studio 2010 -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ref_trace_decode_lib", "ref_trace_decode_lib.vcxproj", "{7F500891-CC76-405F-933F-F682BC39F923}" +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "opencsd_lib", "ref_trace_decode_lib.vcxproj", "{7F500891-CC76-405F-933F-F682BC39F923}" EndProject -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "rctdl_c_api_lib", "..\rctdl_c_api_lib\rctdl_c_api_lib.vcxproj", "{533F929A-A73B-46B6-9D5F-FFCD62F734E3}" +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ocsd_c_api_lib", "..\rctdl_c_api_lib\rctdl_c_api_lib.vcxproj", "{533F929A-A73B-46B6-9D5F-FFCD62F734E3}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "snapshot_parser_lib", "......\tests\build\win\snapshot_parser_lib\snapshot_parser_lib.vcxproj", "{DE1F395D-4F53-42FB-8AEF-993A4BF7E411}" EndProject @@ -14,6 +14,11 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "simple_pkt_print_c_api", ". {533F929A-A73B-46B6-9D5F-FFCD62F734E3} = {533F929A-A73B-46B6-9D5F-FFCD62F734E3} EndProjectSection EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "c_api_pkt_print_test", "......\tests\build\win\c_api_pkt_print_test\c_api_pkt_print_test.vcxproj", "{3AC169DA-E156-4D16-95DF-73D7302A5606}" + ProjectSection(ProjectDependencies) = postProject + {533F929A-A73B-46B6-9D5F-FFCD62F734E3} = {533F929A-A73B-46B6-9D5F-FFCD62F734E3} + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Win32 = Debug|Win32 @@ -98,6 +103,22 @@ Global {D18112ED-E2D7-4D49-B1F0-15E98967AC0A}.Release-dll|Win32.Build.0 = Release-dll|Win32 {D18112ED-E2D7-4D49-B1F0-15E98967AC0A}.Release-dll|x64.ActiveCfg = Release-dll|x64 {D18112ED-E2D7-4D49-B1F0-15E98967AC0A}.Release-dll|x64.Build.0 = Release-dll|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug|Win32.ActiveCfg = Debug|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug|Win32.Build.0 = Debug|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug|x64.ActiveCfg = Debug|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug|x64.Build.0 = Debug|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug-dll|Win32.ActiveCfg = Debug-dll|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug-dll|Win32.Build.0 = Debug-dll|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug-dll|x64.ActiveCfg = Debug-dll|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Debug-dll|x64.Build.0 = Debug-dll|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release|Win32.ActiveCfg = Release|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release|Win32.Build.0 = Release|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release|x64.ActiveCfg = Release|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release|x64.Build.0 = Release|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release-dll|Win32.ActiveCfg = Release-dll|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release-dll|Win32.Build.0 = Release-dll|Win32 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release-dll|x64.ActiveCfg = Release-dll|x64 + {3AC169DA-E156-4D16-95DF-73D7302A5606}.Release-dll|x64.Build.0 = Release-dll|x64 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/decoder/include/c_api/ocsd_c_api_deprc_fn.h b/decoder/include/c_api/ocsd_c_api_deprc_fn.h new file mode 100644 index 0000000..70986ff --- /dev/null +++ b/decoder/include/c_api/ocsd_c_api_deprc_fn.h @@ -0,0 +1,175 @@ +/*! + * \file ocsd_c_api_deprc_fn.h + * \brief OpenCSD : Deprecated C-API functions + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef ARM_OCSD_C_API_DEPRC_FN_H_INCLUDED +#define ARM_OCSD_C_API_DEPRC_FN_H_INCLUDED + +/** @name Deprecated C-API functions +@{*/ + +/*---------------------- ETMv4 Trace ----------------------------------------------------------------------------------*/ +/*! + * Create an ETMv4 instruction trace packet processor only for the supplied configuration. + * Must supply an output callback function which handles the etmv4 packet types, to attach to the packet processor. + * + * @param handle : handle a decode tree to create the packet processsor. + * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. + * @param pPktFn : pointer to a packet handling callback function. + * @param p_context : opaque context pointer value used in callback function.. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_pkt_proc(const dcd_tree_handle_t handle, const void *etmv4_cfg, FnEtmv4IPacketDataIn pPktFn, const void *p_context); + +/*! + * Creates a packet processor + packet decoder pair for the supplied configuration structure. + * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. + * + * @param handle : Handle to decode tree. + * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_decoder(const dcd_tree_handle_t handle, const void *etmv4_cfg); + +/*! + * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. + * + * @param handle : Handle to decode tree. + * @param trc_chan_id : CoreSight Trace ID for packet processor + * @param pPktFn : Function to attach to monitor point. + * @param p_context : opaque context pointer value used in callback function. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv4i_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv4IPktMonDataIn pPktFn, const void *p_context); + +/*---------------------- ETMv3 trace ----------------------------------------------------------------------------------*/ +/*! + * Create an ETMv3 trace packet processor only for the supplied configuration. + * Must supply an output callback function which handles the etmv3 packet types, to attach to the packet processor. + * + * @param handle : handle a decode tree to create the packet processsor. + * @param *etmv3_cfg : pointer to valid Etmv3 configuration structure. + * @param pPktFn : pointer to a packet handling callback function. + * @param p_context : opaque context pointer value used in callback function. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_pkt_proc(const dcd_tree_handle_t handle, const void *etmv3_cfg, FnEtmv3PacketDataIn pPktFn, const void *p_context); + + +/*! + * Creates a packet processor + packet decoder pair for the supplied configuration structure. + * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. + * + * @param handle : Handle to decode tree. + * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_decoder(const dcd_tree_handle_t handle, const void *etmv3_cfg); + + + +/*! + * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. + * Packet processor must exist for the trace ID and be an ETMv3 processor. + * + * @param handle : Handle to decode tree. + * @param trc_chan_id : CoreSight Trace ID for packet processor + * @param pPktFn : Function to attach to monitor point. + * @param p_context : opaque context pointer value used in callback function. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv3_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv3PktMonDataIn pPktFn, const void *p_context); + +/*---------------------- PTM Trace ----------------------------------------------------------------------------------*/ +/*! + * Create an PTM instruction trace packet processor only for the supplied configuration. + * Must supply an output callback function which handles the ptm packet types, to attach to the packet processor. + * + * @param handle : handle a decode tree to create the packet processsor. + * @param *ptm_cfg : pointer to valid Ptm configuration structure. + * @param pPktFn : pointer to a packet handling callback function. + * @param p_context : opaque context pointer value used in callback function.. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_pkt_proc(const dcd_tree_handle_t handle, const void *ptm_cfg, FnPtmPacketDataIn pPktFn, const void *p_context); + +/*! + * Creates a packet processor + packet decoder pair for the supplied configuration structure. + * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. + * + * @param handle : Handle to decode tree. + * @param *ptm_cfg : pointer to valid Ptm configuration structure. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_decoder(const dcd_tree_handle_t handle, const void *ptm_cfg); + +/*! + * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. + * + * @param handle : Handle to decode tree. + * @param trc_chan_id : CoreSight Trace ID for packet processor + * @param pPktFn : Function to attach to monitor point. + * @param p_context : opaque context pointer value used in callback function. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_attach_ptm_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnPtmPktMonDataIn pPktFn, const void *p_context); + + +/*---------------------- STM Trace ----------------------------------------------------------------------------------*/ +/*! + * Create an STM trace packet processor only for the supplied configuration. + * Must supply an output callback function which handles the stm packet types, to attach to the packet processor. + * + * @param handle : handle a decode tree to create the packet processsor. + * @param *stm_cfg : pointer to valid Stm configuration structure. + * @param pPktFn : pointer to a packet handling callback function. + * @param p_context : opaque context pointer value used in callback function. + * + * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + */ +OCSD_C_API ocsd_err_t ocsd_dt_create_stm_pkt_proc(const dcd_tree_handle_t handle, const void *stm_cfg, FnStmPacketDataIn pPktFn, const void *p_context); + +/** @}*/ + +#endif // ARM_OCSD_C_API_DEPRC_FN_H_INCLUDED + +/* End of File ocsd_c_api_deprc_fn.h */ diff --git a/decoder/include/c_api/ocsd_c_api_types.h b/decoder/include/c_api/ocsd_c_api_types.h index a58a67e..1e98255 100644 --- a/decoder/include/c_api/ocsd_c_api_types.h +++ b/decoder/include/c_api/ocsd_c_api_types.h @@ -58,7 +58,6 @@ typedef void * dcd_tree_handle_t; /** define invalid handle value for decode tree handle */ #define C_API_INVALID_TREE_HANDLE (dcd_tree_handle_t)0

- /** Logger output printer - no output. */ #define C_API_MSGLOGOUT_FLG_NONE 0x0 /** Logger output printer - output to file. */ @@ -71,7 +70,24 @@ typedef void * dcd_tree_handle_t; #define C_API_MSGLOGOUT_MASK 0x7

/** function pointer type for decoder outputs. all protocols, generic data element input */ -typedef ocsd_datapath_resp_t (* FnTraceElemIn)(const void *p_context, const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const ocsd_generic_trace_elem *elem); +typedef ocsd_datapath_resp_t (* FnTraceElemIn)( const void *p_context, + const ocsd_trc_index_t index_sop, + const uint8_t trc_chan_id, + const ocsd_generic_trace_elem *elem); + +/** function pointer type for packet processor packet output sink, packet analyser/decoder input - generic declaration */ +typedef ocsd_datapath_resp_t (* FnDefPktDataIn)(const void *p_context, + const ocsd_datapath_op_t op, + const ocsd_trc_index_t index_sop, + const void *p_packet_in); + +/** function pointer type for packet processor packet monitor sink, raw packet monitor / display input - generic declaration */ +typedef void (* FnDefPktDataMon)(const void *p_context, + const ocsd_datapath_op_t op, + const ocsd_trc_index_t index_sop, + const void *p_packet_in, + const uint32_t size, + const uint8_t *p_data);

/** function pointer type for ETMv4 instruction packet processor output, packet analyser/decoder input */ typedef ocsd_datapath_resp_t (* FnEtmv4IPacketDataIn)(const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const ocsd_etmv4_i_pkt *p_packet_in); @@ -127,6 +143,12 @@ typedef struct _file_mem_region { size_t region_size; /**< size in bytes of memory region */ } file_mem_region_t;

+typedef enum _ocsd_c_api_cb_types { + OCSD_C_API_CB_PKT_SINK, + OCSD_C_API_CB_PKT_MON, +} ocsd_c_api_cb_types; + + /** @}*/

#endif // ARM_OCSD_C_API_TYPES_H_INCLUDED diff --git a/decoder/include/c_api/opencsd_c_api.h b/decoder/include/c_api/opencsd_c_api.h index 5574f19..7c0648a 100644 --- a/decoder/include/c_api/opencsd_c_api.h +++ b/decoder/include/c_api/opencsd_c_api.h @@ -147,144 +147,68 @@ OCSD_C_API ocsd_datapath_resp_t ocsd_dt_process_data(const dcd_tree_handle_t han * A single function is used for all trace source IDs in the decode tree. * * @param handle : Handle to decode tree. - * @param pFn : Pointer to the callback functions. + * @param pFn : Pointer to the callback function. * @param p_context : opaque context pointer value used in callback function. * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. + * @return ocsd_err_t : Library error code - OCSD_OK if successful. */ OCSD_C_API ocsd_err_t ocsd_dt_set_gen_elem_outfn(const dcd_tree_handle_t handle, FnTraceElemIn pFn, const void *p_context);

-/*---------------------- ETMv4 Trace ----------------------------------------------------------------------------------*/ +/*---------------------- Trace Decoders ----------------------------------------------------------------------------------*/ /*! - * Create an ETMv4 instruction trace packet processor only for the supplied configuration. - * Must supply an output callback function which handles the etmv4 packet types, to attach to the packet processor. - * - * @param handle : handle a decode tree to create the packet processsor. - * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. - * @param pPktFn : pointer to a packet handling callback function. - * @param p_context : opaque context pointer value used in callback function.. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_pkt_proc(const dcd_tree_handle_t handle, const void *etmv4_cfg, FnEtmv4IPacketDataIn pPktFn, const void *p_context); +* <Detailed description of the method> +* +* @param handle : Handle to decode tree. +* @param *decoder_name : +* @param create_flags : +* @param *decoder_cfg : +* @param *pCSID : Pointer to location to return the configured CoreSight trace ID for the decoder. +* +* @return ocsd_err_t : +*/ +OCSD_C_API ocsd_err_t ocsd_dt_create_decoder(const dcd_tree_handle_t handle, + const char *decoder_name, + const int create_flags, + const void *decoder_cfg, + unsigned char *pCSID + );

/*! - * Creates a packet processor + packet decoder pair for the supplied configuration structure. - * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. - * - * @param handle : Handle to decode tree. - * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_decoder(const dcd_tree_handle_t handle, const void *etmv4_cfg); +* <Detailed description of the method> +* +* @param handle : Handle to decode tree. +* @param CSID : Configured CoreSight trace ID for the decoder. +* +* @return ocsd_err_t : +*/ +OCSD_C_API ocsd_err_t ocsd_dt_remove_decoder( const dcd_tree_handle_t handle, + const unsigned char CSID);

-/*! - * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. - * - * @param handle : Handle to decode tree. - * @param trc_chan_id : CoreSight Trace ID for packet processor - * @param pPktFn : Function to attach to monitor point. - * @param p_context : opaque context pointer value used in callback function. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv4i_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv4IPktMonDataIn pPktFn, const void *p_context);

-/*---------------------- ETMv3 trace ----------------------------------------------------------------------------------*/ /*! - * Create an ETMv3 trace packet processor only for the supplied configuration. - * Must supply an output callback function which handles the etmv3 packet types, to attach to the packet processor. - * - * @param handle : handle a decode tree to create the packet processsor. - * @param *etmv3_cfg : pointer to valid Etmv3 configuration structure. - * @param pPktFn : pointer to a packet handling callback function. - * @param p_context : opaque context pointer value used in callback function. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_pkt_proc(const dcd_tree_handle_t handle, const void *etmv3_cfg, FnEtmv3PacketDataIn pPktFn, const void *p_context); +* Attach a callback function to the packet processor. +* +* The callback_type defines the attachment point:- +* +* +* @param handle : Handle to decode tree. +* @param CSID : Configured CoreSight trace ID for the decoder. +* @param callback_type : +* @param p_fn_pkt_data_in : Pointer to the callback function. +* @param p_context : Opaque context pointer value used in callback function. +* +* @return ocsd_err_t : +*/ +OCSD_C_API ocsd_err_t ocsd_dt_attach_packet_callback( const dcd_tree_handle_t handle, + const unsigned char CSID, + const ocsd_c_api_cb_types callback_type, + void *p_fn_callback_data, + const void *p_context);

-/*! - * Creates a packet processor + packet decoder pair for the supplied configuration structure. - * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. - * - * @param handle : Handle to decode tree. - * @param *etmv4_cfg : pointer to valid Etmv4 configuration structure. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_decoder(const dcd_tree_handle_t handle, const void *etmv3_cfg);

-/*! - * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. - * Packet processor must exist for the trace ID and be an ETMv3 processor. - * - * @param handle : Handle to decode tree. - * @param trc_chan_id : CoreSight Trace ID for packet processor - * @param pPktFn : Function to attach to monitor point. - * @param p_context : opaque context pointer value used in callback function. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv3_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv3PktMonDataIn pPktFn, const void *p_context); - -/*---------------------- PTM Trace ----------------------------------------------------------------------------------*/ -/*! - * Create an PTM instruction trace packet processor only for the supplied configuration. - * Must supply an output callback function which handles the ptm packet types, to attach to the packet processor. - * - * @param handle : handle a decode tree to create the packet processsor. - * @param *ptm_cfg : pointer to valid Ptm configuration structure. - * @param pPktFn : pointer to a packet handling callback function. - * @param p_context : opaque context pointer value used in callback function.. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_pkt_proc(const dcd_tree_handle_t handle, const void *ptm_cfg, FnPtmPacketDataIn pPktFn, const void *p_context); - -/*! - * Creates a packet processor + packet decoder pair for the supplied configuration structure. - * Uses the output function set in ocsd_dt_set_gen_elem_outfn() as the output sink. - * - * @param handle : Handle to decode tree. - * @param *ptm_cfg : pointer to valid Ptm configuration structure. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_decoder(const dcd_tree_handle_t handle, const void *ptm_cfg); - -/*! - * Attach a callback function to the packet processor monitor point defined by the CoreSight ID. - * - * @param handle : Handle to decode tree. - * @param trc_chan_id : CoreSight Trace ID for packet processor - * @param pPktFn : Function to attach to monitor point. - * @param p_context : opaque context pointer value used in callback function. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_attach_ptm_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnPtmPktMonDataIn pPktFn, const void *p_context); - - -/*---------------------- STM Trace ----------------------------------------------------------------------------------*/ -/*! - * Create an STM trace packet processor only for the supplied configuration. - * Must supply an output callback function which handles the stm packet types, to attach to the packet processor. - * - * @param handle : handle a decode tree to create the packet processsor. - * @param *stm_cfg : pointer to valid Stm configuration structure. - * @param pPktFn : pointer to a packet handling callback function. - * @param p_context : opaque context pointer value used in callback function. - * - * @return ocsd_err_t : Library error code - RCDTL_OK if successful. - */ -OCSD_C_API ocsd_err_t ocsd_dt_create_stm_pkt_proc(const dcd_tree_handle_t handle, const void *stm_cfg, FnStmPacketDataIn pPktFn, const void *p_context); - - /** TBD : more C API functions to be added here */

/** @}*/ @@ -455,6 +379,10 @@ OCSD_C_API ocsd_err_t ocsd_gen_elem_str(const ocsd_generic_trace_elem *p_pkt, ch

/** @}*/

+#ifdef OPENCSD_INC_DEPRECATED_API +#include "ocsd_c_api_deprc_fn.h" +#endif + #endif // ARM_OPENCSD_C_API_H_INCLUDED

diff --git a/decoder/source/c_api/ocsd_c_api.cpp b/decoder/source/c_api/ocsd_c_api.cpp index d66cdb0..1e327ae 100644 --- a/decoder/source/c_api/ocsd_c_api.cpp +++ b/decoder/source/c_api/ocsd_c_api.cpp @@ -52,7 +52,9 @@ namespace std { const nothrow_t nothrow = nothrow_t(); } /*******************************************************************************/ /* C API internal helper function declarations */ /*******************************************************************************/ -static ocsd_err_t ocsd_dt_attach_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, ocsd_trace_protocol_t protocol, ITrcTypedBase *pPktMonIf, TraceElemCBBase *pCBObj); + +static ocsd_err_t ocsd_create_pkt_sink_cb(ocsd_trace_protocol_t protocol, FnDefPktDataIn pPktInFn, const void *p_context, ITrcTypedBase **ppCBObj ); +static ocsd_err_t ocsd_create_pkt_mon_cb(ocsd_trace_protocol_t protocol, FnDefPktDataMon pPktInFn, const void *p_context, ITrcTypedBase **ppCBObj );

/*******************************************************************************/ /* C library data - additional data on top of the C++ library objects */ @@ -60,7 +62,7 @@ static ocsd_err_t ocsd_dt_attach_pkt_mon(const dcd_tree_handle_t handle, const u

/* keep a list of interface objects for a decode tree for later disposal */ typedef struct _lib_dt_data_list { - std::vector<TraceElemCBBase *> cb_objs; + std::vector<ITrcTypedBase *> cb_objs; } lib_dt_data_list;

/* map lists to handles */ @@ -83,6 +85,8 @@ OCSD_C_API const char * ocsd_get_version_str(void) }

+/*** Decode tree creation etc. */ + OCSD_C_API dcd_tree_handle_t ocsd_create_dcd_tree(const ocsd_dcd_tree_src_t src_type, const uint32_t deformatterCfgFlags) { dcd_tree_handle_t handle = C_API_INVALID_TREE_HANDLE; @@ -116,7 +120,7 @@ OCSD_C_API void ocsd_destroy_dcd_tree(const dcd_tree_handle_t handle) it = s_data_map.find(handle); if(it != s_data_map.end()) { - std::vector<TraceElemCBBase *>::iterator itcb; + std::vector<ITrcTypedBase *>::iterator itcb; itcb = it->second->cb_objs.begin(); while(itcb != it->second->cb_objs.end()) { @@ -131,6 +135,8 @@ OCSD_C_API void ocsd_destroy_dcd_tree(const dcd_tree_handle_t handle) } }

+/*** Decode tree process data */ + OCSD_C_API ocsd_datapath_resp_t ocsd_dt_process_data(const dcd_tree_handle_t handle, const ocsd_datapath_op_t op, const ocsd_trc_index_t index, @@ -144,325 +150,85 @@ OCSD_C_API ocsd_datapath_resp_t ocsd_dt_process_data(const dcd_tree_handle_t han return resp; }

-OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_pkt_proc(const dcd_tree_handle_t handle, const void *etmv4_cfg, FnEtmv4IPacketDataIn pPktFn, const void *p_context) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - EtmV4Config cfg; - cfg = static_cast<const ocsd_etmv4_cfg *>(etmv4_cfg); - EtmV4ICBObj *p_CBObj = new (std::nothrow) EtmV4ICBObj(pPktFn,p_context); - - if(p_CBObj == 0) - err = OCSD_ERR_MEM; +/*** Decode tree - decoder management */

- if(err == OCSD_OK) - { - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_ETMV4I,OCSD_CREATE_FLG_PACKET_PROC,&cfg); - if(err == OCSD_OK) - { - DecodeTreeElement *pTElem = ((DecodeTree *)handle)->getDecoderElement(cfg.getTraceID()); - if(pTElem) - err = pTElem->getDecoderMngr()->attachPktSink(pTElem->getDecoderHandle(),p_CBObj); - else - err = OCSD_ERR_INVALID_PARAM_VAL; - } - } - if(err == OCSD_OK) - { - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(p_CBObj); - - } - else - delete p_CBObj; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} - -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_decoder(const dcd_tree_handle_t handle, const void *etmv4_cfg) +OCSD_C_API ocsd_err_t ocsd_dt_create_decoder(const dcd_tree_handle_t handle, + const char *decoder_name, + const int create_flags, + const void *decoder_cfg, + unsigned char *pCSID + ) { ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - EtmV4Config cfg; - cfg = static_cast<const ocsd_etmv4_cfg *>(etmv4_cfg); - - // no need for a spcific CB object here - standard generic elements output used. - if(err == OCSD_OK) - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_ETMV4I,OCSD_CREATE_FLG_FULL_DECODER,&cfg); - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} - -OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv4i_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv4IPktMonDataIn pPktFn, const void *p_context) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - DecodeTree *pDT = static_cast<DecodeTree *>(handle); - DecodeTreeElement *pDTElem = pDT->getDecoderElement(trc_chan_id); - if((pDTElem != 0) && (pDTElem->getProtocol() == OCSD_PROTOCOL_ETMV4I)) - { - EtmV4IPktMonCBObj *pktMonObj = new (std::nothrow) EtmV4IPktMonCBObj(pPktFn, p_context); - if(pktMonObj != 0) - { - err = pDTElem->getDecoderMngr()->attachPktMonitor(pDTElem->getDecoderHandle(),pktMonObj); - - if(err == OCSD_OK) - { - // save object pointer for destruction later. - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(pktMonObj); - } - else - delete pktMonObj; - } - else - err = OCSD_ERR_MEM; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; // trace ID not found or not match for element protocol type. - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} - -OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_pkt_proc(const dcd_tree_handle_t handle, const void *etmv3_cfg, FnEtmv3PacketDataIn pPktFn, const void *p_context) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - EtmV3Config cfg; - cfg = static_cast<const ocsd_etmv3_cfg *>(etmv3_cfg); - EtmV3CBObj *p_CBObj = new (std::nothrow) EtmV3CBObj(pPktFn, p_context); - - if(p_CBObj == 0) - err = OCSD_ERR_MEM; + DecodeTree *dt = (DecodeTree *)handle; + std::string dName = decoder_name; + IDecoderMngr *pDcdMngr; + err = OcsdLibDcdRegister::getDecoderRegister()->getDecoderMngrByName(dName,&pDcdMngr); + if(err != OCSD_OK) + return err;

- if(err == OCSD_OK) - { - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_ETMV3,OCSD_CREATE_FLG_PACKET_PROC,&cfg); - if(err == OCSD_OK) - { - DecodeTreeElement *pTElem = ((DecodeTree *)handle)->getDecoderElement(cfg.getTraceID()); - if(pTElem) - err = pTElem->getDecoderMngr()->attachPktSink(pTElem->getDecoderHandle(),p_CBObj); - else - err = OCSD_ERR_INVALID_PARAM_VAL; - } - } + CSConfig *pConfig = 0; + err = pDcdMngr->createConfigFromDataStruct(&pConfig,decoder_cfg); + if(err != OCSD_OK) + return err;

- if(err == OCSD_OK) - { - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(p_CBObj); - } - else - delete p_CBObj; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; + err = dt->createDecoder(dName,create_flags,pConfig); + if(err == OCSD_OK) + *pCSID = pConfig->getTraceID(); + delete pConfig; return err; }

-OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_decoder(const dcd_tree_handle_t handle, const void *etmv3_cfg) +OCSD_C_API ocsd_err_t ocsd_dt_remove_decoder( const dcd_tree_handle_t handle, + const unsigned char CSID) { - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - EtmV3Config cfg; - cfg = static_cast<const ocsd_etmv3_cfg *>(etmv3_cfg); - - // no need for a spcific CB object here - standard generic elements output used. - if(err == OCSD_OK) - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_ETMV3,OCSD_CREATE_FLG_FULL_DECODER,&cfg); - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; + return ((DecodeTree *)handle)->removeDecoder(CSID); }

-OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv3_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv3PktMonDataIn pPktFn, const void *p_context) +OCSD_C_API ocsd_err_t ocsd_dt_attach_packet_callback( const dcd_tree_handle_t handle, + const unsigned char CSID, + const ocsd_c_api_cb_types callback_type, + void *p_fn_callback_data, + const void *p_context) { ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - DecodeTree *pDT = static_cast<DecodeTree *>(handle); - DecodeTreeElement *pDTElem = pDT->getDecoderElement(trc_chan_id); - if((pDTElem != 0) && (pDTElem->getProtocol() == OCSD_PROTOCOL_ETMV3)) - { - EtmV3PktMonCBObj *pktMonObj = new (std::nothrow) EtmV3PktMonCBObj(pPktFn, p_context); - if(pktMonObj != 0) - { - err = pDTElem->getDecoderMngr()->attachPktMonitor(pDTElem->getDecoderHandle(),pktMonObj); - - if(err == OCSD_OK) - { - // save object pointer for destruction later. - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(pktMonObj); - } - else - delete pktMonObj; - } - else - err = OCSD_ERR_MEM; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; // trace ID not found or not match for element protocol type. - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} - + DecodeTree *pDT = static_cast<DecodeTree *>(handle); + DecodeTreeElement *pElem = pDT->getDecoderElement(CSID); + if(pElem == 0) + return OCSD_ERR_INVALID_ID; // cannot find entry for that CSID

-OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_pkt_proc(const dcd_tree_handle_t handle, const void *ptm_cfg, FnPtmPacketDataIn pPktFn, const void *p_context) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) + ITrcTypedBase *pDataInSink = 0; // pointer to a sink callback object + switch(callback_type) { - PtmConfig cfg; - cfg = static_cast<const ocsd_ptm_cfg *>(ptm_cfg); - PtmCBObj *p_CBObj = new (std::nothrow) PtmCBObj(pPktFn, p_context); - - if(p_CBObj == 0) - err = OCSD_ERR_MEM; - - if(err == OCSD_OK) - { - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_PTM,OCSD_CREATE_FLG_PACKET_PROC,&cfg); - if(err == OCSD_OK) - { - DecodeTreeElement *pTElem = ((DecodeTree *)handle)->getDecoderElement(cfg.getTraceID()); - if(pTElem) - err = pTElem->getDecoderMngr()->attachPktSink(pTElem->getDecoderHandle(),p_CBObj); - else - err = OCSD_ERR_INVALID_PARAM_VAL; - } - } + case OCSD_C_API_CB_PKT_SINK: + err = ocsd_create_pkt_sink_cb(pElem->getProtocol(),(FnDefPktDataIn)p_fn_callback_data,p_context,&pDataInSink); + break;

- if(err == OCSD_OK) - { - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(p_CBObj); - } - else - delete p_CBObj; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} + case OCSD_C_API_CB_PKT_MON: + err = ocsd_create_pkt_mon_cb(pElem->getProtocol(),(FnDefPktDataMon)p_fn_callback_data,p_context,&pDataInSink); + break;

-OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_decoder(const dcd_tree_handle_t handle, const void *ptm_cfg) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) - { - PtmConfig cfg; - cfg = static_cast<const ocsd_ptm_cfg *>(ptm_cfg); - - // no need for a spcific CB object here - standard generic elements output used. - if(err == OCSD_OK) - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_PTM,OCSD_CREATE_FLG_FULL_DECODER,&cfg); - } - else + default: err = OCSD_ERR_INVALID_PARAM_VAL; - return err; -} - -OCSD_C_API ocsd_err_t ocsd_dt_attach_ptm_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnPtmPktMonDataIn pPktFn, const void *p_context) -{ - - ocsd_err_t err = OCSD_OK; - PtmPktMonCBObj *pktMonObj = new (std::nothrow) PtmPktMonCBObj(pPktFn, p_context); - err = ocsd_dt_attach_pkt_mon(handle,trc_chan_id,OCSD_PROTOCOL_PTM,pktMonObj,pktMonObj); - if(err != OCSD_OK) - delete pktMonObj; - -#if 0 - if(handle != C_API_INVALID_TREE_HANDLE) - { - DecodeTree *pDT = static_cast<DecodeTree *>(handle); - DecodeTreeElement *pDTElem = pDT->getDecoderElement(trc_chan_id); - if((pDTElem != 0) && (pDTElem->getProtocol() == OCSD_PROTOCOL_PTM)) - { - PtmPktMonCBObj *pktMonObj = new (std::nothrow) PtmPktMonCBObj(pPktFn, p_context); - if(pktMonObj != 0) - { - err = pDTElem->getDecoderMngr()->attachPktMonitor(pDTElem->getDecoderHandle(),pktMonObj); - - if(err == OCSD_OK) - { - // save object pointer for destruction later. - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(pktMonObj); - } - else - delete pktMonObj; - } - else - err = OCSD_ERR_MEM; - } - else - err = OCSD_ERR_INVALID_PARAM_VAL; // trace ID not found or not match for element protocol type. } - else - err = OCSD_ERR_INVALID_PARAM_VAL; -#endif - - return err; -}

-OCSD_C_API ocsd_err_t ocsd_dt_create_stm_pkt_proc(const dcd_tree_handle_t handle, const void *stm_cfg, FnStmPacketDataIn pPktFn, const void *p_context) -{ - ocsd_err_t err = OCSD_OK; - if(handle != C_API_INVALID_TREE_HANDLE) + if(err == OCSD_OK) { - STMConfig cfg; - cfg = static_cast<const ocsd_stm_cfg *>(stm_cfg); - StmCBObj *p_CBObj = new (std::nothrow) StmCBObj(pPktFn, p_context); - - if(p_CBObj == 0) - err = OCSD_ERR_MEM; - - if(err == OCSD_OK) - err = ((DecodeTree *)handle)->createDecoder(OCSD_BUILTIN_DCD_STM,OCSD_CREATE_FLG_FULL_DECODER,&cfg); - + err = pElem->getDecoderMngr()->attachPktSink(pElem->getDecoderHandle(),pDataInSink); if(err == OCSD_OK) { + // save object pointer for destruction later. std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; it = s_data_map.find(handle); if(it != s_data_map.end()) - it->second->cb_objs.push_back(p_CBObj); + it->second->cb_objs.push_back(pDataInSink); } - else - delete p_CBObj; } - else - err = OCSD_ERR_INVALID_PARAM_VAL; return err; }

+/*** Decode tree set element output */ + OCSD_C_API ocsd_err_t ocsd_dt_set_gen_elem_outfn(const dcd_tree_handle_t handle, FnTraceElemIn pFn, const void *p_context) {

@@ -475,6 +241,9 @@ OCSD_C_API ocsd_err_t ocsd_dt_set_gen_elem_outfn(const dcd_tree_handle_t handle, return OCSD_ERR_MEM; }

+ +/*** Default error logging */ + OCSD_C_API ocsd_err_t ocsd_def_errlog_init(const ocsd_err_severity_t verbosity, const int create_output_logger) { if(DecodeTree::getDefaultErrorLogger()->initErrorLogger(verbosity,(bool)(create_output_logger != 0))) @@ -504,6 +273,7 @@ OCSD_C_API void ocsd_def_errlog_msgout(const char *msg) pLogger->LogMsg(msg); }

+/*** Convert packet to string */

OCSD_C_API ocsd_err_t ocsd_pkt_str(const ocsd_trace_protocol_t pkt_protocol, const void *p_pkt, char *buffer, const int buffer_size) { @@ -561,6 +331,9 @@ OCSD_C_API ocsd_err_t ocsd_gen_elem_str(const ocsd_generic_trace_elem *p_pkt, ch return err; }

+ +/*** Decode tree -- memeory accessor control */ + OCSD_C_API ocsd_err_t ocsd_dt_add_binfile_mem_acc(const dcd_tree_handle_t handle, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const char *filepath) { ocsd_err_t err = OCSD_OK; @@ -741,36 +514,75 @@ OCSD_C_API void ocsd_tl_log_mapped_mem_ranges(const dcd_tree_handle_t handle) /*******************************************************************************/ /* C API local fns */ /*******************************************************************************/ -static ocsd_err_t ocsd_dt_attach_pkt_mon( const dcd_tree_handle_t handle, - const uint8_t trc_chan_id, - ocsd_trace_protocol_t protocol, - ITrcTypedBase *pPktMonIf, - TraceElemCBBase *pCBObj) +static ocsd_err_t ocsd_create_pkt_sink_cb(ocsd_trace_protocol_t protocol, FnDefPktDataIn pPktInFn, const void *p_context, ITrcTypedBase **ppCBObj ) { ocsd_err_t err = OCSD_OK; - if(handle == C_API_INVALID_TREE_HANDLE) - return OCSD_ERR_INVALID_PARAM_VAL; + *ppCBObj = 0;

- DecodeTree *pDT = static_cast<DecodeTree *>(handle); - DecodeTreeElement *pDTElem = pDT->getDecoderElement(trc_chan_id); - if((pDTElem != 0) && (pDTElem->getProtocol() == protocol)) + switch(protocol) { - err = pDTElem->getDecoderMngr()->attachPktMonitor(pDTElem->getDecoderHandle(),pPktMonIf); - - if(err == OCSD_OK) - { - // save object pointer for destruction later. - std::map<dcd_tree_handle_t, lib_dt_data_list *>::iterator it; - it = s_data_map.find(handle); - if(it != s_data_map.end()) - it->second->cb_objs.push_back(pCBObj); - } + case OCSD_PROTOCOL_ETMV4I: + *ppCBObj = new (std::nothrow) PktCBObj<EtmV4ITrcPacket,ocsd_etmv4_i_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_ETMV3: + *ppCBObj = new (std::nothrow) PktCBObj<EtmV3TrcPacket,ocsd_etmv3_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_PTM: + *ppCBObj = new (std::nothrow) PktCBObj<PtmTrcPacket,ocsd_ptm_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_STM: + *ppCBObj = new (std::nothrow) PktCBObj<StmTrcPacket,ocsd_stm_pkt>(pPktInFn,p_context); + break; + + default: + err = OCSD_ERR_NO_PROTOCOL; + break; } - else - err = OCSD_ERR_INVALID_PARAM_VAL; // trace ID not found or not match for element protocol type. + + if((*ppCBObj == 0) && (err == OCSD_OK)) + err = OCSD_ERR_MEM; + + return err; +} + +static ocsd_err_t ocsd_create_pkt_mon_cb(ocsd_trace_protocol_t protocol, FnDefPktDataMon pPktInFn, const void *p_context, ITrcTypedBase **ppCBObj ) +{ + ocsd_err_t err = OCSD_OK; + *ppCBObj = 0; + + switch(protocol) + { + case OCSD_PROTOCOL_ETMV4I: + *ppCBObj = new (std::nothrow) PktMonCBObj<EtmV4ITrcPacket,ocsd_etmv4_i_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_ETMV3: + *ppCBObj = new (std::nothrow) PktMonCBObj<EtmV3TrcPacket,ocsd_etmv3_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_PTM: + *ppCBObj = new (std::nothrow) PktMonCBObj<PtmTrcPacket,ocsd_ptm_pkt>(pPktInFn,p_context); + break; + + case OCSD_PROTOCOL_STM: + *ppCBObj = new (std::nothrow) PktMonCBObj<StmTrcPacket,ocsd_stm_pkt>(pPktInFn,p_context); + break; + + default: + err = OCSD_ERR_NO_PROTOCOL; + break; + } + + if((*ppCBObj == 0) && (err == OCSD_OK)) + err = OCSD_ERR_MEM; + return err; }

+ /*******************************************************************************/ /* C API Helper objects */ /*******************************************************************************/ @@ -789,6 +601,9 @@ ocsd_datapath_resp_t GenTraceElemCBObj::TraceElemIn(const ocsd_trc_index_t index return m_c_api_cb_fn(m_p_cb_context, index_sop, trc_chan_id, &elem); }

+ +#if 0 + /****************** Etmv4 packet processor output callback function ************/ EtmV4ICBObj::EtmV4ICBObj(FnEtmv4IPacketDataIn pCBFn, const void *p_context) : m_c_api_cb_fn(pCBFn), @@ -909,6 +724,6 @@ void StmPktMonCBObj::RawPacketDataMon( const ocsd_datapath_op_t op, { return m_c_api_cb_fn(m_p_cb_context, op, index_sop, p_packet_in, size, p_data); } - +#endif

/* End of File ocsd_c_api.cpp */ diff --git a/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp b/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp new file mode 100644 index 0000000..b5d0ff5 --- /dev/null +++ b/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp @@ -0,0 +1,200 @@ +/* + * \file ocsd_c_api_deprc_fn.cpp + * \brief OpenCSD : Deprecated C-API functions. + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/* pull in the C++ decode library */ +#include "opencsd.h" + +/* C-API and wrapper objects */ +#define OPENCSD_INC_DEPRECATED_API +#include "c_api/opencsd_c_api.h" +#include "ocsd_c_api_obj.h" + +#ifdef OPENCSD_INC_DEPRECATED_API + +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_pkt_proc(const dcd_tree_handle_t handle, const void *etmv4_cfg, FnEtmv4IPacketDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + uint8_t CSID = 0; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV4I,OCSD_CREATE_FLG_PACKET_PROC,etmv4_cfg,&CSID); + if(err == OCSD_OK) + { + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + if(err != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); + } + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_decoder(const dcd_tree_handle_t handle, const void *etmv4_cfg) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + uint8_t CSID = 0; + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV4I,OCSD_CREATE_FLG_FULL_DECODER,etmv4_cfg,&CSID); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv4i_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv4IPktMonDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_pkt_proc(const dcd_tree_handle_t handle, const void *etmv3_cfg, FnEtmv3PacketDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + uint8_t CSID = 0; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV3,OCSD_CREATE_FLG_PACKET_PROC,etmv3_cfg,&CSID); + if(err == OCSD_OK) + { + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + if(err != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); + } + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_decoder(const dcd_tree_handle_t handle, const void *etmv3_cfg) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + uint8_t CSID = 0; + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV3,OCSD_CREATE_FLG_FULL_DECODER,etmv3_cfg,&CSID); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv3_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnEtmv3PktMonDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + + +OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_pkt_proc(const dcd_tree_handle_t handle, const void *ptm_cfg, FnPtmPacketDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + uint8_t CSID = 0; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_PTM,OCSD_CREATE_FLG_PACKET_PROC,ptm_cfg,&CSID); + if(err == OCSD_OK) + { + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + if(err != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); + } + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; + +} + +OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_decoder(const dcd_tree_handle_t handle, const void *ptm_cfg) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + uint8_t CSID = 0; + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_PTM,OCSD_CREATE_FLG_FULL_DECODER,ptm_cfg,&CSID); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_attach_ptm_pkt_mon(const dcd_tree_handle_t handle, const uint8_t trc_chan_id, FnPtmPktMonDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +OCSD_C_API ocsd_err_t ocsd_dt_create_stm_pkt_proc(const dcd_tree_handle_t handle, const void *stm_cfg, FnStmPacketDataIn pPktFn, const void *p_context) +{ + ocsd_err_t err = OCSD_OK; + uint8_t CSID = 0; + if(handle != C_API_INVALID_TREE_HANDLE) + { + err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_STM,OCSD_CREATE_FLG_PACKET_PROC,stm_cfg,&CSID); + if(err == OCSD_OK) + { + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + if(err != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); + } + } + else + err = OCSD_ERR_INVALID_PARAM_VAL; + return err; +} + +#endif + +/* End of File ocsd_c_api_deprc_fn.cpp */ diff --git a/decoder/source/c_api/ocsd_c_api_obj.h b/decoder/source/c_api/ocsd_c_api_obj.h index 6b1f105..dbe6d08 100644 --- a/decoder/source/c_api/ocsd_c_api_obj.h +++ b/decoder/source/c_api/ocsd_c_api_obj.h @@ -34,6 +34,61 @@ private: const void *m_p_cb_context; };

+ + +template<class TrcPkt, class TrcPktStruct> +class PktCBObj : public IPktDataIn<TrcPkt> +{ +public: + PktCBObj( FnDefPktDataIn pCBFunc, const void *p_context) + { + m_c_api_cb_fn = pCBFunc; + m_p_context = p_context; + }; + + virtual ~PktCBObj() {}; + + virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, + const ocsd_trc_index_t index_sop, + const TrcPkt *p_packet_in) + { + return m_c_api_cb_fn(m_p_context,op,index_sop,(TrcPktStruct *)p_packet_in); + }; + +private: + FnDefPktDataIn m_c_api_cb_fn; + const void *m_p_context; +}; + + +template<class TrcPkt, class TrcPktStruct> +class PktMonCBObj : public IPktRawDataMon<TrcPkt> +{ +public: + PktMonCBObj( FnDefPktDataMon pCBFunc, const void *p_context) + { + m_c_api_cb_fn = pCBFunc; + m_p_context = p_context; + }; + + virtual ~PktMonCBObj() {}; + + virtual void RawPacketDataMon( const ocsd_datapath_op_t op, + const ocsd_trc_index_t index_sop, + const TrcPkt *p_packet_in, + const uint32_t size, + const uint8_t *p_data) + { + m_c_api_cb_fn(m_p_context,op,index_sop,(TrcPktStruct *)p_packet_in,size,p_data); + }; + +private: + FnDefPktDataMon m_c_api_cb_fn; + const void *m_p_context; +}; + +#if 0 + /************************************************************************/ /*** ETMv4 ***/ /************************************************************************/ @@ -184,6 +239,8 @@ private: const void *m_p_cb_context; };

+#endif + #endif // ARM_OCSD_C_API_OBJ_H_INCLUDED

/* End of File ocsd_c_api_obj.h */ diff --git a/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj b/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj new file mode 100644 index 0000000..0c03c76 --- /dev/null +++ b/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj @@ -0,0 +1,325 @@ +<?xml version="1.0" encoding="utf-8"?> +<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> + <ItemGroup Label="ProjectConfigurations"> + <ProjectConfiguration Include="Debug-dll|Win32"> + <Configuration>Debug-dll</Configuration> + <Platform>Win32</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Debug-dll|x64"> + <Configuration>Debug-dll</Configuration> + <Platform>x64</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Debug|Win32"> + <Configuration>Debug</Configuration> + <Platform>Win32</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Debug|x64"> + <Configuration>Debug</Configuration> + <Platform>x64</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Release-dll|Win32"> + <Configuration>Release-dll</Configuration> + <Platform>Win32</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Release-dll|x64"> + <Configuration>Release-dll</Configuration> + <Platform>x64</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Release|Win32"> + <Configuration>Release</Configuration> + <Platform>Win32</Platform> + </ProjectConfiguration> + <ProjectConfiguration Include="Release|x64"> + <Configuration>Release</Configuration> + <Platform>x64</Platform> + </ProjectConfiguration> + </ItemGroup> + <ItemGroup> + <ClCompile Include="..\..\..\source\c_api_pkt_print_test.c" /> + </ItemGroup> + <PropertyGroup Label="Globals"> + <ProjectGuid>{3AC169DA-E156-4D16-95DF-73D7302A5606}</ProjectGuid> + <Keyword>Win32Proj</Keyword> + <RootNamespace>c_api_pkt_print_test</RootNamespace> + </PropertyGroup> + <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" /> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>true</UseDebugLibraries> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|Win32'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>true</UseDebugLibraries> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>true</UseDebugLibraries> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|x64'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>true</UseDebugLibraries> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>false</UseDebugLibraries> + <WholeProgramOptimization>true</WholeProgramOptimization> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|Win32'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>false</UseDebugLibraries> + <WholeProgramOptimization>true</WholeProgramOptimization> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>false</UseDebugLibraries> + <WholeProgramOptimization>true</WholeProgramOptimization> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|x64'" Label="Configuration"> + <ConfigurationType>Application</ConfigurationType> + <UseDebugLibraries>false</UseDebugLibraries> + <WholeProgramOptimization>true</WholeProgramOptimization> + <CharacterSet>MultiByte</CharacterSet> + </PropertyGroup> + <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" /> + <ImportGroup Label="ExtensionSettings"> + </ImportGroup> + <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|Win32'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|x64'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|Win32'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <ImportGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|x64'" Label="PropertySheets"> + <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" /> + <Import Project="..\..\..\..\build\win\opencsd.props" /> + </ImportGroup> + <PropertyGroup Label="UserMacros" /> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'"> + <LinkIncremental>true</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\dbg</OutDir> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|Win32'"> + <LinkIncremental>true</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\dbg</OutDir> + <TargetName>$(ProjectName)-dl</TargetName> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'"> + <LinkIncremental>true</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\dbg</OutDir> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|x64'"> + <LinkIncremental>true</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\dbg</OutDir> + <TargetName>$(ProjectName)-dl</TargetName> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> + <LinkIncremental>false</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\rel</OutDir> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|Win32'"> + <LinkIncremental>false</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\rel</OutDir> + <TargetName>$(ProjectName)-dl</TargetName> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'"> + <LinkIncremental>false</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\rel</OutDir> + </PropertyGroup> + <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|x64'"> + <LinkIncremental>false</LinkIncremental> + <OutDir>......\bin\win$(PlatformArchitecture)\rel</OutDir> + <TargetName>$(ProjectName)-dl</TargetName> + </PropertyGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'"> + <ClCompile> + <PrecompiledHeader> + </PrecompiledHeader> + <WarningLevel>Level3</WarningLevel> + <Optimization>Disabled</Optimization> + <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;OCSD_USE_STATIC_C_API;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\dbg</AdditionalLibraryDirectories> + <AdditionalDependencies>lib$(LIB_CAPI_NAME).lib;lib$(LIB_BASE_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + <PostBuildEvent> + <Command> + </Command> + </PostBuildEvent> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|Win32'"> + <ClCompile> + <PrecompiledHeader> + </PrecompiledHeader> + <WarningLevel>Level3</WarningLevel> + <Optimization>Disabled</Optimization> + <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\dbg</AdditionalLibraryDirectories> + <AdditionalDependencies>$(LIB_CAPI_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + <PostBuildEvent> + <Command>copy ........\lib\win32\dbg*.dll ......\bin\win32\dbg.</Command> + </PostBuildEvent> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'"> + <ClCompile> + <PrecompiledHeader> + </PrecompiledHeader> + <WarningLevel>Level3</WarningLevel> + <Optimization>Disabled</Optimization> + <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;OCSD_USE_STATIC_C_API;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <AdditionalDependencies>lib$(LIB_CAPI_NAME).lib;lib$(LIB_BASE_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\dbg</AdditionalLibraryDirectories> + </Link> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug-dll|x64'"> + <ClCompile> + <PrecompiledHeader> + </PrecompiledHeader> + <WarningLevel>Level3</WarningLevel> + <Optimization>Disabled</Optimization> + <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\dbg</AdditionalLibraryDirectories> + <AdditionalDependencies>$(LIB_CAPI_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + <PostBuildEvent> + <Command>copy ........\lib\win64\dbg*.dll ......\bin\win64\dbg.</Command> + </PostBuildEvent> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'"> + <ClCompile> + <WarningLevel>Level3</WarningLevel> + <PrecompiledHeader> + </PrecompiledHeader> + <Optimization>MaxSpeed</Optimization> + <FunctionLevelLinking>true</FunctionLevelLinking> + <IntrinsicFunctions>true</IntrinsicFunctions> + <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;OCSD_USE_STATIC_C_API;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <EnableCOMDATFolding>true</EnableCOMDATFolding> + <OptimizeReferences>true</OptimizeReferences> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\rel</AdditionalLibraryDirectories> + <AdditionalDependencies>lib$(LIB_CAPI_NAME).lib;lib$(LIB_BASE_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|Win32'"> + <ClCompile> + <WarningLevel>Level3</WarningLevel> + <PrecompiledHeader> + </PrecompiledHeader> + <Optimization>MaxSpeed</Optimization> + <FunctionLevelLinking>true</FunctionLevelLinking> + <IntrinsicFunctions>true</IntrinsicFunctions> + <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <EnableCOMDATFolding>true</EnableCOMDATFolding> + <OptimizeReferences>true</OptimizeReferences> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\rel</AdditionalLibraryDirectories> + <AdditionalDependencies>kernel32.lib;user32.lib;gdi32.lib;winspool.lib;comdlg32.lib;advapi32.lib;shell32.lib;ole32.lib;oleaut32.lib;uuid.lib;odbc32.lib;odbccp32.lib;$(LIB_CAPI_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + <PostBuildEvent> + <Command>copy ........\lib\win32\rel*.dll ......\bin\win32\rel.</Command> + </PostBuildEvent> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'"> + <ClCompile> + <WarningLevel>Level3</WarningLevel> + <PrecompiledHeader> + </PrecompiledHeader> + <Optimization>MaxSpeed</Optimization> + <FunctionLevelLinking>true</FunctionLevelLinking> + <IntrinsicFunctions>true</IntrinsicFunctions> + <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;OCSD_USE_STATIC_C_API;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <EnableCOMDATFolding>true</EnableCOMDATFolding> + <OptimizeReferences>true</OptimizeReferences> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\rel</AdditionalLibraryDirectories> + <AdditionalDependencies>lib$(LIB_CAPI_NAME).lib;lib$(LIB_BASE_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + </ItemDefinitionGroup> + <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release-dll|x64'"> + <ClCompile> + <WarningLevel>Level3</WarningLevel> + <PrecompiledHeader> + </PrecompiledHeader> + <Optimization>MaxSpeed</Optimization> + <FunctionLevelLinking>true</FunctionLevelLinking> + <IntrinsicFunctions>true</IntrinsicFunctions> + <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions> + <AdditionalIncludeDirectories>........\include</AdditionalIncludeDirectories> + </ClCompile> + <Link> + <SubSystem>Console</SubSystem> + <GenerateDebugInformation>true</GenerateDebugInformation> + <EnableCOMDATFolding>true</EnableCOMDATFolding> + <OptimizeReferences>true</OptimizeReferences> + <AdditionalLibraryDirectories>........\lib\win$(PlatformArchitecture)\rel</AdditionalLibraryDirectories> + <AdditionalDependencies>$(LIB_CAPI_NAME).lib;%(AdditionalDependencies)</AdditionalDependencies> + </Link> + <PostBuildEvent> + <Command>copy ........\lib\win64\rel*.dll ......\bin\win64\rel.</Command> + </PostBuildEvent> + </ItemDefinitionGroup> + <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" /> + <ImportGroup Label="ExtensionTargets"> + </ImportGroup> +</Project> \ No newline at end of file diff --git a/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj.filters b/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj.filters new file mode 100644 index 0000000..e8fc90b --- /dev/null +++ b/decoder/tests/build/win/c_api_pkt_print_test/c_api_pkt_print_test.vcxproj.filters @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> + <ItemGroup> + <Filter Include="Source Files"> + <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier> + <Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions> + </Filter> + <Filter Include="Header Files"> + <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier> + <Extensions>h;hpp;hxx;hm;inl;inc;xsd</Extensions> + </Filter> + <Filter Include="Resource Files"> + <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier> + <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions> + </Filter> + </ItemGroup> + <ItemGroup> + <ClCompile Include="..\..\..\source\c_api_pkt_print_test.c"> + <Filter>Source Files</Filter> + </ClCompile> + </ItemGroup> +</Project> \ No newline at end of file diff --git a/decoder/tests/source/c_api_pkt_print_test.c b/decoder/tests/source/c_api_pkt_print_test.c new file mode 100644 index 0000000..138df1a --- /dev/null +++ b/decoder/tests/source/c_api_pkt_print_test.c @@ -0,0 +1,825 @@ +/* + * \file c_api_pkt_print_test.c + * \brief OpenCSD : C-API test program + * + * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved. + */ + +/* + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * 3. Neither the name of the copyright holder nor the names of its contributors + * may be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * Example of using the library with the C-API. Used to validate that the C-API + * functions work. + * + * Simple test program to print packets from a single trace ID source stream. + * Hard coded configuration based on the Juno r1-1 test snapshot for ETMv4 and + * STM, TC2 test snapshot for ETMv3, PTM. + * + * The test source can be set from the command line, but will default to the + * ETMv4 trace for trace ID 0x10 on the juno r1-1 test snapshot. + * This example uses the updated C-API functionality from library version 0v004 onwards. + */ + +#include <stdio.h> +#include <string.h> +#include <stdint.h> +#include <stdlib.h> + +/* include the C-API library header */ +#include "c_api/opencsd_c_api.h" + +/* path to test snapshots, relative to tests/bin/<plat>/<dbg|rel> build output dir */ +#ifdef _WIN32 +const char *default_path_to_snapshot = "..\..\..\snapshots\juno_r1_1\"; +const char *tc2_snapshot = "..\..\..\snapshots\TC2\"; +#else +const char *default_path_to_snapshot = "../../../snapshots/juno_r1_1/"; +const char *tc2_snapshot = "../../../snapshots/TC2/"; +#endif + +/* trace data and memory file dump names */ +const char *trace_data_filename = "cstrace.bin"; +const char *stmtrace_data_filename = "cstraceitm.bin"; +const char *memory_dump_filename = "kernel_dump.bin"; +ocsd_vaddr_t mem_dump_address=0xFFFFFFC000081000; +const ocsd_vaddr_t mem_dump_address_tc2=0xC0008000; + +/* test variables - set by command line to feature test API */ +static int using_mem_acc_cb = 0; /* test the memory access callback function */ +static int use_region_file = 0; /* test multi region memory files */ + +/* buffer to handle a packet string */ +#define PACKET_STR_LEN 1024 +static char packet_str[PACKET_STR_LEN]; + +/* decide if we decode & monitor, decode only or packet print */ +typedef enum _test_op { + TEST_PKT_PRINT, // process trace input into discrete packets and print. + TEST_PKT_DECODE, // process and decode trace packets, printing discrete packets and generic output. + TEST_PKT_DECODEONLY // process and decode trace packets, printing generic output packets only. +} test_op_t; + +// Default test operations +static test_op_t op = TEST_PKT_PRINT; // default operation is to packet print +static ocsd_trace_protocol_t test_protocol = OCSD_PROTOCOL_ETMV4I; // ETMV4 protocl +static uint8_t test_trc_id_override = 0x00; // no trace ID override. + + +/* Process command line options - choose the operation to use for the test. */ +static int process_cmd_line(int argc, char *argv[]) +{ + int idx = 1; + + while(idx < argc) + { + if(strcmp(argv[idx],"-decode_only") == 0) + { + op = TEST_PKT_DECODEONLY; + } + else if(strcmp(argv[idx],"-decode") == 0) + { + op = TEST_PKT_DECODE; + } + else if(strcmp(argv[idx],"-id") == 0) + { + idx++; + if(idx < argc) + { + test_trc_id_override = (uint8_t)(strtoul(argv[idx],0,0)); + printf("ID override = 0x%02X\n",test_trc_id_override); + } + } + else if(strcmp(argv[idx],"-etmv3") == 0) + { + test_protocol = OCSD_PROTOCOL_ETMV3; + default_path_to_snapshot = tc2_snapshot; + mem_dump_address = mem_dump_address_tc2; + } + else if(strcmp(argv[idx],"-ptm") == 0) + { + test_protocol = OCSD_PROTOCOL_PTM; + default_path_to_snapshot = tc2_snapshot; + mem_dump_address = mem_dump_address_tc2; + } + else if(strcmp(argv[idx],"-stm") == 0) + { + test_protocol = OCSD_PROTOCOL_STM; + trace_data_filename = stmtrace_data_filename; + } + else if(strcmp(argv[idx],"-test_cb") == 0) + { + using_mem_acc_cb = 1; + use_region_file = 0; + } + else if(strcmp(argv[idx],"-test_region_file") == 0) + { + use_region_file = 1; + using_mem_acc_cb = 0; + } + else if(strcmp(argv[idx],"-help") == 0) + { + return -1; + } + else + printf("Ignored unknown argument %s\n", argv[idx]); + idx++; + } + return 0; +} + +static void print_cmd_line_help() +{ + printf("Usage:\n-etmv3|-stm|-ptm : choose protocol (one only, default etmv4)\n"); + printf("-id <ID> : decode source for id <ID> (default 0x10)\n"); + printf("-decode | -decode_only : full decode + trace packets / full decode packets only (default trace packets only)\n"); + printf("-test_region_file | -test_cb : mem accessor - test multi region file API | test callback API (default single memroy file)\n\n"); +} + + + +/************************************************************************/ +/* Memory accessor functionality */ +/************************************************************************/ + +static FILE *dump_file = NULL; /* pointer to the file providing the opcode memory */ +static ocsd_mem_space_acc_t dump_file_mem_space = OCSD_MEM_SPACE_ANY; /* memory space used by the dump file */ +static long mem_file_size = 0; /* size of the memory file */ +static ocsd_vaddr_t mem_file_en_address = 0; /* end address last inclusive address in file. */ + + +/* decode memory access using a CallBack function +* tests CB API and add / remove mem acc API. +*/ +static uint32_t mem_acc_cb(const void *p_context, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint32_t reqBytes, uint8_t *byteBuffer) +{ + uint32_t read_bytes = 0; + size_t file_read_bytes; + + if(dump_file == NULL) + return 0; + + /* bitwise & the incoming mem space and supported mem space to confirm coverage */ + if(((uint8_t)mem_space & (uint8_t)dump_file_mem_space ) == 0) + return 0; + + /* calculate the bytes that can be read */ + if((address >= mem_dump_address) && (address <= mem_file_en_address)) + { + /* some bytes in our range */ + read_bytes = reqBytes; + + if((address + reqBytes - 1) > mem_file_en_address) + { + /* more than are available - just read the available */ + read_bytes = (uint32_t)(mem_file_en_address - (address - 1)); + } + } + + /* read some bytes if more than 0 to read. */ + if(read_bytes != 0) + { + fseek(dump_file,(long)(address-mem_dump_address),SEEK_SET); + file_read_bytes = fread(byteBuffer,sizeof(uint8_t),read_bytes,dump_file); + if(file_read_bytes < read_bytes) + read_bytes = file_read_bytes; + } + return read_bytes; +} + +/* Create the memory accessor using the callback function and attach to decode tree */ +static ocsd_err_t create_mem_acc_cb(dcd_tree_handle_t dcd_tree_h, const char *mem_file_path) +{ + ocsd_err_t err = OCSD_OK; + dump_file = fopen(mem_file_path,"rb"); + if(dump_file != NULL) + { + fseek(dump_file,0,SEEK_END); + mem_file_size = ftell(dump_file); + mem_file_en_address = mem_dump_address + mem_file_size - 1; + + err = ocsd_dt_add_callback_mem_acc(dcd_tree_h, + mem_dump_address,mem_file_en_address,dump_file_mem_space,&mem_acc_cb,0); + if(err != OCSD_OK) + { + fclose(dump_file); + dump_file = NULL; + } + } + else + err = OCSD_ERR_MEM_ACC_FILE_NOT_FOUND; + return err; +} + +/* remove the callback memory accessor from decode tree */ +static void destroy_mem_acc_cb(dcd_tree_handle_t dcd_tree_h) +{ + if(dump_file != NULL) + { + ocsd_dt_remove_mem_acc(dcd_tree_h,mem_dump_address,dump_file_mem_space); + fclose(dump_file); + dump_file = NULL; + } +} + +/* create and attach the memory accessor according to required test parameters */ +static ocsd_err_t create_test_memory_acc(dcd_tree_handle_t handle) +{ + ocsd_err_t ret = OCSD_OK; + char mem_file_path[512]; + uint32_t i0adjust = 0x100; + int i = 0; + + /* region list to test multi region memory file API */ + file_mem_region_t region_list[4]; + + /* path to the file containing the memory image traced - raw binary data in the snapshot */ + strcpy(mem_file_path,default_path_to_snapshot); + strcat(mem_file_path,memory_dump_filename); + + /* + * decide how to handle the file - test the normal memory accessor (contiguous binary file), + * a callback accessor or a multi-region file (e.g. similar to using the code region in a .so) + * + * The same memory dump file is used in each case, we just present it differently + * to test the API functions. + */ + + /* memory access callback */ + if(using_mem_acc_cb) + { + ret = create_mem_acc_cb(handle,mem_file_path); + } + /* multi region file */ + else if(use_region_file) + { + + dump_file = fopen(mem_file_path,"rb"); + if(dump_file != NULL) + { + fseek(dump_file,0,SEEK_END); + mem_file_size = ftell(dump_file); + fclose(dump_file); + + /* populate the region list - split existing file into four regions */ + for(i = 0; i < 4; i++) + { + if(i != 0) + i0adjust = 0; + region_list[i].start_address = mem_dump_address + (i * mem_file_size/4) + i0adjust; + region_list[i].region_size = (mem_file_size/4) - i0adjust; + region_list[i].file_offset = (i * mem_file_size/4) + i0adjust; + } + + /* create a memory file accessor - full binary file */ + ret = ocsd_dt_add_binfile_region_mem_acc(handle,&region_list[0],4,OCSD_MEM_SPACE_ANY,mem_file_path); + } + else + ret = OCSD_ERR_MEM_ACC_FILE_NOT_FOUND; + } + /* create a memory file accessor - simple contiguous full binary file */ + else + { + ret = ocsd_dt_add_binfile_mem_acc(handle,mem_dump_address,OCSD_MEM_SPACE_ANY,mem_file_path); + } + return ret; +} + +/************************************************************************/ +/** Packet printers */ +/************************************************************************/ + +/* +* Callback function to process the packets in the packet processor output stream - +* simply print them out in this case to the library message/error logger. +*/ +ocsd_datapath_resp_t packet_handler(void *context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const void *p_packet_in) +{ + ocsd_datapath_resp_t resp = OCSD_RESP_CONT; + int offset = 0; + + switch(op) + { + default: break; + case OCSD_OP_DATA: + sprintf(packet_str,"Idx:%ld; ", index_sop); + offset = strlen(packet_str); + + /* + * got a packet - convert to string and use the libraries' message output to print to file and stdoout + * Since the test always prints a single ID, we know the protocol type. + */ + if(ocsd_pkt_str(test_protocol,p_packet_in,packet_str+offset,PACKET_STR_LEN-offset) == OCSD_OK) + { + /* add in <CR> */ + if(strlen(packet_str) == PACKET_STR_LEN - 1) /* maximum length */ + packet_str[PACKET_STR_LEN-2] = '\n'; + else + strcat(packet_str,"\n"); + + /* print it using the library output logger. */ + ocsd_def_errlog_msgout(packet_str); + } + else + resp = OCSD_RESP_FATAL_INVALID_PARAM; /* mark fatal error */ + break; + + case OCSD_OP_EOT: + sprintf(packet_str,"**** END OF TRACE ****\n"); + ocsd_def_errlog_msgout(packet_str); + break; + } + + return resp; +} + +/* print an array of hex data - used by the packet monitor to print hex data from packet.*/ +static int print_data_array(const uint8_t *p_array, const int array_size, char *p_buffer, int buf_size) +{ + int chars_printed = 0; + int bytes_processed; + p_buffer[0] = 0; + + if(buf_size > 9) + { + /* set up the header */ + strcat(p_buffer,"[ "); + chars_printed+=2; + + for(bytes_processed = 0; bytes_processed < array_size; bytes_processed++) + { + sprintf(p_buffer+chars_printed,"0x%02X ", p_array[bytes_processed]); + chars_printed += 5; + if((chars_printed + 5) > buf_size) + break; + } + + strcat(p_buffer,"];"); + chars_printed+=2; + } + else if(buf_size >= 4) + { + sprintf(p_buffer,"[];"); + chars_printed+=3; + } + return chars_printed; +} + +/* +* Callback function to process packets and packet data from the monitor output of the +* packet processor. Again print them to the library error logger. +*/ +void packet_monitor(const ocsd_datapath_op_t op, + const ocsd_trc_index_t index_sop, + const void *p_packet_in, + const uint32_t size, + const uint8_t *p_data) +{ + int offset = 0; + + switch(op) + { + default: break; + case OCSD_OP_DATA: + sprintf(packet_str,"Idx:%ld;", index_sop); + offset = strlen(packet_str); + offset+= print_data_array(p_data,size,packet_str+offset,PACKET_STR_LEN-offset); + + /* got a packet - convert to string and use the libraries' message output to print to file and stdoout */ + if(ocsd_pkt_str(test_protocol,p_packet_in,packet_str+offset,PACKET_STR_LEN-offset) == OCSD_OK) + { + /* add in <CR> */ + if(strlen(packet_str) == PACKET_STR_LEN - 1) /* maximum length */ + packet_str[PACKET_STR_LEN-2] = '\n'; + else + strcat(packet_str,"\n"); + + /* print it using the library output logger. */ + ocsd_def_errlog_msgout(packet_str); + } + break; + + case OCSD_OP_EOT: + sprintf(packet_str,"**** END OF TRACE ****\n"); + ocsd_def_errlog_msgout(packet_str); + break; + } +} + + +/* +* printer for the generic trace elements when decoder output is being processed +*/ +ocsd_datapath_resp_t gen_trace_elem_print(const void *p_context, const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const ocsd_generic_trace_elem *elem) +{ + ocsd_datapath_resp_t resp = OCSD_RESP_CONT; + int offset = 0; + + sprintf(packet_str,"Idx:%ld; TrcID:0x%02X; ", index_sop, trc_chan_id); + offset = strlen(packet_str); + + if(ocsd_gen_elem_str(elem, packet_str+offset,PACKET_STR_LEN - offset) == OCSD_OK) + { + /* add in <CR> */ + if(strlen(packet_str) == PACKET_STR_LEN - 1) /* maximum length */ + packet_str[PACKET_STR_LEN-2] = '\n'; + else + strcat(packet_str,"\n"); + } + else + { + strcat(packet_str,"Unable to create element string\n"); + } + + /* print it using the library output logger. */ + ocsd_def_errlog_msgout(packet_str); + + return resp; +} + +/************************************************************************/ +/** decoder creation **/ + +/*** generic ***/ +static ocsd_err_t create_generic_decoder(dcd_tree_handle_t handle, const char *p_name, const void *p_cfg, const void *p_context) +{ + ocsd_err_t ret = OCSD_OK; + uint8_t CSID = 0; + + if(op == TEST_PKT_PRINT) /* test operation set to packet printing only */ + { + /* + * Create a packet processor on the decode tree for the configuration we have. + * We need to supply the configuration + */ + ret = ocsd_dt_create_decoder(handle,p_name,OCSD_CREATE_FLG_PACKET_PROC,p_cfg,&CSID); + if(ret == OCSD_OK) + { + /* Attach the packet handler to the output of the packet processor - referenced by CSID */ + ret = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,&packet_handler,p_context); + if(ret != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); /* if the attach failed then destroy the decoder. */ + } + } + else + { + /* Full decode - need decoder, and memory dump */ + + /* create the packet decoder and packet processor pair from the supplied name */ + ret = ocsd_dt_create_decoder(handle,p_name,OCSD_CREATE_FLG_FULL_DECODER,p_cfg,&CSID); + if(ret == OCSD_OK) + { + if((op != TEST_PKT_DECODEONLY) && (ret == OCSD_OK)) + { + /* + * print the packets as well as the decode - use the packet processors monitor + * output this time, as the main output is attached to the packet decoder. + */ + ret = ocsd_dt_attach_packet_callback(handle,CSID,OCSD_C_API_CB_PKT_MON,packet_monitor,p_context); + } + + /* attach a memory accessor */ + if(ret == OCSD_OK) + ret = create_test_memory_acc(handle); + + /* if the attach failed then destroy the decoder. */ + if(ret != OCSD_OK) + ocsd_dt_remove_decoder(handle,CSID); + } + } + return ret; +} + +/*** ETMV4 specific settings ***/ +static ocsd_err_t create_decoder_etmv4(dcd_tree_handle_t dcd_tree_h) +{ + ocsd_err_t ret = OCSD_OK; + ocsd_etmv4_cfg trace_config; + + /* + * populate the ETMv4 configuration structure with + * hard coded values from snapshot .ini files. + */ + + trace_config.arch_ver = ARCH_V8; + trace_config.core_prof = profile_CortexA; + + trace_config.reg_configr = 0x000000C1; + trace_config.reg_traceidr = 0x00000010; /* this is the trace ID -> 0x10, change this to analyse other streams in snapshot.*/ + + if(test_trc_id_override != 0) + { + trace_config.reg_traceidr = (uint32_t)test_trc_id_override; + } + + trace_config.reg_idr0 = 0x28000EA1; + trace_config.reg_idr1 = 0x4100F403; + trace_config.reg_idr2 = 0x00000488; + trace_config.reg_idr8 = 0x0; + trace_config.reg_idr9 = 0x0; + trace_config.reg_idr10 = 0x0; + trace_config.reg_idr11 = 0x0; + trace_config.reg_idr12 = 0x0; + trace_config.reg_idr13 = 0x0; + + /* create an ETMV4 decoder - no context needed as we have a single stream to a single handler. */ + return create_generic_decoder(dcd_tree_h,OCSD_BUILTIN_DCD_ETMV4I,(void *)&trace_config,0); +} + +/*** ETMV3 specific settings ***/ +static ocsd_err_t create_decoder_etmv3(dcd_tree_handle_t dcd_tree_h) +{ + ocsd_err_t ret = OCSD_OK; + ocsd_etmv3_cfg trace_config_etmv3; + + /* + * populate the ETMv3 configuration structure with + * hard coded values from snapshot .ini files. + */ + + trace_config_etmv3.arch_ver = ARCH_V7; + trace_config_etmv3.core_prof = profile_CortexA; + trace_config_etmv3.reg_ccer = 0x344008F2; + trace_config_etmv3.reg_ctrl = 0x10001860; + trace_config_etmv3.reg_idr = 0x410CF250; + trace_config_etmv3.reg_trc_id = 0x010; + if(test_trc_id_override != 0) + { + trace_config_etmv3.reg_trc_id = (uint32_t)test_trc_id_override; + } + + /* create an ETMV3 decoder - no context needed as we have a single stream to a single handler. */ + return create_generic_decoder(dcd_tree_h,OCSD_BUILTIN_DCD_ETMV3,(void *)&trace_config_etmv3,0); +} + +/*** PTM specific settings ***/ +static ocsd_err_t create_decoder_ptm(dcd_tree_handle_t dcd_tree_h) +{ + ocsd_err_t ret = OCSD_OK; + ocsd_ptm_cfg trace_config_ptm; + + /* + * populate the PTM configuration structure with + * hard coded values from snapshot .ini files. + */ + + trace_config_ptm.arch_ver = ARCH_V7; + trace_config_ptm.core_prof = profile_CortexA; + trace_config_ptm.reg_ccer = 0x34C01AC2; + trace_config_ptm.reg_ctrl = 0x10001000; + trace_config_ptm.reg_idr = 0x411CF312; + trace_config_ptm.reg_trc_id = 0x013; + if(test_trc_id_override != 0) + { + trace_config_ptm.reg_trc_id = (uint32_t)test_trc_id_override; + } + + /* create an PTM decoder - no context needed as we have a single stream to a single handler. */ + return create_generic_decoder(dcd_tree_h,OCSD_BUILTIN_DCD_PTM,(void *)&trace_config_ptm,0); + +} + +/*** STM specific settings ***/ +static ocsd_err_t create_decoder_stm(dcd_tree_handle_t dcd_tree_h) +{ + ocsd_err_t ret = OCSD_OK; + ocsd_stm_cfg trace_config_stm; + + /* + * populate the STM configuration structure with + * hard coded values from snapshot .ini files. + */ + #define STMTCSR_TRC_ID_MASK 0x007F0000 + #define STMTCSR_TRC_ID_SHIFT 16 + + trace_config_stm.reg_tcsr = 0x00A00005; + if(test_trc_id_override != 0) + { + trace_config_stm.reg_tcsr &= ~STMTCSR_TRC_ID_MASK; + trace_config_stm.reg_tcsr |= ((((uint32_t)test_trc_id_override) << STMTCSR_TRC_ID_SHIFT) & STMTCSR_TRC_ID_MASK); + } + trace_config_stm.reg_feat3r = 0x10000; /* channel default */ + trace_config_stm.reg_devid = 0xFF; /* master default */ + + /* not using hw event trace decode */ + trace_config_stm.reg_hwev_mast = 0; + trace_config_stm.reg_feat1r = 0; + trace_config_stm.hw_event = HwEvent_Unknown_Disabled; + + /* STM only has packet processor at present */ + if(op == TEST_PKT_PRINT) /* packet printing only */ + { + ret = create_generic_decoder(dcd_tree_h,OCSD_BUILTIN_DCD_STM,(void *)&trace_config_stm,0); + } + else + { + /* Full decode */ + /* not supported in library at present */ + printf("STM Full decode not supported in library at present. Packet print only\n"); + ret = OCSD_ERR_RDR_NO_DECODER; + } + return ret; +} + +/************************************************************************/ + +/* create a decoder according to options */ +static ocsd_err_t create_decoder(dcd_tree_handle_t dcd_tree_h) +{ + ocsd_err_t err = OCSD_OK; + switch(test_protocol) + { + case OCSD_PROTOCOL_ETMV4I: + err = create_decoder_etmv4(dcd_tree_h); + break; + + case OCSD_PROTOCOL_ETMV3: + err = create_decoder_etmv3(dcd_tree_h); + break; + + case OCSD_PROTOCOL_STM: + err = create_decoder_stm(dcd_tree_h); + break; + + case OCSD_PROTOCOL_PTM: + err = create_decoder_ptm(dcd_tree_h); + break; + + default: + err = OCSD_ERR_NO_PROTOCOL; + break; + } + return err; +} + +#define INPUT_BLOCK_SIZE 1024 + +/* process buffer until done or error */ +ocsd_err_t process_data_block(dcd_tree_handle_t dcd_tree_h, int block_index, uint8_t *p_block, const int block_size) +{ + ocsd_err_t ret = OCSD_OK; + uint32_t bytes_done = 0; + ocsd_datapath_resp_t dp_ret = OCSD_RESP_CONT; + uint32_t bytes_this_time = 0; + + while((bytes_done < (uint32_t)block_size) && (ret == OCSD_OK)) + { + if(OCSD_DATA_RESP_IS_CONT(dp_ret)) + { + dp_ret = ocsd_dt_process_data(dcd_tree_h, + OCSD_OP_DATA, + block_index+bytes_done, + block_size-bytes_done, + ((uint8_t *)p_block)+bytes_done, + &bytes_this_time); + bytes_done += bytes_this_time; + } + else if(OCSD_DATA_RESP_IS_WAIT(dp_ret)) + { + dp_ret = ocsd_dt_process_data(dcd_tree_h, OCSD_OP_FLUSH,0,0,NULL,NULL); + } + else + ret = OCSD_ERR_DATA_DECODE_FATAL; /* data path responded with an error - stop processing */ + } + return ret; +} + +int process_trace_data(FILE *pf) +{ + ocsd_err_t ret = OCSD_OK; + dcd_tree_handle_t dcdtree_handle = C_API_INVALID_TREE_HANDLE; + uint8_t data_buffer[INPUT_BLOCK_SIZE]; + ocsd_trc_index_t index = 0; + size_t data_read; + + + /* Create a decode tree for this source data. + source data is frame formatted, memory aligned from an ETR (no frame syncs) so create tree accordingly + */ + dcdtree_handle = ocsd_create_dcd_tree(OCSD_TRC_SRC_FRAME_FORMATTED, OCSD_DFRMTR_FRAME_MEM_ALIGN); + + if(dcdtree_handle != C_API_INVALID_TREE_HANDLE) + { + + ret = create_decoder(dcdtree_handle); + ocsd_tl_log_mapped_mem_ranges(dcdtree_handle); + + if(ret == OCSD_OK) + /* attach the generic trace element output callback */ + ret = ocsd_dt_set_gen_elem_outfn(dcdtree_handle,gen_trace_elem_print,0); + + /* now push the trace data through the packet processor */ + while(!feof(pf) && (ret == OCSD_OK)) + { + /* read from file */ + data_read = fread(data_buffer,1,INPUT_BLOCK_SIZE,pf); + if(data_read > 0) + { + /* process a block of data - any packets from the trace stream + we have configured will appear at the callback + */ + ret = process_data_block(dcdtree_handle, + index, + data_buffer, + data_read); + index += data_read; + } + else if(ferror(pf)) + ret = OCSD_ERR_FILE_ERROR; + } + + /* no errors - let the data path know we are at end of trace */ + if(ret == OCSD_OK) + ocsd_dt_process_data(dcdtree_handle, OCSD_OP_EOT, 0,0,NULL,NULL); + + + /* shut down the mem acc CB if in use. */ + if(using_mem_acc_cb) + { + destroy_mem_acc_cb(dcdtree_handle); + } + + /* dispose of the decode tree - which will dispose of any packet processors we created + */ + ocsd_destroy_dcd_tree(dcdtree_handle); + } + else + { + printf("Failed to create trace decode tree\n"); + ret = OCSD_ERR_NOT_INIT; + } + return (int)ret; +} + +int main(int argc, char *argv[]) +{ + FILE *trace_data; + char trace_file_path[512]; + int ret = 0; + char message[512]; + + /* command line params */ + if(process_cmd_line(argc,argv) != 0) + { + print_cmd_line_help(); + return -2; + } + + /* trace data file path */ + strcpy(trace_file_path,default_path_to_snapshot); + strcat(trace_file_path,trace_data_filename); + trace_data = fopen(trace_file_path,"rb"); + + if(trace_data != NULL) + { + /* set up the logging in the library - enable the error logger, with an output printer*/ + ret = ocsd_def_errlog_init(OCSD_ERR_SEV_INFO,1); + + /* set up the output - to file and stdout, set custom logfile name */ + if(ret == 0) + ret = ocsd_def_errlog_config_output(C_API_MSGLOGOUT_FLG_FILE | C_API_MSGLOGOUT_FLG_STDOUT, "c_api_test.log"); + + /* print sign-on message in log */ + sprintf(message, "C-API packet print test\nLibrary Version %s\n\n",ocsd_get_version_str()); + ocsd_def_errlog_msgout(message); + + + /* process the trace data */ + if(ret == 0) + ret = process_trace_data(trace_data); + + /* close the data file */ + fclose(trace_data); + } + else + { + printf("Unable to open file %s to process trace data\n", trace_file_path); + ret = -1; + } + return ret; +} +/* End of File simple_pkt_c_api.c */ diff --git a/decoder/tests/source/simple_pkt_c_api.c b/decoder/tests/source/simple_pkt_c_api.c index 6c6e503..32312b8 100644 --- a/decoder/tests/source/simple_pkt_c_api.c +++ b/decoder/tests/source/simple_pkt_c_api.c @@ -46,6 +46,7 @@ #include <stdint.h> #include <stdlib.h>

+#define OPENCSD_INC_DEPRECATED_API /* include the C-API library header */ #include "c_api/opencsd_c_api.h"

Makefiles updated to reflect new decoder registration code. Makefiles updated for changed C API

Some source changes to reflect differing requirements in MSVC and G++ compilation.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/build/linux/makefile | 2 + decoder/build/linux/rctdl_c_api_lib/makefile | 3 +- decoder/build/linux/ref_trace_decode_lib/makefile | 1 + decoder/include/common/ocsd_dcd_mngr.h | 6 +- decoder/include/common/ocsd_lib_dcd_register.h | 2 +- decoder/include/ocsd_if_types.h | 1 + decoder/source/c_api/ocsd_c_api_deprc_fn.cpp | 14 ++-- .../build/linux/c_api_pkt_print_test/makefile | 82 ++++++++++++++++++++++ 8 files changed, 99 insertions(+), 12 deletions(-) create mode 100644 decoder/tests/build/linux/c_api_pkt_print_test/makefile

diff --git a/decoder/build/linux/makefile b/decoder/build/linux/makefile index 4befae3..b86fafe 100644 --- a/decoder/build/linux/makefile +++ b/decoder/build/linux/makefile @@ -158,6 +158,7 @@ tests: libs cd $(OCSD_ROOT)/tests/build/linux/snapshot_parser_lib && make cd $(OCSD_ROOT)/tests/build/linux/trc_pkt_lister && make cd $(OCSD_ROOT)/tests/build/linux/simple_pkt_print_c_api && make + cd $(OCSD_ROOT)/tests/build/linux/c_api_pkt_print_test && make

############################################################# # clean targets @@ -174,3 +175,4 @@ clean_tests: cd $(OCSD_ROOT)/tests/build/linux/snapshot_parser_lib && make clean cd $(OCSD_ROOT)/tests/build/linux/trc_pkt_lister && make clean cd $(OCSD_ROOT)/tests/build/linux/simple_pkt_print_c_api && make clean + cd $(OCSD_ROOT)/tests/build/linux/c_api_pkt_print_test && make clean diff --git a/decoder/build/linux/rctdl_c_api_lib/makefile b/decoder/build/linux/rctdl_c_api_lib/makefile index 9338bfa..dfebe09 100644 --- a/decoder/build/linux/rctdl_c_api_lib/makefile +++ b/decoder/build/linux/rctdl_c_api_lib/makefile @@ -49,7 +49,8 @@ CPP_INCLUDES= \ -I$(OCSD_INCLUDE) \ -I$(OCSD_SOURCE)/c_api

-OBJECTS=$(BUILD_DIR)/ocsd_c_api.o +OBJECTS=$(BUILD_DIR)/ocsd_c_api.o \ + $(BUILD_DIR)/ocsd_c_api_deprc_fn.o

all: build_dir $(OBJECTS) diff --git a/decoder/build/linux/ref_trace_decode_lib/makefile b/decoder/build/linux/ref_trace_decode_lib/makefile index 56982bd..b650331 100644 --- a/decoder/build/linux/ref_trace_decode_lib/makefile +++ b/decoder/build/linux/ref_trace_decode_lib/makefile @@ -90,6 +90,7 @@ OBJECTS=$(BUILD_DIR)/ocsd_code_follower.o \ $(BUILD_DIR)/ocsd_error.o \ $(BUILD_DIR)/ocsd_error_logger.o \ $(BUILD_DIR)/ocsd_gen_elem_list.o \ + $(BUILD_DIR)/ocsd_lib_dcd_register.o \ $(BUILD_DIR)/ocsd_msg_logger.o \ $(BUILD_DIR)/ocsd_version.o \ $(BUILD_DIR)/trc_component.o \ diff --git a/decoder/include/common/ocsd_dcd_mngr.h b/decoder/include/common/ocsd_dcd_mngr.h index 487e1db..b70a4cc 100644 --- a/decoder/include/common/ocsd_dcd_mngr.h +++ b/decoder/include/common/ocsd_dcd_mngr.h @@ -39,7 +39,7 @@ #include "common/ocsd_dcd_mngr_i.h" #include "common/ocsd_lib_dcd_register.h" #include "common/trc_pkt_decode_base.h" - +#include "common/trc_pkt_proc_base.h"

template <class P, class Pt, class Pc> class DecoderMngrBase : public IDecoderMngr @@ -327,7 +327,7 @@ class DecodeMngrFullDcd : public DecoderMngrBase<P,Pt,Pc> { public: DecodeMngrFullDcd (const std::string &name, ocsd_trace_protocol_t builtInProtocol) - : DecoderMngrBase(name,builtInProtocol) {}; + : DecoderMngrBase<P,Pt,Pc>(name,builtInProtocol) {};

virtual ~DecodeMngrFullDcd() {};

@@ -370,7 +370,7 @@ class DecodeMngrPktProc : public DecoderMngrBase<P,Pt,Pc> { public: DecodeMngrPktProc (const std::string &name, ocsd_trace_protocol_t builtInProtocol) - : DecoderMngrBase(name,builtInProtocol) {}; + : DecoderMngrBase<P,Pt,Pc>(name,builtInProtocol) {};

virtual ~DecodeMngrPktProc() {};

diff --git a/decoder/include/common/ocsd_lib_dcd_register.h b/decoder/include/common/ocsd_lib_dcd_register.h index d059214..3e6611e 100644 --- a/decoder/include/common/ocsd_lib_dcd_register.h +++ b/decoder/include/common/ocsd_lib_dcd_register.h @@ -79,7 +79,7 @@ private: // singleton pattern - need just one of these in the library - ensure all default constructors are private. OcsdLibDcdRegister(); OcsdLibDcdRegister(OcsdLibDcdRegister const &) {}; - OcsdLibDcdRegister& operator=(OcsdLibDcdRegister const &){}; + OcsdLibDcdRegister& operator=(OcsdLibDcdRegister const &){ }; ~OcsdLibDcdRegister();

static OcsdLibDcdRegister *m_p_libMngr; diff --git a/decoder/include/ocsd_if_types.h b/decoder/include/ocsd_if_types.h index f5d1fde..f026d4e 100644 --- a/decoder/include/ocsd_if_types.h +++ b/decoder/include/ocsd_if_types.h @@ -36,6 +36,7 @@ #define ARM_OCSD_IF_TYPES_H_INCLUDED

#include <stdint.h> +#include <stddef.h>

/** @defgroup ocsd_interfaces OpenCSD Library : Interfaces @brief Set of types, structures and virtual interface classes making up the primary API diff --git a/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp b/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp index b5d0ff5..959ef0b 100644 --- a/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp +++ b/decoder/source/c_api/ocsd_c_api_deprc_fn.cpp @@ -51,7 +51,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_create_etmv4i_pkt_proc(const dcd_tree_handle_t han err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV4I,OCSD_CREATE_FLG_PACKET_PROC,etmv4_cfg,&CSID); if(err == OCSD_OK) { - err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,(void *)pPktFn,p_context); if(err != OCSD_OK) ocsd_dt_remove_decoder(handle,CSID); } @@ -79,7 +79,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv4i_pkt_mon(const dcd_tree_handle_t hand ocsd_err_t err = OCSD_OK; if(handle != C_API_INVALID_TREE_HANDLE) { - err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,(void *)pPktFn,p_context); } else err = OCSD_ERR_INVALID_PARAM_VAL; @@ -95,7 +95,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_create_etmv3_pkt_proc(const dcd_tree_handle_t hand err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_ETMV3,OCSD_CREATE_FLG_PACKET_PROC,etmv3_cfg,&CSID); if(err == OCSD_OK) { - err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,(void *)pPktFn,p_context); if(err != OCSD_OK) ocsd_dt_remove_decoder(handle,CSID); } @@ -123,7 +123,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_attach_etmv3_pkt_mon(const dcd_tree_handle_t handl ocsd_err_t err = OCSD_OK; if(handle != C_API_INVALID_TREE_HANDLE) { - err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,(void *)pPktFn,p_context); } else err = OCSD_ERR_INVALID_PARAM_VAL; @@ -140,7 +140,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_create_ptm_pkt_proc(const dcd_tree_handle_t handle err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_PTM,OCSD_CREATE_FLG_PACKET_PROC,ptm_cfg,&CSID); if(err == OCSD_OK) { - err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,(void *)pPktFn,p_context); if(err != OCSD_OK) ocsd_dt_remove_decoder(handle,CSID); } @@ -169,7 +169,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_attach_ptm_pkt_mon(const dcd_tree_handle_t handle, ocsd_err_t err = OCSD_OK; if(handle != C_API_INVALID_TREE_HANDLE) { - err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,trc_chan_id,OCSD_C_API_CB_PKT_MON,(void *)pPktFn,p_context); } else err = OCSD_ERR_INVALID_PARAM_VAL; @@ -185,7 +185,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_create_stm_pkt_proc(const dcd_tree_handle_t handle err = ocsd_dt_create_decoder(handle,OCSD_BUILTIN_DCD_STM,OCSD_CREATE_FLG_PACKET_PROC,stm_cfg,&CSID); if(err == OCSD_OK) { - err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,pPktFn,p_context); + err = ocsd_dt_attach_packet_callback(handle,CSID, OCSD_C_API_CB_PKT_SINK,(void *)pPktFn,p_context); if(err != OCSD_OK) ocsd_dt_remove_decoder(handle,CSID); } diff --git a/decoder/tests/build/linux/c_api_pkt_print_test/makefile b/decoder/tests/build/linux/c_api_pkt_print_test/makefile new file mode 100644 index 0000000..01d4660 --- /dev/null +++ b/decoder/tests/build/linux/c_api_pkt_print_test/makefile @@ -0,0 +1,82 @@ +######################################################## +# Copyright 2015 ARM Limited. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, +# are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors +# may be used to endorse or promote products derived from this software without +# specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +################################################################################# + +######## +# RCTDL - test makefile for simple c api packet list test. +# + +CC := $(MASTER_CC) +CC_FLAGS := $(MASTER_CC_FLAGS) -Wno-switch +LINKER := $(MASTER_LINKER) +LINKER_FLAGS := $(MASTER_LINKER_FLAGS) + +PROG = c_api_pkt_print_test + +BUILD_DIR=./$(PLAT_DIR) + +VPATH = $(OCSD_TESTS)/source + +CC_INCLUDES = \ + -I$(OCSD_TESTS)/source \ + -I$(OCSD_INCLUDE) + +OBJECTS = $(BUILD_DIR)/c_api_pkt_print_test.o + +LIBS = -L$(LIB_TARGET_DIR) -l$(LIB_BASE_NAME) -l$(LIB_CAPI_NAME) + +all: build_dir test_app copy_libs + +test_app: $(OBJECTS) $(BIN_TEST_TARGET_DIR)/$(PROG) + + + $(BIN_TEST_TARGET_DIR)/$(PROG): + mkdir -p $(BIN_TEST_TARGET_DIR) + $(LINKER) $(LINKER_FLAGS) $(OBJECTS) -Wl,--start-group $(LIBS) -Wl,--end-group -o $(BIN_TEST_TARGET_DIR)/$(PROG) + cp $(LIB_TARGET_DIR)/*.so . + +build_dir: + mkdir -p $(BUILD_DIR) + +.PHONY: copy_libs + +copy_libs: + cp $(LIB_TARGET_DIR)/*.so $(BIN_TEST_TARGET_DIR)/. + + +#### build rules +$(BUILD_DIR)/%.o : %.c + $(CC) $(CC_FLAGS) $(CC_INCLUDES) $< -o $@ + +#### clean +.PHONY: clean +clean : + rm -f $(BIN_TEST_TARGET_DIR)/$(PROG) $(OBJECTS) + +# end of file makefile

Move deprecated types out of the main C API header into the deprecated header for eventual permanent removal.

Remove #if 0 disabled deprecated code blocks from the C-API source.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/include/c_api/ocsd_c_api_types.h | 49 +--------- decoder/include/c_api/opencsd_c_api.h | 30 +++--- decoder/source/c_api/ocsd_c_api.cpp | 125 ------------------------- decoder/source/c_api/ocsd_c_api_obj.h | 154 ------------------------------- 4 files changed, 18 insertions(+), 340 deletions(-)

diff --git a/decoder/include/c_api/ocsd_c_api_types.h b/decoder/include/c_api/ocsd_c_api_types.h index aa11391..be7316f 100644 --- a/decoder/include/c_api/ocsd_c_api_types.h +++ b/decoder/include/c_api/ocsd_c_api_types.h @@ -89,56 +89,11 @@ typedef void (* FnDefPktDataMon)(const void *p_context, const uint32_t size, const uint8_t *p_data);

-/** function pointer type for ETMv4 instruction packet processor output, packet analyser/decoder input */ -typedef ocsd_datapath_resp_t (* FnEtmv4IPacketDataIn)(const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const ocsd_etmv4_i_pkt *p_packet_in); - -/** function pointer type for ETMv4 instruction packet processor monitor output, raw packet monitor / display input */ -typedef void (* FnEtmv4IPktMonDataIn)( const void *p_context, - const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const ocsd_etmv4_i_pkt *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - -/** function pointer type for ETMv3 packet processor output, packet analyser/decoder input */ -typedef ocsd_datapath_resp_t (* FnEtmv3PacketDataIn)(const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const ocsd_etmv3_pkt *p_packet_in); - -/** function pointer type for ETMv3 packet processor monitor output, raw packet monitor / display input */ -typedef void (* FnEtmv3PktMonDataIn)( const void *p_context, - const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const ocsd_etmv3_pkt *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - - -/** function pointer type for PTM packet processor output, packet analyser/decoder input */ -typedef ocsd_datapath_resp_t (* FnPtmPacketDataIn)(const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const ocsd_ptm_pkt *p_packet_in); - -/** function pointer type for PTM packet processor monitor output, raw packet monitor / display input */ -typedef void (* FnPtmPktMonDataIn)( const void *p_context, - const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const ocsd_ptm_pkt *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - - -/** function pointer type for STM packet processor output, packet analyser/decoder input */ -typedef ocsd_datapath_resp_t (* FnStmPacketDataIn)(const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const ocsd_stm_pkt *p_packet_in); - -/** function pointer type for STM packet processor monitor output, raw packet monitor / display input */ -typedef void (* FnStmPktMonDataIn)( const void *p_context, - const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const ocsd_stm_pkt *p_packet_in, - const uint32_t size, - const uint8_t *p_data);

/** Callback interface type when attaching monitor/sink to packet processor */ typedef enum _ocsd_c_api_cb_types { - OCSD_C_API_CB_PKT_SINK, - OCSD_C_API_CB_PKT_MON, + OCSD_C_API_CB_PKT_SINK, /** Attach to the packet processor primary packet output (CB fn is FnDefPktDataIn) */ + OCSD_C_API_CB_PKT_MON, /** Attach to the packet processor packet monitor output (CB fn is FnDefPktDataMon) */ } ocsd_c_api_cb_types;

/** @}*/ diff --git a/decoder/include/c_api/opencsd_c_api.h b/decoder/include/c_api/opencsd_c_api.h index 061bfe4..c40c20f 100644 --- a/decoder/include/c_api/opencsd_c_api.h +++ b/decoder/include/c_api/opencsd_c_api.h @@ -126,7 +126,7 @@ OCSD_C_API void ocsd_destroy_dcd_tree(const dcd_tree_handle_t handle); * @param *pDataBlock : Pointer to data block. * @param *numBytesProcessed : Number of bytes actually processed by the decoder. * - * @return ocsd_datapath_resp_t : Datapath response code + * @return ocsd_datapath_resp_t : Datapath response code (CONT/WAIT/FATAL) */ OCSD_C_API ocsd_datapath_resp_t ocsd_dt_process_data(const dcd_tree_handle_t handle, const ocsd_datapath_op_t op, @@ -156,15 +156,18 @@ OCSD_C_API ocsd_err_t ocsd_dt_set_gen_elem_outfn(const dcd_tree_handle_t handle,

/*---------------------- Trace Decoders ----------------------------------------------------------------------------------*/ /*! -* <Detailed description of the method> +* Creates a decoder that is registered with the library under the supplied name. +* Flags determine if a full packet processor / packet decoder pair or +* packet processor only is created. +* Uses the supplied configuration structure. * * @param handle : Handle to decode tree. -* @param *decoder_name : -* @param create_flags : -* @param *decoder_cfg : +* @param *decoder_name : Registered name of the decoder to create. +* @param create_flags : Decoder creation options. +* @param *decoder_cfg : Pointer to a valid configuration structure for the named decoder. * @param *pCSID : Pointer to location to return the configured CoreSight trace ID for the decoder. * -* @return ocsd_err_t : +* @return ocsd_err_t : Library error code - OCSD_OK if successful. */ OCSD_C_API ocsd_err_t ocsd_dt_create_decoder(const dcd_tree_handle_t handle, const char *decoder_name, @@ -174,12 +177,12 @@ OCSD_C_API ocsd_err_t ocsd_dt_create_decoder(const dcd_tree_handle_t handle, );

/*! -* <Detailed description of the method> +* Remove a decoder from the tree and destroy it. * * @param handle : Handle to decode tree. * @param CSID : Configured CoreSight trace ID for the decoder. * -* @return ocsd_err_t : +* @return ocsd_err_t : Library error code - OCSD_OK if successful. */ OCSD_C_API ocsd_err_t ocsd_dt_remove_decoder( const dcd_tree_handle_t handle, const unsigned char CSID); @@ -188,16 +191,16 @@ OCSD_C_API ocsd_err_t ocsd_dt_remove_decoder( const dcd_tree_handle_t handle, /*! * Attach a callback function to the packet processor. * -* The callback_type defines the attachment point:- +* The callback_type defines the attachment point, either the main packet output +* (only if no decoder attached), or the packet monitor. * -* * @param handle : Handle to decode tree. * @param CSID : Configured CoreSight trace ID for the decoder. -* @param callback_type : +* @param callback_type : Attachment point * @param p_fn_pkt_data_in : Pointer to the callback function. * @param p_context : Opaque context pointer value used in callback function. * -* @return ocsd_err_t : +* @return ocsd_err_t : Library error code - OCSD_OK if successful. */ OCSD_C_API ocsd_err_t ocsd_dt_attach_packet_callback( const dcd_tree_handle_t handle, const unsigned char CSID, @@ -208,8 +211,7 @@ OCSD_C_API ocsd_err_t ocsd_dt_attach_packet_callback( const dcd_tree_handle_t h

- -/** TBD : more C API functions to be added here */ +

/** @}*/ /*---------------------- Memory Access for traced opcodes ----------------------------------------------------------------------------------*/ diff --git a/decoder/source/c_api/ocsd_c_api.cpp b/decoder/source/c_api/ocsd_c_api.cpp index 335bbe5..dcea304 100644 --- a/decoder/source/c_api/ocsd_c_api.cpp +++ b/decoder/source/c_api/ocsd_c_api.cpp @@ -498,129 +498,4 @@ ocsd_datapath_resp_t GenTraceElemCBObj::TraceElemIn(const ocsd_trc_index_t index return m_c_api_cb_fn(m_p_cb_context, index_sop, trc_chan_id, &elem); }

- -#if 0 - -/****************** Etmv4 packet processor output callback function ************/ -EtmV4ICBObj::EtmV4ICBObj(FnEtmv4IPacketDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -ocsd_datapath_resp_t EtmV4ICBObj::PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV4ITrcPacket *p_packet_in) -{ - return m_c_api_cb_fn(m_p_cb_context, op,index_sop,p_packet_in); -} - -/****************** Etmv4 packet processor monitor callback function ***********/ -EtmV4IPktMonCBObj::EtmV4IPktMonCBObj(FnEtmv4IPktMonDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -void EtmV4IPktMonCBObj::RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV4ITrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data) -{ - return m_c_api_cb_fn(m_p_cb_context, op, index_sop, p_packet_in, size, p_data); -} - -/****************** Etmv3 packet processor output callback function ************/ -EtmV3CBObj::EtmV3CBObj(FnEtmv3PacketDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -ocsd_datapath_resp_t EtmV3CBObj::PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV3TrcPacket *p_packet_in) -{ - return m_c_api_cb_fn(m_p_cb_context, op,index_sop,*p_packet_in); -} - -/****************** Etmv3 packet processor monitor callback function ***********/ -EtmV3PktMonCBObj::EtmV3PktMonCBObj(FnEtmv3PktMonDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -void EtmV3PktMonCBObj::RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV3TrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data) -{ - return m_c_api_cb_fn(m_p_cb_context, op, index_sop, *p_packet_in, size, p_data); -} - - -/****************** Ptm packet processor output callback function ************/ -PtmCBObj::PtmCBObj(FnPtmPacketDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -ocsd_datapath_resp_t PtmCBObj::PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const PtmTrcPacket *p_packet_in) -{ - return m_c_api_cb_fn(m_p_cb_context, op,index_sop,p_packet_in); -} - -/****************** Ptm packet processor monitor callback function ***********/ -PtmPktMonCBObj::PtmPktMonCBObj(FnPtmPktMonDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -void PtmPktMonCBObj::RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const PtmTrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data) -{ - return m_c_api_cb_fn(m_p_cb_context, op, index_sop, p_packet_in, size, p_data); -} - -/****************** Stm packet processor output callback function ************/ -StmCBObj::StmCBObj(FnStmPacketDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -ocsd_datapath_resp_t StmCBObj::PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const StmTrcPacket *p_packet_in) -{ - return m_c_api_cb_fn(m_p_cb_context, op,index_sop,p_packet_in); -} - -/****************** Stm packet processor monitor callback function ***********/ -StmPktMonCBObj::StmPktMonCBObj(FnStmPktMonDataIn pCBFn, const void *p_context) : - m_c_api_cb_fn(pCBFn), - m_p_cb_context(p_context) -{ -} - -void StmPktMonCBObj::RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const StmTrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data) -{ - return m_c_api_cb_fn(m_p_cb_context, op, index_sop, p_packet_in, size, p_data); -} -#endif - /* End of File ocsd_c_api.cpp */ diff --git a/decoder/source/c_api/ocsd_c_api_obj.h b/decoder/source/c_api/ocsd_c_api_obj.h index dbe6d08..e6f901d 100644 --- a/decoder/source/c_api/ocsd_c_api_obj.h +++ b/decoder/source/c_api/ocsd_c_api_obj.h @@ -87,160 +87,6 @@ private: const void *m_p_context; };

-#if 0 - -/************************************************************************/ -/*** ETMv4 ***/ -/************************************************************************/ - -class EtmV4ICBObj : public IPktDataIn<EtmV4ITrcPacket>, public TraceElemCBBase -{ -public: - EtmV4ICBObj(FnEtmv4IPacketDataIn pCBFn, const void *p_context); - virtual ~EtmV4ICBObj() {}; - - virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV4ITrcPacket *p_packet_in); - -private: - - FnEtmv4IPacketDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - - -class EtmV4IPktMonCBObj : public IPktRawDataMon<EtmV4ITrcPacket>, public TraceElemCBBase -{ -public: - EtmV4IPktMonCBObj(FnEtmv4IPktMonDataIn pCBFn, const void *p_context); - virtual ~EtmV4IPktMonCBObj() {}; - - virtual void RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV4ITrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - -private: - FnEtmv4IPktMonDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - -/************************************************************************/ -/*** ETMv3 ***/ -/************************************************************************/ - -class EtmV3CBObj : public IPktDataIn<EtmV3TrcPacket>, public TraceElemCBBase -{ -public: - EtmV3CBObj(FnEtmv3PacketDataIn pCBFn, const void *p_context); - virtual ~EtmV3CBObj() {}; - - virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV3TrcPacket *p_packet_in); - -private: - - FnEtmv3PacketDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - -class EtmV3PktMonCBObj : public IPktRawDataMon<EtmV3TrcPacket>, public TraceElemCBBase -{ -public: - EtmV3PktMonCBObj(FnEtmv3PktMonDataIn pCBFn, const void *p_context); - virtual ~EtmV3PktMonCBObj() {}; - - virtual void RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const EtmV3TrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - -private: - FnEtmv3PktMonDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - - -/************************************************************************/ -/*** PTM ***/ -/************************************************************************/ - -class PtmCBObj : public IPktDataIn<PtmTrcPacket>, public TraceElemCBBase -{ -public: - PtmCBObj(FnPtmPacketDataIn pCBFn, const void *p_context); - virtual ~PtmCBObj() {}; - - virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const PtmTrcPacket *p_packet_in); - -private: - - FnPtmPacketDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - -class PtmPktMonCBObj : public IPktRawDataMon<PtmTrcPacket>, public TraceElemCBBase -{ -public: - PtmPktMonCBObj(FnPtmPktMonDataIn pCBFn, const void *p_context); - virtual ~PtmPktMonCBObj() {}; - - virtual void RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const PtmTrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - -private: - FnPtmPktMonDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - - -/************************************************************************/ -/*** STM ***/ -/************************************************************************/ - -class StmCBObj : public IPktDataIn<StmTrcPacket>, public TraceElemCBBase -{ -public: - StmCBObj(FnStmPacketDataIn pCBFn, const void *p_context); - virtual ~StmCBObj() {}; - - virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const StmTrcPacket *p_packet_in); - -private: - FnStmPacketDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - -class StmPktMonCBObj : public IPktRawDataMon<StmTrcPacket>, public TraceElemCBBase -{ -public: - StmPktMonCBObj(FnStmPktMonDataIn pCBFn, const void *p_context); - virtual ~StmPktMonCBObj() {}; - - virtual void RawPacketDataMon( const ocsd_datapath_op_t op, - const ocsd_trc_index_t index_sop, - const StmTrcPacket *p_packet_in, - const uint32_t size, - const uint8_t *p_data); - -private: - FnStmPktMonDataIn m_c_api_cb_fn; - const void *m_p_cb_context; -}; - -#endif - #endif // ARM_OCSD_C_API_OBJ_H_INCLUDED

/* End of File ocsd_c_api_obj.h */

Extraction of multibyte payload values using the 0x80 cont bit per byte was incorrectly handling the cont bit when extracting the value bits.

Masking added to processing of 32bit and 64 bit payloads. --- decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp index 0125788..d7f0fbf 100644 --- a/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp +++ b/decoder/source/etmv4/trc_pkt_proc_etmv4i_impl.cpp @@ -1462,7 +1462,7 @@ void EtmV4IPktProcImpl::BuildIPacketTable() // each byte has seven bits + cont bit byteVal = buffer[(st_idx + idx)]; lastByte = (byteVal & 0x80) != 0x80; - value |= ((uint32_t)byteVal) << (idx * 7); + value |= ((uint32_t)(byteVal & 0x7F)) << (idx * 7); idx++; } else @@ -1479,14 +1479,14 @@ unsigned EtmV4IPktProcImpl::extractContField64(const std::vector<uint8_t> &buffe bool lastByte = false; uint8_t byteVal; value = 0; - while(!lastByte && (idx < byte_limit)) // max 9 bytes for 32 bit value; + while(!lastByte && (idx < byte_limit)) // max 9 bytes for 64 bit value; { if(buffer.size() > (st_idx + idx)) { // each byte has seven bits + cont bit byteVal = buffer[(st_idx + idx)]; lastByte = (byteVal & 0x80) != 0x80; - value |= ((uint64_t)byteVal) << (idx * 7); + value |= ((uint64_t)(byteVal & 0x7F)) << (idx * 7); idx++; } else

A number of code blocks were disabled from compilation using #if 0 blocks.

These were either deprecated code that should have been removed once the new code was tested, or proposed 'future' ideas yet to be implemented.

All these blocks have been removed from the source.

Signed-off-by: Mike Leach mike.leach@linaro.org --- decoder/include/trc_gen_elem_types.h | 9 +--- decoder/source/etmv4/trc_pkt_proc_etmv4.cpp | 73 ----------------------------- decoder/source/i_dec/trc_idec_arminst.cpp | 33 ------------- decoder/source/trc_frame_deformatter.cpp | 20 +------- decoder/source/trc_frame_deformatter_impl.h | 10 ---- decoder/tests/source/simple_pkt_c_api.c | 24 +--------- 6 files changed, 3 insertions(+), 166 deletions(-)

diff --git a/decoder/include/trc_gen_elem_types.h b/decoder/include/trc_gen_elem_types.h index 3f3108e..66d8d79 100644 --- a/decoder/include/trc_gen_elem_types.h +++ b/decoder/include/trc_gen_elem_types.h @@ -58,14 +58,7 @@ typedef enum _ocsd_gen_trc_elem_t OCSD_GEN_TRC_ELEM_EXCEPTION_RET, /*!< expection return */ OCSD_GEN_TRC_ELEM_TIMESTAMP, /*!< Timestamp - preceding elements happeded before this time. */ OCSD_GEN_TRC_ELEM_CYCLE_COUNT, /*!< Cycle count - cycles since last cycle count value - associated with a preceding instruction range. */ - OCSD_GEN_TRC_ELEM_EVENT, /*!< Event - trigger, (TBC - perhaps have a set of event types - cut down additional processing?) */ -#if 0 - OCSD_GEN_TRC_ELEM_DATA_VAL, /*!< Data value - associated with prev instr (if same stream) + daddr, or data assoc key if supplied. */ - OCSD_GEN_TRC_ELEM_DATA_ADDR, /*!< Data address - associated with prev instr (if same stream), or data assoc key if supplied. */ - OCSD_GEN_TRC_ELEM_SWCHAN_DATA, /*!< data out on a SW channel (master, ID, data, type etc). */ - OCSD_GEN_TRC_ELEM_BUS_TRANSFER, /*!< Bus transfer event from a bus trace module (HTM) */ -#endif - + OCSD_GEN_TRC_ELEM_EVENT, /*!< Event - trigger, (TBC - perhaps have a set of event types - cut down additional processing?) */ } ocsd_gen_trc_elem_t;

diff --git a/decoder/source/etmv4/trc_pkt_proc_etmv4.cpp b/decoder/source/etmv4/trc_pkt_proc_etmv4.cpp index e5df23a..09d8c84 100644 --- a/decoder/source/etmv4/trc_pkt_proc_etmv4.cpp +++ b/decoder/source/etmv4/trc_pkt_proc_etmv4.cpp @@ -35,17 +35,14 @@

#include "etmv4/trc_pkt_proc_etmv4.h" #include "trc_pkt_proc_etmv4i_impl.h" -#include "trc_pkt_proc_etmv4d_impl.h" #include "common/ocsd_error.h"

#ifdef __GNUC__ // G++ doesn't like the ## pasting #define ETMV4I_PKTS_NAME "PKTP_ETMV4I" -#define ETMV4D_PKTS_NAME "PKTP_ETMV4D" #else // VC++ is fine #define ETMV4I_PKTS_NAME OCSD_CMPNAME_PREFIX_PKTPROC##"_ETMV4I" -#define ETMV4D_PKTS_NAME OCSD_CMPNAME_PREFIX_PKTPROC##"_ETMV4D" #endif

static const uint32_t ETMV4_SUPPORTED_OP_FLAGS = OCSD_OPFLG_PKTPROC_COMMON; @@ -126,74 +123,4 @@ const bool TrcPktProcEtmV4I::isBadPacket() const return false; }

-/***************************************************************************/ -/*******************ETM V4 DATA ********************************************/ -/***************************************************************************/ - -#if 0 -TrcPktProcEtmV4D::TrcPktProcEtmV4D() : TrcPktProcBase(ETMV4I_PKTS_NAME), - m_pProcessor(0) -{ -} - -TrcPktProcEtmV4D::TrcPktProcEtmV4D(int instIDNum) : TrcPktProcBase(ETMV4I_PKTS_NAME, instIDNum), - m_pProcessor(0) -{ -} - -TrcPktProcEtmV4D::~TrcPktProcEtmV4D() -{ - if(m_pProcessor) - delete m_pProcessor; - m_pProcessor = 0; -} - -ocsd_err_t TrcPktProcEtmV4D::onProtocolConfig() -{ - if(m_pProcessor == 0) - { - m_pProcessor = new (std::nothrow) EtmV4DPktProcImpl(); - if(m_pProcessor == 0) - { - LogError(ocsdError(OCSD_ERR_SEV_ERROR,OCSD_ERR_MEM)); - return OCSD_ERR_MEM; - } - m_pProcessor->Initialise(this); - } - return m_pProcessor->Configure(m_config); -} - -ocsd_datapath_resp_t TrcPktProcEtmV4D::processData( const ocsd_trc_index_t index, - const uint32_t dataBlockSize, - const uint8_t *pDataBlock, - uint32_t *numBytesProcessed) -{ - if(m_pProcessor) - return m_pProcessor->processData(index,dataBlockSize,pDataBlock,numBytesProcessed); - return OCSD_RESP_FATAL_NOT_INIT; -} - -ocsd_datapath_resp_t TrcPktProcEtmV4D::onEOT() -{ - if(m_pProcessor) - return m_pProcessor->onEOT(); - return OCSD_RESP_FATAL_NOT_INIT; -} - -ocsd_datapath_resp_t TrcPktProcEtmV4D::onReset() -{ - if(m_pProcessor) - return m_pProcessor->onReset(); - return OCSD_RESP_FATAL_NOT_INIT; -} - -ocsd_datapath_resp_t TrcPktProcEtmV4D::onFlush() -{ - if(m_pProcessor) - return m_pProcessor->onFlush(); - return OCSD_RESP_FATAL_NOT_INIT; -} - -#endif - /* End of File trc_pkt_proc_etmv4.cpp */ diff --git a/decoder/source/i_dec/trc_idec_arminst.cpp b/decoder/source/i_dec/trc_idec_arminst.cpp index 2a41d4d..ed7eb24 100644 --- a/decoder/source/i_dec/trc_idec_arminst.cpp +++ b/decoder/source/i_dec/trc_idec_arminst.cpp @@ -102,14 +102,6 @@ int inst_ARM_is_indirect_branch(uint32_t inst) } else if ((inst & 0x0f9000f0) == 0x01800090) { /* Some extended loads and stores */ is_indirect_branch = 0; -#if 0 - } else if ((inst & 0x0ff000f0) == 0x01200070) { - /* BKPT */ - is_indirect_branch = 0; - } else if ((inst & 0x0fb0f0f0) == 0x0120f000) { - /* MSR CPSR/SPSR,rx - appears to write PC, but is special */ - is_indirect_branch = 0; -#endif } else if ((inst & 0x0fb0f000) == 0x0320f000) { /* MSR #imm */ is_indirect_branch = 0; @@ -324,26 +316,6 @@ int inst_A64_branch_destination(uint64_t addr, uint32_t inst, uint64_t *pnpc) return is_direct_branch; }

- -#if 0 -int inst_ARM_is_direct_branch(uint32_t inst) -{ - return inst_ARM_branch_destination(0, inst, NULL); -} - - -int inst_Thumb_is_direct_branch(uint32_t inst) -{ - return inst_Thumb_branch_destination(0, inst, NULL); -} - -int inst_A64_is_direct_branch(uint32_t inst) -{ - return inst_A64_branch_destination(0, inst, NULL); -} -#endif - - int inst_ARM_is_branch(uint32_t inst) { return inst_ARM_is_indirect_branch(inst) || @@ -478,11 +450,6 @@ int inst_A64_is_conditional(uint32_t inst) } else if ((inst & 0xff000010) == 0x54000000) { /* B.cond */ return 1; -#if 0 - } else if ((inst & 0x3fe00000) == 0x1a800000) { - /* CSEL */ -#endif - return 1; } return 0; } diff --git a/decoder/source/trc_frame_deformatter.cpp b/decoder/source/trc_frame_deformatter.cpp index 07bed6f..57a7197 100644 --- a/decoder/source/trc_frame_deformatter.cpp +++ b/decoder/source/trc_frame_deformatter.cpp @@ -393,25 +393,7 @@ bool TraceFmtDcdImpl::checkForSync() uint32_t TraceFmtDcdImpl::findfirstFSync() { uint32_t unsynced = m_in_block_size; // consider entire block as unsynced at present. -#if 0 - if(m_match_fsync.patternSize() == 0) - { - uint8_t pattern[] = { 0xFF, 0xFF, 0xFF, 0x7F }; - if(!m_match_fsync.setPattern(pattern,sizeof(pattern))) - { - ocsdError err(OCSD_ERR_SEV_ERROR, OCSD_ERR_NOT_INIT); - err.setMessage("Failed to set pattern in FSYNC matcher."); - throw ocsdError(&err); - } - } - - // find an FSYNC - if(m_match_fsync.checkBuffer(m_in_block_base,m_in_block_size)) - { - unsynced = m_match_fsync.pos(); // number of unsynced bytes is the position in the buffer. - m_frame_synced = true; - } -#endif + //**TBD - handle fsync patterns in TPIU captured code return unsynced; }

diff --git a/decoder/source/trc_frame_deformatter_impl.h b/decoder/source/trc_frame_deformatter_impl.h index c9e5d3f..8e3f1ba 100644 --- a/decoder/source/trc_frame_deformatter_impl.h +++ b/decoder/source/trc_frame_deformatter_impl.h @@ -42,11 +42,6 @@ #include "interfaces/trc_indexer_src_i.h" #include "common/trc_component.h"

-#if 0 -#include "blk_pattern_match.h" -#endif - - //! output data fragment from the current frame - collates bytes associated with an ID. typedef struct _out_chan_data { ocsd_trc_index_t index; //!< trace source index for start of these bytes @@ -163,11 +158,6 @@ private: bool m_b_output_unpacked_raw;

bool m_raw_chan_enable[128]; - -#if 0 - /* pattern match for fsyncs */ - BlkPatternMatch m_match_fsync; -#endif };

diff --git a/decoder/tests/source/simple_pkt_c_api.c b/decoder/tests/source/simple_pkt_c_api.c index 32312b8..1deb18f 100644 --- a/decoder/tests/source/simple_pkt_c_api.c +++ b/decoder/tests/source/simple_pkt_c_api.c @@ -738,31 +738,9 @@ static ocsd_err_t create_decoder_stm(dcd_tree_handle_t dcd_tree_h) { /* Full decode */ /* not supported in library at present */ - -#if 0 - /* create the packet decoder and packet processor pair */ - ret = ocsd_dt_create_stm_decoder(dcd_tree_h,&trace_config_stm); - if(ret == OCSD_OK) - { - if((op != TEST_PKT_DECODEONLY) && (ret == OCSD_OK)) - { - ret = ocsd_dt_attach_stm_pkt_mon(dcd_tree_h, (uint8_t)((trace_config_stm.reg_tcsr & STMTCSR_TRC_ID_MASK) >> STMTCSR_TRC_ID_SHIFT), stm_packet_monitor); - } - } - - /* trace data file path */ - strcpy(mem_file_path,); - strcat(mem_file_path,memory_dump_filename); - - if(ret == OCSD_OK) - { - /* create a memory file accessor */ - ret = ocsd_dt_add_binfile_mem_acc(dcd_tree_h,mem_dump_address,OCSD_MEM_SPACE_ANY,mem_file_path); - } -#else + printf("STM Full decode not supported in library at present. Packet print only\n"); ret = OCSD_ERR_RDR_NO_DECODER; -#endif } return ret; }

On 12 August 2016 at 05:37, Mike Leach mike.leach@linaro.org wrote:

Version 0v004 in development.

Ensure that any tests done during D&T of new feature do not have same version as the stable library.

README: change to work done / work TBD for STM

test program: Updated output of help message to include the -log*** commands. Allowed help with input of any of -help --help -h.

HOWTO: Updated the HOWTO document to reflect operation with the latest perf-opencsd branch, perf-opencsd-4.7-rc4, and the opencsd-0v003 library branch.

Branch "perf-opencsd-4.7-rc4" doesn't exist anymore and has been replaced by "perf-opencsd-4.7". This is the official branch name that should be used in the commit log and the patch itself.

Added addtional example using the --dump option in perf report
to see trace packet data.

Signed-off-by: Mike Leach mike.leach@linaro.org

HOWTO.md | 90 +++++++++++++++++++++++++-------- README.md | 10 +++- decoder/docs/doxygen_config.dox | 2 +- decoder/include/ocsd_if_types.h | 4 +- decoder/tests/source/trc_pkt_lister.cpp | 14 +++-- 5 files changed, 90 insertions(+), 30 deletions(-)

diff --git a/HOWTO.md b/HOWTO.md index 93d6a9d..ad19e9e 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -7,9 +7,9 @@ This HOWTO explains how to use the perf cmd line tools and the openCSD library to collect and extract program flow traces generated by the CoreSight IP blocks on a Linux system. The examples have been generated using an aarch64 Juno-r0 platform. All information is considered accurate and tested -using library branch `opencsd-0v003` (decode library only) and the latest perf -branch `perf-opencsd-4.7-rc1` (decode library + perf tools) on the -[OpenCSD github repository][1]. +using library branches `opencsd-0v002` and `opencsd-0v003` (decode library only) +and the latest perf branch `perf-opencsd-4.7-rc4` (decode library + perf tools) +on the [OpenCSD github repository][1].

On Target Trace Acquisition - Perf Record @@ -17,8 +17,8 @@ On Target Trace Acquisition - Perf Record

All the enhancement to the Perf tools that support the new `cs_etm` pmu have not been upstreamed yet. To get the required functionality branch -`perf-opencsd-4.7-rc1` needs to be downloaded to the target system where -traces are to be collected. This branch is an upstream v4.7-rc1 kernel +`perf-opencsd-4.7-rc4` needs to be downloaded to the target system where +traces are to be collected. This branch is an upstream v4.7-rc4 kernel supplemented with modifications to the CoreSight framework and drivers to be usable by the Perf core. The remaining out of tree patches are being upstreamed incrementally. @@ -135,42 +135,42 @@ Off Target OpenCSD Compilation As of this writing the openCSD library is not part of the perf tools source. It is available on [github][1] and needs to be compiled before perf.

• linaro@t430:~/linaro/coresight$ git clone -b opencsd-0v002 https://github.com/Linaro/OpenCSD.git opencsd-0v002

• linaro@t430:~/linaro/coresight$ git clone -b opencsd-0v003 https://github.com/Linaro/OpenCSD.git opencsd-0v003 Cloning into 'OpenCSD'... remote: Counting objects: 2063, done. remote: Total 2063 (delta 0), reused 0 (delta 0), pack-reused 2063 Receiving objects: 100% (2063/2063), 2.51 MiB | 1.24 MiB/s, done. Resolving deltas: 100% (1399/1399), done. Checking connectivity... done.

• linaro@t430:~/linaro/coresight$ ls opencsd-0v002

• linaro@t430:~/linaro/coresight$ ls opencsd-0v003 decoder LICENSE README.md

Once the source code has been acquired compilation of the openCSD library can take place. For Linux two options are available, LINUX and LINUX64, based on the host's (which has nothing to do with the target) architecture:

• linaro@t430:~/linaro/coresight/$ cd opencsd-0v002/decoder/build/linux/
• linaro@t430:~/linaro/coresight/opencsd-0v002/decoder/build/linux$ ls

• linaro@t430:~/linaro/coresight/$ cd opencsd-0v003/decoder/build/linux/
• linaro@t430:~/linaro/coresight/opencsd-0v003/decoder/build/linux$ ls makefile rctdl_c_api_lib ref_trace_decode_lib

• linaro@t430:~/linaro/coresight/opencsd-0v002/decoder/build/linux$ make LINUX64=1 DEBUG=1

• linaro@t430:~/linaro/coresight/opencsd-0v003/decoder/build/linux$ make LINUX64=1 DEBUG=1 ... ...

• linaro@t430:~/linaro/coresight/opencsd-0v002/decoder/build/linux$ ls ../../lib/linux64/dbg/

• linaro@t430:~/linaro/coresight/opencsd-0v003/decoder/build/linux$ ls ../../lib/linux64/dbg/ libcstraced.a libcstraced_c_api.a libcstraced_c_api.so libcstraced.so

Off Target Perf Tools Compilation

As stated above not all the pieces of the solution have been upstreamed. To -get all the components branch `perf-opencsd-4.7-rc1` needs to be +get all the components branch `perf-opencsd-4.7-rc4` needs to be obtained:

• linaro@t430:~/linaro/coresight$ git clone -b perf-opencsd-4.7-rc1 https://github.com/Linaro/OpenCSD.git perf-opencsd-4.7-rc1

• linaro@t430:~/linaro/coresight$ git clone -b perf-opencsd-4.7-rc4 https://github.com/Linaro/OpenCSD.git perf-opencsd-4.7-rc4 ... ...

• linaro@t430:~/linaro/coresight$ ls perf-opencsd-4.7-rc1/

• linaro@t430:~/linaro/coresight$ ls perf-opencsd-4.7-rc4/ arch certs CREDITS Documentation firmware include ipc Kconfig lib Makefile net REPORTING-BUGS scripts sound usr block COPYING crypto drivers fs init Kbuild kernel MAINTAINERS mm README samples security tools virt

@@ -179,12 +179,12 @@ variable telling the build scripts where to find the library is needed. If the `CSTRACE_PATH` variable is not defined the compilation will still be successful, but handling of CoreSight trace data won't be supported.

• linaro@t430:~/linaro/coresight$ cd perf-opencsd-4.7-rc1
• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc1$ export CSTRACE_PATH=~/linaro/coresight/opencsd-0v002/decoder
• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc1$ make -C tools/perf

• linaro@t430:~/linaro/coresight$ cd perf-opencsd-4.7-rc4
• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ export CSTRACE_PATH=~/linaro/coresight/opencsd-0v003/decoder
• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ make -C tools/perf ... ...

• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc1$ ls -l tools/perf/perf

• linaro@t430:~/linaro/coresight/perf-opencsd-4.7-rc4$ ls -l tools/perf/perf -rwxrwxr-x 1 linaro linaro 6276360 Mar 3 10:05 tools/perf/perf

@@ -223,8 +223,8 @@ to be sure everything is clean.

 linaro@t430:~/linaro/coresight/feb24$ rm -rf ~/.debug
 linaro@t430:~/linaro/coresight/feb24$ cp -dpR .debug ~/

• linaro@t430:~/linaro/coresight/feb24$ export LD_LIBRARY_PATH=~/linaro/coresight/opencsd-0v002/decoder/lib/linux64/dbg/
• linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc1/tools/perf/perf report --stdio

• linaro@t430:~/linaro/coresight/feb24$ export LD_LIBRARY_PATH=~/linaro/coresight/opencsd-0v003/decoder/lib/linux64/dbg/

• linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc4/tools/perf/perf report --stdio

  # To display the perf.data header info, please use --header/--header-only options. #

@@ -266,15 +266,61 @@ to be sure everything is clean. 1.24% 1.24% uname libc-2.21.so [.] 0x00000000000fcab8 ...

+Additional data can be obtained, which contains a dump of the trace packets received using the command

• mjl@ubuntu-vbox:./perf-opencsd-4.7-rc4/coresight/tools/perf/perf report --stdio --dump

+resulting a large amount of data, trace looking like:-

• 0x618 [0x30]: PERF_RECORD_AUXTRACE size: 0x11ef0 offset: 0 ref: 0x4d881c1f13216016 idx: 0 tid: 15244 cpu: -1
• . ... CoreSight ETM Trace data: size 73456 bytes

•  0: I_ASYNC : Alignment Synchronisation.
  

•  12: I_TRACE_INFO : Trace Info.
  

•  17: I_TRACE_ON : Trace On.
  

•  18: I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0x0000007F89F24D80; Ctxt: AArch64,EL0, NS;
  

•  28: I_ATOM_F6 : Atom format 6.; EEEEEEEEEEEEEEEEEEEEEEEE
  

•  29: I_ATOM_F6 : Atom format 6.; EEEEEEEEEEEEEEEEEEEEEEEE
  

•  30: I_ATOM_F6 : Atom format 6.; EEEEEEEEEEEEEEEEEEEEEEEE
  

•  32: I_ATOM_F6 : Atom format 6.; EEEEN
  

•  33: I_ATOM_F1 : Atom format 1.; E
  

•  34: I_EXCEPT : Exception.;  Data Fault; Ret Addr Follows;
  

•  36: I_ADDR_L_64IS0 : Address, Long, 64 bit, IS0.; Addr=0x0000007F89F2832C;
  

•  45: I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0xFFFFFFC000083400; Ctxt: AArch64,EL1, NS;
  

•  56: I_TRACE_ON : Trace On.
  

•  57: I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0x0000007F89F2832C; Ctxt: AArch64,EL0, NS;
  

•  68: I_ATOM_F3 : Atom format 3.; NEE
  

•  69: I_ATOM_F3 : Atom format 3.; NEN
  

•  70: I_ATOM_F3 : Atom format 3.; NNE
  

•  71: I_ATOM_F5 : Atom format 5.; ENENE
  

•  72: I_ATOM_F5 : Atom format 5.; NENEN
  

•  73: I_ATOM_F5 : Atom format 5.; ENENE
  

•  74: I_ATOM_F5 : Atom format 5.; NENEN
  

•  75: I_ATOM_F5 : Atom format 5.; ENENE
  

•  76: I_ATOM_F3 : Atom format 3.; NNE
  

•  77: I_ATOM_F3 : Atom format 3.; NNE
  

•  78: I_ATOM_F3 : Atom format 3.; NNE
  

•  80: I_ATOM_F3 : Atom format 3.; NNE
  

•  81: I_ATOM_F3 : Atom format 3.; ENN
  

•  82: I_EXCEPT : Exception.;  Data Fault; Ret Addr Follows;
  

•  84: I_ADDR_L_64IS0 : Address, Long, 64 bit, IS0.; Addr=0x0000007F89F283F0;
  

•  93: I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0xFFFFFFC000083400; Ctxt: AArch64,EL1, NS;
  

•  104: I_TRACE_ON : Trace On.
  

•  105: I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0x0000007F89F283F0; Ctxt: AArch64,EL0, NS;
  

•  116: I_ATOM_F5 : Atom format 5.; NNNNN
  

•  117: I_ATOM_F5 : Atom format 5.; NNNNN
  

Trace Decoding with Perf Script

Working with perf scripts needs more command line options but yields interesting results.

• linaro@t430:~/linaro/coresight/feb24$ export EXEC_PATH=/home/linaro/coresight/perf-opencsd-4.7-rc1/tools/perf/

• linaro@t430:~/linaro/coresight/feb24$ export EXEC_PATH=/home/linaro/coresight/perf-opencsd-4.7-rc4/tools/perf/ linaro@t430:~/linaro/coresight/feb24$ export SCRIPT_PATH=$EXEC_PATH/scripts/python/ linaro@t430:~/linaro/coresight/feb24$ export XTOOL_PATH=/your/aarch64/toolchain/path/bin/

• linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc1/tools/perf/perf --exec-path=${EXEC_PATH} script --script=python:${SCRIPT_PATH}/cs-trace-disasm.py -- -d ${XTOOL_PATH}/aarch64-linux-gnu-objdump

• linaro@t430:~/linaro/coresight/feb24$ ../perf-opencsd-4.7-rc4/tools/perf/perf --exec-path=${EXEC_PATH} script --script=python:${SCRIPT_PATH}/cs-trace-disasm.py -- -d ${XTOOL_PATH}/aarch64-linux-gnu-objdump

        7f89f24d80:   910003e0        mov     x0, sp
        7f89f24d84:   94000d53        bl      7f89f282d0 <free@plt+0x3790>
  

diff --git a/README.md b/README.md index 9d07e94..d422b4a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The library is implemented in C++ with an optional "C" API. CoreSight Trace Component Support.

---

-_Current Version 0.003_ +_Current Version 0.004_

### Current support:

@@ -26,10 +26,15 @@ _Current Version 0.003_

### Support to be added:

-- ITM software trace - packet processing. +- STM software trace - packet decode. +- ITM software trace - packet processing and decode.

• ETMv3 data trace - packet decode.
• ETMv4 data trace - packet processing and decode.

+Note: for ITM and STM, packet decode is combining Master+Channel+Marker+Payload packets into a single generic +output packet.

Note on the Git Repository.

@@ -78,6 +83,7 @@ Version and Modification Information

• _Version 0.001_: Library development - tested with `perf` tools integration - BKK16, 8th March 2016
• _Version 0.002_: Library development - added in PTM decoder support. Restructure header dir, replaced ARM rctdl prefix with opencsd/ocsd.
• _Version 0.003_: Library development - added in ETMv3 instruction decoder support.

+- _Version 0.004_: In development - decode tree api updates.

Licence Information

diff --git a/decoder/docs/doxygen_config.dox b/decoder/docs/doxygen_config.dox index ed9f327..bdb24f0 100644 --- a/decoder/docs/doxygen_config.dox +++ b/decoder/docs/doxygen_config.dox @@ -38,7 +38,7 @@ PROJECT_NAME = "OpenCSD - CoreSight Trace Decode Library" # could be handy for archiving the generated documentation or if some version # control system is used.

-PROJECT_NUMBER = 0.003 +PROJECT_NUMBER = 0.004

# Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/decoder/include/ocsd_if_types.h b/decoder/include/ocsd_if_types.h index 00f8604..4fb428d 100644 --- a/decoder/include/ocsd_if_types.h +++ b/decoder/include/ocsd_if_types.h @@ -48,8 +48,8 @@ /** @name Library Versioning @{*/ #define OCSD_VER_MAJOR 0x0 /**< Library Major Version */ -#define OCSD_VER_MINOR 0x3 /**< Library Minor Version */ -#define OCSD_VER_STRING "0.003" /**< Library Version string */ +#define OCSD_VER_MINOR 0x4 /**< Library Minor Version */ +#define OCSD_VER_STRING "0.004" /**< Library Version string */ #define OCSD_LIB_NAME "OpenCSD Library" /**< Library name string */ #define OCSD_LIB_SHORT_NAME "OCSD" /**< Library Short name string */ /** @}*/ diff --git a/decoder/tests/source/trc_pkt_lister.cpp b/decoder/tests/source/trc_pkt_lister.cpp index c96d09b..893bc36 100644 --- a/decoder/tests/source/trc_pkt_lister.cpp +++ b/decoder/tests/source/trc_pkt_lister.cpp @@ -181,10 +181,10 @@ void print_help() { std::ostringstream oss; oss << "Trace Packet Lister - commands\n\n";

• oss << "Snapshot:\n";

• oss << "Snapshot:\n\n"; oss << "-ss_dir <dir> Set the directory path to a trace snapshot\n"; oss << "-ss_verbose Verbose output when reading the snapshot\n";

• oss << "Decode:\n";

• oss << "\nDecode:\n\n"; oss << "-id <n> Set an ID to list (may be used mutiple times) - default if no id set is for all IDs to be printed\n"; oss << "-src_name <name> List packets from a given snapshot source name (defaults to first source found)\n"; oss << "-decode Full decode of the packets from the trace snapshot (default is to list undecoded packets only\n";

@@ -192,6 +192,14 @@ void print_help() oss << "-o_raw_packed Output raw packed trace frames\n"; oss << "-o_raw_unpacked Output raw unpacked trace data per ID\n"; oss << "-test_waits <N> Force wait from packet printer for N packets - test the wait/flush mechanisms for the decoder\n";

• oss << "\nOutput:\n";
• oss << " Setting any of these options cancels the default output to file & stdout,\n using _only_ the options supplied.\n\n";
• oss << "-logstdout Output to stdout -> console.\n";
• oss << "-logstderr Output to stderr.\n";
• oss << "-logfile Output to default file - " << logfileName << "\n";
• oss << "-logfilename <name> Output to file <name> \n";
• logger.LogMsg(oss.str());

}

@@ -381,7 +389,7 @@ bool process_cmd_line_opts(int argc, char* argv[]) no_undecoded_packets = true; decode = true; }

•        else if(strcmp(argv[optIdx], "-help") == 0)
  

•        else if((strcmp(argv[optIdx], "-help") == 0) || (strcmp(argv[optIdx], "--help") == 0) || (strcmp(argv[optIdx], "-h") == 0))
         {
             print_help();
             bOptsOK = false;
  

-- 2.7.4

---

CoreSight mailing list CoreSight@lists.linaro.org https://lists.linaro.org/mailman/listinfo/coresight