aboutsummaryrefslogtreecommitdiffstats
path: root/metis/ccnx/forwarder/metis/processor/metis_PitEntry.c
blob: 4b65960babb55400bf85e354babdf5283d31d916 (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
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * Copyright (c) 2017 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.
 */


#include <config.h>
#include <stdio.h>

#include <parc/algol/parc_Memory.h>
#include <ccnx/forwarder/metis/processor/metis_PitEntry.h>
#include <ccnx/forwarder/metis/core/metis_NumberSet.h>

#include <LongBow/runtime.h>

struct metis_pit_entry {
    MetisMessage *message;
    MetisNumberSet *ingressIdSet;
    MetisNumberSet *egressIdSet;

    MetisFibEntry *fibEntry;

    MetisTicks creationTime;
    MetisTicks expiryTime;

    unsigned refcount;
};

MetisPitEntry *
metisPitEntry_Create(MetisMessage *message, MetisTicks expiryTime, MetisTicks creationTime)
{
    MetisPitEntry *pitEntry = parcMemory_AllocateAndClear(sizeof(MetisPitEntry));
    assertNotNull(pitEntry, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(MetisPitEntry));
    pitEntry->message = message;
    pitEntry->ingressIdSet = metisNumberSet_Create();
    pitEntry->egressIdSet = metisNumberSet_Create();
    pitEntry->refcount = 1;

    // add the message to the reverse path set
    metisNumberSet_Add(pitEntry->ingressIdSet, metisMessage_GetIngressConnectionId(message));

    // hack in a 4-second timeout
    pitEntry->expiryTime = expiryTime;
    pitEntry->fibEntry = NULL;

    pitEntry->creationTime = creationTime;
    return pitEntry;
}

void
metisPitEntry_Release(MetisPitEntry **pitEntryPtr)
{
    assertNotNull(pitEntryPtr, "Parameter must be non-null double pointer");
    assertNotNull(*pitEntryPtr, "Parameter must dereference to non-null pointer");

    MetisPitEntry *pitEntry = *pitEntryPtr;
    trapIllegalValueIf(pitEntry->refcount == 0, "Illegal state: has refcount of 0");

    pitEntry->refcount--;
    if (pitEntry->refcount == 0) {
        if(pitEntry->fibEntry != NULL){
            metisFibEntry_Release(&pitEntry->fibEntry);
        }
        metisNumberSet_Release(&pitEntry->ingressIdSet);
        metisNumberSet_Release(&pitEntry->egressIdSet);
        metisMessage_Release(&pitEntry->message);
        parcMemory_Deallocate((void **) &pitEntry);
    }
    *pitEntryPtr = NULL;
}

MetisPitEntry *
metisPitEntry_Acquire(MetisPitEntry *original)
{
    assertNotNull(original, "Parameter original must be non-null");
    original->refcount++;
    return original;
}

void
metisPitEntry_AddIngressId(MetisPitEntry *pitEntry, unsigned ingressId)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    metisNumberSet_Add(pitEntry->ingressIdSet, ingressId);
}

void
metisPitEntry_AddEgressId(MetisPitEntry *pitEntry, unsigned egressId)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    metisNumberSet_Add(pitEntry->egressIdSet, egressId);
}

void
metisPitEntry_AddFibEntry(MetisPitEntry *pitEntry, MetisFibEntry *fibEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    assertNotNull(fibEntry, "Parameter fibEntry must be non-null");
    //the fibEntry should be always the same for all the interests in the same pitEntry 
    if(pitEntry->fibEntry == NULL){
        metisFibEntry_Acquire(fibEntry);
        pitEntry->fibEntry = fibEntry;
    }
}

MetisFibEntry *
metisPitEntry_GetFibEntry(MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return pitEntry->fibEntry;
}

MetisTicks
metisPitEntry_GetExpiryTime(const MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return pitEntry->expiryTime;
}

MetisTicks
metisPitEntry_GetCreationTime(const MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return pitEntry->creationTime;
}

void
metisPitEntry_SetExpiryTime(MetisPitEntry *pitEntry, MetisTicks expiryTime)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    pitEntry->expiryTime = expiryTime;
}


const MetisNumberSet *
metisPitEntry_GetIngressSet(const MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return pitEntry->ingressIdSet;
}

const MetisNumberSet *
metisPitEntry_GetEgressSet(const MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return pitEntry->egressIdSet;
}

MetisMessage *
metisPitEntry_GetMessage(const MetisPitEntry *pitEntry)
{
    assertNotNull(pitEntry, "Parameter pitEntry must be non-null");
    return metisMessage_Acquire(pitEntry->message);
}