Reader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed 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 __MIO_CIRCLE_READER_H__
#define __MIO_CIRCLE_READER_H__
 
#include <mio/circle/schema_generated.h>
 
#include <map>
#include <string>
#include <vector>
 
// NOTE Reader class originated from circledump and for circle-tensordump
//      where this class has more work to be done for stability
//      as the tools are for developers not customores.
 
namespace mio
{
namespace circle
{
 
class Reader
{
private:
  using CircleSubGraphs_t = flatbuffers::Vector<flatbuffers::Offset<::circle::SubGraph>>;
  using CircleBuffers_t = flatbuffers::Vector<flatbuffers::Offset<::circle::Buffer>>;
  using CircleTensors_t = flatbuffers::Vector<flatbuffers::Offset<::circle::Tensor>>;
  using CircleOperators_t = flatbuffers::Vector<flatbuffers::Offset<::circle::Operator>>;
  using CircleMetadata_t = flatbuffers::Vector<flatbuffers::Offset<::circle::Metadata>>;
  using CircleSignatureDef_t = flatbuffers::Vector<flatbuffers::Offset<::circle::SignatureDef>>;
 
public:
  Reader(const ::circle::Model *model);
  Reader(const ::circle::Model *model, const std::vector<char> *rawdata);
 
  Reader() = delete;
 
public:
  uint32_t version() const { return _version; }
 
  const std::vector<const ::circle::OperatorCode *> &opcodes() { return _op_codes; }
  const CircleBuffers_t *buffers() { return _buffers; }
  const CircleTensors_t *tensors() { return _tensors; }
  const CircleOperators_t *operators() { return _operators; }
  const std::vector<int32_t> &inputs() const { return _inputs; }
  const std::vector<int32_t> &outputs() const { return _outputs; }
  const CircleMetadata_t *metadata() const { return _metadata; }
  const CircleSignatureDef_t *signature_defs() const { return _signature_defs; }
 
  uint32_t num_subgraph() const { return _subgraphs->size(); }
 
  size_t buffer_info(uint32_t buf_idx, const uint8_t **buff_data);
  size_t buffer_info(uint32_t buf_idx, const uint8_t **buff_data, bool &ext_offset);
  ::circle::BuiltinOperator builtin_code(const ::circle::Operator *op) const;
  std::string opcode_name(const ::circle::Operator *op) const;
  std::vector<int32_t> outputs(const ::circle::Operator *op) const;
  std::string tensor_name(const ::circle::Tensor *tensor) const;
  std::string tensor_dtype(const ::circle::Tensor *tensor) const;
 
public:
  bool select_subgraph(uint32_t subgraph);
  const std::string &subgraph_name(void) const { return _subgraph_name; }
  uint32_t subgraph_index(void) const { return _subgraph_index; }
 
private:
  uint32_t _version;
 
  const std::vector<char> *_rawdata{nullptr};
 
  const CircleSubGraphs_t *_subgraphs{nullptr};
  const CircleBuffers_t *_buffers{nullptr};
  const CircleTensors_t *_tensors{nullptr};
  const CircleOperators_t *_operators{nullptr};
  const CircleMetadata_t *_metadata{nullptr};
  const CircleSignatureDef_t *_signature_defs{nullptr};
 
  uint32_t _subgraph_index = 0;
  std::string _subgraph_name;
  std::vector<const ::circle::OperatorCode *> _op_codes;
  std::vector<int32_t> _inputs;
  std::vector<int32_t> _outputs;
};
 
} // namespace circle
} // namespace mio
 
#endif // __MIO_CIRCLE_READER_H__