Lines Matching +full:test +full:- +full:shared +full:- +full:dbg
4 @brief How to build the library and test programs and include the library in an application
7 ----------------
10 - Linux and Windows, x86 or x64 hosts.
11 - ARM linux - AArch32 and AArch64
12 - ARM aarch32 and aarch64 libs, x-compiled on x86/64 hosts.
18 --------------------
20 The library and test programs are built from the library `./build/<platform>` directory, where
21 <platform> is either 'linux' or 'win-vs2022'
23 See [`./docs/test_progs.md`](@ref test_progs) for further information on use of the test
29 libraries in `decoder/lib/<tgt_dir>`, and also as a sub-directory of the build process for
30 intermediate files - `decoder/build/linux/ref_trace_decode_lib/<tgt_dir>`.
36 For development, alternatively use `make -f makefile.dev`
38 This will set <tgt_dir> to `linux<bit-variant>/<dbg|rel>` and therefore build libraries into the
39 `decoder/lib/linux<bit-variant>/<dbg|rel>` directories, allowing multiple variants of the library
46 `./lib/linux-arm64/dbg` will contain the linux aarch 64 debug libraries for ARM.
48 Options to pass to both makefiles are:-
49 - `DEBUG=1` : build the debug version of the library.
51 Options to pass to makefile.dev are:-
52 - ARCH=<arch> : sets the bit variant in the delivery directories. Set if cross compilation for ARCH
53 other than host. Otherwise ARCH is auto-detected.
57 compiler to use. The following would set the environment to cross-compile for ARM
59 export PATH=$PATH:~/work/gcc-x-aarch64-6.2/bin
61 export CROSS_COMPILE=aarch64-linux-gnu-
67 - `libcstraced.so.M.m.p` : shared library containing the main C++ based decoder library
68 - `libcstrace.so.M` : symbolic link name to library - major version only.
69 - `libcstrace.so` : symbolic link name to library - no version.
72 - `libcstraced_c_api.so.M.m.p` : shared library containing the C-API wrapper library. Dependent on …
73 - `libcstraced_c_api.so.M` : symbolic link name to library - major version only.
74 - `libcstraced_c_api.so` : symbolic link name to library - no version.
77 - `libcstraced.a` : static library containing the main C++ based decoder library.
78 - `libcstraced_c_api.a` : static library containing the C-API wrapper library.
80 Test programs are delivered to the `./tests/bin/<tgt_dir>` directories.
82 The test programs are built to used the .so versions of the libraries.
83 - `trc_pkt_lister` - dependent on `libcstraced.so`.
84 - `simple_pkt_print_c_api` - dependent on `libcstraced_c_api.so` & hence `libcstraced.so`.
86 The test program build for `trc_pkt_lister` also builds an auxiliary library used by this program f…
99 e.g. ` make -f makefile.dev DEBUG=1 install`
101 will install from `./lib/linux64/dbg`
105 Sufficient header files to build using the C-API library will be installed to `/usr/include/opencsd…
113 which contains all library and test build projects.
115 Libraries are delivered to the `./lib/win<bitsize>/<dbg\rel>` directories.
118 The solution contains four configurations:-
119 - *Debug* : builds debug versions of static C++ main library and C-API libraries, test programs lin…
120 - *Debug-dll* : builds debug versions of static main library and C-API DLL. C-API statically linked…
121 C-API test built as `simple_pkt_print_c_api-dl.exe` and linked against the DLL version of the C-API…
122 - *Release* : builds release static library versions, test programs linked to static libraries.
123 - *Release-dll* : builds release C-API DLL, static main library.
128 Libraries built are:-
129 - `libcstraced.lib` : static main C++ decoder library.
130 - `cstraced_c_api.dll` : C-API DLL library. Statically linked against `libcstraced.lib` at .DLL bui…
131 - `libcstraced_c_api.lib` : C-API static library.
133 There is also a project file to build an auxiliary library used `trc_pkt_lister` for test purposes …
145 32 bit ARM architectures it may be desirable to build a library that uses a v-addr size of
150 ---------------------------------------
152 The user source code includes a header according to the API to be used:-
154 - Main C++ decoder library - include `opencsd.h`. Link to C++ library.
155 - C-API library - include `opencsd_c_api.h`. Link to C-API library.
159 By default linux builds will link against the .so versions of the library. Using the C-API library …
167 To link against the C-API DLL, include the .DLL name as a dependency in the application project opt…
169 To link against the C-API static library, include the library name in the dependency list, and defi…
177 ---------------------------
193 - `OPENCSD_MEMACC_CACHE_PAGE_SIZE` : Page size in bytes.
194 - `OPENCSD_MEMACC_CACHE_PAGE_NUM` : number of pages.
195 - `OPENCSD_MEMACC_CACHE_OFF` : disable memacc caching.
199 ---------------------
213 …define any opcode with the top 16 bits as 0x0000 as an invalid opcode range - which is the range d…