Difference between pages "r7.1.1:Building Guide (libshared)" and "r7.1.1:Function libbenchmark misc pal helper add logical processor node to topology tree"

From liblfds.org
(Difference between pages)
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
 
Line 1: Line 1:
{{DISPLAYTITLE:Building Guide (libshared)}}
{{DISPLAYTITLE:function libbenchmark_misc_pal_helper_new_topology_node}}
==Introducton==
==Source Files==
The ''libshared'' library is used by ''libtest'', ''libbenchmark'', ''test'' and ''benchmark''.  As such, it must be built for any of these other components to build.  It is not used by, or needed to build, ''liblfds711''.
 
The ''libshared'' library uses a porting abstraction layer to mask platform differences.  Building ''libshared'' requires build files (makefile, etc) for your toolchain (GCC, gnumake, etc) and a port of the abstraction layer to your platform.
 
A small number of popular toolchains are supported out-of-the-box, along with porting abstraction layers which cover Windows (user-mode and kernel-mode) and Linux (user-mode).  A kernel-mode Linux port is present but one function is unimplemented, as there is no kernel-mode Linux function to wait for a thread to complete, and so the ''libshared'' abstraction for threading has to be rewritten, and it was decided not to delay the 7.1.1 release for this work to be done.
 
==Supported Toolchains==
The supported toolchains are;
 
* GCC and gnumake
* GCC, kbuild and gnumake (Linux kernel toolchain)
* MSVC and and gnumake (Windows user-mode toolchain - and, yup, gnumake, not nmake)
* WDK 7.1 (Windows XP/Vista/7 kernel toolchain)
 
Note that in 7.1.1, Visual Studio solution files are not provided.  This is because there are over ''liblfds'' and the ''benchmark'' and ''benchmark'' libraries and programmes (seven projects in all) in the end due to the multple build variants (debug, release, library, DLL, kernel library, kernel DLL, and repeated twice, once for VS2012 and once for VS2013) what comes to something like ten thousand settings, all of which have to be set using a mouse and a GUI, which is not only extraordinarily time-consuming and error-prone, but emotionally agonizing.
 
Mac support is not available due to lack of access to a Mac.
 
==Directory Structure==
└───test_and_benchmark
    └───libshared                                    : libshared library
        ├───bin                                      : output directory - the library file ends up here
        ├───build                                    : build configuration directory - contains one directory per platform
        │  ├───gcc_gnumake                          : GCC and gnumake
        │  ├───gcc_gnumake_kbuild                  : GCC, gnumake, and kbuild
        │  ├───msvc_gnumake                        : Microsoft Visual C (command line compiler) and gnumake
        │  └───wdk_7.1                              : WDK 7.1
        ├───inc                                      : the public header files
        │  └───libshared
        ├───obj                                      : temporary directory for object files
        └───src                                      : the source files
            ├───libshared_ansi                      : implementations of standard library functions
            ├───libshared_memory                    : memory container, for handling user provided store
            ├───libshared_misc                      : misc functions
            └───libshared_porting_abstraction_layer  : porting abstraction layer
 
==Building==
The library directory tree contains at its top level directory called ''build''.
 
This directory contains one directory per supported toolchain, where each such directory contains the files necessary to build for that toolchain.  Detailed descriptions of how to build for each toolchain are given below, with one heading per toolchain.
 
The various other components (''test'', ''benchmark'', etc) in their build files know the location of the resultant library file, so it does not need to be installed.
 
On all platforms, you need to clean between changing build types (debug, release, static, dynamic, profiled, etc), as there is only one directory used to hold object files.
 
==Per-Toolchain Build Instructions==
 
===GCC and gnumake===
└───test_and_benchmark
    └───libshared
        └───build
            └───gcc_gnumake
                    Makefile
 
To build, install GCC and gnumake, enter the build directory and type;
 
make
 
The following targets are available;
 
ar_cov      : archive (.a), coverage
ar_dbg      : archive (.a), debug
ar_prof      : archive (.a), profiling
ar_rel      : archive (.a), release
ar_tsan      : archive (.a), thread sanitizer
ar_vanilla  : archive (.a), no specific-build arguments
so_cov      : shared (.so), coverage
so_dbg      : shared (.so), debug
so_prof      : shared (.so), profiling
so_rel      : shared (.so), release
so_tsan      : shared (.so), thread sanitizer
so_vanilla  : shared (.so), no specific-build arguments
clean        : what you'd expect
 
