summaryrefslogtreecommitdiffstats
path: root/hicn-plugin/src/strategies/strategy_rr.c
blob: 53b9b688f17d49454a3c405bd242a98902a24b83 (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
 * Copyright (c) 2017-2019 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.
 */

#include <vlib/vlib.h>
#include <vnet/vnet.h>

#include "../strategy.h"
#include "../strategy_dpo_ctx.h"
#include "dpo_rr.h"
#include "../faces/face.h"
#include "../route.h"
#include "../pcs.h"
#include "../strategy_dpo_manager.h"

/* Simple strategy that chooses the next hop with the maximum weight */
/* It does not require to exend the hicn_dpo */
void hicn_receive_data_rr (index_t dpo_idx, int nh_idx);
void hicn_add_interest_rr (index_t dpo_idx, hicn_hash_entry_t * pit_entry);
void hicn_on_interest_timeout_rr (index_t dpo_idx);
u32 hicn_select_next_hop_rr (index_t dpo_idx, int *nh_idx,
			     dpo_id_t ** outface);
u32 get_strategy_node_index_rr (void);

static hicn_strategy_vft_t hicn_strategy_rr_vft = {
  .hicn_receive_data = &hicn_receive_data_rr,
  .hicn_add_interest = &hicn_add_interest_rr,
  .hicn_on_interest_timeout = &hicn_on_interest_timeout_rr,
  .hicn_select_next_hop = &hicn_select_next_hop_rr,
  .get_strategy_node_index = get_strategy_node_index_rr
};

/* Stats string values */
static char *hicn_strategy_error_strings[] = {
#define _(sym, string) string,
  foreach_hicnfwd_error
#undef _
};

/*
 * Return the vft of the strategy.
 */
hicn_strategy_vft_t *
hicn_rr_strategy_get_vft (void)
{
  return &hicn_strategy_rr_vft;
}

/* Registration struct for a graph node */
vlib_node_registration_t hicn_rr_strategy_node;

u32
get_strategy_node_index_rr (void)
{
  return hicn_rr_strategy_node.index;
}

/* DPO should be give in input as it containes all the information to calculate the next hops*/
u32
hicn_select_next_hop_rr (index_t dpo_idx, int *nh_idx, dpo_id_t ** outface)
{
  hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx =
    (hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (dpo_idx);

  if (dpo_id_is_valid
      (&hicn_strategy_rr_ctx->default_ctx.
       next_hops[hicn_strategy_rr_ctx->current_nhop]))
    {
      *outface =
	(dpo_id_t *) & hicn_strategy_rr_ctx->default_ctx.
	next_hops[hicn_strategy_rr_ctx->current_nhop];

    }
  else
    return HICN_ERROR_STRATEGY_NH_NOT_FOUND;

  hicn_strategy_rr_ctx->current_nhop =
    (hicn_strategy_rr_ctx->current_nhop +
     1) % hicn_strategy_rr_ctx->default_ctx.entry_count;

  return HICN_ERROR_NONE;
}

uword
hicn_rr_strategy_node_fn (vlib_main_t * vm,
			  vlib_node_runtime_t * node, vlib_frame_t * frame)
{
  return hicn_forward_interest_fn (vm, node, frame, &hicn_strategy_rr_vft,
				   hicn_dpo_strategy_rr_get_type (),
				   &hicn_rr_strategy_node);
}

void
hicn_add_interest_rr (index_t dpo_ctx_idx, hicn_hash_entry_t * hash_entry)
{
  hash_entry->dpo_ctx_id = dpo_ctx_idx;
  dpo_id_t hicn_dpo_id =
    { hicn_dpo_strategy_rr_get_type (), 0, 0, dpo_ctx_idx };
  hicn_strategy_rr_ctx_lock (&hicn_dpo_id);
  hash_entry->vft_id = hicn_dpo_get_vft_id (&hicn_dpo_id);
}

void
hicn_on_interest_timeout_rr (index_t dpo_idx)
{
  /* Nothign to do in the rr strategy when we receive an interest */
}

void
hicn_receive_data_rr (index_t dpo_idx, int nh_idx)
{
}


/* packet trace format function */
static u8 *
hicn_strategy_format_trace_rr (u8 * s, va_list * args)
{
  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  hicn_strategy_trace_t *t = va_arg (*args, hicn_strategy_trace_t *);

  s = format (s, "Strategy_rr: pkt: %d, sw_if_index %d, next index %d",
	      (int) t->pkt_type, t->sw_if_index, t->next_index);
  return (s);
}

/*
 * Node registration for the forwarder node
 */
/* *INDENT-OFF* */
VLIB_REGISTER_NODE (hicn_rr_strategy_node) =
{
  .name = "hicn-rr-strategy",
  .function = hicn_rr_strategy_node_fn,
  .vector_size = sizeof (u32),
  .runtime_data_bytes = sizeof (int) + sizeof(hicn_pit_cs_t *),
  .format_trace = hicn_strategy_format_trace_rr,
  .type = VLIB_NODE_TYPE_INTERNAL,
  .n_errors = ARRAY_LEN (hicn_strategy_error_strings),
  .error_strings = hicn_strategy_error_strings,
  .n_next_nodes = HICN_STRATEGY_N_NEXT,
  .next_nodes = {
    [HICN_STRATEGY_NEXT_INTEREST_HITPIT] = "hicn-interest-hitpit",
    [HICN_STRATEGY_NEXT_INTEREST_HITCS] = "hicn-interest-hitcs",
    [HICN_STRATEGY_NEXT_ERROR_DROP] = "error-drop",
    [HICN_STRATEGY_NEXT_EMPTY] = "ip4-lookup",
  },
};
/* *INDENT-ON* */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
* The key in the DB is a pair of the interface's name. * If the keys match, save the ra-config */ auto key = it->first; if (i.key() == key.first) { rac.push_back(it->second.lock()); } ++it; } return (rac); } /** * A functor class that binds the ra config to the interface */ class config_cmd : public rpc_cmd<HW::item<bool>, rc_t, CMD> { public: /** * Constructor */ config_cmd(HW::item<bool>& item, const handle_t& itf, const class_t& cls) : rpc_cmd<HW::item<bool>, rc_t, CMD>(item) , m_itf(itf) , m_cls(cls) { } /** * Issue the command to VPP/HW */ rc_t issue(connection& con); /** * convert to string format for debug purposes */ std::string to_string() const { std::ostringstream s; s << "interface-ip6-nd: " << this->item().to_string() << " itf:" << m_itf.to_string() << " " << m_cls.to_string(); return (s.str()); } /** * Comparison operator - only used for UT */ bool operator==(const config_cmd& other) const { return ((m_itf == other.m_itf) && (m_cls == other.m_cls)); } private: /** * Reference to the interface to bind to */ const handle_t& m_itf; /** * Reference to the config class */ const class_t& m_cls; }; /** * A cmd class that Unbinds L3 Config from an interface */ class unconfig_cmd : public rpc_cmd<HW::item<bool>, rc_t, CMD> { public: /** * Constructor */ unconfig_cmd(HW::item<bool>& item, const handle_t& itf, const class_t& cls) : rpc_cmd<HW::item<bool>, rc_t, CMD>(item) , m_itf(itf) , m_cls(cls) { } /** * Issue the command to VPP/HW */ rc_t issue(connection& con); /** * convert to string format for debug purposes */ std::string to_string() const { std::ostringstream s; s << "interface-ip6-nd: " << this->item().to_string() << " itf:" << m_itf.to_string() << " " << m_cls.to_string(); return (s.str()); } /** * Comparison operator - only used for UT */ bool operator==(const unconfig_cmd& other) const { return ((m_itf == other.m_itf) && (m_cls == other.m_cls)); } private: /** * Reference to the interface to unbind fomr */ const handle_t& m_itf; /** * Reference to the config class to undo configurations */ const class_t& m_cls; }; private: /** * Class definition for listeners to OM events */ class event_handler : public OM::listener, public inspect::command_handler { public: event_handler() { OM::register_listener(this); inspect::register_handler({ "ip6_nd " }, "interface ip6 nd", this); } virtual ~event_handler() = default; /** * Handle a populate event */ void handle_populate(const client_db::key_t& key) { /** * VPP provides no dump for ra config */ } /** * Handle a replay event */ void handle_replay() { m_db.replay(); } /** * Show the object in the Singular DB */ void show(std::ostream& os) { m_db.dump(os); } /** * Get the sortable Id of the listener */ dependency_t order() const { return (dependency_t::BINDING); } }; /** * event_handler to register with OM */ static event_handler m_evh; /** * Enqueue commands to the VPP for the update */ void update(const interface_ip6_nd& obj) { if (!m_config) { HW::enqueue(new config_cmd(m_config, m_itf->handle(), m_cls)); } } void sweep() { if (m_config) { HW::enqueue(new unconfig_cmd(m_config, m_itf->handle(), m_cls)); } HW::write(); } /** * Replay the objects state to HW */ void replay(void) { if (m_config) { HW::enqueue(new config_cmd(m_config, m_itf->handle(), m_cls)); } } /** * Find or add the singular instance in the DB */ static std::shared_ptr<interface_ip6_nd> find_or_add( const interface_ip6_nd& temp) { return (m_db.find_or_add(temp.m_itf->key(), temp)); } /* * It's the VPPHW class that updates the objects in HW */ friend class OM; /** * It's the singular_db class that calls replay() */ friend class singular_db<key_t, interface_ip6_nd>; const std::shared_ptr<interface> m_itf; const class_t m_cls; const key_t m_key; /** * HW configuration for the binding. The bool representing the * do/don't bind. */ HW::item<bool> m_config; /** * A map of all interface ip6 nd keyed against a combination of the * interface and subnet's keys. */ static singular_db<key_t, interface_ip6_nd> m_db; }; /** * Typedef the ip6nd_ra_config */ typedef interface_ip6_nd<ra_config, vapi::Sw_interface_ip6nd_ra_config> ip6nd_ra_config; /** * Typedef the ip6nd_ra_prefix */ typedef interface_ip6_nd<ra_prefix, vapi::Sw_interface_ip6nd_ra_prefix> ip6nd_ra_prefix; /** * Definition of the static singular_db for ACL Lists */ template <typename CLASS, typename CMD> singular_db<typename interface_ip6_nd<CLASS, CMD>::key_t, interface_ip6_nd<CLASS, CMD>> interface_ip6_nd<CLASS, CMD>::m_db; template <typename CLASS, typename CMD> typename interface_ip6_nd<CLASS, CMD>::event_handler interface_ip6_nd<CLASS, CMD>::m_evh; }; /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "mozilla") * End: */ #endif