aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-light/src/hicn/content_store/listLRU.c
blob: 242af4078fe7602fd5b16780eb9755893039dfad (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
/*
 * 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 _WIN32
#include <sys/queue.h>
#endif
#include <hicn/hicn-light/config.h>
#include <stdbool.h>
#include <stdio.h>

#include <parc/algol/parc_Memory.h>
#include <parc/assert/parc_Assert.h>
#include <hicn/content_store/listLRU.h>

struct list_lru_entry {
  void *userData;

  // always set to the list
  ListLru *parentList;

  // indicates if the Entry is currently in the list
  bool inList;

  TAILQ_ENTRY(list_lru_entry) list;
};

// this defines the TAILQ structure so we can access the tail pointer
TAILQ_HEAD(lru_s, list_lru_entry);

struct list_lru {
  struct lru_s head;
  size_t itemsInList;
};

void listLRU_EntryDestroy(ListLruEntry **entryPtr) {
  parcAssertNotNull(entryPtr,
                    "Parameter entryPtr must be non-null double pointer");

  ListLruEntry *entry = *entryPtr;
  if (entry->inList) {
    TAILQ_REMOVE(&entry->parentList->head, entry, list);
    parcAssertTrue(
        entry->parentList->itemsInList > 0,
        "Invalid state, removed entry from list, but itemsInList is 0");
    entry->parentList->itemsInList--;
  }

  parcMemory_Deallocate((void **)&entry);
  *entryPtr = NULL;
}

void listLRU_EntryMoveToHead(ListLruEntry *entry) {
  parcAssertNotNull(entry, "Parameter entry must be non-null");

  TAILQ_REMOVE(&entry->parentList->head, entry, list);
  TAILQ_INSERT_HEAD(&entry->parentList->head, entry, list);
}

void *listLRU_EntryGetData(ListLruEntry *entry) { return entry->userData; }

ListLru *listLRU_Create() {
  ListLru *list = parcMemory_AllocateAndClear(sizeof(ListLru));
  parcAssertNotNull(list, "parcMemory_AllocateAndClear(%zu) returned NULL",
                    sizeof(ListLru));
  list->itemsInList = 0;
  TAILQ_INIT(&list->head);
  return list;
}

void listLRU_Destroy(ListLru **lruPtr) {
  parcAssertNotNull(lruPtr, "Parameter lruPtr must be non-null double pointer");

  ListLru *lru = *lruPtr;

  ListLruEntry *entry = TAILQ_FIRST(&lru->head);
  while (entry != NULL) {
    ListLruEntry *next = TAILQ_NEXT(entry, list);
    listLRU_EntryDestroy(&entry);
    entry = next;
  }

  parcMemory_Deallocate((void **)&lru);
  *lruPtr = NULL;
}

ListLruEntry *listLRU_NewHeadEntry(ListLru *lru, void *data) {
  parcAssertNotNull(lru, "Parameter lru must be non-null");
  parcAssertNotNull(data, "Parameter data must be non-null");

  ListLruEntry *entry = parcMemory_AllocateAndClear(sizeof(ListLruEntry));
  parcAssertNotNull(entry, "parcMemory_AllocateAndClear(%zu) returned NULL",
                    sizeof(ListLruEntry));
  entry->userData = data;
  entry->parentList = lru;
  entry->inList = true;

  TAILQ_INSERT_HEAD(&lru->head, entry, list);
  lru->itemsInList++;

  return entry;
}

ListLruEntry *listLRU_PopTail(ListLru *lru) {
  parcAssertNotNull(lru, "Parameter lru must be non-null");

  ListLruEntry *entry = TAILQ_LAST(&lru->head, lru_s);

  if (entry) {
    parcAssertTrue(
        lru->itemsInList > 0,
        "Invalid state, removed entry from list, but itemsInList is 0");
    lru->itemsInList--;
    TAILQ_REMOVE(&lru->head, entry, list);
    entry->inList = false;
  }

  return entry;
}

size_t listLRU_Length(const ListLru *lru) {
  parcAssertNotNull(lru, "Parameter lru must be non-null");
  return lru->itemsInList;
}