opt_kernel.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#ifndef _ST_HPC_PPL_NN_RUNTIME_OPT_KERNEL_H_
#define _ST_HPC_PPL_NN_RUNTIME_OPT_KERNEL_H_

#include "ppl/nn/ir/graph.h"
#include "ppl/nn/runtime/kernel_impl.h"

#ifdef PPLNN_ENABLE_PMX_MODEL
#include "ppl/nn/utils/data_stream.h"
#include "ppl/nn/models/pmx/serialization_context.h"
#include "ppl/nn/models/pmx/deserialization_context.h"
#endif

namespace ppl { namespace nn {

/**
   @class OptKernel
   @brief used to store shared runtime data.
*/
class OptKernel {
public:
    /** @param node the corresponding node in ir::GraphTopo */
    OptKernel(const ir::Node* node) : node_(node) {}

    virtual ~OptKernel() {}

    /** @brief get the corresponding node in ir::GraphTopo */
    const ir::Node* GetNode() const {
        return node_;
    }

    /** @brief create a KernelImpl used in runtime stage */
    virtual KernelImpl* CreateKernelImpl() const = 0;

#ifdef PPLNN_ENABLE_PMX_MODEL
    virtual ppl::common::RetCode SerializeData(const pmx::SerializationContext&, utils::DataStream*) const = 0;
    virtual ppl::common::RetCode DeserializeData(const pmx::DeserializationContext&, const void*, uint64_t) = 0;
#endif

private:
    const ir::Node* node_;
};

}} // namespace ppl::nn

#endif