Changing struct name with TP_ prefix.

Making TP_OptimizerBuilder as a struct.

Author: Solaryee

rfcs/20201027-modular-tensorflow-graph-c-api.md

@@ -48,12 +48,12 @@ When initializing, TensorFlow loads the plugin and registers a new graph optimiz
 
 ### Struct/Function/Object Overview
 - Struct
-  - Struct that should be filled by the plugin: `P_OptimizerConfigFns`, `P_RegistrationParams`, `TF_OptimizerBuilder`
+  - Struct that should be filled by the plugin: `TP_OptimizerConfigFns`, `TP_RegistrationParams`, `TP_OptimizerBuilder`
   - Struct that should be filled by the proper: `TF_GrapplerItem`, `TF_GraphProperties`, `TF_FunctionLibraryDefinition`
 - Function
   - Function that should be implemented by plugin:
     - Creation/Deletion/Optimization function of optimizer.
-    - `P_MessageToBuffer`, `P_BufferToMessage`: Serialization/Deserialization of objects generated by protobuf.
+    - `plugin::MessageToBuffer`, `plugin::BufferToMessage`: Serialization/Deserialization of objects generated by protobuf.
     - `TF_InitGraphPlugin`: Optimizer registration.
     - (Optional)Util function for graph transformation.
 - Object:
@@ -88,18 +88,18 @@ When initializing, TensorFlow loads the plugin and registers a new graph optimiz
 
   After optimizing, plugin authors need to serialize the optimized `GraphDef` object into `TF_Buffer` as output.
 
-  Serialization function `MessageToBuffer` is already defined, desearization function `BufferToMessage` will be added in proper to convert plugin passed `TF_Buffer` back to proper's `GraphDef`. In plugin side, plugin authors need to define `P_MessageToBuffer` and `P_BufferToMessage`, which should be the same as those defined in proper, except the namespace of protobuf.
+  Serialization function `tensorflow::MessageToBuffer` is already defined, desearization function `tensorflow::BufferToMessage` will be added in proper to convert plugin passed `TF_Buffer` back to proper's `GraphDef`. In plugin side, plugin authors need to define `plugin::MessageToBuffer` and `plugin::BufferToMessage`, which should be the same as those defined in proper, except the namespace of protobuf. To be noticed, these two are internal defined functions, they are not a part of C API interface.
 
   Proper:
   ```cpp
-  Status MessageToBuffer(const tensorflow::protobuf::MessageLite& in, TF_Buffer* out);
-  Status BufferToMessage(const TF_Buffer* in, tensorflow::protobuf::MessageLite& out);
+  Status tensorflow::MessageToBuffer(const tensorflow::protobuf::MessageLite& in, TF_Buffer* out);
+  Status tensorflow::BufferToMessage(const TF_Buffer* in, tensorflow::protobuf::MessageLite& out);
   ```
 
   Plugin:
   ```cpp
-  Status P_MessageToBuffer(const plugin::protobuf::MessageLite& in, TF_Buffer* out);
-  Status P_BufferToMessage(const TF_Buffer* in, plugin::protobuf::MessageLite& out);
+  Status plugin::MessageToBuffer(const plugin::protobuf::MessageLite& in, TF_Buffer* out);
+  Status plugin::BufferToMessage(const TF_Buffer* in, plugin::protobuf::MessageLite& out);
   ```
 
 * **Util functions**
@@ -109,8 +109,8 @@ When initializing, TensorFlow loads the plugin and registers a new graph optimiz
 * **Registration**
   1. Core TensorFlow links to plugin's dynamic library and loads the function `TF_InitGraphPlugin`.
   2. In `TF_InitGraphPlugin`,
-      - Plugin populates `P_RegistrationParams`.
-      - Plugin creates an optimizer `TF_OptimizerBuilder` with creation/optimization/deletion functions.
+      - Plugin populates `TP_RegistrationParams`.
+      - Plugin populates `TP_OptimizerBuilder` with creation/optimization/deletion functions.
       - Plugin calls `TF_RegisterOptimizer` to register the optimizer with params.
 
 ### Supported User Scenarios
@@ -130,13 +130,13 @@ Plugin graph optimization is targeting backend device specific optimization, and
 
 * **Configuring existing optimizers**
 
