Difference between pages "r7.1.1:Macro LFDS711 LIST ASU GET START AND THEN NEXT" 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:macro LFDS711_LIST_ASU_GET_START_AND_THEN_NEXT}}
{{DISPLAYTITLE:function libbenchmark_misc_pal_helper_new_topology_node}}
==Source File==
==Source Files==
  └───liblfds711
  └───test_and_benchmark
     └───inc
     └───libbenchmark
         └───liblfds711
         ├───inc
                lfds711_list_addonly_singlylinked_unordered.h
        │  └───libbenchmark
        │          libbenchmark_porting_abstraction_layer.h
        └───src
            └───libbenchmark_misc
                    libbenchmark_misc_pal_helpers.c


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


==Macro==
==Prototype==
  #define LFDS711_LIST_ASU_GET_START_AND_THEN_NEXT( list_asu_state, pointer_to_list_asu_element )
  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==
==Parameters==
''list_asu_state''
''struct libbenchmark_topology_state *ts''
: A ''struct lfds711_list_asu_state''.  Not a pointer to it - the struct itself.
: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.


''pointer_to_list_asu_element''
''lfds711_pal_uint_t logical_processor_number''
: A pointer to ''struct lfds711_list_asu_element''.  This is and only is a pointer - it's not the address of an actual, allocated struct.
: 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==
==Return Value==
If ''pointer_to_list_element'' is NULL, returns (and sets ''pointer_to_list_element'' to be the same value) a ''struct lfds711_list_asu_element *'' to the first element in the list.
No return value.


If ''pointer_to_list_element'' is not NULL, returns (and sets ''pointer_to_list_element'' to be the same value) a ''struct lfds711_list_asu_element *'' to the element after the list element ''*pointer_to_list_element''.
==Example==


==Notes==
==Notes==
As with all ''liblfds'' macros, the macro operates on the structure itself, not a pointer to it.
This helper function is used by ''libbenchmark_pal_populate_topology'' to add a logical processor node to the topology tree.
 
This is a convenience macro, expected use is in the conditional part of while loops.  If the element argument is NULL, then the macro returns (and sets the element pointer to be) the first element; if it is non-NULL (and then should be a pointer to an element in the list), then the macro returns (and sets the element pointer to be)  the next element in the list, eventully returning (and setting the element pointer to be) NULL, which causes the while loop to finish.
 
==Example==


==See Also==
==See Also==
* [[r7.1.1:List (add-only, singly-linked, unordered)|List (add-only, singly-linked, unordered)]]
* [[r7.1.1:Porting Guide (libbenchmark)|Porting Guide (libbenchmark)]]
* ''[[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:Macro_LFDS711_LIST_ASU_GET_START_AND_THEN_NEXT&oldid=1113’