When switching from one target to another, ''clean'' must be made.
 
If building ''*_ar_tsan'', ''libtsan'' must be installed.  This is not necessary if building ''*_so_tsan''.
 
===GCC, gnumake and kbuild===
└───test_and_benchmark
    └───libshared
        └───build
            └───gcc_gnumake_kbuild
                    Kbuild
                    Makefile
 
Remember, although the build files are present, the porting abstraction layer is not fully implemented.  '''This platform cannot currently build'''.
 
To build, install GCC, gnumake, kbuild (and the Linux kernel headers), enter the build directory and type;
 
make
 
The makefile is complimentory (mint-flavoured :-) and simply issues the necessary kbuild command.
 
There are three targets;
 
  clean
  help
  modules
 
Note that ''modules'' is the default build (i.e. with no arguments).
 
I do not properly understand kbuild.  I've read the documentation; I find for example examples which have switches in which are simply not present in the documentation, and in general I don't see how libraries are built to fit in with larger projects.  The most I can say about this build is that it compiles without warnings or errors.  I am pretty sure it's not something which can be used as it is in a kernel build or driver, but anyone who knows enough to be developing such a thing should be able to take what is here (since it compiles against the kernel) and easily fit it into their work.
 
Any feedback on making this build proper is greatly appreciated.
 
===MSVC and gnumake===
└───test_and_benchmark
    └───libshared
        └───build
            └───msvc_and_gnumake
                    libshared.def
                    makefile
 
To build, install an MSVC command line compiler, enter the build directory and type;
 
make
 
The following targets are available;
 
libdbg : archive (.lib), debug
librel : archive (.lib), release
dlldbg : shared (.dll), debug
dllrel : shared (.dll), release
clean  : what you'd expect
 
When switching from one target to another, clean must be made.
 
===WDK 7.1===
  └───test_and_benchmark
  └───test_and_benchmark
     └───libshared
     └───libbenchmark
         └───build
         ├───inc
            └───wdk_7.1
        │  └───libbenchmark
                    dirs
        │          libbenchmark_porting_abstraction_layer.h
                    driver_entry_renamed_to_avoid_compiler_warning.c
        └───src
                    libshared.def
            └───libbenchmark_misc
                    readme_before_win_kernel_build.txt
                     libbenchmark_misc_pal_helpers.c
                     runme_before_win_kernel_dynamic_lib_build.bat
                    runme_before_win_kernel_static_lib_build.bat
                    sources.dynamic
                    sources.static


All processor types are supported (x86, IA64, x64).
==Opaque Structures==
struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];


The WDK 7.1 kernel build environment is primitive and has a number of severe limitations; in particular, all source files must be in one directory and it is not possible to choose the output binary type (static or dynamic library) from the build command line; rather, a string has to be modified in a text file used by the build (!)
==Prototype==
void libbenchmark_misc_pal_helper_add_logical_processor_node_to_topology_tree( struct libbenchmark_topology_state *ts,
                                                                                lfds711_pal_uint_t logical_processor_number,
                                                                                enum flag windows_processor_group_inuse_flag,
                                                                                lfds711_pal_uint_t windows_processor_group_number );


To deal with these limitations, it is necessary for a Windows kernel build to run a batch file prior to building.  There are two batch files, one for static library builds and the other for dynamic library builds.  They are idempotent; you can run them as often as you like and switch between them as often as you want.  It's all fine.
==Parameters==
''struct libbenchmark_topology_state *ts''
: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.


Both batch files copy all the sources file into a single directory, ''libshared/build/wdk7.1/single_dir_for_windows_kernel/''.
''lfds711_pal_uint_t logical_processor_number''
: The logical processor number of the logical processor to add to the topology tree pointed to by ''ts''.


