aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-plugin/src/infra.h
blob: a9744fe978d45135161846dc0d8b77297ca2e92f (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
/*
 * 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.
 */

#ifndef __HICN_INFRA_H__
#define __HICN_INFRA_H__

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

#include "pcs.h"

/**
 * hICN plugin global state: see also
 * - fib and pits
 */
typedef struct hicn_main_s
{
  /* Binary API message ID base */
  u16 msg_id_base;

  /* Have we been enabled */
  u16 is_enabled;

  /* Forwarder PIT/CS */
  hicn_pit_cs_t pitcs;

  /* Global PIT lifetime info */
  /*
   * Default PIT entry timeout to use in case an interest does not
   * contain a valid interest lifetime
   */
  u64 pit_lifetime_dflt_ms;
  /*
   * Boundarier for the interest lifetime. If outside,
   * pit_lifetime_dflt_ms is used in the PIT
   */
  u64 pit_lifetime_min_ms;
  u64 pit_lifetime_max_ms;

} hicn_main_t;

extern hicn_main_t hicn_main;

extern int hicn_infra_fwdr_initialized;

/* PIT and CS size */
u32 hicn_infra_pit_size;
u32 hicn_infra_cs_size;

/**
 * @brief Enable and disable the hicn plugin
 *
 * Enable the time the hICN plugin and set the forwarder parameters.
 * @param enable_disable 1 if to enable, 0 otherwisw (currently only enable is supported)
 * @param pit_max_size Max size of the PIT
 * @param pit_dflt_lifetime_sec_req Default PIT entry timeout to use in case an interest does not contain a valid interest lifetime
 * @param pit_min_lifetime_sec_req Minimum timeout allowed for a PIT entry lifetime
 * @param pit_max_lifetime_sec_req Maximum timeout allowed for a PIT entry lifetime
 * @param cs_max_size CS size. Must be <= than pit_max_size
 * @param cs_reserved_app Amount of CS reserved for application faces
 */
int
hicn_infra_plugin_enable_disable (int enable_disable,
				  int pit_max_size,
				  f64 pit_dflt_lifetime_sec_req,
				  f64 pit_min_lifetime_sec_req,
				  f64 pit_max_lifetime_sec_req,
				  int cs_max_size, int cs_reserved_app);


/* vlib nodes that compose the hICN forwarder */
extern vlib_node_registration_t hicn_interest_pcslookup_node;
extern vlib_node_registration_t hicn_data_pcslookup_node;
extern vlib_node_registration_t hicn_data_fwd_node;
extern vlib_node_registration_t hicn_data_store_node;
extern vlib_node_registration_t hicn_interest_hitpit_node;
extern vlib_node_registration_t hicn_interest_hitcs_node;
extern vlib_node_registration_t hicn_pg_interest_node;
extern vlib_node_registration_t hicn_pg_data_node;
extern vlib_node_registration_t hicn_pg_server_node;


#endif /* // __HICN_INFRA_H__ */

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