Difference between pages "r7.1.1:Macro LFDS711 QUEUE UMM GET KEY FROM 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_QUEUE_UMM_GET_KEY_FROM_ELEMENT}}
+{{DISPLAYTITLE:function libbenchmark_misc_pal_helper_new_topology_node}}
 ==Source Files==
-  └───liblfds711
+  └───test_and_benchmark
-      └───inc
+      └───libbenchmark
-          └───liblfds711
+          ├───inc
-                 lfds711_queue_umm.h
+         │   └───libbenchmark
+         │           libbenchmark_porting_abstraction_layer.h
+         └───src
+             └───libbenchmark_misc
+                     libbenchmark_misc_pal_helpers.c
 ==Opaque Structures==
-  struct [[r7.1.1:struct lfds711_queue_umm_element|lfds711_queue_umm_element]];
+  struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];
-==Macro==
+==Prototype==
-  #define LFDS711_QUEUE_GET_KEY_FROM_ELEMENT( queue_umm_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==
-''queue_umm_element''
+''struct libbenchmark_topology_state *ts''
-: A ''struct lfds711_queue_umm_element''.  Not a pointer to it - the struct itself.
+: A pointer a ''struct libbenchmark_topology'' obtained from ''libbenchmark_pal_populate_topology''.
-==Return Value==
+''lfds711_pal_uint_t logical_processor_number''
-Returns a void pointer, the key from the element.
+: The logical processor number of the logical processor to add to the topology tree pointed to by ''ts''.
-==Notes==
+''enum flag windows_processor_group_inuse_flag''
-The key set into a queue element is only guranteed to be visible to another logical core once the element has been dequeued by a thread running on that logical core.
+: 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).
-So, for example, if there was a globally allocated queue element, where a thread on logical core A set a value and then enqueued the element to the queue, a thread on logical core B would only be guaranteed to see the key set by the other thread once it dequeues the element from the queue.
+''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.
-As with all ''liblfds'' macros, the macro operates on the structure itself, not a pointer to it.
+==Return Value==
+No return value.
-The key is not used in any way by the queue, and is provided for convenience when moving keys and values between different data structures.
+==Example==
-==Example==
+==Notes==
-Coming soon.  No, really!  (Written 29th Dec 2015).
+This helper function is used by ''libbenchmark_pal_populate_topology'' to add a logical processor node to the topology tree.
 ==See Also==
-* [[r7.1.1:Queue (unbounded, many producer, many consumer)|Queue (unbounded, many producer, many consumer)]]
+* [[r7.1.1:Porting Guide (libbenchmark)|Porting Guide (libbenchmark)]]
-* ''[[r7.1.1:macro LFDS711_QUEUE_UMM_SET_KEY_IN_ELEMENT|LFDS711_QUEUE_UMM_SET_KEY_IN_ELEMENT]]''
+* ''[[r7.1.1:function libbenchmark_pal_populate_topology|libbenchmark_pal_populate_topology]]''

Difference between pages "r7.1.1:Macro LFDS711 QUEUE UMM GET KEY FROM 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