-  If pluggable graph optimizer is registered to a device type, e.g., GPU, its optional for plugin authors to provide a recommended configuration indicate whether some of existing optimizers in proper can be turned on/off, by populating flags in `P_RegistrationParams`.
+  If pluggable graph optimizer is registered to a device type, e.g., GPU, its optional for plugin authors to provide a recommended configuration indicate whether some of existing optimizers in proper can be turned on/off, by populating flags in `TP_RegistrationParams`.
 
   ```cpp
   TF_Bool get_remapping() { return false; }
   TF_Bool get_auto_mixed_precision() { return true; }
 
-  void TF_InitGraphPlugin(P_RegistrationParams* params, TF_Status* status) {
+  void TF_InitGraphPlugin(TP_OptimizerBuilder* builder, TP_RegistrationParams* params, TF_Status* status) {
     // Plugin authors can turn on/off some optimizers.
     params.config_fns.get_remapping = get_remapping;
     params.config_fns.get_auto_mixed_precision = get_auto_mixed_precision;
@@ -301,7 +301,7 @@ Plugin graph optimization is targeting backend device specific optimization, and
   // Flags indicating whether existing optimizers should be turned on/off.
   // It's optional for plugin to set functions to return true/false. If not
   // set, proper uses default configuration.
-  typedef struct P_OptimizerConfigFns {
+  typedef struct TP_OptimizerConfigFns {
     size_t struct_size;
     void* ext;  // reserved for future use
     TF_Bool (*get_disable_model_pruning)();
@@ -323,12 +323,12 @@ Plugin graph optimization is targeting backend device specific optimization, and
     TF_Bool (*get_memory_optimization)();
     TF_Bool (*get_auto_parallel)();
     TF_Bool (*get_scoped_allocator_optimization)();
-  } P_OptimizerConfigFns;
+  } TP_OptimizerConfigFns;
 
-  #define P_OPTIMIZERCONFIG_FNS_STRUCT_SIZE \
-    TF_OFFSET_OF_END(P_OptimizerConfigFns, get_scoped_allocator_optimization)
+  #define TP_OPTIMIZERCONFIG_FNS_STRUCT_SIZE \
+    TF_OFFSET_OF_END(TP_OptimizerConfigFns, get_scoped_allocator_optimization)
 
-  typedef struct P_RegistrationParams {
+  typedef struct TP_RegistrationParams {
     size_t struct_size;
     void* ext;  // reserved for future use
 
@@ -338,24 +338,30 @@ Plugin graph optimization is targeting backend device specific optimization, and
 
     // device_type optimizer is registered.
     const char* device_type;
-    P_OptimizerConfigFns* config_fns;
-  } P_RegistrationParams;
+    TP_OptimizerConfigFns* config_fns;
+  } TP_RegistrationParams;
 
-  #define P_REGISTRATIONPARAMS_STRUCT_SIZE \
-    TF_OFFSET_OF_END(P_RegistrationParams, config_fns)
-
-  void TF_InitGraphPlugin(P_RegistrationParams* params, TF_Status* status);
+  #define TP_REGISTRATIONPARAMS_STRUCT_SIZE \
+    TF_OFFSET_OF_END(TP_RegistrationParams, config_fns)
 
   // Struct for Optimizer builder. Plugin authors must provide an optimize function.
   // Creation and deletion functions are optional.
-  typedef struct TF_OptimizerBuilder {
+  typedef struct TP_OptimizerBuilder {
+    size_t struct_size;
+    void* ext;  // reserved for future use
+
     void* (*create_func)(),
     void (*optimize_func)(void*, TF_Buffer*, TF_Buffer*),
     void (*delete_func)(void*)
-  } TF_OptimizerBuilder;
+  } TP_OptimizerBuilder;
 
-  // Register plugin optimizer TF_OptimizerBuilder with P_RegistrationParams.
-  void TF_RegisterOptimizer(TF_OptimizerBuilder* builder, P_RegistrationParams* params, TF_Status* status);
+  #define TP_OPTIMIZERBUILDER_STRUCT_SIZE \
+    TF_OFFSET_OF_END(TP_OptimizerBuilder, delete_func)
+
+  void TF_InitGraphPlugin(TP_OptimizerBuilder* builder, TP_RegistrationParams* params, TF_Status* status);
+
+  // Register plugin optimizer TP_OptimizerBuilder with TP_RegistrationParams.
+  void TF_RegisterOptimizer(TP_OptimizerBuilder* builder, TP_RegistrationParams* params, TF_Status* status);
 
   #ifdef __cplusplus
   }  // extern "C"
@@ -386,7 +392,7 @@ Plugin graph optimization is targeting backend device specific optimization, and
 
     // 2. Deserialize graph_buf into plugin::GraphDef
     plugin::GraphDef graph_def;
-    P_BufferToMessage(graph_buf, graph_def);
+    plugin::BufferToMessage(graph_buf, graph_def);
 
     // 3. Infer shapes(optional)
     TF_GraphProperties g_prop = TF_NewGraphProperties(item);
@@ -399,7 +405,7 @@ Plugin graph optimization is targeting backend device specific optimization, and
     }
     TF_GetInputProperties(g_prop, "node1", in_prop_buf.data(), &max_size);
     plugin::OpInfo::TensorProperties in_prop;
-    P_BufferToMessage(in_prop_buf, in_prop);
+    plugin::BufferToMessage(in_prop_buf, in_prop);
     for (int i = 0; i < max_size; i++)
       TF_DeleteBuffer(in_prop_buf[i]);
 
@@ -409,14 +415,14 @@ Plugin graph optimization is targeting backend device specific optimization, and
     TF_Buffer* op_buf = TF_NewBuffer();
     plugin::NodeDef node_def = graph_def.node(0);
     TF_LookUpOpDef(f_lib, node_def.name(), op_buf);
-    P_BufferToMessage(op_buf, op_def);
+    plugin::BufferToMessage(op_buf, op_def);
     TF_DeleteBuffer(op_buf);
     plugin::DataType dt = op_def.input_arg(0).type();
 
     // 5. Transform graph(optional)
 
     // 6. Serialize output plugin::GraphDef into optimized_graph_buf.
-    P_MessageToBuffer(graph_def, optimized_graph_buf);
+    plugin::MessageToBuffer(graph_def, optimized_graph_buf);
     TF_DeleteGraphProperties(g_prop);
     TF_DeleteFunctionLibraryDefinition(f_lib);
   }
@@ -428,16 +434,17 @@ Plugin graph optimization is targeting backend device specific optimization, and
   TF_Bool get_remapping() { return false; }
   TF_Bool get_auto_mixed_precision() { return true; }
 
-  void TF_InitGraphPlugin(P_RegistrationParams* params, TF_Status* status) {
-    params.device_type = "GPU";
+  void TF_InitGraphPlugin(TP_OptimizerBuilder* builder, TP_RegistrationParams* params, TF_Status* status) {
+    params->device_type = "GPU";
     // Define some flags indicating whether existing optimizers should be turned on/off
-    params.config_fns.get_remapping = get_remapping;
-    params.config_fns.get_auto_mixed_precision = get_auto_mixed_precision;
+    params->config_fns->get_remapping = get_remapping;
+    params->config_fns->get_auto_mixed_precision = get_auto_mixed_precision;
     // ...
    
     // Create a new builder and register it with TF_RegisterOptimizer
-    TF_OptimizerBuilder* builder = 
-      TF_OptimizerBuilder(&P_Create, &P_Optimize, &P_Delete);
+    builder->create_func = MyOptimizer_Create;
+    builder->optimize_func = MyOptimizer_Optimize;
+    builder->delete_func = MyOptimizer_Delete;
     TF_RegisterOptimizer(builder, params, status);
     if (TF_GetCode(status) != TF_OK) { /* handle errors */ }
   }
@@ -453,12 +460,13 @@ Plugin graph optimization is targeting backend device specific optimization, and
     tensorflow::Env* env = tensorflow::Env::Default();
     env->GetSymbolFromLibrary(dso_handle, "TF_InitGraphPlugin", &dso_symbol).IgnoreError();
 
-    using TF_InitGraphPlugin = void(*)(P_RegistrationParams*, TF_Status*);
+    using TF_InitGraphPlugin = void(*)(TP_OptimizerBuilder*, TP_RegistrationParams*, TF_Status*);
     auto init_plugin_fn = reinterpret_cast<TF_InitGraphPlugin>(dso_symbol);
 
-    P_RegistrationParams params;
+    TP_OptimizerBuilder builder;
+    TP_RegistrationParams params;
     TF_Status status;
-    init_plugin_fn(&params, status);
+    init_plugin_fn(&builder, &params, status);
   }
   ```