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
165
166
167
|
/*
* 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 <stdlib.h>
#include <limits.h>
#include <parc/algol/parc_Memory.h>
#include <LongBow/runtime.h>
#include <ccnx/common/internal/ccnx_TlvError.h>
struct error_messages {
CCNxTlvErrorCodes code;
const char *message;
} TlvErrorMessages[] = {
{ .code = TLV_ERR_NO_ERROR, .message = "No error" },
{ .code = TLV_ERR_VERSION, .message = "Unsupported version" },
{ .code = TLV_ERR_PACKETTYPE, .message = "Unsupported packet type" },
{ .code = TLV_ERR_BEYOND_PACKET_END, .message = "Field goes beyond end of packet" },
{ .code = TLV_ERR_TOO_LONG, .message = "Length too long for parent container" },
{ .code = TLV_ERR_NOT_FIXED_SIZE, .message = "Fixed size Type wrong Length" },
{ .code = TLV_ERR_DUPLICATE_FIELD, .message = "Duplicate field" },
{ .code = TLV_ERR_EMPTY_SPACE, .message = "The sum of child TLVs did not add up to parent container length" },
// missing mandatory field errors
{ .code = TLV_MISSING_MANDATORY, .message = "Missing mandatory field" },
{ .code = TLV_ERR_DECODE, .message = "Decoding error" },
// end of list sentinel, the NULL determines the end of list
{ .code = UINT16_MAX, .message = NULL }
};
const char *
ccnxTlvErrors_ErrorMessage(CCNxTlvErrorCodes code)
{
for (int i = 0; TlvErrorMessages[i].message != NULL; i++) {
if (TlvErrorMessages[i].code == code) {
return TlvErrorMessages[i].message;
}
}
return "No error message found";
}
// ==========================================================================
struct ccnx_tlv_error {
CCNxTlvErrorCodes code;
const char *functionName;
int line;
size_t byteOffset;
unsigned refcount;
char *toString;
};
CCNxTlvError *
ccnxTlvError_Create(CCNxTlvErrorCodes code, const char *func, int line, size_t byteOffset)
{
CCNxTlvError *error = parcMemory_AllocateAndClear(sizeof(CCNxTlvError));
assertNotNull(error, "parcMemory_AllocateAndClear(%u) returned NULL", sizeof(CCNxTlvError));
error->code = code;
error->functionName = func;
error->line = line;
error->byteOffset = byteOffset;
error->toString = NULL; // computed on the fly
error->refcount = 1;
return error;
}
CCNxTlvError *
ccnxTlvError_Acquire(CCNxTlvError *error)
{
assertNotNull(error, "Parameter error must be non-null");
assertTrue(error->refcount > 0, "Parameter has 0 refcount, not valid");
error->refcount++;
return error;
}
void
ccnxTlvError_Release(CCNxTlvError **errorPtr)
{
assertNotNull(errorPtr, "Parameter must be non-null double pointer");
assertNotNull(*errorPtr, "Parameter must derefernece to non-null pointer");
CCNxTlvError *error = *errorPtr;
assertTrue(error->refcount > 0, "Parameter has 0 refcount, not valid");
error->refcount--;
if (error->refcount == 0) {
if (error->toString) {
// this is asprintf generated
free(error->toString);
}
parcMemory_Deallocate((void **) &error);
}
*errorPtr = NULL;
}
size_t
ccnxTlvError_GetByteOffset(const CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
return error->byteOffset;
}
CCNxTlvErrorCodes
ccnxTlvError_GetErrorCode(const CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
return error->code;
}
const char *
ccnxTlvError_GetFunction(const CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
return error->functionName;
}
int
ccnxTlvError_GetLine(const CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
return error->line;
}
const char *
ccnxTlvError_GetErrorMessage(const CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
return ccnxTlvErrors_ErrorMessage(error->code);
}
const char *
ccnxTlvError_ToString(CCNxTlvError *error)
{
assertNotNull(error, "Parameter must be non-null");
if (error->toString) {
return error->toString;
}
asprintf(&error->toString, "TLV error: %s:%d offset %zu: %s",
error->functionName,
error->line,
error->byteOffset,
ccnxTlvError_GetErrorMessage(error));
return error->toString;
}
|
