aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-plugin/src/cache_policies/cs_policy.h
blob: c1a9a44c95b91033274939401bfc21e1f9bc3721 (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
/*
 * 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_CS_POLICY_H__
#define __HICN_CS_POLICY_H__

#include "../hashtb.h"

/*
 * Structure
 */
typedef struct hicn_cs_policy_s
{
  u32 max;
  u32 count;

  /* Indexes to hashtable nodes forming CS LRU */
  u32 head;
  u32 tail;

} hicn_cs_policy_t;

/* Forward declaration */
struct hicn_pit_cs_s;
struct hicn_hash_node_s;
struct hicn_pcs_entry_s;
struct hicn_cs_policy_s;

/**
 * @brief Definition of the virtual functin table for a cache policy.
 *
 * A cache policy must implement three functions: insert, update, delete, trim.
 */
typedef struct hicn_cs_policy_vft_s
{
  void (*hicn_cs_insert) (struct hicn_pit_cs_s * p,
			  struct hicn_hash_node_s * node,
			  struct hicn_pcs_entry_s * pcs,
			  hicn_cs_policy_t * policy);

  void (*hicn_cs_update) (struct hicn_pit_cs_s * p,
			  struct hicn_hash_node_s * node,
			  struct hicn_pcs_entry_s * pcs,
			  hicn_cs_policy_t * policy);

  void (*hicn_cs_dequeue) (struct hicn_pit_cs_s * p,
			   struct hicn_hash_node_s * node,
			   struct hicn_pcs_entry_s * pcs,
			   hicn_cs_policy_t * policy);

  void (*hicn_cs_delete_get) (struct hicn_pit_cs_s * p,
			      hicn_cs_policy_t * policy,
			      struct hicn_hash_node_s ** node,
			      struct hicn_pcs_entry_s ** pcs,
			      struct hicn_hash_entry_s ** hash_entry);

  int (*hicn_cs_trim) (struct hicn_pit_cs_s * p, u32 * node_list, int sz,
		       hicn_cs_policy_t * policy);

  int (*hicn_cs_flush) (vlib_main_t * vm, struct hicn_pit_cs_s * p,
			hicn_cs_policy_t * policy_state);
} hicn_cs_policy_vft_t;



#endif /* // __HICN_POLICY_H__ */

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