Difference between pages "r7.1.1:Function benchmark pal numa malloc" 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:function benchmark_pal_numa_malloc}}
+{{DISPLAYTITLE:function libbenchmark_misc_pal_helper_new_topology_node}}
 ==Source Files==
   └───test_and_benchmark
-      └───benchmark
+      └───libbenchmark
+         ├───inc
+         │   └───libbenchmark
+         │           libbenchmark_porting_abstraction_layer.h
           └───src
-              └───porting_abstraction_layer_numa_malloc.c
+              └───libbenchmark_misc
+                     libbenchmark_misc_pal_helpers.c
+==Opaque Structures==
+ struct [[r7.1.1:struct libbenchmark_topology_state|libbenchmark_topology_state]];
 ==Prototype==
-  void *benchmark_pal_numa_malloc( lfds711_pal_uint_t numa_node_id, lfds711_pal_uint_t size_in_bytes );
+  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==
-''lfds711_pal_uint_t numa_node_id''
+''struct libbenchmark_topology_state *ts''
-: A NUMA node ID.  This is the ID used by the system to identify a NUMA node.
+: 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 size_in_bytes''
+''lfds711_pal_uint_t windows_processor_group_number''
-: The number of bytes to allocate.
+: 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==
-A pointer to the allocate memory, or NULL on failure.
+No return value.
 ==Example==
- void *benchmark_pal_numa_malloc( lfds711_pal_uint_t numa_node_id, lfds711_pal_uint_t size_in_bytes )
- {
-   HANDLE
-     process_handle;
-   LPVOID
-     memory;
-   // TRD : numa_node_id can be any value in its range
-   // TRD : size_in_bytes can be any value in its range
-   process_handle = GetCurrentProcess();
-   memory = VirtualAllocExNuma( process_handle, NULL, size_in_bytes, MEM_COMMIT, PAGE_READWRITE, (DWORD) numa_node_id );
-   return memory;
- }
 ==Notes==
-The ''libbenchmark'' library performs no memory allocations, rather it expects allocated memory to be passed to it, which it then uses.  As such the ''benchmark'' programme ''does'' perform allocations, as it is calling the ''libbenchmark'' functions to perform benchmarking.
+This helper function is used by ''libbenchmark_pal_populate_topology'' to add a logical processor node to the topology tree.
-The ''benchmark'' programme requires a hosted implementation and as such on SMP systems, simply calls ''malloc''.  However, on NUMA systems, the standard library offers no NUMA-aware allocator, so this abstraction function is required.
 ==See Also==
-* [[r7.1.1:Porting Guide (benchmark)|Porting Guide (benchmark)]]
+* [[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:Function benchmark pal numa malloc" 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