Dive into TensorFlow系列（2）- 解析TF核心抽象op算子

本文作者：李杰

TF计算图从逻辑层来讲，由op与tensor构成。op是项点代表计算单元，tensor是边代表op之间流动的数据内容，两者配合以数据流图的形式来表达计算图。那么op对应的物理层实现是什么？TF中有哪些op，以及各自的适用场景是什么？op到底是如何运行的？接下来让我们一起探索和回答这些问题。

一、初识op

1.1 op定义

op代表计算图中的节点，是tf.Operation对象，代表一个计算单元。用户在创建模型和训练代码时，会创建一系列op及其依赖关系，并将这些op和依赖添加到tf.Graph对象中（一般为默认图）。比如：tf.matmul()就是一个op，它有两个输入tensor和一个输出tensor。

1.2 op分类

op的分类一般有多个视角，比如按是否内置划分、按工作类型划分。

按是否内置划分，一般分为：内置op和自定义op（见“二、自定义op”部分介绍）。

按工作类型划分，一般分为：常见数学op、数组op、矩阵op、有状态op、神经网络op、检查点op、队列与同步op、控制流op。TF白皮书对内置op的分类总结如下：

1.3 op与kernel

op一般都有名称且代表一个抽象的计算过程。op可以设置若干属性，但这些属性必须在编译期提供或推理得到，因为它们用来实例化一个节点对象从而执行真正的计算。属性的经典用法就是拿来支持类型多态，比如两个浮点张量的矩阵乘法与两个整型张量的矩阵乘法。

kernel是op在指定设备类型（CPU/GPU）上的具体实现。TF二进制库通过注册机制定义了一系列op及对应的kernel实现，用户可以提供额外的op定义与kernel实现进行扩充。一般来说，一个op对应多个kernel实现。

接下来让我们一起用矩阵乘法MatMul算子的相关代码来理解op与kernel的关系（此处不必纠结代码细节，只需体会op与kernel关系即可）：

1// 首先给出op注册的定义。其中输入输出支持泛型，其合法类型在Attr中进行枚举。
2// 代码位置 tensorflow1.15.5\tensorflow\core\ops\math_ops.cc
3REGISTER_OP("MatMul")
4    .Input("a: T")
5    .Input("b: T")
6    .Output("product: T")
7    .Attr("transpose_a: bool = false")
8    .Attr("transpose_b: bool = false")
9    .Attr(
10        "T: {bfloat16, half, float, double, int32, int64, complex64, "
11        "complex128}")
12    .SetShapeFn(shape_inference::MatMulShape);
13    
14// MatMul的实现，采用类模板机制
15// 代码位置 tensorflow1.15.5\tensorflow\core\kernels\matmul_op.cc
16template <typename Device, typename T, bool USE_CUBLAS>
17class MatMulOp : public OpKernel {
18  public:
19    explicit MatMulOp(OpKernelConstruction* ctx)
20      : OpKernel(ctx), algorithms_set_already_(false) {
21      OP_REQUIRES_OK(ctx, ctx->GetAttr("transpose_a", &transpose_a_));
22      OP_REQUIRES_OK(ctx, ctx->GetAttr("transpose_b", &transpose_b_));
23
24      LaunchMatMul<Device, T, USE_CUBLAS>::GetBlasGemmAlgorithm(
25        ctx, &algorithms_, &algorithms_set_already_);
26      use_autotune_ = MatmulAutotuneEnable();
27    }
28  // 省略了很多代码...  
29  private:
30    std::vector<int64> algorithms_;
31    bool algorithms_set_already_;
32    bool use_autotune_;
33    bool transpose_a_;
34    bool transpose_b_;
35};
36
37// MatMul的op定义与kernel实现绑定处理
38// 代码位置 tensorflow1.15.5\tensorflow\core\kernels\matmul_op.cc
39#define REGISTER_CPU_EIGEN(T)  /*cpu与eigen组合对应实现*/                       \
40  REGISTER_KERNEL_BUILDER(                                                     \
41      Name("MatMul").Device(DEVICE_CPU).TypeConstraint<T>("T").Label("eigen"), \
42      MatMulOp<CPUDevice, T, false /* cublas, ignored for CPU */>);
43
44#define REGISTER_CPU(T)      /*cpu对应实现(eigen与非eigen)*/         \
45  REGISTER_KERNEL_BUILDER(                                          \
46      Name("MatMul").Device(DEVICE_CPU).TypeConstraint<T>("T"),     \
47      MatMulOp<CPUDevice, T, false /* cublas, ignored for CPU */>); \
48  REGISTER_CPU_EIGEN(T);
49
50#define REGISTER_GPU(T)     /*gpu对应实现(cublas与非cublas)*/       \
51  REGISTER_KERNEL_BUILDER(                                         \
52      Name("MatMul").Device(DEVICE_GPU).TypeConstraint<T>("T"),    \
53      MatMulOp<GPUDevice, T, true /* cublas, true by default */>); \
54  REGISTER_KERNEL_BUILDER(Name("MatMul")                           \
55                              .Device(DEVICE_GPU)                  \
56                              .TypeConstraint<T>("T")              \
57                              .Label("cublas"),                    \
58                          MatMulOp<GPUDevice, T, true /* cublas */>)