The static library batch file will then copy ''libshared/sources.static'' into ''libshared/build/wdk7.1/single_dir_for_windows_kernel/'', which will cause a static library to be built.
''enum flag windows_processor_group_inuse_flag''
: An ''enum flag'' which indicates whether or not the ''windows_processor_group_number'' argument contains a valid value (for that field is only meaningful on Windows 7 and greater).


The dynamic library batch file will then copy ''libshared/sources.dynamic'' into ''libshared/build/wdk7.1/single_dir_for_windows_kernel/'', which will cause a dynamic library to be built.  It will also copy ''driver_entry_renamed_to_avoid_compiler_warning.c'' to ''libshared/build/wdk7.1/single_dir_for_windows_kernel/driver_entry.c'' (note the renaming), since the linker requires the ''DriverEntry'' function to exist, even though it's not used.
''lfds711_pal_uint_t windows_processor_group_number''
: The Windows processor group number of the logical processor to add to the topology tree pointed to by ''ts''.  This value is only meaningful on Windows 7 and greater.  It will only be used if the ''windows_processor_group_inuse_flag'' is set to ''RAISED'', and so if not used, can be set to any value.  Zero is as good a choice as any other.


To build, start a build command line as usual, indicating through the command line you select whether you are making a debug or release build.  Then run the appropriate liblfds batch file to select a static or dynamic library.  Then, finally, run ''build.exe'' in the ''libshared/build/wdk_7.1/'' directory, with whatever arguments you prefer.
==Return Value==
No return value.


Note that due to limitations in the build environment, object files appear in a subdirectory in ''libshared/build/wdk7.1/single_dir_for_windows_kernel/'', rather than in the usual ''libshared/obj/''.  The final binary output however still appears almost as usual, in ''libshared/bin/[processor]/'', where processor might be ''i386''.  (The usual is just ''libshared/bin/'', with no subdirectories).
==Example==


Note that the ''sources'' file used to compile the library asserts the define ''KERNEL_MODE''.  This appears to be necessary, due to the lack of a compiler-provided macro to differentiate in the code between a user-mode or kernel-mode build.
==Notes==
This helper function is used by ''libbenchmark_pal_populate_topology'' to add a logical processor node to the topology tree.


==See Also==
==See Also==
* [[r7.1.1:Building Guide (benchmarking)|Building Guide (benchmarking)]]
* [[r7.1.1:Porting Guide (libbenchmark)|Porting Guide (libbenchmark)]]
* [[r7.1.1:Building Guide (testing)|Building Guide (testing)]]
* ''[[r7.1.1:function libbenchmark_pal_populate_topology|libbenchmark_pal_populate_topology]]''

Latest revision as of 20:16, 17 February 2017

Source Files

└───test_and_benchmark
    └───libbenchmark
        ├───inc
        │   └───libbenchmark
        │           libbenchmark_porting_abstraction_layer.h
        └───src
            └───libbenchmark_misc
                    libbenchmark_misc_pal_helpers.c

Opaque Structures

struct libbenchmark_topology_state;

Prototype

void libbenchmark_misc_pal_helper_add_logical_processor_node_to_topology_tree( struct libbenchmark_topology_state *ts,
                                                                               lfds711_pal_uint_t logical_processor_number,
                                                                               enum flag windows_processor_group_inuse_flag,
                                                                               lfds711_pal_uint_t windows_processor_group_number );

Parameters

struct libbenchmark_topology_state *ts

A pointer a struct libbenchmark_topology obtained from libbenchmark_pal_populate_topology.

lfds711_pal_uint_t logical_processor_number

The logical processor number of the logical processor to add to the topology tree pointed to by ts.

enum flag windows_processor_group_inuse_flag

An enum flag which indicates whether or not the windows_processor_group_number argument contains a valid value (for that field is only meaningful on Windows 7 and greater).

lfds711_pal_uint_t windows_processor_group_number

The Windows processor group number of the logical processor to add to the topology tree pointed to by ts. This value is only meaningful on Windows 7 and greater. It will only be used if the windows_processor_group_inuse_flag is set to RAISED, and so if not used, can be set to any value. Zero is as good a choice as any other.

Return Value

No return value.

Example

Notes

This helper function is used by libbenchmark_pal_populate_topology to add a logical processor node to the topology tree.

See Also