move vulkan code to subdir, new layer interface create_pipeline and destroy_pipeline for post-loading works

Author: nihui

benchmark/benchncnn.cpp

@@ -57,6 +57,9 @@ class BenchNet : public Net
         // load file
         int ret = 0;
 
+        Option opt;
+        opt.vulkan_compute = use_vulkan_compute;
+
         ModelBinFromEmpty mb;
         for (size_t i=0; i<layers.size(); i++)
         {
@@ -69,6 +72,14 @@ class BenchNet : public Net
                 ret = -1;
                 break;
             }
+
+            int cret = layer->create_pipeline(opt);
+            if (cret != 0)
+            {
+                fprintf(stderr, "layer create_pipeline %d failed\n", (int)i);
+                ret = -1;
+                break;
+            }
         }
 
 #if NCNN_VULKAN

src/CMakeLists.txt

@@ -55,36 +55,43 @@ macro(ncnn_add_layer class)
         else()
             set(arch x86)
         endif()
-        set(LAYER_SRC ${CMAKE_CURRENT_SOURCE_DIR}/layer/${arch}/${name}_${arch}.cpp)
-        if(EXISTS ${LAYER_SRC})
+
+        set(LAYER_ARCH_SRC ${CMAKE_CURRENT_SOURCE_DIR}/layer/${arch}/${name}_${arch}.cpp)
+        if(EXISTS ${LAYER_ARCH_SRC})
             set(WITH_LAYER_${name}_${arch} 1)
-            list(APPEND ncnn_SRCS ${LAYER_SRC})
-            if(NCNN_CMAKE_VERBOSE)
-                message(STATUS "Adding layer: ${LAYER_SRC}")
-            endif()
+            list(APPEND ncnn_SRCS ${LAYER_ARCH_SRC})
+        endif()
+
+        set(LAYER_VULKAN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/layer/vulkan/${name}_vulkan.cpp)
+        if(NCNN_VULKAN AND EXISTS ${LAYER_VULKAN_SRC})
+            set(WITH_LAYER_${name}_vulkan 1)
+            list(APPEND ncnn_SRCS ${LAYER_VULKAN_SRC})
         endif()
     endif()
 
     # generate layer_declaration and layer_registry file
     if(WITH_LAYER_${name})
-        if(WITH_LAYER_${name}_${arch})
-            string(APPEND layer_declaration
-                "extern Layer* ${class}_${arch}_layer_creator();\n")
-            string(APPEND layer_registry
-                "#if NCNN_STRING\n{\"${class}\",${class}_${arch}_layer_creator},\n#else\n{${class}_${arch}_layer_creator},\n#endif\n")
-        else()
-            string(APPEND layer_declaration
-                "extern Layer* ${class}_layer_creator();\n")
-            string(APPEND layer_registry
-                "#if NCNN_STRING\n{\"${class}\",${class}_layer_creator},\n#else\n{${class}_layer_creator},\n#endif\n")
-        endif()
-    else()
-        string(APPEND layer_registry "#if NCNN_STRING\n{\"${class}\",0},\n#else\n{0},\n#endif\n")
+        set(layer_declaration "${layer_declaration}#include \"layer/${name}.h\"\n")
+        set(layer_declaration_class "class ${class}_final : virtual public ${class}")
+        set(create_pipeline_content "        { int ret = ${class}::create_pipeline(opt); if (ret) return ret; }\n")
+        set(destroy_pipeline_content "        { int ret = ${class}::destroy_pipeline(opt); if (ret) return ret; }\n")
+    endif()
+
+    if(WITH_LAYER_${name}_${arch})
+        set(layer_declaration "${layer_declaration}#include \"layer/${arch}/${name}_${arch}.h\"\n")
+        set(layer_declaration_class "${layer_declaration_class}, virtual public ${class}_${arch}")
+        set(create_pipeline_content "${create_pipeline_content}        { int ret = ${class}_${arch}::create_pipeline(opt); if (ret) return ret; }\n")
+        set(destroy_pipeline_content "        { int ret = ${class}_${arch}::destroy_pipeline(opt); if (ret) return ret; }\n${destroy_pipeline_content}")
     endif()
 
-    if(WITH_LAYER_${name} AND NCNN_VULKAN)
-        file(GLOB_RECURSE SHADER_SRCS "layer/shader/${name}.comp")
-        file(GLOB_RECURSE SHADER_SUBSRCS "layer/shader/${name}_*.comp")
+    if(WITH_LAYER_${name}_vulkan)
+        set(layer_declaration "${layer_declaration}#include \"layer/vulkan/${name}_vulkan.h\"\n")
+        set(layer_declaration_class "${layer_declaration_class}, virtual public ${class}_vulkan")
+        set(create_pipeline_content "${create_pipeline_content}        if (opt.vulkan_compute) { int ret = ${class}_vulkan::create_pipeline(opt); if (ret) return ret; }\n")
+        set(destroy_pipeline_content "        if (opt.vulkan_compute) { int ret = ${class}_vulkan::destroy_pipeline(opt); if (ret) return ret; }\n${destroy_pipeline_content}")
+
+        file(GLOB_RECURSE SHADER_SRCS "layer/vulkan/shader/${name}.comp")
+        file(GLOB_RECURSE SHADER_SUBSRCS "layer/vulkan/shader/${name}_*.comp")
         list(APPEND SHADER_SRCS ${SHADER_SUBSRCS})
         foreach(SHADER_SRC ${SHADER_SRCS})
             get_filename_component(SHADER_SRC_NAME_WE ${SHADER_SRC} NAME_WE)