二、自定义op

用户编写的模型训练代码一般由TF原生的op算子及其依赖关系组成，但有时候我们定义的计算逻辑在TF中没有相应的op实现。根据TensorFlow官网的建议，我们应当先组合python op算子或python函数进行尝试。完成尝试之后再决定要不要自定义op。

2.1 自定义op场景

一般来说，需要自定义op的场景有如下3个：

•用TF原生op组合来表达新计算逻辑的过程比较复杂或不可能

•用TF原生op组合来表达新计算逻辑，其计算性能较低

•在新版编译器中也较难实现op融合的计算逻辑需要我们手动实现融合

在此举个例子方便大家理解。假如我们要实现一个新计算实逻：中位数池化（median pooling），过程中要在滑动窗口不断求得中位数。检索TF文档没有发现对应op，因此我们先考虑用TF python op组合来实现它，果然通过ExtractImagePatches and TopK就可以实现这个功能。经测试前述组合方案并不是计算和存储高效的，因此我们就有必要将median pooling在一个op中进行高效实现。

2.2 自定义op流程

自定义op一般遵循5个基本步骤：

1.注册op，具体包括：指定名称、输入/输出声明、形状函数。

2.定义kernel（即op的实现）并与op绑定。一个op有多个kernel实现，具体由输入输出类型、硬件（CPU、GPU）决定。

3.创建python包装器，一般由op注册机制自动完成。

4.编写op的梯度计算函数（可选项）。

5.测试op，通过python测试较为方便，当然也可通过C++进行测试。

接下来我们就以官网最简单的ZeroOut同步式自定义op（继承OpKernel）为例，结合代码来讲述上述5个步骤。下面先给出步骤1和步骤2用C++实现的代码（官方推荐用bazel编译so文件）：

