diff options
Diffstat (limited to 'hicn-plugin/src/network/strategies/dpo_rr.h')
-rw-r--r-- | hicn-plugin/src/network/strategies/dpo_rr.h | 152 |
1 files changed, 0 insertions, 152 deletions
diff --git a/hicn-plugin/src/network/strategies/dpo_rr.h b/hicn-plugin/src/network/strategies/dpo_rr.h deleted file mode 100644 index e4e5b5372..000000000 --- a/hicn-plugin/src/network/strategies/dpo_rr.h +++ /dev/null @@ -1,152 +0,0 @@ -/* - * Copyright (c) 2017-2020 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 __HICN_DPO_RR_H__ -#define __HICN_DPO_RR_H__ - -#include <vnet/dpo/dpo.h> -#include "../strategy_dpo_ctx.h" - -/** - * @file dpo_rr.h - * - * This file implements the strategy vtf (see strategy.h) and - * the dpo vft (see strategy_dpo_manager.h) for the strategy - * round robin. - */ - - -/** - * Context for the Round Robin strategy - */ - -typedef struct hicn_strategy_rr_ctx_s -{ - u8 current_nhop; -} hicn_strategy_rr_ctx_t; - -/** - * @brief Format the dpo ctx for a human-readable string - * - * @param s String to which to append the formatted dpo ctx - * @param ap List of parameters for the formatting - * - * @result The string with the formatted dpo ctx - */ -u8 *format_hicn_strategy_rr_ctx (u8 * s, va_list * ap); - -const static dpo_vft_t dpo_strategy_rr_ctx_vft = { - .dv_lock = hicn_strategy_dpo_ctx_lock, - .dv_unlock = hicn_strategy_dpo_ctx_unlock, - .dv_format = format_hicn_strategy_rr_ctx, -}; - -/** - * @brief Retrieve an hicn_strategy_rr_ctx object - * - * @param indext Index of the hicn_dpo_ctx to retrieve - * @return The hicn_dpo_ctx object or NULL - */ -hicn_dpo_ctx_t *hicn_strategy_rr_ctx_get (index_t index); - -/** - * @brief Create a new round robin ctx - * - * @param proto The protocol to which the dpo is meant for (see vpp docs) - * @param next_hop A list of next hops to be inserted in the dpo ctx - * @param nh_len Size of the list - * @param dpo_idx index_t that will hold the index of the created dpo ctx - * @return HICN_ERROR_NONE if the creation was fine, otherwise EINVAL - */ -void -hicn_strategy_rr_ctx_create (fib_protocol_t proto, const hicn_face_id_t * next_hop, - int nh_len, index_t * dpo_idx); - -/** - * @brief Add or update a next hop in the dpo ctx. - * - * This function is meant to be used in the control plane and not in the data plane, - * as it is not optimized for the latter. - * - * @param nh Next hop to insert in the dpo ctx - * @param dpo_idx Index of the dpo ctx to update with the new or updated next - * hop - * @return HICN_ERROR_NONE if the update or insert was fine, - * otherwise HICN_ERROR_DPO_CTX_NOT_FOUND - */ -int hicn_strategy_rr_ctx_add_nh (hicn_face_id_t nh, index_t dpo_idx); - -/** - * @brief Delete a next hop in the dpo ctx. - * - * @param face_id Face identifier of the next hop - * @param dpo_idx Index of the dpo ctx to update with the new or updated next - * hop - * @return HICN_ERROR_NONE if the update or insert was fine, - * otherwise HICN_ERROR_DPO_CTS_NOT_FOUND - */ -int hicn_strategy_rr_ctx_del_nh (hicn_face_id_t face_id, index_t dpo_idx); - -/** - * @brief Prefetch a dpo - * - * @param dpo_idx Index of the dpo ctx to prefetch - */ -void hicn_strategy_rr_ctx_prefetch (index_t dpo_idx); - -/** - * @brief Return true if the dpo is of type strategy rr - * - * @param dpo Dpo to check the type - */ -int hicn_dpo_is_type_strategy_rr (const dpo_id_t * dpo); - -/** - * @brief Initialize the Round Robin strategy - */ -void hicn_dpo_strategy_rr_module_init (void); - -/** - * @brief Return the dpo type for the Round Robin strategy - */ -dpo_type_t hicn_dpo_strategy_rr_get_type (void); - -/** - * @brief Format the dpo ctx for the strategy Round Robin - * - * @param s String to append the formatted dpo ctx - * @param ap List of arguments to format - */ -u8 *format_hicn_dpo_strategy_rr (u8 * s, va_list * ap); - -/** - * @brief Format the dpo ctx for the strategy Round Robin. To - * call from other functions - * - * @param s String to append the formatted dpo ctx - * @param ... List of arguments to format - */ -u8 *hicn_strategy_rr_format_ctx (u8 * s, int n, ...); - - -#endif // __HICN_DPO_RR_H__ - -/* - * fd.io coding-style-patch-verification: ON - * - * Local Variables: - * eval: (c-set-style "gnu") - * End: - */ |