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
|
/*
* Copyright (C) 2007-2010 Xagasoft, All rights reserved.
*
* This file is part of the libbu++ library and is released under the
* terms of the license contained in the file LICENSE.
*/
#ifndef BU_MYRIAD_H
#define BU_MYRIAD_H
#include <stdint.h>
#include "bu/bitstring.h"
#include "bu/exceptionbase.h"
#include "bu/array.h"
#include "bu/hash.h"
namespace Bu
{
class Stream;
class MyriadStream;
subExceptionDeclBegin( MyriadException )
enum
{
emptyStream,
invalidFormat,
badVersion,
invalidWordSize,
noSuchStream,
streamExists,
invalidStreamId,
protectedStream
};
subExceptionDeclEnd()
/**
* Myriad block-allocated stream multiplexing system. This is a system for
* creating streams that contain other streams in a flexible and lightweight
* manner. Basically, you can create a file (or any other stream) that can
* store any number of flexible, growing streams. The streams within the
* Myriad stream are automatically numbered, not named. This works more
* or less like a filesystem, but without the extra layer for managing
* file and directory links. This would actually be very easy to add
* on top of Myriad, but is not required.
*
* Header format is as follows:
*
* MMMMvBssssSSSS*
* M = Magic number (FFC399BD)
* v = version number
* B = Bits per int
* s = Blocksize in bytes
* S = Number of Streams
*
* The * represents the Stream headers, one per stream, as follows:
* IIIIssss$
* I = Id number of the stream
* s = size of stream in bytes
*
* The $ represents the Block headers, one per used block, as follows:
* IIII
* I = Index of the block
*
* The stream/block data is interleaved in the header, so all blocks stored
* with one stream are together. The block headers are in order, and the
* data in them is required to be "solid" you cannot fill partial blocks
* mid-way through a stream.
*
* The initial block starts with the nids header, and is both the zero block
* and the zero stream. For now, the minimum block size is the size needed
* to store the base header, the zero stream header, and the first two
* blocks of the zero stream, so 30 bytes. Since it's reccomended to use
* a size that will fit evenly into filesystem blocks, then a size of 32 is
* probably the smallest reccomended size because all powers of two equal
* to or greater than 32 are evenly divisible by 32.
*
* I have had a thought that if the block size were smaller than 42 bytes
* the header would consume the first N blocks where N * block size is
* enough space to house the initial header, the first stream header, and
* the first N block headers. This, of course, causes you to hit an
* infinite header if the block size is small enough.
*/
class Myriad
{
friend class MyriadStream;
public:
/**
* Create a Myriad object that uses the given stream to store data.
* This stream must be random access. The block size and preallocate
* values passed in are values that will be used if the given stream
* is empty. In that case the stream will be "formatted" for myriad
* with the specified block size. If there is already a viable Myriad
* format present in the stream, then the blocksize and preallocate
* values will be ignored and the values from the stream will be used
* instead. If the stream doesn't appear to be Myriad formatted an
* exception will be thrown.
*/
Myriad( Bu::Stream &sStore, int iBlockSize=512, int iPreallocate=8 );
virtual ~Myriad();
/**
* Destroy whatever data may be in the base stream and create a new
* Myriad system there with the given blocksize. Use this with care,
* it will destroy anything that was already in the stream, and
* generally, should not ever have to be used.
*/
void initialize( int iBlockSize, int iPreAllocate=1 );
/**
* Create a new stream within the Myriad system. The ID of the new
* stream is returned.
*/
int createStream( int iPreAllocate=1 );
/**
* Create a new stream within the Myriad system with a given id. The
* id that you provide will be the new id of the stream unless it's
* already used, in which case an error is thrown. This is primarilly
* useful when copying an old Myriad file into a new one.
*/
int createStreamWithId( int iId, int iPreAllocate=1 );
/**
* Delete a stream that's already within the Myriad.
*/
void deleteStream( int iId );
/**
* Return a new Stream object assosiated with the given stream ID.
*/
MyriadStream openStream( int iId );
Bu::Array<int> getStreamIds();
int getStreamSize( int iId );
int getNumStreams();
int getBlockSize();
int getNumBlocks();
int getNumUsedBlocks();
/**
* Syncronize the header data, etc. with the storage stream. It's not
* a bad idea to call this periodically.
*/
void sync();
/**
* Read the first few bytes from the given stream and return true/false
* depending on weather or not it's a Myriad stream. This will throw
* an exception if the stream is empty, or is not random access.
*/
static bool isMyriad( Bu::Stream &sStore );
private:
/**
* Initialize this object based on the data already in the assosiated
* stream. This will be called automatically for you if you forget,
* but if you want to pre-initialize for some reason, just call this
* once before you actually start doing anything with your Myriad.
*/
void initialize();
enum
{
blockUnused = 0xFFFFFFFFUL
};
typedef Bu::Array<int> BlockArray;
class Stream
{
public:
int iId;
int iSize;
BlockArray aBlocks;
};
typedef Bu::Array<Stream *> StreamArray;
class Block
{
public:
char *pData;
bool bChanged;
int iBlockIndex;
};
void updateHeader();
int findEmptyBlock();
/**
*@todo Change this to use a binary search, it's nicer.
*/
Stream *findStream( int iId );
Block *getBlock( int iBlock );
void releaseBlock( Block *pBlock );
void syncBlock( Block *pBlock );
int streamAddBlock( Stream *pStream );
void setStreamSize( Stream *pStream, long iSize );
private:
Bu::Stream &sStore;
int iBlockSize;
int iBlocks;
int iUsed;
Bu::BitString bsBlockUsed;
StreamArray aStreams;
typedef Bu::Hash<int, Block *> BlockHash;
BlockHash hActiveBlocks;
bool bHeaderChanged;
};
};
#endif
|
