xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/printers/DotGraphPrinter.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2019,2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H
25 #define ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H
26 
27 #include "arm_compute/graph/IGraphPrinter.h"
28 
29 #include "arm_compute/graph/INodeVisitor.h"
30 
31 #include <string>
32 
33 namespace arm_compute
34 {
35 namespace graph
36 {
37 /** Graph printer visitor. */
38 class DotGraphVisitor final : public DefaultNodeVisitor
39 {
40 public:
41     /** Default Constructor **/
42     DotGraphVisitor() = default;
43     /** Returns the output information of the last visited node
44      *
45      * @return Information of the last visited node
46      */
47     const std::string &info() const;
48 
49     // Reveal parent method
50     using DefaultNodeVisitor::visit;
51 
52     // Inherited methods overridden
53     void visit(ActivationLayerNode &n) override;
54     void visit(BatchNormalizationLayerNode &n) override;
55     void visit(ConcatenateLayerNode &n) override;
56     void visit(ConvolutionLayerNode &n) override;
57     void visit(DepthwiseConvolutionLayerNode &n) override;
58     void visit(EltwiseLayerNode &n) override;
59     void visit(FusedConvolutionBatchNormalizationNode &n) override;
60     void visit(FusedConvolutionBatchNormalizationWithPostOpsNode &n) override;
61     void visit(FusedConvolutionWithPostOpNode &n) override;
62     void visit(FusedDepthwiseConvolutionBatchNormalizationNode &n) override;
63     void visit(NormalizationLayerNode &n) override;
64     void visit(PoolingLayerNode &n) override;
65     void default_visit(INode &n) override;
66 
67 private:
68     std::string _info{};
69 };
70 
71 /** Graph printer interface */
72 class DotGraphPrinter final : public IGraphPrinter
73 {
74 public:
75     // Inherited methods overridden
76     void print(const Graph &g, std::ostream &os) override;
77 
78 private:
79     /** Print dot graph header
80      *
81      * @param[in]  g  Graph
82      * @param[out] os Output stream to use
83      */
84     void print_header(const Graph &g, std::ostream &os);
85     /** Print dot graph footer
86      *
87      * @param[in]  g  Graph
88      * @param[out] os Output stream to use
89      */
90     void print_footer(const Graph &g, std::ostream &os);
91     /** Prints nodes in dot format
92      *
93      * @param[in]  g  Graph
94      * @param[out] os Output stream to use
95      */
96     void print_nodes(const Graph &g, std::ostream &os);
97     /** Prints edges in dot format
98      *
99      * @param[in]  g  Graph
100      * @param[out] os Output stream to use
101      */
102     void print_edges(const Graph &g, std::ostream &os);
103 
104 private:
105     DotGraphVisitor _dot_node_visitor = {};
106 };
107 } // namespace graph
108 } // namespace arm_compute
109 #endif /* ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H */
110