forked from mongodb/libbson
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bson-oid.c
354 lines (308 loc) · 10.9 KB
/
bson-oid.c
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
/*
* Copyright 2013 MongoDB Inc.
*
* 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 <limits.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include "bson-context-private.h"
#include "bson-md5.h"
#include "bson-oid.h"
/*
* This table contains an array of two character pairs for every possible
* bson_uint8_t. It is used as a lookup table when encoding a bson_oid_t
* to hex formatted ASCII. Performing two characters at a time roughly
* reduces the number of operations by one-half.
*/
static const bson_uint16_t gHexCharPairs[] = {
#if BSON_BYTE_ORDER == BSON_BIG_ENDIAN
12336, 12337, 12338, 12339, 12340, 12341, 12342, 12343, 12344, 12345,
12385, 12386, 12387, 12388, 12389, 12390, 12592, 12593, 12594, 12595,
12596, 12597, 12598, 12599, 12600, 12601, 12641, 12642, 12643, 12644,
12645, 12646, 12848, 12849, 12850, 12851, 12852, 12853, 12854, 12855,
12856, 12857, 12897, 12898, 12899, 12900, 12901, 12902, 13104, 13105,
13106, 13107, 13108, 13109, 13110, 13111, 13112, 13113, 13153, 13154,
13155, 13156, 13157, 13158, 13360, 13361, 13362, 13363, 13364, 13365,
13366, 13367, 13368, 13369, 13409, 13410, 13411, 13412, 13413, 13414,
13616, 13617, 13618, 13619, 13620, 13621, 13622, 13623, 13624, 13625,
13665, 13666, 13667, 13668, 13669, 13670, 13872, 13873, 13874, 13875,
13876, 13877, 13878, 13879, 13880, 13881, 13921, 13922, 13923, 13924,
13925, 13926, 14128, 14129, 14130, 14131, 14132, 14133, 14134, 14135,
14136, 14137, 14177, 14178, 14179, 14180, 14181, 14182, 14384, 14385,
14386, 14387, 14388, 14389, 14390, 14391, 14392, 14393, 14433, 14434,
14435, 14436, 14437, 14438, 14640, 14641, 14642, 14643, 14644, 14645,
14646, 14647, 14648, 14649, 14689, 14690, 14691, 14692, 14693, 14694,
24880, 24881, 24882, 24883, 24884, 24885, 24886, 24887, 24888, 24889,
24929, 24930, 24931, 24932, 24933, 24934, 25136, 25137, 25138, 25139,
25140, 25141, 25142, 25143, 25144, 25145, 25185, 25186, 25187, 25188,
25189, 25190, 25392, 25393, 25394, 25395, 25396, 25397, 25398, 25399,
25400, 25401, 25441, 25442, 25443, 25444, 25445, 25446, 25648, 25649,
25650, 25651, 25652, 25653, 25654, 25655, 25656, 25657, 25697, 25698,
25699, 25700, 25701, 25702, 25904, 25905, 25906, 25907, 25908, 25909,
25910, 25911, 25912, 25913, 25953, 25954, 25955, 25956, 25957, 25958,
26160, 26161, 26162, 26163, 26164, 26165, 26166, 26167, 26168, 26169,
26209, 26210, 26211, 26212, 26213, 26214
#else
12336, 12592, 12848, 13104, 13360, 13616, 13872, 14128, 14384, 14640,
24880, 25136, 25392, 25648, 25904, 26160, 12337, 12593, 12849, 13105,
13361, 13617, 13873, 14129, 14385, 14641, 24881, 25137, 25393, 25649,
25905, 26161, 12338, 12594, 12850, 13106, 13362, 13618, 13874, 14130,
14386, 14642, 24882, 25138, 25394, 25650, 25906, 26162, 12339, 12595,
12851, 13107, 13363, 13619, 13875, 14131, 14387, 14643, 24883, 25139,
25395, 25651, 25907, 26163, 12340, 12596, 12852, 13108, 13364, 13620,
13876, 14132, 14388, 14644, 24884, 25140, 25396, 25652, 25908, 26164,
12341, 12597, 12853, 13109, 13365, 13621, 13877, 14133, 14389, 14645,
24885, 25141, 25397, 25653, 25909, 26165, 12342, 12598, 12854, 13110,
13366, 13622, 13878, 14134, 14390, 14646, 24886, 25142, 25398, 25654,
25910, 26166, 12343, 12599, 12855, 13111, 13367, 13623, 13879, 14135,
14391, 14647, 24887, 25143, 25399, 25655, 25911, 26167, 12344, 12600,
12856, 13112, 13368, 13624, 13880, 14136, 14392, 14648, 24888, 25144,
25400, 25656, 25912, 26168, 12345, 12601, 12857, 13113, 13369, 13625,
13881, 14137, 14393, 14649, 24889, 25145, 25401, 25657, 25913, 26169,
12385, 12641, 12897, 13153, 13409, 13665, 13921, 14177, 14433, 14689,
24929, 25185, 25441, 25697, 25953, 26209, 12386, 12642, 12898, 13154,
13410, 13666, 13922, 14178, 14434, 14690, 24930, 25186, 25442, 25698,
25954, 26210, 12387, 12643, 12899, 13155, 13411, 13667, 13923, 14179,
14435, 14691, 24931, 25187, 25443, 25699, 25955, 26211, 12388, 12644,
12900, 13156, 13412, 13668, 13924, 14180, 14436, 14692, 24932, 25188,
25444, 25700, 25956, 26212, 12389, 12645, 12901, 13157, 13413, 13669,
13925, 14181, 14437, 14693, 24933, 25189, 25445, 25701, 25957, 26213,
12390, 12646, 12902, 13158, 13414, 13670, 13926, 14182, 14438, 14694,
24934, 25190, 25446, 25702, 25958, 26214
#endif
};
/**
* bson_oid_init_sequence:
* @oid: A bson_oid_t.
* @context: A bson_context_t.
*
* Initializes @oid with the next oid in the sequence. The first 4 bytes
* contain the current time and the following 8 contain a 64-bit integer
* in big-endian format.
*
* The bson_oid_t generated by this function is not guaranteed to be globally
* unique. Only unique within this context. It is however, guaranteed to be
* sequential.
*/
void
bson_oid_init_sequence (bson_oid_t *oid,
bson_context_t *context)
{
bson_uint32_t now = (bson_uint32_t)(time (NULL));
if (!context) {
context = bson_context_get_default ();
}
now = BSON_UINT32_TO_BE (now);
memcpy (&oid->bytes[0], &now, 4);
context->oid_get_seq64 (context, oid);
}
/**
* bson_oid_init:
* @oid: A bson_oid_t.
*
* Generates bytes for a new bson_oid_t and stores them in @oid. The bytes
* will be generated according to the specification and includes the current
* time, first 3 bytes of MD5(hostname), pid (or tid), and monotonic counter.
*/
void
bson_oid_init (bson_oid_t *oid,
bson_context_t *context)
{
bson_uint32_t now = (bson_uint32_t)(time (NULL));
bson_return_if_fail (oid);
if (!context) {
context = bson_context_get_default ();
}
now = BSON_UINT32_TO_BE (now);
memcpy (&oid->bytes[0], &now, 4);
context->oid_get_host (context, oid);
context->oid_get_pid (context, oid);
context->oid_get_seq32 (context, oid);
}
/**
* bson_oid_init_from_data:
* @oid: A bson_oid_t to initialize.
* @bytes: A 12-byte buffer to copy into @oid.
*
* Initializes an @oid from @data. @data MUST be a buffer of at least 12 bytes.
* This method is analagous to memcpy()'ing data into @oid.
*/
void
bson_oid_init_from_data (bson_oid_t *oid,
const bson_uint8_t *data)
{
bson_return_if_fail (oid);
bson_return_if_fail (data);
memcpy (oid, data, 12);
}
/**
* bson_oid_init_from_string:
* @oid: A bson_oid_t
* @str: A string containing at least 24 characters.
*
* Parses @str containing hex formatted bytes of an object id and places
* the bytes in @oid.
*/
void
bson_oid_init_from_string (bson_oid_t *oid,
const char *str)
{
bson_return_if_fail (oid);
bson_return_if_fail (str);
bson_oid_init_from_string_unsafe (oid, str);
}
/**
* bson_oid_get_time_t:
* @oid: A bson_oid_t.
*
* Fetches the time for which @oid was created.
*
* Returns: A time_t.
*/
time_t
bson_oid_get_time_t (const bson_oid_t *oid)
{
bson_return_val_if_fail (oid, 0);
return bson_oid_get_time_t_unsafe (oid);
}
/**
* bson_oid_to_string:
* @oid: A bson_oid_t.
* @str: A location to store the resulting string.
*
* Formats a bson_oid_t into a string. @str must contain enough bytes
* for the resulting string which is 25 bytes with a terminating NUL-byte.
*/
void
bson_oid_to_string (const bson_oid_t *oid,
char str[BSON_ENSURE_ARRAY_PARAM_SIZE(25)])
{
bson_uint16_t *dst;
bson_uint8_t *id = (bson_uint8_t *)oid;
bson_return_if_fail (oid);
bson_return_if_fail (str);
dst = (bson_uint16_t *)(void *)str;
dst[0] = gHexCharPairs[id[0]];
dst[1] = gHexCharPairs[id[1]];
dst[2] = gHexCharPairs[id[2]];
dst[3] = gHexCharPairs[id[3]];
dst[4] = gHexCharPairs[id[4]];
dst[5] = gHexCharPairs[id[5]];
dst[6] = gHexCharPairs[id[6]];
dst[7] = gHexCharPairs[id[7]];
dst[8] = gHexCharPairs[id[8]];
dst[9] = gHexCharPairs[id[9]];
dst[10] = gHexCharPairs[id[10]];
dst[11] = gHexCharPairs[id[11]];
str[24] = '\0';
}
/**
* bson_oid_hash:
* @oid: A bson_oid_t to hash.
*
* Hashes the bytes of the provided bson_oid_t using DJB hash.
* This allows bson_oid_t to be used as keys in a hash table.
*
* Returns: A hash value corresponding to @oid.
*/
bson_uint32_t
bson_oid_hash (const bson_oid_t *oid)
{
bson_return_val_if_fail (oid, 5381);
return bson_oid_hash_unsafe (oid);
}
/**
* bson_oid_compare:
* @oid1: The bson_oid_t to compare as the left.
* @oid2: The bson_oid_t to compare as the right.
*
* A qsort() style compare function that will return less than zero
* if @oid1 is less than @oid2, zero if they are the same, and greater
* than zero if @oid2 is greater than @oid1.
*
* Returns: A qsort() style compare integer.
*/
int
bson_oid_compare (const bson_oid_t *oid1,
const bson_oid_t *oid2)
{
bson_return_val_if_fail (oid1, 0);
bson_return_val_if_fail (oid2, 0);
return bson_oid_compare_unsafe (oid1, oid2);
}
/**
* bson_oid_equal:
* @oid1: A bson_oid_t.
* @oid2: A bson_oid_t.
*
* Compares for equality of @oid1 and @oid2. If they are equal, then
* TRUE is returned, otherwise FALSE.
*
* Returns: A boolean indicating the equality of @oid1 and @oid2.
*/
bson_bool_t
bson_oid_equal (const bson_oid_t *oid1,
const bson_oid_t *oid2)
{
bson_return_val_if_fail (oid1, FALSE);
bson_return_val_if_fail (oid2, FALSE);
return bson_oid_equal_unsafe (oid1, oid2);
}
/**
* bson_oid_copy:
* @src: A bson_oid_t to copy from.
* @dst: A bson_oid_t to copy to.
*
* Copies the contents of @src to @dst.
*/
void
bson_oid_copy (const bson_oid_t *src,
bson_oid_t *dst)
{
bson_return_if_fail (src);
bson_return_if_fail (dst);
bson_oid_copy_unsafe (src, dst);
}
/**
* bson_oid_is_valid:
* @str: A string to validate.
* @length: The length of @str.
*
* Validates that @str is a valid OID string. @length MUST be 12, but is
* provided as a parameter to simplify calling code.
*
* Returns: TRUE if @str can be passed to bson_oid_init_from_string().
*/
bson_bool_t
bson_oid_is_valid (const char *str,
bson_size_t length)
{
bson_size_t i;
bson_return_val_if_fail (str, FALSE);
if (length == 24) {
for (i = 0; i < length; i++) {
switch (str[i]) {
case '0': case '1': case '2': case '3': case '4': case '5': case '6':
case '7': case '8': case '9': case 'a': case 'b': case 'c': case 'd':
case 'e': case 'f':
break;
default:
return FALSE;
}
}
return TRUE;
}
return FALSE;
}