@@ -145,6 +152,21 @@ macro(ncnn_add_layer class)
         endforeach()
     endif()
 
+    if(WITH_LAYER_${name})
+        set(layer_declaration "${layer_declaration}namespace ncnn {\n${layer_declaration_class}\n{\n")
+        set(layer_declaration "${layer_declaration}public:\n")
+        set(layer_declaration "${layer_declaration}    virtual int create_pipeline(const Option& opt) {\n${create_pipeline_content}        return 0;\n    }\n")
+        set(layer_declaration "${layer_declaration}    virtual int destroy_pipeline(const Option& opt) {\n${destroy_pipeline_content}        return 0;\n    }\n")
+        set(layer_declaration "${layer_declaration}};\n")
+        set(layer_declaration "${layer_declaration}DEFINE_LAYER_CREATOR(${class}_final)\n} // namespace ncnn\n\n")
+    endif()
+
+    if(WITH_LAYER_${name})
+        set(layer_registry "${layer_registry}#if NCNN_STRING\n{\"${class}\",${class}_final_layer_creator},\n#else\n{${class}_final_layer_creator},\n#endif\n")
+    else()
+        set(layer_registry "${layer_registry}#if NCNN_STRING\n{\"${class}\",0},\n#else\n{0},\n#endif\n")
+    endif()
+
     # generate layer_type_enum file
     string(APPEND layer_type_enum "${class} = ${__LAYER_TYPE_ENUM_INDEX},\n")
     math(EXPR __LAYER_TYPE_ENUM_INDEX "${__LAYER_TYPE_ENUM_INDEX}+1")

src/layer.cpp

@@ -20,6 +20,11 @@
 #include <algorithm>
 #include "cpu.h"
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Woverloaded-virtual"
+#include "layer_declaration.h"
+#pragma clang diagnostic pop
+
 namespace ncnn {
 
 Option::Option()
@@ -29,12 +34,17 @@ Option::Option()
     blob_allocator = 0;
     workspace_allocator = 0;
 
-#if NCNN_VULKAN
     vulkan_compute = false;
+
+#if NCNN_VULKAN
     blob_vkallocator = 0;
     workspace_vkallocator = 0;
     staging_vkallocator = 0;
 #endif // NCNN_VULKAN
+
+    use_winograd_convolution = 1;
+    use_sgemm_convolution = 1;
+    use_int8_inference = 1;
 }
 
 static Option g_default_option;
@@ -82,6 +92,16 @@ int Layer::load_model(const ModelBin& /*mb*/)
     return 0;
 }
 
+int Layer::create_pipeline(const Option& /*opt*/)
+{
+    return 0;
+}
+
+int Layer::destroy_pipeline(const Option& /*opt*/)
+{
+    return 0;
+}
+
 int Layer::forward(const std::vector<Mat>& bottom_blobs, std::vector<Mat>& top_blobs, const Option& opt) const
 {
     if (!support_inplace)
@@ -126,16 +146,6 @@ int Layer::upload_model(VkTransfer& /*cmd*/)
     return 0;
 }
 
-int Layer::create_pipeline()
-{
-    return 0;
-}
-
-int Layer::destroy_pipeline()
-{
-    return 0;
-}
-
 int Layer::forward(const std::vector<VkMat>& bottom_blobs, std::vector<VkMat>& top_blobs, VkCompute& cmd, const Option& opt) const
 {
     if (!support_inplace)
@@ -179,8 +189,6 @@ int Layer::forward_inplace(VkMat& /*bottom_top_blob*/, VkCompute& /*cmd*/, const
 }
 #endif // NCNN_VULKAN
 
-#include "layer_declaration.h"
-
 static const layer_registry_entry layer_registry[] =
 {
 #include "layer_registry.h"

src/layer.h

@@ -59,10 +59,10 @@ class Option
     // workspace memory allocator
     Allocator* workspace_allocator;
 
-#if NCNN_VULKAN
     // enable vulkan compute
     bool vulkan_compute;
 
+#if NCNN_VULKAN
     // blob memory allocator
     VkAllocator* blob_vkallocator;
 
@@ -72,6 +72,11 @@ class Option
     // staging memory allocator
     VkAllocator* staging_vkallocator;
 #endif // NCNN_VULKAN
+
+public:
+    int use_winograd_convolution;
+    int use_sgemm_convolution;
+    int use_int8_inference;
 };
 
 // the global default option
@@ -94,6 +99,12 @@ class Layer
     // return 0 if success
     virtual int load_model(const ModelBin& mb);
 
+    //
+    virtual int create_pipeline(const Option& opt = get_default_option());
+
+    //
+    virtual int destroy_pipeline(const Option& opt = get_default_option());
+
 public:
     // one input and one output blob
     bool one_blob_only;
@@ -120,9 +131,6 @@ class Layer
     // upload weight blob from host to device
     virtual int upload_model(VkTransfer& cmd);
 
-    virtual int create_pipeline();
-    virtual int destroy_pipeline();
-
 public:
     // implement inference
     // return 0 if success

src/layer/absval.cpp

@@ -22,12 +22,6 @@ AbsVal::AbsVal()
 {
     one_blob_only = true;
     support_inplace = true;
-    support_vulkan = true;
-
-#if NCNN_VULKAN
-    pipeline_absval = 0;
-    pipeline_absval_pack4 = 0;
-#endif // NCNN_VULKAN
 }
 
 int AbsVal::forward_inplace(Mat& bottom_top_blob, const Option& opt) const
@@ -52,62 +46,4 @@ int AbsVal::forward_inplace(Mat& bottom_top_blob, const Option& opt) const
     return 0;
 }
 
