Add cross-platform NUMA library
[blender.git] / intern / numaapi / include / numaapi.h
1 // Copyright (c) 2016, libnumaapi authors
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to
5 // deal in the Software without restriction, including without limitation the
6 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 // sell copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19 // IN THE SOFTWARE.
20 //
21 // Author: Sergey Sharybin (sergey.vfx@gmail.com)
22
23 #ifndef __LIBNUMAAPI_H__
24 #define __LIBNUMAAPI_H__
25
26 #include <stdbool.h>
27 #include <stddef.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 #define NUMAAPI_VERSION_MAJOR 1
34 #define NUMAAPI_VERSION_MINOR 0
35
36 typedef enum NUMAAPI_Result {
37   NUMAAPI_SUCCESS       = 0,
38   // NUMA is not available on this platform.
39   NUMAAPI_NOT_AVAILABLE = 1,
40   // Generic error, no real details are available,
41   NUMAAPI_ERROR         = 2,
42   // Error installing atexit() handlers.
43   NUMAAPI_ERROR_ATEXIT  = 3,
44 } NUMAAPI_Result;
45
46 ////////////////////////////////////////////////////////////////////////////////
47 // Initialization.
48
49 // Initialize NUMA API.
50 //
51 // This is first call which should be called before any other NUMA functions
52 // can be used.
53 NUMAAPI_Result numaAPI_Initialize(void);
54
55 // Get string representation of NUMAPIResult.
56 const char* numaAPI_ResultAsString(NUMAAPI_Result result);
57
58 ////////////////////////////////////////////////////////////////////////////////
59 // Topology query.
60
61 // Get number of available nodes.
62 //
63 // This is in fact an index of last node plus one and it's not guaranteed
64 // that all nodes up to this one are available.
65 int numaAPI_GetNumNodes(void);
66
67 // Returns truth if the given node is available for compute.
68 bool numaAPI_IsNodeAvailable(int node);
69
70 // Getnumber of available processors on a given node.
71 int numaAPI_GetNumNodeProcessors(int node);
72
73 ////////////////////////////////////////////////////////////////////////////////
74 // Affinities.
75
76 // Runs the current process and its children on a specific node.
77 //
78 // Returns truth if affinity has successfully changed.
79 //
80 // NOTE: This function can not change active CPU group. Mainly designed to deal
81 // with Threadripper 2 topology, to make it possible to gain maximum performance
82 // for the main application thread.
83 bool numaAPI_RunProcessOnNode(int node);
84
85 // Runs the current thread and its children on a specific node.
86 //
87 // Returns truth if affinity has successfully changed.
88 bool numaAPI_RunThreadOnNode(int node);
89
90 ////////////////////////////////////////////////////////////////////////////////
91 // Memory management.
92
93 // Allocate memory on a given node,
94 void* numaAPI_AllocateOnNode(size_t size, int node);
95
96 // Allocate memory in the local memory, closest to the current node.
97 void* numaAPI_AllocateLocal(size_t size);
98
99 // Frees size bytes of memory starting at start.
100 //
101 // TODO(sergey): Consider making it regular free() semantic.
102 void numaAPI_Free(void* start, size_t size);
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif  // __LIBNUMAAPI_H__