aboutsummaryrefslogtreecommitdiffstats
path: root/extras/vom/vom/interface_span_cmds.hpp
blob: e83ed728fb15366bd53f848e00d7457dad13e471 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * 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 __VOM_INTERFACE_SPAN_CMDS_H__
#define __VOM_INTERFACE_SPAN_CMDS_H__

#include "vom/dump_cmd.hpp"
#include "vom/interface_span.hpp"
#include "vom/rpc_cmd.hpp"

#include <vapi/span.api.vapi.hpp>

namespace VOM {
namespace interface_span_cmds {

/**
 * A command class that configures the interface span
 */
class config_cmd
  : public rpc_cmd<HW::item<bool>, vapi::Sw_interface_span_enable_disable>
{
public:
  /**
   * Constructor
   */
  config_cmd(HW::item<bool>& item,
             const handle_t& itf_from,
             const handle_t& itf_to,
             const interface_span::state_t& state);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const config_cmd& i) const;

private:
  /**
   * Reference to the interface to be mirrored
   */
  const handle_t& m_itf_from;
  /**
   * Reference to the interface where the traffic is mirrored
   */
  const handle_t& m_itf_to;
  /**
   * the state (rx, tx or both) of the interface to be mirrored
   */
  const interface_span::state_t& m_state;
};

/**
 * A cmd class that Unconfigs interface span
 */
class unconfig_cmd
  : public rpc_cmd<HW::item<bool>, vapi::Sw_interface_span_enable_disable>
{
public:
  /**
   * Constructor
   */
  unconfig_cmd(HW::item<bool>& item,
               const handle_t& itf_from,
               const handle_t& itf_to);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const unconfig_cmd& i) const;

private:
  /**
   * Reference to the interface to be mirrored
   */
  const handle_t& m_itf_from;
  /**
   * Reference to the interface where the traffic is mirrored
   */
  const handle_t& m_itf_to;
};

/**
 * A cmd class that Dumps all the interface spans
 */
class dump_cmd : public VOM::dump_cmd<vapi::Sw_interface_span_dump>
{
public:
  /**
   * Constructor
   */
  dump_cmd();
  dump_cmd(const dump_cmd& d);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const dump_cmd& i) const;

private:
  /**
   * HW reutrn code
   */
  HW::item<bool> item;
};
};
};

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */

#endif