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
|
// oid.h
/* Copyright 2009 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects
* for all of the code used other than as permitted herein. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you do not
* wish to do so, delete this exception statement from your version. If you
* delete this exception statement from all source files in the program,
* then also delete it in the license file.
*/
#pragma once
#include <string>
#include "mongo/bson/util/misc.h"
#include "mongo/util/hex.h"
namespace mongo {
#pragma pack(1)
/** Object ID type.
BSON objects typically have an _id field for the object id. This field should be the first
member of the object when present. class OID is a special type that is a 12 byte id which
is likely to be unique to the system. You may also use other types for _id's.
When _id field is missing from a BSON object, on an insert the database may insert one
automatically in certain circumstances.
Warning: You must call OID::newState() after a fork().
Typical contents of the BSON ObjectID is a 12-byte value consisting of a 4-byte timestamp (seconds since epoch),
a 3-byte machine id, a 2-byte process id, and a 3-byte counter. Note that the timestamp and counter fields must
be stored big endian unlike the rest of BSON. This is because they are compared byte-by-byte and we want to ensure
a mostly increasing order.
*/
class OID {
public:
OID() : a(0), b(0) { }
enum {
kOIDSize = 12,
kIncSize = 3
};
/** init from a 24 char hex string */
explicit OID(const std::string &s) { init(s); }
/** init from a reference to a 12-byte array */
explicit OID(const unsigned char (&arr)[kOIDSize]) {
memcpy(data, arr, sizeof(arr));
}
/** initialize to 'null' */
void clear() { a = 0; b = 0; }
const unsigned char *getData() const { return data; }
bool operator==(const OID& r) const { return a==r.a && b==r.b; }
bool operator!=(const OID& r) const { return a!=r.a || b!=r.b; }
int compare( const OID& other ) const { return memcmp( data , other.data , kOIDSize ); }
bool operator<( const OID& other ) const { return compare( other ) < 0; }
bool operator<=( const OID& other ) const { return compare( other ) <= 0; }
/** @return the object ID output as 24 hex digits */
std::string str() const { return toHexLower(data, kOIDSize); }
std::string toString() const { return str(); }
/** @return the random/sequential part of the object ID as 6 hex digits */
std::string toIncString() const { return toHexLower(_inc, kIncSize); }
static OID gen() { OID o; o.init(); return o; }
/** sets the contents to a new oid / randomized value */
void init();
/** sets the contents to a new oid
* guaranteed to be sequential
* NOT guaranteed to be globally unique
* only unique for this process
* */
void initSequential();
/** init from a 24 char hex string */
void init( const std::string& s );
/** Set to the min/max OID that could be generated at given timestamp. */
void init( Date_t date, bool max=false );
time_t asTimeT();
Date_t asDateT() { return asTimeT() * (long long)1000; }
bool isSet() const { return a || b; }
/**
* this is not consistent
* do not store on disk
*/
void hash_combine(size_t &seed) const;
/** call this after a fork to update the process id */
static void justForked();
static unsigned getMachineId(); // features command uses
static void regenMachineId(); // used by unit tests
private:
struct MachineAndPid {
unsigned char _machineNumber[3];
unsigned short _pid;
bool operator!=(const OID::MachineAndPid& rhs) const;
};
static MachineAndPid ourMachine, ourMachineAndPid;
union {
struct {
// 12 bytes total
unsigned char _time[4];
MachineAndPid _machineAndPid;
unsigned char _inc[3];
};
struct {
long long a;
unsigned b;
};
struct {
// TODO: get rid of this eventually
// this is a hack because of hash_combine with older versions of boost
// on 32-bit platforms
int x;
int y;
int z;
};
unsigned char data[kOIDSize];
};
static void foldInPid(MachineAndPid& x);
static MachineAndPid genMachineAndPid();
};
#pragma pack()
std::ostream& operator<<( std::ostream &s, const OID &o );
inline StringBuilder& operator<< (StringBuilder& s, const OID& o) { return (s << o.str()); }
/** Formatting mode for generating JSON from BSON.
See <http://dochub.mongodb.org/core/mongodbextendedjson>
for details.
*/
enum JsonStringFormat {
/** strict RFC format */
Strict,
/** 10gen format, which is close to JS format. This form is understandable by
javascript running inside the Mongo server via eval() */
TenGen,
/** Javascript JSON compatible */
JS
};
std::ostream& operator<<( std::ostream &s, const OID &o );
}
|
