trex_rpc_cmds.h revision 6e1919c3
1/*
2 Itay Marom
3 Cisco Systems, Inc.
4*/
5
6/*
7Copyright (c) 2015-2015 Cisco Systems, Inc.
8
9Licensed under the Apache License, Version 2.0 (the "License");
10you may not use this file except in compliance with the License.
11You may obtain a copy of the License at
12
13    http://www.apache.org/licenses/LICENSE-2.0
14
15Unless required by applicable law or agreed to in writing, software
16distributed under the License is distributed on an "AS IS" BASIS,
17WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18See the License for the specific language governing permissions and
19limitations under the License.
20*/
21
22#ifndef __TREX_RPC_CMD_H__
23#define __TREX_RPC_CMD_H__
24
25#include <trex_rpc_cmd_api.h>
26#include <json/json.h>
27#include <memory>
28
29class TrexStream;
30class TrexStatelessPort;
31
32/* all the RPC commands decl. goes here */
33
34/******************* test section ************/
35
36/**
37 * syntactic sugar for creating a simple command
38 */
39
40#define TREX_RPC_CMD_DEFINE_EXTENDED(class_name, cmd_name, param_count, needs_ownership, api_type, ext)      \
41    class class_name : public TrexRpcCommand {                                                               \
42    public:                                                                                                  \
43        class_name () : TrexRpcCommand(cmd_name, param_count, needs_ownership, api_type) {}                  \
44    protected:                                                                                               \
45        virtual trex_rpc_cmd_rc_e _run(const Json::Value &params, Json::Value &result);                      \
46        ext                                                                                                  \
47    }
48
49#define TREX_RPC_CMD_DEFINE(class_name, cmd_name, param_count, needs_ownership, api_type) TREX_RPC_CMD_DEFINE_EXTENDED(class_name, cmd_name, param_count, needs_ownership, api_type, ;)
50
51/**
52 * test cmds
53 */
54TREX_RPC_CMD_DEFINE(TrexRpcCmdTestAdd,    "test_add", 2, false, APIClass::API_CLASS_TYPE_NO_API);
55TREX_RPC_CMD_DEFINE(TrexRpcCmdTestSub,    "test_sub", 2, false, APIClass::API_CLASS_TYPE_NO_API);
56
57/**
58 * api_sync command always present and valid and also ping....
59 */
60TREX_RPC_CMD_DEFINE(TrexRpcCmdAPISync,    "api_sync",             1, false, APIClass::API_CLASS_TYPE_NO_API);
61TREX_RPC_CMD_DEFINE(TrexRpcCmdPing,       "ping",                 0, false, APIClass::API_CLASS_TYPE_NO_API);
62
63/**
64 * general cmds
65 */
66
67TREX_RPC_CMD_DEFINE(TrexRpcPublishNow,         "publish_now",          2, false, APIClass::API_CLASS_TYPE_CORE);
68TREX_RPC_CMD_DEFINE(TrexRpcCmdGetCmds,         "get_supported_cmds",   0, false, APIClass::API_CLASS_TYPE_CORE);
69TREX_RPC_CMD_DEFINE(TrexRpcCmdGetVersion,      "get_version",          0, false, APIClass::API_CLASS_TYPE_CORE);
70TREX_RPC_CMD_DEFINE(TrexRpcCmdGetActivePGIds,  "get_active_pgids",     0, false, APIClass::API_CLASS_TYPE_CORE);
71TREX_RPC_CMD_DEFINE(TrexRpcCmdGetUtilization,  "get_utilization",      0, false, APIClass::API_CLASS_TYPE_CORE);
72
73TREX_RPC_CMD_DEFINE_EXTENDED(TrexRpcCmdGetSysInfo, "get_system_info", 0, false, APIClass::API_CLASS_TYPE_CORE,
74
75std::string get_cpu_model();
76void get_hostname(std::string &hostname);
77
78);
79
80/**
81 * ownership
82 */
83TREX_RPC_CMD_DEFINE(TrexRpcCmdGetOwner,   "get_owner",       1, false, APIClass::API_CLASS_TYPE_CORE);
84TREX_RPC_CMD_DEFINE(TrexRpcCmdAcquire,    "acquire",         4, false, APIClass::API_CLASS_TYPE_CORE);
85TREX_RPC_CMD_DEFINE(TrexRpcCmdRelease,    "release",         1, true,  APIClass::API_CLASS_TYPE_CORE);
86
87
88/**
89 * port commands
90 */
91TREX_RPC_CMD_DEFINE(TrexRpcCmdGetPortStats,        "get_port_stats",         1, false, APIClass::API_CLASS_TYPE_CORE);
92TREX_RPC_CMD_DEFINE(TrexRpcCmdGetPortStatus,       "get_port_status",        1, false, APIClass::API_CLASS_TYPE_CORE);
93TREX_RPC_CMD_DEFINE(TrexRpcCmdGetPortXStatsValues, "get_port_xstats_values", 1, false, APIClass::API_CLASS_TYPE_CORE);
94TREX_RPC_CMD_DEFINE(TrexRpcCmdGetPortXStatsNames,  "get_port_xstats_names",  1, false, APIClass::API_CLASS_TYPE_CORE);
95
96TREX_RPC_CMD_DEFINE_EXTENDED(TrexRpcCmdSetPortAttr, "set_port_attr", 2, true,  APIClass::API_CLASS_TYPE_CORE,
97
98    void high_priority_pass(const Json::Value &attr, uint8 port_id, Json::Value &result);
99    void regular_priority_pass(const Json::Value &attr, uint8_t port_id, Json::Value &result);
100    int parse_rx_filter_mode(const Json::Value &msg, uint8_t port_id, Json::Value &result);
101    int parse_ipv4(const Json::Value &msg, uint8_t port_id, Json::Value &result);
102    int parse_dest(const Json::Value &msg, uint8_t port_id, Json::Value &result);
103);
104
105
106/**
107 * stream cmds
108 */
109TREX_RPC_CMD_DEFINE(TrexRpcCmdRemoveAllStreams,   "remove_all_streams",   1, true, APIClass::API_CLASS_TYPE_CORE);
110TREX_RPC_CMD_DEFINE(TrexRpcCmdRemoveStream,       "remove_stream",        2, true, APIClass::API_CLASS_TYPE_CORE);
111
112TREX_RPC_CMD_DEFINE_EXTENDED(TrexRpcCmdAddStream, "add_stream", 3, true, APIClass::API_CLASS_TYPE_CORE,
113
114/* extended part */
115std::unique_ptr<TrexStream> allocate_new_stream(const Json::Value &section, uint8_t port_id, uint32_t stream_id, Json::Value &result);
116void validate_stream(const std::unique_ptr<TrexStream> &stream, Json::Value &result);
117void parse_vm(const Json::Value &vm, std::unique_ptr<TrexStream> &stream, Json::Value &result);
118void parse_vm_instr_checksum(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
119void parse_vm_instr_checksum_hw(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
120
121void parse_vm_instr_flow_var(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
122void parse_vm_instr_flow_var_rand_limit(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
123void check_min_max(uint8_t flow_var_size, uint64_t init_value,uint64_t step,uint64_t min_value,uint64_t max_value,Json::Value &result);
124
125
126void parse_vm_instr_tuple_flow_var(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
127void parse_vm_instr_trim_pkt_size(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
128void parse_rate(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
129void parse_vm_instr_write_flow_var(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
130void parse_vm_instr_write_mask_flow_var(const Json::Value &inst, std::unique_ptr<TrexStream> &stream, Json::Value &result);
131void handle_range_padding(uint64_t &max_value, uint64_t &min_value, uint64_t step, int op, Json::Value &result);
132
133);
134
135
136TREX_RPC_CMD_DEFINE(TrexRpcCmdGetStreamList, "get_stream_list", 1, false, APIClass::API_CLASS_TYPE_CORE);
137TREX_RPC_CMD_DEFINE(TrexRpcCmdGetAllStreams, "get_all_streams", 1, false, APIClass::API_CLASS_TYPE_CORE);
138
139TREX_RPC_CMD_DEFINE(TrexRpcCmdGetStream, "get_stream", 3, false, APIClass::API_CLASS_TYPE_CORE);
140
141
142
143TREX_RPC_CMD_DEFINE(TrexRpcCmdStartTraffic,    "start_traffic",     4, true, APIClass::API_CLASS_TYPE_CORE);
144TREX_RPC_CMD_DEFINE(TrexRpcCmdStopTraffic,     "stop_traffic",      1, true, APIClass::API_CLASS_TYPE_CORE);
145TREX_RPC_CMD_DEFINE(TrexRpcCmdRemoveRXFilters, "remove_rx_filters", 1, true, APIClass::API_CLASS_TYPE_CORE);
146TREX_RPC_CMD_DEFINE(TrexRpcCmdPauseTraffic,    "pause_traffic",     1, true, APIClass::API_CLASS_TYPE_CORE);
147TREX_RPC_CMD_DEFINE(TrexRpcCmdResumeTraffic,   "resume_traffic",    1, true, APIClass::API_CLASS_TYPE_CORE);
148
149TREX_RPC_CMD_DEFINE(TrexRpcCmdUpdateTraffic, "update_traffic", 3, true, APIClass::API_CLASS_TYPE_CORE);
150
151TREX_RPC_CMD_DEFINE(TrexRpcCmdValidate, "validate", 2, false, APIClass::API_CLASS_TYPE_CORE);
152
153TREX_RPC_CMD_DEFINE(TrexRpcCmdPushRemote, "push_remote", 6, true, APIClass::API_CLASS_TYPE_CORE);
154
155TREX_RPC_CMD_DEFINE(TrexRpcCmdShutdown, "shutdown", 2, false, APIClass::API_CLASS_TYPE_CORE);
156
157TREX_RPC_CMD_DEFINE_EXTENDED(TrexRpcCmdSetRxFeature, "set_rx_feature", 3, false, APIClass::API_CLASS_TYPE_CORE,
158    void parse_capture_msg(const Json::Value &msg, TrexStatelessPort *port, Json::Value &result);
159    void parse_queue_msg(const Json::Value &msg,  TrexStatelessPort *port, Json::Value &result);
160    void parse_server_msg(const Json::Value &msg, TrexStatelessPort *port, Json::Value &result);
161
162);
163
164TREX_RPC_CMD_DEFINE(TrexRpcCmdGetRxQueuePkts, "get_rx_queue_pkts", 2, false, APIClass::API_CLASS_TYPE_CORE);
165
166#endif /* __TREX_RPC_CMD_H__ */
167
168