Difference between pages "r7.1.1:Function libbenchmark misc pal helper add cache node to topology tree" 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 9: Line 9:
             └───libbenchmark_misc
             └───libbenchmark_misc
                     libbenchmark_misc_pal_helpers.c
                     libbenchmark_misc_pal_helpers.c
==Enums==
enum [[r7.1.1:enum libbenchmark_topology_node_cache_type|libbenchmark_topology_node_cache_type]];


==Opaque Structures==
==Opaque Structures==
  struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];
  struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];
struct [[r7.1.1:struct libbenchmark_topology_node_state|libbenchmark_topology_node_state]];


==Prototype==
==Prototype==
  void libbenchmark_misc_pal_helper_add_cache_node_to_topology_tree( struct libbenchmark_topology_state *ts,
  void libbenchmark_misc_pal_helper_add_logical_processor_node_to_topology_tree( struct libbenchmark_topology_state *ts,
                                                                    struct libbenchmark_topology_node_state *tns,
                                                                                lfds711_pal_uint_t logical_processor_number,
                                                                    lfds711_pal_uint_t level,
                                                                                enum flag windows_processor_group_inuse_flag,
                                                                    enum libbenchmark_topology_node_cache_type type );
                                                                                lfds711_pal_uint_t windows_processor_group_number );


==Parameters==
==Parameters==
Line 27: Line 23:
: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.
: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.


''struct libbenchmark_topology_node_state *tns''
''lfds711_pal_uint_t logical_processor_number''
: A pointer a ''struct libbenchmark_topology_node'' obtained from ''libbenchmark_misc_pal_helper_new_topology_node''.
: The logical processor number of the logical processor to add to the topology tree pointed to by ''ts''.


''lfds711_pal_uint_t level''
''enum flag windows_processor_group_inuse_flag''
: The cache's level (typically 1 to 3).
: 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).


''enum libbenchmark_topology_node_cache_type type''
''lfds711_pal_uint_t windows_processor_group_number''
: This argument indicates the type of the cache (data, instruction or unified).
: 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==
==Return Value==
Line 42: Line 38:


==Notes==
==Notes==
This helper function is used by ''libbenchmark_pal_populate_topology'' to add a cache node to the topology tree.
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:Porting Guide (libbenchmark)|Porting Guide (libbenchmark)]]
* [[r7.1.1:Porting Guide (libbenchmark)|Porting Guide (libbenchmark)]]
* ''[[r7.1.1:function libbenchmark_pal_populate_topology|libbenchmark_pal_populate_topology]]''
* ''[[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

Retrieved from ‘https://www.liblfds.org/mediawiki/index.php?title=r7.1.1:Function_libbenchmark_misc_pal_helper_add_cache_node_to_topology_tree&oldid=1113’