summaryrefslogtreecommitdiff
path: root/compiler/luci/export/include/luci/CircleExporter.h
blob: 0584c623cfa7c0763335aae4ee8007d6305aeb0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (c) 2020 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 __LUCI_CIRCLEEXPORTER_H__
#define __LUCI_CIRCLEEXPORTER_H__

#include <luci/IR/Module.h>

#include <loco.h>

#include <memory>

namespace luci
{

class CircleExporter
{
public:
  // This contract class describes the interaction between a exporter and its client.
  struct Contract
  {
  public:
    virtual ~Contract() = default;

  public: // Client -> Exporter
    // Input Graph (to be exported)
    // Exporter expects a loco graph that consists of Circle nodes
    virtual loco::Graph *graph(void) const = 0;

    // Input Module (to be exported)
    // Exporter expects a luci module that consists of loco graphs
    // TODO make this pure virtual
    virtual luci::Module *module(void) const;

  public: // Exporter -> Client
    // Exporter calls store for export data
    // Notice: Please DO NOT STORE ptr and size when implementing this in Client
    virtual bool store(const char *ptr, const size_t size) const = 0;
  };

public:
  explicit CircleExporter();

public:
  // invoke(...) returns false on failure.
  bool invoke(Contract *) const;
};

} // namespace luci

#endif // __LUCI_CIRCLEEXPORTER_H__