-#if NCNN_VULKAN
-int AbsVal::create_pipeline()
-{
-    std::vector<vk_specialization_type> specializations;
-
-    // pack1
-    {
-        pipeline_absval = new Pipeline(vkdev);
-        pipeline_absval->set_optimal_local_size_xyz();
-        pipeline_absval->create("absval", specializations, 1, 5);
-    }
-
-    // pack4
-    {
-        pipeline_absval_pack4 = new Pipeline(vkdev);
-        pipeline_absval_pack4->set_optimal_local_size_xyz();
-        pipeline_absval_pack4->create("absval_pack4", specializations, 1, 5);
-    }
-
-    return 0;
-}
-
-int AbsVal::destroy_pipeline()
-{
-    delete pipeline_absval;
-    pipeline_absval = 0;
-
-    delete pipeline_absval_pack4;
-    pipeline_absval_pack4 = 0;
-
-    return 0;
-}
-
-int AbsVal::forward_inplace(VkMat& bottom_top_blob, VkCompute& cmd, const Option& opt) const
-{
-    int packing = bottom_top_blob.packing;
-
-//     fprintf(stderr, "AbsVal::forward_inplace %p\n", bottom_top_blob.buffer());
-
-    std::vector<VkMat> bindings(1);
-    bindings[0] = bottom_top_blob;
-
-    std::vector<vk_constant_type> constants(5);
-    constants[0].i = bottom_top_blob.dims;
-    constants[1].i = bottom_top_blob.w;
-    constants[2].i = bottom_top_blob.h;
-    constants[3].i = bottom_top_blob.c;
-    constants[4].i = bottom_top_blob.cstep;
-
-    const Pipeline* pipeline = packing == 4 ? pipeline_absval_pack4 : pipeline_absval;
-
-    // record
-    cmd.record_pipeline(pipeline, bindings, constants, bottom_top_blob);
-
-    return 0;
-}
-#endif // NCNN_VULKAN
-
 } // namespace ncnn

src/layer/absval.h

@@ -25,20 +25,6 @@ class AbsVal : public Layer
     AbsVal();
 
     virtual int forward_inplace(Mat& bottom_top_blob, const Option& opt) const;
-
-#if NCNN_VULKAN
-    virtual int create_pipeline();
-    virtual int destroy_pipeline();
-
-    virtual int forward_inplace(VkMat& bottom_top_blob, VkCompute& cmd, const Option& opt) const;
-#endif // NCNN_VULKAN
-
-public:
-
-#if NCNN_VULKAN
-    Pipeline* pipeline_absval;
-    Pipeline* pipeline_absval_pack4;
-#endif // NCNN_VULKAN
 };
 
 } // namespace ncnn

src/layer/arm/absval_arm.h

@@ -19,7 +19,7 @@
 
 namespace ncnn {
 
-class AbsVal_arm : public AbsVal
+class AbsVal_arm : virtual public AbsVal
 {
 public:
     virtual int forward_inplace(Mat& bottom_top_blob, const Option& opt) const;

src/layer/arm/batchnorm_arm.h

@@ -19,7 +19,7 @@
 
 namespace ncnn {
 
-class BatchNorm_arm : public BatchNorm
+class BatchNorm_arm : virtual public BatchNorm
 {
 public:
     virtual int forward_inplace(Mat& bottom_top_blob, const Option& opt) const;

src/layer/arm/bias_arm.h

@@ -19,7 +19,7 @@
 
 namespace ncnn {
 
-class Bias_arm : public Bias
+class Bias_arm : virtual public Bias
 {
 public:
     virtual int forward_inplace(Mat& bottom_top_blob, const Option& opt) const;

src/layer/arm/clip_arm.h

@@ -19,7 +19,7 @@
 
 namespace ncnn {
 
-class Clip_arm : public Clip
+class Clip_arm : virtual public Clip
 {
 public:
     virtual int forward_inplace(Mat& bottom_top_blob, const Option& opt) const;