Change prefix from offload to ol

Author: callumfare

offload/new-api/API/APIDefs.td

@@ -14,7 +14,7 @@
 
 // Prefix for API naming. This could be hard-coded in the future when a value
 // is agreed upon.
-defvar PREFIX = "OFFLOAD";
+defvar PREFIX = "OL";
 defvar prefix = !tolower(PREFIX);
 
 // Parameter flags

offload/new-api/API/Common.td

@@ -1,69 +1,69 @@
 def : Macro {
-  let name = "OFFLOAD_VERSION_MAJOR";
+  let name = "OL_VERSION_MAJOR";
   let desc = "Major version of the Offload API";
   let value = "0";
 }
 
 def : Macro {
-  let name = "OFFLOAD_VERSION_MINOR";
+  let name = "OL_VERSION_MINOR";
   let desc = "Minor version of the Offload API";
   let value = "0";
 }
 
 def : Macro {
-  let name = "OFFLOAD_VERSION_PATCH";
+  let name = "OL_VERSION_PATCH";
   let desc = "Patch version of the Offload API";
   let value = "1";
 }
 
 def : Macro {
-  let name = "OFFLOAD_APICALL";
+  let name = "OL_APICALL";
   let desc = "Calling convention for all API functions";
   let condition = "defined(_WIN32)";
   let value = "__cdecl";
   let alt_value = "";
 }
 
 def : Macro {
-  let name = "OFFLOAD_APIEXPORT";
+  let name = "OL_APIEXPORT";
   let desc = "Microsoft-specific dllexport storage-class attribute";
   let condition = "defined(_WIN32)";
   let value = "__declspec(dllexport)";
   let alt_value = "";
 }
 
 def : Macro {
-  let name = "OFFLOAD_DLLEXPORT";
+  let name = "OL_DLLEXPORT";
   let desc = "Microsoft-specific dllexport storage-class attribute";
   let condition = "defined(_WIN32)";
   let value = "__declspec(dllexport)";
 }
 
 def : Macro {
-  let name = "OFFLOAD_DLLEXPORT";
+  let name = "OL_DLLEXPORT";
   let desc = "GCC-specific dllexport storage-class attribute";
   let condition = "__GNUC__ >= 4";
   let value = "__attribute__ ((visibility (\"default\")))";
   let alt_value = "";
 }
 
 def : Handle {
-  let name = "offload_platform_handle_t";
+  let name = "ol_platform_handle_t";
   let desc = "Handle of a platform instance";
 }
 
 def : Handle {
-  let name = "offload_device_handle_t";
+  let name = "ol_device_handle_t";
   let desc = "Handle of platform's device object";
 }
 
 def : Handle {
-  let name = "offload_context_handle_t";
+  let name = "ol_context_handle_t";
   let desc = "Handle of context object";
 }
 
 def : Enum {
-  let name = "offload_errc_t";
+  let name = "ol_errc_t";
   let desc = "Defines Return/Error codes";
   let etors =[
     Etor<"SUCCESS", "Success">,
@@ -87,28 +87,28 @@ def : Enum {
 }
 
 def : Struct {
-  let name = "offload_error_struct_t";
+  let name = "ol_error_struct_t";
   let desc = "Details of the error condition returned by an API call";
   let members = [
-    StructMember<"offload_errc_t", "Code", "The error code">,
+    StructMember<"ol_errc_t", "Code", "The error code">,
     StructMember<"const char*", "Details", "String containing error details">
   ];
 }
 
 def : Typedef {
-  let name = "offload_result_t";
+  let name = "ol_result_t";
   let desc = "Result type returned by all entry points.";
-  let value = "const offload_error_struct_t*";
+  let value = "const ol_error_struct_t*";
 }
 
 def : Macro {
-  let name = "OFFLOAD_RESULT_SUCCESS";
+  let name = "OL_SUCCESS";
   let desc = "Success condition";
   let value = "NULL";
 }
 
 def : Struct {
-  let name = "offload_code_location_t";
+  let name = "ol_code_location_t";
   let desc = "Code location information that can optionally be associated with an API call";
   let members = [
     StructMember<"const char*", "FunctionName", "Function name">,
@@ -119,18 +119,18 @@ def : Struct {
 }
 
 def : Function {
-  let name = "offloadInit";
+  let name = "olInit";
   let desc = "Perform initialization of the Offload library and plugins";
   let details = [
     "This must be the first API call made by a user of the Offload library",
-    "Each call will increment an internal reference count that is decremented by `offloadShutDown`"
+    "Each call will increment an internal reference count that is decremented by `olShutDown`"
   ];
   let params = [];
   let returns = [];
 }
 
 def : Function {
-  let name = "offloadShutDown";
+  let name = "olShutDown";
   let desc = "Release the resources in use by Offload";
   let details = [
     "This decrements an internal reference count. When this reaches 0, all resources will be released",

offload/new-api/API/Device.td

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 def : Enum {
-  let name = "offload_device_type_t";
+  let name = "ol_device_type_t";
   let desc = "Supported device types";
   let etors =[
     Etor<"DEFAULT", "The default device type as preferred by the runtime">,
@@ -22,85 +22,85 @@ def : Enum {
 }
 
 def : Enum {
-  let name = "offload_device_info_t";
+  let name = "ol_device_info_t";
   let desc = "Supported device info";
   let is_typed = 1;
   let etors =[
-    TaggedEtor<"TYPE", "offload_device_type_t", "type of the device">,
-    TaggedEtor<"PLATFORM", "offload_platform_handle_t", "the platform associated with the device">,
+    TaggedEtor<"TYPE", "ol_device_type_t", "type of the device">,
+    TaggedEtor<"PLATFORM", "ol_platform_handle_t", "the platform associated with the device">,
     TaggedEtor<"NAME", "char[]", "Device name">,
     TaggedEtor<"VENDOR", "char[]", "Device vendor">,
     TaggedEtor<"DRIVER_VERSION", "char[]", "Driver version">
   ];
 }
 
 def : Function {
-  let name = "offloadDeviceGetCount";
+  let name = "olGetDeviceCount";
   let desc = "Retrieves the number of available devices within a platform";
   let params = [
-    Param<"offload_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
+    Param<"ol_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
     Param<"uint32_t*", "NumDevices", "pointer to the number of devices.", PARAM_OUT>
   ];
   let returns = [];
 }
 
 def : Function {
-  let name = "offloadDeviceGet";
+  let name = "olGetDevice";
   let desc = "Retrieves devices within a platform";
   let details = [
     "Multiple calls to this function will return identical device handles, in the same order.",
   ];
   let params = [
-    Param<"offload_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
+    Param<"ol_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
     Param<"uint32_t", "NumEntries", "the number of devices to be added to phDevices, which must be greater than zero", PARAM_IN>,
-    RangedParam<"offload_device_handle_t*", "Devices", "Array of device handles. "
+    RangedParam<"ol_device_handle_t*", "Devices", "Array of device handles. "
         "If NumEntries is less than the number of devices available, then this function shall only retrieve that number of devices.", PARAM_OUT,
         Range<"0", "NumEntries">>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_INVALID_SIZE", [
+    Return<"OL_ERRC_INVALID_SIZE", [
       "`NumEntries == 0`"
     ]>
   ];
 }
 
 def : Function {
-  let name = "offloadDeviceGetInfo";
+  let name = "olGetDeviceInfo";
   let desc = "Queries the given property of the device";
   let details = [];
   let params = [
-    Param<"offload_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
-    Param<"offload_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
+    Param<"ol_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
+    Param<"ol_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
     Param<"size_t", "PropSize", "the number of bytes pointed to by PropValue.", PARAM_IN>,
     TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. If PropSize is not equal to or greater than the real "
-                    "number of bytes needed to return the info then the OFFLOAD_ERRC_INVALID_SIZE error is returned and "
+                    "number of bytes needed to return the info then the OL_ERRC_INVALID_SIZE error is returned and "
                     "PropValue is not used.", PARAM_OUT, TypeInfo<"PropName" , "PropSize">>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
+    Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
       "If `PropName` is not supported by the device."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_SIZE", [
+    Return<"OL_ERRC_INVALID_SIZE", [
       "`PropSize == 0`",
       "If `PropSize` is less than the real number of bytes needed to return the info."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_DEVICE">
+    Return<"OL_ERRC_INVALID_DEVICE">
   ];
 }
 
 def : Function {
-  let name = "offloadDeviceGetInfoSize";
+  let name = "olGetDeviceInfoSize";
   let desc = "Returns the storage size of the given device query";
   let details = [];
   let params = [
-    Param<"offload_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
-    Param<"offload_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
+    Param<"ol_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
+    Param<"ol_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
     Param<"size_t*", "PropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
+    Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
       "If `PropName` is not supported by the device."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_DEVICE">
+    Return<"OL_ERRC_INVALID_DEVICE">
   ];
 }

offload/new-api/API/Platform.td

@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 def : Function {
-  let name = "offloadPlatformGet";
+  let name = "olGetPlatform";
   let desc = "Retrieves all available platforms";
   let details = [
     "Multiple calls to this function will return identical platforms handles, in the same order.",
@@ -20,21 +20,21 @@ def : Function {
       "The number of platforms to be added to Platforms. NumEntries must be "
       "greater than zero.",
       PARAM_IN>,
-    RangedParam<"offload_platform_handle_t*", "Platforms", 
+    RangedParam<"ol_platform_handle_t*", "Platforms", 
       "Array of handle of platforms. If NumEntries is less than the number of "
-      "platforms available, then offloadPlatformGet shall only retrieve that "
+      "platforms available, then olGetPlatform shall only retrieve that "
       "number of platforms.",
       PARAM_OUT, Range<"0", "NumEntries">>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_INVALID_SIZE", [
+    Return<"OL_ERRC_INVALID_SIZE", [
       "`NumEntries == 0`"
     ]>
   ];
 }
 
 def : Function {
-  let name = "offloadPlatformGetCount";
+  let name = "olGetPlatformCount";
   let desc = "Retrieves the number of available platforms";
   let params = [
     Param<"uint32_t*",
@@ -45,19 +45,19 @@ def : Function {
 }
 
 def : Enum {
-  let name = "offload_platform_info_t";
+  let name = "ol_platform_info_t";
   let desc = "Supported platform info";
   let is_typed = 1;
   let etors = [
     TaggedEtor<"NAME", "char[]", "The string denoting name of the platform. The size of the info needs to be dynamically queried.">,
     TaggedEtor<"VENDOR_NAME", "char[]", "The string denoting name of the vendor of the platform. The size of the info needs to be dynamically queried.">,
     TaggedEtor<"VERSION", "char[]", "The string denoting the version of the platform. The size of the info needs to be dynamically queried.">,
-    TaggedEtor<"BACKEND", "offload_platform_backend_t", "The native backend of the platform.">
+    TaggedEtor<"BACKEND", "ol_platform_backend_t", "The native backend of the platform.">
   ];
 }
 
 def : Enum {
-  let name = "offload_platform_backend_t";
+  let name = "ol_platform_backend_t";
   let desc = "Identifies the native backend of the platform";
   let etors =[
     Etor<"UNKNOWN", "The backend is not recognized">,
@@ -67,46 +67,46 @@ def : Enum {
 }
 
 def : Function {
-  let name = "offloadPlatformGetInfo";
+  let name = "olGetPlatformInfo";
   let desc = "Queries the given property of the platform";
   let details = [
-    "`offloadPlatformGetInfoSize` can be used to query the storage size "
+    "`olGetPlatformInfoSize` can be used to query the storage size "
     "required for the given query."
   ];
   let params = [
-    Param<"offload_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
-    Param<"offload_platform_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
+    Param<"ol_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
+    Param<"ol_platform_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
     Param<"size_t", "PropSize", "the number of bytes pointed to by pPlatformInfo.", PARAM_IN>,
     TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. "
       "If Size is not equal to or greater to the real number of bytes needed to return the info "
-      "then the OFFLOAD_ERRC_INVALID_SIZE error is returned and pPlatformInfo is not used.", PARAM_OUT,
+      "then the OL_ERRC_INVALID_SIZE error is returned and pPlatformInfo is not used.", PARAM_OUT,
       TypeInfo<"PropName" , "PropSize">>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
+    Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
       "If `PropName` is not supported by the platform."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_SIZE", [
+    Return<"OL_ERRC_INVALID_SIZE", [
       "`PropSize == 0`",
       "If `PropSize` is less than the real number of bytes needed to return the info."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_PLATFORM">
+    Return<"OL_ERRC_INVALID_PLATFORM">
   ];
 }
 
 def : Function {
-  let name = "offloadPlatformGetInfoSize";
+  let name = "olGetPlatformInfoSize";
   let desc = "Returns the storage size of the given platform query";
   let details = [];
   let params = [
-    Param<"offload_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
-    Param<"offload_platform_info_t", "PropName", "type of the info to query", PARAM_IN>,
+    Param<"ol_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
+    Param<"ol_platform_info_t", "PropName", "type of the info to query", PARAM_IN>,
     Param<"size_t*", "PropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
   ];
   let returns = [
-    Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
+    Return<"OL_ERRC_UNSUPPORTED_ENUMERATION", [
       "If `PropName` is not supported by the platform."
     ]>,
-    Return<"OFFLOAD_ERRC_INVALID_PLATFORM">
+    Return<"OL_ERRC_INVALID_PLATFORM">
   ];
 }

offload/new-api/API/README.md

@@ -31,7 +31,7 @@ plugin-specific implementation details.
 
 There are two special variants of a *parameter*:
 * **RangedParameter** - Represents a parameter that has a range described by other parameters. Generally these are pointers to an arbitrary number of objects. The range is used for generating validation and printing code. E.g, a range might be between `(0, NumDevices)`
-* **TypeTaggedParameter** - Represents a parameter (usually of `void*` type) that has the type and size of its pointee data described by other function parameters. The type is usually described by a type-tagged enum. This allows functions (e.g. `offloadDeviceGetInfo`) to return data of an arbitrary type.
+* **TypeTaggedParameter** - Represents a parameter (usually of `void*` type) that has the type and size of its pointee data described by other function parameters. The type is usually described by a type-tagged enum. This allows functions (e.g. `olGetDeviceInfo`) to return data of an arbitrary type.
 
 #### Return
 A return represents a possible return code from the function, and optionally a
@@ -64,7 +64,7 @@ and description.
 
 A `TaggedEtor` record type also exists which addtionally takes a type. This type
 is used when the enum is used as a parameter to a function with a type-tagged
-function parameter (e.g. `offloadDeviceGetInfo`).
+function parameter (e.g. `olGetDeviceInfo`).
 
 All enums automatically get a `<enum_name>_FORCE_UINT32 = 0x7fffffff` value,
 which forces the underlying type to be uint32.