1// 步骤1：注册op
2REGISTER_OP("ZeroOut")
3.Input("to_zero: int32")
4.Output("zeroed: int32")
5.SetShapeFn([](::tensorflow::shape_inference::InferenceContext* c) {
6    c->set_output(0, c->input(0));    //c's input and output type is std::vector<ShapeHandle>
7    return Status::OK();
8    });
9
10// 步骤2：定义kernel（常规CPU设备）,并把kernel与op绑定
11class ZeroOutOp : public OpKernel {
12public:
13    explicit ZeroOutOp(OpKernelConstruction* context) : OpKernel(context) {}
14
15    void Compute(OpKernelContext* context) override {
16        // Grab the input tensor from OpKernelContext instance
17        const Tensor& input_tensor = context->input(0); 
18        auto input = input_tensor.flat<int32>();
19
20        // Create an output tensor
21        Tensor* output_tensor = NULL;
22        OP_REQUIRES_OK(context, context->allocate_output(0, input_tensor.shape(),
23            &output_tensor));    // OP_REQUIRES_OK第二个参数一般为方法调用,此处为输出张量分配内存空间
24        auto output_flat = output_tensor->flat<int32>();
25
26        // Set all but the first element of the output tensor to 0.
27        const int N = input.size();
28        for (int i = 1; i < N; i++) {
29            output_flat(i) = 0;
30        }
31
32        // Preserve the first input value if possible.
33        if (N > 0) output_flat(0) = input(0);
34    }
35};
36
37REGISTER_KERNEL_BUILDER(Name("ZeroOut").Device(DEVICE_CPU), ZeroOutOp);

步骤3加载上述so文件（自动完成前后端op映射）；步骤4是可选项，此处不需要；步骤5基于python api测试op功能。相应代码如下：

1import tensorflow as tf
2zero_out_module = tf.load_op_library('./zero_out.so')    # 加载so文件生成python module
3with tf.Session(''):
4  zero_out_module.zero_out([[1, 2], [3, 4]]).eval()
5
6# Prints
7array([[1, 0], [0, 0]], dtype=int32)

2.3 高级话题

关于op的技术话题还有很多，我们在此简述一些要点：

1.如果实现了一个多线程CPU kernel，则可以利用work_sharder.h中的Shard函数。

2.大多数op以同步方式工作，只需继承OpKernel改写Compute()方法，且此方法必须线程安全。

3.如果一个op因为其它op的运行而阻塞，则这个op可以采用异步方式工作，继承AsyncOpKernel改写ComputeAsync()方法，且此方法必须线程安全。异步op最经典的例子就是跨设备通信send/recv pair中的RecvOp。

4.如果要为op配置一些静态属性，可使用Attr，它有一套特有的支持类型。典型应用是支持泛型。

5.实现GPU kernel有两部分内容：OpKernel和CUDA kernel，相应的加载代码。

6.编译自定义op，首先要配置头文件搜索路径与库文件搜索路径，接着指定编译和链接选项，最后还要确保ABI兼容性。

7.Resource（资源）代表相同设备上op共享的内容，比如：张量值、kv存储表、队列、读取器、网络连接等。代表资源的类必须继承ResourceBase，然后注册ResourceHandleOp生成资源句柄，普通op以resouce类型的Input进行引入。

三、op工作原理

3.1 op运行框架

整体来看，op与kernel都有其结构描述与统一的注册管理中心。而OpDefBuilder有两个包装类OpDefBuilderWrapper和OpDefBuilderReceiver，前者支持op构建的链式语法，后者接受op构建结果并进行注册。众所周知，op是编译期概念，而kernel是运行期概念，在AI编译器的后端处理流程中会进行op的算子选择，此过程会基于一系列策略为op匹配最合适的kernel实现。

3.2 若干技术细节

首先，我们来看一下大家在使用TensorFlow过程中经常碰到的libtensorflow_framework.so。按照tf1.15.5/tensorflow/BUILD中的描述，libtensorflow_framework.so定义了op和kernel的注册机制而不涉及具体实现。

