69 lines · plain
1****************************************************************************2* README *3* *4* This file provides all the information regarding new CLI commands that *5* enable using various hardware features of Intel(R) architecture based *6* processors from LLDB's CLI. *7****************************************************************************8 9 10============11Introduction12============13A shared library has been developed to use various hardware features of14Intel(R) architecture based processors through LLDB's command line. The library15currently comprises of hardware features namely Intel(R) Processor Trace and16Intel(R) Memory Protection Extensions.17 18 19============20Details21============22A C++ based cli wrapper (cli-wrapper.cpp) has been developed here that23agglomerates all cli commands for various hardware features. This wrapper is24build to generate a shared library (lldbIntelFeatures) to provide all these25commands.26 27For each hardware feature, separate cli commands have been developed that are28provided by wrappers (e.g. cli-wrapper-mpxtable.cpp) residing29in feature specific folders.30 31For details regarding cli commands of each feature, please refer to these32feature specific wrappers.33 34 35 36============37How to Build38============39The shared library (lldbIntelFeatures) has a cmake based build and can be built40while building LLDB with cmake. "cli-wrapper.cpp" file is compiled along with all41the feature specific source files (residing in feature specific folders).42 43Furthermore, flexibility is provided to the user to include/exclude a particular44feature while building lldbIntelFeatures library. This is done by flags described45below:46 47 - LLDB_BUILD_INTEL_MPX - Enables building Intel(R) Memory Protection Extensions48 feature (inside intel-mpx folder). This flag defaults to "ON" meaning49 the feature is excluded while building lldbIntelFeatures library.50 51Please refer to README files in feature specific folders to know about additional52flags that need to be set in order to build that feature successfully.53 54 55============56How to Use57============58All CLI commands provided by this shared library can be used through the LLDB's59CLI by executing "plugin load <shared_lib_name>" on LLDB CLI. shared_lib_name here60is lldbIntelFeatures61 62 63 64============65Description66============67Please refer to README_CLI file of each feature to know about details of CLI68commands.69