Difference between pages "r7.1.1:Macro LFDS711 LIST ASU SET KEY IN ELEMENT" and "r7.1.1:Function libbenchmark misc pal helper add logical processor node to topology tree"

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.

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:macro LFDS711_LIST_ASU_SET_KEY_IN_ELEMENT}}
+{{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==
-  struct [[r7.1.1:struct lfds711_list_asu_element|lfds711_list_asu_element]];
+  struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];
-==Macro==
+==Prototype==
-  #define LFDS711_LIST_ASU_SET_KEY_IN_ELEMENT( list_asu_element, new_key )
+  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==
-''list_asu_element''
+''struct libbenchmark_topology_state *ts''
-: A ''struct lfds711_list_asu_element''.  Not a pointer to it - the struct itself.
+: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.
-''new_key''
+''lfds711_pal_uint_t logical_processor_number''
-: A void pointer, which the key in ''list_asu_element'' is set to.
+: 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==
-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.
-The key can only be set before an element enters the list.  If it is set after, the list will likely be broken (as the new key, being different to the old key, would most likely require the element to be in a different position in the tree, and this element movement is not supported) and also, key is not set atomically, so that even if a change was made, there is in principle no guarantee any other logical core would see that change anyway.
-Key is not set atomically because it is known it will only be set before an element enters the tree.  Matters can be (and have been) arranged to ensure key is despite the lack of an atomic set correctly propagated to other logical cores, but this is a behaviour of the linking code, not of the macro which sets key.
-==Example==
 ==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]]''

Difference between pages "r7.1.1:Macro LFDS711 LIST ASU SET KEY IN ELEMENT" and "r7.1.1:Function libbenchmark misc pal helper add logical processor node to topology tree"

Latest revision as of 20:16, 17 February 2017

Contents