1// rootdir=tensorflow1.15.5
2// ${rootdir}/tensorflow/BUILD
3/*
4# A shared object which includes registration mechanisms for ops and
5# kernels. Does not include the implementations of any ops or kernels. Instead,
6# the library which loads libtensorflow_framework.so
7# (e.g. _pywrap_tensorflow_internal.so for Python, libtensorflow.so for the C
8# API) is responsible for registering ops with libtensorflow_framework.so. In
9# addition to this core set of ops, user libraries which are loaded (via
10# TF_LoadLibrary/tf.load_op_library) register their ops and kernels with this
11# shared object directly.
12*/
13tf_cc_shared_object(
14    name = "tensorflow_framework",
15    framework_so = [],
16    linkopts = select({
17        "//tensorflow:macos": [],
18        "//tensorflow:windows": [],
19        "//tensorflow:freebsd": [
20            "-Wl,--version-script,$(location //tensorflow:tf_framework_version_script.lds)",
21            "-lexecinfo",
22        ],
23        "//conditions:default": [
24            "-Wl,--version-script,$(location //tensorflow:tf_framework_version_script.lds)",
25        ],
26    }),
27    linkstatic = 1,
28    per_os_targets = True,
29    soversion = VERSION,
30    visibility = ["//visibility:public"],
31    deps = [
32        "//tensorflow/cc/saved_model:loader_lite_impl",
33        "//tensorflow/core:core_cpu_impl",
34        "//tensorflow/core:framework_internal_impl",    /* 展开此target进行查看 */
35        "//tensorflow/core:gpu_runtime_impl",
36        "//tensorflow/core/grappler/optimizers:custom_graph_optimizer_registry_impl",
37        "//tensorflow/core:lib_internal_impl",
38        "//tensorflow/stream_executor:stream_executor_impl",
39        "//tensorflow:tf_framework_version_script.lds",
40    ] + tf_additional_binary_deps(),
41)
42
43// ${rootdir}/tensorflow/core/BUILD
44tf_cuda_library(
45    name = "framework_internal_impl",
46    srcs = FRAMEWORK_INTERNAL_PRIVATE_HEADERS + glob(   // 可以查看FRAMEWORK_INTERNAL_PRIVATE_HEADERS内容
47        [
48            "example/**/*.cc",
49            "framework/**/*.cc",
50            "util/**/*.cc",
51            "graph/edgeset.cc",
52            "graph/graph.cc",
53            "graph/graph_def_builder.cc",
54            "graph/node_builder.cc",
55            "graph/tensor_id.cc",
56            "graph/while_context.h",
57            "graph/while_context.cc",
58        ],
59    // 省略了诸多代码
60)
61
62// FRAMEWORK_INTERNAL_PRIVATE_HEADERS的内容
63FRAMEWORK_INTERNAL_PRIVATE_HEADERS =  [
64    "graph/edgeset.h",
65    "graph/graph.h",
66    "graph/graph_def_builder.h",
67    "graph/node_builder.h",
68    "graph/tensor_id.h",
69] + glob(
70    [
71        "example/**/*.h",
72        "framework/**/*.h",   // 这里就是重点，查看${rootdir}/tensorflow/core/framework/op.h和opkernel.h
73        "util/**/*.h",
74    ]
75) 
76
77// 先来看op.h
78#define REGISTER_OP(name) REGISTER_OP_UNIQ_HELPER(__COUNTER__, name)
79#define REGISTER_OP_UNIQ_HELPER(ctr, name) REGISTER_OP_UNIQ(ctr, name)
80#define REGISTER_OP_UNIQ(ctr, name)                                          \
81  static ::tensorflow::register_op::OpDefBuilderReceiver register_op##ctr    \
82      TF_ATTRIBUTE_UNUSED =                                                  \
83          ::tensorflow::register_op::OpDefBuilderWrapper<SHOULD_REGISTER_OP( \
84              name)>(name)
85              
86// 再来看看opkernel.h
87#define REGISTER_KERNEL_BUILDER(kernel_builder, ...) \
88  REGISTER_KERNEL_BUILDER_UNIQ_HELPER(__COUNTER__, kernel_builder, __VA_ARGS__)
89
90#define REGISTER_KERNEL_BUILDER_UNIQ_HELPER(ctr, kernel_builder, ...) \
91  REGISTER_KERNEL_BUILDER_UNIQ(ctr, kernel_builder, __VA_ARGS__)
92
93#define REGISTER_KERNEL_BUILDER_UNIQ(ctr, kernel_builder, ...)        \
94  constexpr bool should_register_##ctr##__flag =                      \
95      SHOULD_REGISTER_OP_KERNEL(#__VA_ARGS__);                        \
96  static ::tensorflow::kernel_factory::OpKernelRegistrar              \
97      registrar__body__##ctr##__object(                               \
98          should_register_##ctr##__flag                               \
99              ? ::tensorflow::register_kernel::kernel_builder.Build() \
100              : nullptr,                                              \
101          #__VA_ARGS__,                                               \
102          [](::tensorflow::OpKernelConstruction* context)             \
103              -> ::tensorflow::OpKernel* {                            \
104            return new __VA_ARGS__(context);                          \
105          });

参照上述同样的流程，我们可以发现libtensorflow.so中涉及op与kernel的具体实现，同时也包括Session的具体实现。

最后，我们再来讲讲REGISTER_OP宏背后的具体原理。我们在上面已经给出了此宏的定义，此处针对它的实现展开谈谈：

1// 先来看op.h
2#define REGISTER_OP(name) REGISTER_OP_UNIQ_HELPER(__COUNTER__, name)
3#define REGISTER_OP_UNIQ_HELPER(ctr, name) REGISTER_OP_UNIQ(ctr, name)
4#define REGISTER_OP_UNIQ(ctr, name)                                          \
5  static ::tensorflow::register_op::OpDefBuilderReceiver register_op##ctr    \
6      TF_ATTRIBUTE_UNUSED =                                                  \
7          ::tensorflow::register_op::OpDefBuilderWrapper<SHOULD_REGISTER_OP( \
8              name)>(name)
9
10// REGISTER_OP的一般用法如下
11REGISTER_OP("ZeroOut")
12    .Input("to_zero: int32")
13    .Output("zeroed: int32")
14    .SetShapeFn([](::tensorflow::shape_inference::InferenceContext* c) {
15      c->set_output(0, c->input(0));
16      return Status::OK();
17    });
18
19// op定义的链式规则是通过OpDefBuilderWrapper类实现的
20class OpDefBuilderWrapper<true> {
21 public:
22  explicit OpDefBuilderWrapper(const char name[]) : builder_(name) {}
23
24  OpDefBuilderWrapper<true>& Input(string spec) {
25    builder_.Input(std::move(spec));
26    return *this;                        // 显而易见，调用Input仍然返回OpDefBuilderWrapper<true>本身
27  }
28  OpDefBuilderWrapper<true>& Output(string spec) {
29    builder_.Output(std::move(spec));
30    return *this;
31  }
32
33  OpDefBuilderWrapper<true>& SetShapeFn(
34      Status (*fn)(shape_inference::InferenceContext*)) {
35    builder_.SetShapeFn(fn);
36    return *this;
37  }
38  const ::tensorflow::OpDefBuilder& builder() const { return builder_; }
39
40 private:
41  mutable ::tensorflow::OpDefBuilder builder_;
42};
43
44// 当通过链式规划构建好op后，再通过OpDefBuilderReceiver完成op的注册
45// op.h
46struct OpDefBuilderReceiver {
47  // To call OpRegistry::Global()->Register(...), used by the
48  // REGISTER_OP macro below.
49  // Note: These are implicitly converting constructors.
50  OpDefBuilderReceiver(
51      const OpDefBuilderWrapper<true>& wrapper);  // NOLINT(runtime/explicit)
52  constexpr OpDefBuilderReceiver(const OpDefBuilderWrapper<false>&) {
53  }  // NOLINT(runtime/explicit)
54};
55
56// op.cc，然后在OpDefBuilderReceiver构造函数内部完成OpDefBuilderWrapper的全局注册
57OpDefBuilderReceiver::OpDefBuilderReceiver(
58    const OpDefBuilderWrapper<true>& wrapper) {
59  OpRegistry::Global()->Register(
60      [wrapper](OpRegistrationData* op_reg_data) -> Status {
61        return wrapper.builder().Finalize(op_reg_data);
62      });
63}