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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_UUID_H_
#define _RTL_UUID_H_
#include <sal/types.h>
#include <rtl/string.h>
/**
@HTML
@file
Specification (from draft-leach-uuids-guids-01.txt )
<p>
A UUID is an identifier that is unique across both space and time,
with respect to the space of all UUIDs. To be precise, the UUID
consists of a finite bit space. Thus, collision cannot be avoided in
principle. A UUID can be used for multiple purposes, from tagging objects
with an extremely short lifetime, to reliably identifying very persistent
objects across a network.
<p>
The generation of UUIDs does not require that a registration
authority be contacted for each identifier. Instead, Version 4 UUIDs are
generated from (pseudo unique) sequences of (pseudo) random bits.
*/
#ifdef __cplusplus
extern "C" {
#endif
/** Generates a new Version 4 (random number based) UUID (Universally Unique
IDentifier).
@param pTargetUUID pointer to at least 16 bytes of memory. After the call it contains
the newly generated uuid in network byte order.
@param pPredecessorUUID ignored (was used when this function returned
Version 1 instead of Version 4 UUIDs).
@param bUseEthernetAddress ignored (was used when this function returned
Version 1 instead of Version 4 UUIDs).
*/
void SAL_CALL rtl_createUuid( sal_uInt8 *pTargetUUID ,
const sal_uInt8 *pPredecessorUUID,
sal_Bool bUseEthernetAddress );
/** Compare two UUID's lexically
<p>
Note: lexical ordering is not temporal ordering!
<p>
Note: For equalnesschecking, a memcmp(pUUID1,pUUID2,16) is more efficient
@return
<ul>
<li>-1 u1 is lexically before u2
<li>0 u1 is equal to u2
<li>1 u1 is lexically after u2
</ul>
*/
sal_Int32 SAL_CALL rtl_compareUuid( const sal_uInt8 *pUUID1 , const sal_uInt8 *pUUID2 );
/** Creates named UUIDs.
<p>
The version 3 UUID is meant for generating UUIDs from <em>names</em> that
are drawn from, and unique within, some <em>name space</em>. Some examples
of names (and, implicitly, name spaces) might be DNS names, URLs, ISO
Object IDs (OIDs), reserved words in a programming language, or X.500
Distinguished Names (DNs); thus, the concept of name and name space
should be broadly construed, and not limited to textual names.
<p>
The requirements for such UUIDs are as follows:
<ul>
<li> The UUIDs generated at different times from the same name in the
same namespace MUST be equal
<li> The UUIDs generated from two different names in the same namespace
should be different (with very high probability)
<li> The UUIDs generated from the same name in two different namespaces
should be different with (very high probability)
<li> If two UUIDs that were generated from names are equal, then they
were generated from the same name in the same namespace (with very
high probability).
</ul>
@param pTargetUUID pointer to at least 16 bytes of memory. After the call
it contains the newly generated uuid in network byte order.
@param pNameSpaceUUID The namespace uuid. Below are some predefined ones,
but any arbitray uuid can be used as namespace.
@param pName the name
*/
void SAL_CALL rtl_createNamedUuid(
sal_uInt8 *pTargetUUID,
const sal_uInt8 *pNameSpaceUUID,
const rtl_String *pName
);
/*
Predefined Namespaces
(Use them the following way : sal_uInt8 aNsDNS[16]) = RTL_UUID_NAMESPACE_DNS;
*/
/** namesapce DNS
<p>
(Use them the following way : sal_uInt8 aNsDNS[16]) = RTL_UUID_NAMESPACE_DNS;
<p>
6ba7b810-9dad-11d1-80b4-00c04fd430c8 */
#define RTL_UUID_NAMESPACE_DNS {\
0x6b,0xa7,0xb8,0x10,\
0x9d,0xad,\
0x11,0xd1,\
0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8\
}
/** namespace URL
<p>
6ba7b811-9dad-11d1-80b4-00c04fd430c8 */
#define RTL_UUID_NAMESPACE_URL { \
0x6b, 0xa7, 0xb8, 0x11,\
0x9d, 0xad,\
0x11, 0xd1,\
0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8\
}
/** namespace oid
<p>
6ba7b812-9dad-11d1-80b4-00c04fd430c8 */
#define RTL_UUID_NAMESPACE_OID {\
0x6b, 0xa7, 0xb8, 0x12,\
0x9d, 0xad,\
0x11, 0xd1,\
0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8\
}
/** namespace X500
<p>
6ba7b814-9dad-11d1-80b4-00c04fd430c8 */
#define RTL_UUID_NAMESPACE_X500 {\
0x6b, 0xa7, 0xb8, 0x14,\
0x9d, 0xad,\
0x11, 0xd1,\
0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8\
}
/*
This macro must have a value below the system time resolution of the
system. The uuid routines use this value as an upper limit for adding ticks to the
the predecessor time value if system times are equal.
*/
#ifdef SAL_W32
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 1000
#elif defined SAL_OS2 // YD we use posix functions for time
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 10
#elif LINUX
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 10
#elif NETBSD
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 10
#elif FREEBSD
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 10
#elif SOLARIS
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 10
#elif MACOSX
#define UUID_SYSTEM_TIME_RESOLUTION_100NS_TICKS 100000
#else
#error "System time resolution must be calculated!"
#endif
#ifdef __cplusplus
}
#endif
#endif
|
