aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-plugin/src/face_db.h
blob: 37a2af9cabfd43b23bbb6d82880bf94d5327f234 (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
/*
 * Copyright (c) 2021 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_FACE_DB_H__
#define __HICN_FACE_DB_H__

#include <vnet/dpo/dpo.h>
#include "faces/face.h"

/**
 * @file face_db.h
 *
 * Define a face db that is store in every pit entry. A face db containes a
 * list of incoming faces for interest packets that are used to forward data
 * packets on the interests' reverse path
 */

/* Must be power of two */
#define HICN_FACE_DB_INLINE_FACES 8

#define HICN_PIT_BITMAP_SIZE_BYTE  HICN_PARAM_FACES_MAX / 8
#define HICN_PIT_N_HOP_BITMAP_SIZE HICN_PARAM_FACES_MAX

#define HICN_PIT_N_HOP_BUCKET                                                 \
  (HICN_PARAM_PIT_ENTRY_PHOPS_MAX - HICN_FACE_DB_INLINE_FACES)

typedef struct hicn_face_bucket_s
{
  /* Array of indexes of virtual faces */
  hicn_face_id_t faces[HICN_PIT_N_HOP_BUCKET];

  /* Used to check if interests are retransmission */
  u8 bitmap[HICN_PIT_BITMAP_SIZE_BYTE];

} hicn_face_bucket_t;

extern hicn_face_bucket_t *hicn_face_bucket_pool;

typedef struct __attribute__ ((packed)) hicn_face_db_s
{
  /* 19B + 1B = 20B */
  /* Equal to one or zero */
  u8 is_overflow;

  /* Number of faces in the last bucket */
  /* Or next availabe entry for storing a dpo_id_t */
  /* 20B + 4B = 24B */
  u32 n_faces;

  /* 24B + 32B (8*4) = 56B */
  /* Array of indexes of virtual faces */
  hicn_face_id_t inline_faces[HICN_FACE_DB_INLINE_FACES];

  /* 56B + 4B = 60B */
  u32 next_bucket;

  /* 60B + 4B = 64B */
  u32 align;
  // align back to 64

} hicn_face_db_t;

always_inline hicn_face_id_t
hicn_face_db_get_dpo_face (u32 index, hicn_face_db_t *face_db)
{
  ASSERT (index < face_db->n_faces);

  return index < HICN_FACE_DB_INLINE_FACES ?
		 (face_db->inline_faces[index]) :
		 (pool_elt_at_index (hicn_face_bucket_pool, face_db->next_bucket)
	      ->faces[(index - HICN_FACE_DB_INLINE_FACES) &
		      (HICN_PIT_N_HOP_BUCKET - 1)]);
}

always_inline void
hicn_face_db_init (int max_element)
{
  pool_init_fixed (hicn_face_bucket_pool, max_element);
}

always_inline hicn_face_bucket_t *
hicn_face_db_get_bucket (u32 bucket_index)
{
  return pool_elt_at_index (hicn_face_bucket_pool, bucket_index);
}

always_inline void
hicn_face_db_add_face (hicn_face_id_t face_id, hicn_face_db_t *face_db)
{
  // ASSERT (dpo->dpoi_index != ~0);

  hicn_face_bucket_t *faces_bkt =
    pool_elt_at_index (hicn_face_bucket_pool, face_db->next_bucket);

  hicn_face_id_t *element =
    face_db->n_faces < HICN_FACE_DB_INLINE_FACES ?
	    &(face_db->inline_faces[face_db->n_faces]) :
	    &(faces_bkt->faces[(face_db->n_faces - HICN_FACE_DB_INLINE_FACES) &
			 (HICN_PIT_N_HOP_BUCKET - 1)]);

  *element = face_id;

  u32 bitmap_index = face_id % HICN_PIT_N_HOP_BITMAP_SIZE;
  u32 position_array = bitmap_index / 8;
  u8 bit_index = (u8) (bitmap_index - position_array * 8);

  faces_bkt->bitmap[position_array] |= (0x01 << bit_index);
  face_db->n_faces++;
}

always_inline u8
hicn_face_search (hicn_face_id_t index, hicn_face_db_t *face_db)
{
  hicn_face_bucket_t *faces_bkt =
    pool_elt_at_index (hicn_face_bucket_pool, face_db->next_bucket);
  u32 bitmap_index = index % HICN_PIT_N_HOP_BITMAP_SIZE;

  u32 position_array = bitmap_index / 8;
  u8 bit_index = bitmap_index - position_array * 8;

  return (faces_bkt->bitmap[position_array] >> bit_index) & 0x01;
}

always_inline void
hicn_faces_flush (hicn_face_db_t *face_db)
{
  hicn_face_bucket_t *faces_bkt =
    pool_elt_at_index (hicn_face_bucket_pool, face_db->next_bucket);
  clib_memset_u8 (&(faces_bkt->bitmap), 0, HICN_PIT_BITMAP_SIZE_BYTE);
  face_db->n_faces = 0;
  pool_put_index (hicn_face_bucket_pool, face_db->next_bucket);
}

#endif /* // __HICN_FACE_DB_H__ */

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