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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* 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 _STORE_STORBIOS_HXX_
#define _STORE_STORBIOS_HXX_
#include "sal/types.h"
#include "rtl/ref.hxx"
#include "osl/mutex.hxx"
#include "store/types.h"
#include "object.hxx"
#include "lockbyte.hxx"
#include "storbase.hxx"
#include "storcach.hxx"
/*========================================================================
*
* OStorePageBIOS.
*
*======================================================================*/
namespace store
{
struct SuperBlockPage;
class OStorePageBIOS : public store::OStoreObject
{
public:
/** Construction.
*/
OStorePageBIOS (void);
/** Conversion into Mutex&
*/
inline operator osl::Mutex& (void) const;
/** Initialization.
* @param pLockBytes [in]
* @param eAccessMode [in]
* @param rnPageSize [inout]
* @return store_E_None upon success
*/
virtual storeError initialize (
ILockBytes * pLockBytes,
storeAccessMode eAccessMode,
sal_uInt16 & rnPageSize);
rtl::Reference< PageData::Allocator > & allocator()
{
return m_xAllocator;
}
/** read.
*/
storeError read (
sal_uInt32 nAddr, void *pData, sal_uInt32 nSize);
/** write.
*/
storeError write (
sal_uInt32 nAddr, const void *pData, sal_uInt32 nSize);
/** isWriteable.
*/
inline bool isWriteable (void) const;
/** isValid.
*/
inline sal_Bool isValid (void) const;
/** Page Access.
*/
storeError acquirePage (
const OStorePageDescriptor& rDescr, storeAccessMode eMode);
storeError releasePage (
const OStorePageDescriptor& rDescr, storeAccessMode eMode);
sal_uInt32 getRefererCount (void);
/** Page Allocation.
*/
enum Allocation
{
ALLOCATE_FIRST = 0,
ALLOCATE_BEST = 1,
ALLOCATE_EOF = 2
};
storeError allocate (
OStorePageObject& rPage, Allocation eAllocation = ALLOCATE_FIRST);
storeError free (sal_uInt32 nAddr);
/** Page I/O.
*/
storeError loadObjectAt (
OStorePageObject& rPage, sal_uInt32 nAddr);
storeError saveObjectAt (
OStorePageObject& rPage, sal_uInt32 nAddr);
/** close.
* @return store_E_None upon success.
*/
storeError close (void);
/** flush.
* @return store_E_None upon success.
*/
storeError flush (void);
/** size.
*/
storeError size (sal_uInt32 &rnSize);
/** ScanContext.
*/
struct ScanContext
{
/** Representation.
*/
OStorePageDescriptor m_aDescr;
sal_uInt32 m_nSize;
sal_uInt32 m_nMagic;
/** Construction.
*/
inline ScanContext (void);
/** isValid.
*/
inline bool isValid (void) const;
};
/** scanBegin.
*/
storeError scanBegin (
ScanContext &rCtx,
sal_uInt32 nMagic = 0);
/** scanNext.
*/
storeError scanNext (
ScanContext &rCtx,
OStorePageObject &rPage);
protected:
/** Destruction (OReference).
*/
virtual ~OStorePageBIOS (void);
private:
/** Representation.
*/
rtl::Reference<ILockBytes> m_xLockBytes;
osl::Mutex m_aMutex;
SuperBlockPage * m_pSuper;
bool m_bWriteable;
rtl::Reference< PageData::Allocator > m_xAllocator;
rtl::Reference< PageCache > m_xCache;
/** Page Access (control).
*/
public:
struct Ace
{
Ace * m_next;
Ace * m_prev;
sal_uInt32 m_addr;
sal_uInt32 m_used;
Ace();
~Ace();
static int SAL_CALL constructor (void * obj, void * arg);
static Ace * find (Ace * head, sal_uInt32 addr);
static void insert (Ace * head, Ace * entry);
};
private:
Ace m_ace_head;
class AceCache;
/** Initialization.
*/
storeError initialize_Impl (
ILockBytes * pLockBytes,
storeAccessMode eAccessMode,
sal_uInt16 & rnPageSize);
void cleanup_Impl();
/** Page Maintenance.
*/
storeError loadObjectAt_Impl (
OStorePageObject & rPage, sal_uInt32 nAddr);
storeError saveObjectAt_Impl (
OStorePageObject & rPage, sal_uInt32 nAddr);
/** Not implemented.
*/
OStorePageBIOS (const OStorePageBIOS&);
OStorePageBIOS& operator= (const OStorePageBIOS&);
};
inline OStorePageBIOS::operator osl::Mutex& (void) const
{
return (osl::Mutex&)m_aMutex;
}
inline bool OStorePageBIOS::isWriteable (void) const
{
return m_bWriteable;
}
inline sal_Bool OStorePageBIOS::isValid (void) const
{
return m_xLockBytes.is();
}
inline OStorePageBIOS::ScanContext::ScanContext (void)
: m_aDescr (0, 0, 0), m_nSize (0), m_nMagic (0)
{
}
inline bool OStorePageBIOS::ScanContext::isValid (void) const
{
return (m_aDescr.m_nAddr < m_nSize);
}
/*========================================================================
*
* The End.
*
*======================================================================*/
} // namespace store
#endif /* !_STORE_STORBIOS_HXX_ */
|
