VirtualBox

source: vbox/trunk/src/VBox/Runtime/generic/uuid-generic.cpp@ 5999

Last change on this file since 5999 was 5999, checked in by vboxsync, 17 years ago

The Giant CDDL Dual-License Header Change.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 13.7 KB
Line 
1/* $Id: uuid-generic.cpp 5999 2007-12-07 15:05:06Z vboxsync $ */
2/** @file
3 * innotek Portable Runtime - UUID, Generic.
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*******************************************************************************
29* Header Files *
30*******************************************************************************/
31#include <iprt/uuid.h>
32#include <iprt/assert.h>
33#include <iprt/err.h>
34#include <iprt/time.h>
35#include <iprt/asm.h>
36#include <iprt/rand.h>
37
38
39/* WARNING: This implementation ASSUMES little endian. */
40
41
42/**
43 * Generates a new UUID value.
44 *
45 * @returns iprt status code.
46 * @param pUuid Where to store generated uuid.
47 */
48RTDECL(int) RTUuidCreate(PRTUUID pUuid)
49{
50 /* validate input. */
51 AssertReturn(pUuid, VERR_INVALID_PARAMETER);
52
53 RTRandBytes(pUuid, sizeof(*pUuid));
54 pUuid->Gen.u16ClockSeq = (pUuid->Gen.u16ClockSeq & 0x3fff) | 0x8000;
55 pUuid->Gen.u16TimeHiAndVersion = (pUuid->Gen.u16TimeHiAndVersion & 0x0fff) | 0x4000;
56
57 return VINF_SUCCESS;
58}
59
60
61/**
62 * Makes a null UUID value.
63 *
64 * @returns iprt status code.
65 * @param pUuid Where to store generated null uuid.
66 */
67RTDECL(int) RTUuidClear(PRTUUID pUuid)
68{
69 AssertReturn(pUuid, VERR_INVALID_PARAMETER);
70 pUuid->au64[0] = 0;
71 pUuid->au64[1] = 0;
72 return VINF_SUCCESS;
73}
74
75
76/**
77 * Checks if UUID is null.
78 *
79 * @returns true if UUID is null.
80 * @param pUuid uuid to check.
81 */
82RTDECL(int) RTUuidIsNull(PCRTUUID pUuid)
83{
84 AssertReturn(pUuid, VERR_INVALID_PARAMETER);
85 return !pUuid->au64[0]
86 && !pUuid->au64[1];
87}
88
89
90/**
91 * Compares two UUID values.
92 *
93 * @returns 0 if eq, < 0 or > 0.
94 * @param pUuid1 First value to compare.
95 * @param pUuid2 Second value to compare.
96 */
97RTDECL(int) RTUuidCompare(PCRTUUID pUuid1, PCRTUUID pUuid2)
98{
99 /*
100 * Special cases.
101 */
102 if (pUuid1 == pUuid2)
103 return 0;
104 if (!pUuid1)
105 return RTUuidIsNull(pUuid2) ? 0 : -1;
106 if (!pUuid2)
107 return RTUuidIsNull(pUuid1) ? 0 : 1;
108
109 /*
110 * Standard cases.
111 */
112 if (pUuid1->Gen.u32TimeLow != pUuid2->Gen.u32TimeLow)
113 return pUuid1->Gen.u32TimeLow < pUuid2->Gen.u32TimeLow ? -1 : 1;
114 if (pUuid1->Gen.u16TimeMid != pUuid2->Gen.u16TimeMid)
115 return pUuid1->Gen.u16TimeMid < pUuid2->Gen.u16TimeMid ? -1 : 1;
116 if (pUuid1->Gen.u16TimeHiAndVersion != pUuid2->Gen.u16TimeHiAndVersion)
117 return pUuid1->Gen.u16TimeHiAndVersion < pUuid2->Gen.u16TimeHiAndVersion ? -1 : 1;
118 if (pUuid1->Gen.u16ClockSeq != pUuid2->Gen.u16ClockSeq)
119 return pUuid1->Gen.u16ClockSeq < pUuid2->Gen.u16ClockSeq ? -1 : 1;
120 if (pUuid1->Gen.au8Node[0] != pUuid2->Gen.au8Node[0])
121 return pUuid1->Gen.au8Node[0] < pUuid2->Gen.au8Node[0] ? -1 : 1;
122 if (pUuid1->Gen.au8Node[1] != pUuid2->Gen.au8Node[1])
123 return pUuid1->Gen.au8Node[1] < pUuid2->Gen.au8Node[1] ? -1 : 1;
124 if (pUuid1->Gen.au8Node[2] != pUuid2->Gen.au8Node[2])
125 return pUuid1->Gen.au8Node[2] < pUuid2->Gen.au8Node[2] ? -1 : 1;
126 if (pUuid1->Gen.au8Node[3] != pUuid2->Gen.au8Node[3])
127 return pUuid1->Gen.au8Node[3] < pUuid2->Gen.au8Node[3] ? -1 : 1;
128 if (pUuid1->Gen.au8Node[4] != pUuid2->Gen.au8Node[4])
129 return pUuid1->Gen.au8Node[4] < pUuid2->Gen.au8Node[4] ? -1 : 1;
130 if (pUuid1->Gen.au8Node[5] != pUuid2->Gen.au8Node[5])
131 return pUuid1->Gen.au8Node[5] < pUuid2->Gen.au8Node[5] ? -1 : 1;
132 return 0;
133}
134
135
136/**
137 * Converts binary UUID to its string representation.
138 *
139 * @returns iprt status code.
140 * @param pUuid Uuid to convert.
141 * @param pszString Where to store result string.
142 * @param cchString pszString buffer length, must be >= RTUUID_STR_LENGTH.
143 */
144RTDECL(int) RTUuidToStr(PCRTUUID pUuid, char *pszString, unsigned cchString)
145{
146 /* validate parameters */
147 AssertReturn(pUuid, VERR_INVALID_PARAMETER);
148 AssertReturn(pszString, VERR_INVALID_PARAMETER);
149 AssertReturn(cchString >= RTUUID_STR_LENGTH, VERR_INVALID_PARAMETER);
150
151 /*
152 * RTStrPrintf(,,"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
153 * pUuid->Gen.u32TimeLow,
154 * pUuid->Gen.u16TimeMin,
155 * pUuid->Gen.u16TimeHiAndVersion,
156 * pUuid->Gen.u16ClockSeq & 0xff,
157 * pUuid->Gen.u16ClockSeq >> 8,
158 * pUuid->Gen.au8Node[0],
159 * pUuid->Gen.au8Node[1],
160 * pUuid->Gen.au8Node[2],
161 * pUuid->Gen.au8Node[3],
162 * pUuid->Gen.au8Node[4],
163 * pUuid->Gen.au8Node[5]);
164 */
165 static const char s_achDigits[17] = "0123456789abcdef";
166 uint32_t u32TimeLow = pUuid->Gen.u32TimeLow;
167 pszString[ 0] = s_achDigits[(u32TimeLow >> 28)/*& 0xf*/];
168 pszString[ 1] = s_achDigits[(u32TimeLow >> 24) & 0xf];
169 pszString[ 2] = s_achDigits[(u32TimeLow >> 20) & 0xf];
170 pszString[ 3] = s_achDigits[(u32TimeLow >> 16) & 0xf];
171 pszString[ 4] = s_achDigits[(u32TimeLow >> 12) & 0xf];
172 pszString[ 5] = s_achDigits[(u32TimeLow >> 8) & 0xf];
173 pszString[ 6] = s_achDigits[(u32TimeLow >> 4) & 0xf];
174 pszString[ 7] = s_achDigits[(u32TimeLow/*>>0*/)& 0xf];
175 pszString[ 8] = '-';
176 unsigned u = pUuid->Gen.u16TimeMid;
177 pszString[ 9] = s_achDigits[(u >> 12)/*& 0xf*/];
178 pszString[10] = s_achDigits[(u >> 8) & 0xf];
179 pszString[11] = s_achDigits[(u >> 4) & 0xf];
180 pszString[12] = s_achDigits[(u/*>>0*/)& 0xf];
181 pszString[13] = '-';
182 u = pUuid->Gen.u16TimeHiAndVersion;
183 pszString[14] = s_achDigits[(u >> 12)/*& 0xf*/];
184 pszString[15] = s_achDigits[(u >> 8) & 0xf];
185 pszString[16] = s_achDigits[(u >> 4) & 0xf];
186 pszString[17] = s_achDigits[(u/*>>0*/)& 0xf];
187 pszString[18] = '-';
188 u = pUuid->Gen.u16ClockSeq;
189 pszString[19] = s_achDigits[(u >> 4) & 0xf];
190 pszString[20] = s_achDigits[(u/*>>0*/)& 0xf];
191 pszString[21] = s_achDigits[(u >> 12)/*& 0xf*/];
192 pszString[22] = s_achDigits[(u >> 8) & 0xf];
193 pszString[23] = '-';
194 pszString[24] = s_achDigits[pUuid->Gen.au8Node[0] >> 4];
195 pszString[25] = s_achDigits[pUuid->Gen.au8Node[0] & 0xf];
196 pszString[26] = s_achDigits[pUuid->Gen.au8Node[1] >> 4];
197 pszString[27] = s_achDigits[pUuid->Gen.au8Node[1] & 0xf];
198 pszString[28] = s_achDigits[pUuid->Gen.au8Node[2] >> 4];
199 pszString[29] = s_achDigits[pUuid->Gen.au8Node[2] & 0xf];
200 pszString[30] = s_achDigits[pUuid->Gen.au8Node[3] >> 4];
201 pszString[31] = s_achDigits[pUuid->Gen.au8Node[3] & 0xf];
202 pszString[32] = s_achDigits[pUuid->Gen.au8Node[4] >> 4];
203 pszString[33] = s_achDigits[pUuid->Gen.au8Node[4] & 0xf];
204 pszString[34] = s_achDigits[pUuid->Gen.au8Node[5] >> 4];
205 pszString[35] = s_achDigits[pUuid->Gen.au8Node[5] & 0xf];
206 pszString[36] = '\0';
207
208 return VINF_SUCCESS;
209}
210
211
212/**
213 * Converts UUID from its string representation to binary format.
214 *
215 * @returns iprt status code.
216 * @param pUuid Where to store result Uuid.
217 * @param pszString String with UUID text data.
218 */
219RTDECL(int) RTUuidFromStr(PRTUUID pUuid, const char *pszString)
220{
221 /* 0xff if not a hex number, otherwise the value. (Assumes UTF-8 encoded strings.) */
222 static const uint8_t s_aDigits[256] =
223 {
224 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 0..0f */
225 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 10..1f */
226 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 20..2f */
227 0x00,0x01,0x02,0x03, 0x04,0x05,0x06,0x07, 0x08,0x09,0xff,0xff, 0xff,0xff,0xff,0xff, /* 30..3f */
228 0xff,0x0a,0x0b,0x0c, 0x0d,0x0e,0x0f,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 40..4f */
229 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 50..5f */
230 0xff,0x0a,0x0b,0x0c, 0x0d,0x0e,0x0f,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 60..6f */
231 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 70..7f */
232 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 80..8f */
233 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* 90..9f */
234 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* a0..af */
235 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* b0..bf */
236 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* c0..cf */
237 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* d0..df */
238 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* e0..ef */
239 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, 0xff,0xff,0xff,0xff, /* f0..ff */
240 };
241
242 /*
243 * Validate parameters.
244 */
245 AssertReturn(pUuid, VERR_INVALID_PARAMETER);
246 AssertReturn(pszString, VERR_INVALID_PARAMETER);
247
248#define MY_CHECK(expr) do { if (RT_UNLIKELY(!(expr))) return VERR_INVALID_UUID_FORMAT; } while (0)
249#define MY_ISXDIGIT(ch) (s_aDigits[(ch) & 0xff] != 0xff)
250 MY_CHECK(MY_ISXDIGIT(pszString[ 0]));
251 MY_CHECK(MY_ISXDIGIT(pszString[ 1]));
252 MY_CHECK(MY_ISXDIGIT(pszString[ 2]));
253 MY_CHECK(MY_ISXDIGIT(pszString[ 3]));
254 MY_CHECK(MY_ISXDIGIT(pszString[ 4]));
255 MY_CHECK(MY_ISXDIGIT(pszString[ 5]));
256 MY_CHECK(MY_ISXDIGIT(pszString[ 6]));
257 MY_CHECK(MY_ISXDIGIT(pszString[ 7]));
258 MY_CHECK(pszString[ 8] == '-');
259 MY_CHECK(MY_ISXDIGIT(pszString[ 9]));
260 MY_CHECK(MY_ISXDIGIT(pszString[10]));
261 MY_CHECK(MY_ISXDIGIT(pszString[11]));
262 MY_CHECK(MY_ISXDIGIT(pszString[12]));
263 MY_CHECK(pszString[13] == '-');
264 MY_CHECK(MY_ISXDIGIT(pszString[14]));
265 MY_CHECK(MY_ISXDIGIT(pszString[15]));
266 MY_CHECK(MY_ISXDIGIT(pszString[16]));
267 MY_CHECK(MY_ISXDIGIT(pszString[17]));
268 MY_CHECK(pszString[18] == '-');
269 MY_CHECK(MY_ISXDIGIT(pszString[19]));
270 MY_CHECK(MY_ISXDIGIT(pszString[20]));
271 MY_CHECK(MY_ISXDIGIT(pszString[21]));
272 MY_CHECK(MY_ISXDIGIT(pszString[22]));
273 MY_CHECK(pszString[23] == '-');
274 MY_CHECK(MY_ISXDIGIT(pszString[24]));
275 MY_CHECK(MY_ISXDIGIT(pszString[25]));
276 MY_CHECK(MY_ISXDIGIT(pszString[26]));
277 MY_CHECK(MY_ISXDIGIT(pszString[27]));
278 MY_CHECK(MY_ISXDIGIT(pszString[28]));
279 MY_CHECK(MY_ISXDIGIT(pszString[29]));
280 MY_CHECK(MY_ISXDIGIT(pszString[30]));
281 MY_CHECK(MY_ISXDIGIT(pszString[31]));
282 MY_CHECK(MY_ISXDIGIT(pszString[32]));
283 MY_CHECK(MY_ISXDIGIT(pszString[33]));
284 MY_CHECK(MY_ISXDIGIT(pszString[34]));
285 MY_CHECK(MY_ISXDIGIT(pszString[35]));
286 MY_CHECK(!pszString[36]);
287#undef MY_ISXDIGIT
288#undef MY_CHECK
289
290 /*
291 * Inverse of RTUuidToStr (see above).
292 */
293#define MY_TONUM(ch) (s_aDigits[(ch) & 0xff])
294 pUuid->Gen.u32TimeLow = (uint32_t)MY_TONUM(pszString[ 0]) << 28
295 | (uint32_t)MY_TONUM(pszString[ 1]) << 24
296 | (uint32_t)MY_TONUM(pszString[ 2]) << 20
297 | (uint32_t)MY_TONUM(pszString[ 3]) << 16
298 | (uint32_t)MY_TONUM(pszString[ 4]) << 12
299 | (uint32_t)MY_TONUM(pszString[ 5]) << 8
300 | (uint32_t)MY_TONUM(pszString[ 6]) << 4
301 | (uint32_t)MY_TONUM(pszString[ 7]);
302 pUuid->Gen.u16TimeMid = (uint16_t)MY_TONUM(pszString[ 9]) << 12
303 | (uint16_t)MY_TONUM(pszString[10]) << 8
304 | (uint16_t)MY_TONUM(pszString[11]) << 4
305 | (uint16_t)MY_TONUM(pszString[12]);
306 pUuid->Gen.u16TimeHiAndVersion =
307 (uint16_t)MY_TONUM(pszString[14]) << 12
308 | (uint16_t)MY_TONUM(pszString[15]) << 8
309 | (uint16_t)MY_TONUM(pszString[16]) << 4
310 | (uint16_t)MY_TONUM(pszString[17]);
311 pUuid->Gen.u16ClockSeq =(uint16_t)MY_TONUM(pszString[19]) << 4
312 | (uint16_t)MY_TONUM(pszString[20])
313 | (uint16_t)MY_TONUM(pszString[21]) << 12
314 | (uint16_t)MY_TONUM(pszString[22]) << 8;
315 pUuid->Gen.au8Node[0] = (uint8_t)MY_TONUM(pszString[24]) << 4
316 | (uint8_t)MY_TONUM(pszString[25]);
317 pUuid->Gen.au8Node[1] = (uint8_t)MY_TONUM(pszString[26]) << 4
318 | (uint8_t)MY_TONUM(pszString[27]);
319 pUuid->Gen.au8Node[2] = (uint8_t)MY_TONUM(pszString[28]) << 4
320 | (uint8_t)MY_TONUM(pszString[29]);
321 pUuid->Gen.au8Node[3] = (uint8_t)MY_TONUM(pszString[30]) << 4
322 | (uint8_t)MY_TONUM(pszString[31]);
323 pUuid->Gen.au8Node[4] = (uint8_t)MY_TONUM(pszString[32]) << 4
324 | (uint8_t)MY_TONUM(pszString[33]);
325 pUuid->Gen.au8Node[5] = (uint8_t)MY_TONUM(pszString[34]) << 4
326 | (uint8_t)MY_TONUM(pszString[35]);
327#undef MY_TONUM
328 return VINF_SUCCESS;
329}
330
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette