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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
|
//+---------------------------------------------------------------------------
//
// Microsoft Windows
// Copyright (C) Microsoft Corporation, 1992 - 1992.
//
// File: page.hxx
//
// Contents: Paging classes for MSF
//
// Classes: CMSFPage
// CMSFPageTable
//
// Functions:
//
// History: 28-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
#ifndef __PAGE_HXX__
#define __PAGE_HXX__
class CPagedVector;
#define STG_S_NEWPAGE \
MAKE_SCODE(SEVERITY_SUCCESS, FACILITY_STORAGE, 0x2FF)
#define FB_NONE 0x00000000
#define FB_DIRTY 0x00000001
#define FB_NEW 0x00000002
#define FB_TOUCHED 0x10000000
class CMSFPageTable;
class CMSFPage;
SAFE_DFBASED_PTR(CBasedPagedVectorPtr, CPagedVector);
SAFE_DFBASED_PTR(CBasedMSFPageTablePtr, CMSFPageTable);
SAFE_DFBASED_PTR(CBasedMSFPagePtr, CMSFPage);
//+---------------------------------------------------------------------------
//
// Class: CMSFPage (mp)
//
// Purpose: Contain MSF data in a form that is swappable to disk
//
// Interface: See below.
//
// History: 20-Oct-92 PhilipLa Created
//
// Notes:
//
//----------------------------------------------------------------------------
#ifndef REF
#if _MSC_VER == 700
#pragma warning(disable:4001)
#elif _MSC_VER >= 800
#pragma warning(disable:4200)
#endif
#endif //!REF
class CMSFPage : public CMallocBased
{
public:
void * operator new(size_t size, IMalloc * const pMalloc,
size_t sizeData);
#if DBG == 1
CMSFPage(CMSFPage *pmpNext, CMSFPageTable *pmpt);
#else
CMSFPage(CMSFPage *pmpNext);
#endif
inline ~CMSFPage();
inline void AddRef(void);
inline void Release(void);
inline CMSFPage *GetNext(void) const;
inline CMSFPage *GetPrev(void) const;
inline SID GetSid(void) const;
inline ULONG GetOffset(void) const;
inline SECT GetSect(void) const;
inline void *GetData(void) const;
inline DWORD GetFlags(void) const;
inline CPagedVector * GetVector(void) const;
inline void Remove(void);
inline void SetChain(CMSFPage *const pmpPrev,
CMSFPage *const pmpNext);
inline void SetPrev(CMSFPage *const pmpPrev);
inline void SetNext(CMSFPage *const pmpNext);
inline void SetSid(const SID sid);
inline void SetOffset(const ULONG ulOffset);
#ifndef SORTPAGETABLE
inline void SetSect(const SECT sect);
#endif
inline void SetFlags(const DWORD dwFlags);
inline void SetVector(CPagedVector *ppv);
inline void SetDirty(void);
inline void ResetDirty(void);
inline BOOL IsDirty(void) const;
inline BOOL IsInUse(void) const;
inline BOOL IsFlushable(void) const;
private:
#ifdef SORTPAGETABLE
friend CMSFPageTable;
inline void SetSect(const SECT sect);
#endif
CBasedMSFPagePtr _pmpNext;
CBasedMSFPagePtr _pmpPrev;
#if DBG == 1
CBasedMSFPageTablePtr _pmpt;
#endif
SID _sid;
ULONG _ulOffset;
CBasedPagedVectorPtr _ppv;
SECT _sect;
DWORD _dwFlags;
LONG _cReferences;
BYTE _ab[];
};
SAFE_DFBASED_PTR(CBasedMSFPagePtrPtr, CBasedMSFPagePtr);
#ifndef REF
#if _MSC_VER == 700
#pragma warning(default:4001)
#elif _MSC_VER >= 800
#pragma warning(default:4200)
#endif
#endif //!REF
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::~CMSFPage, public
//
// Synopsis: Destructor
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
#ifdef CODESEGMENTS
#pragma code_seg(SEG_CMSFPage_1CMSFPage)
#endif
inline CMSFPage::~CMSFPage()
{
msfAssert(_cReferences == 0);
Remove();
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::Remove, public
//
// Synopsis: Remove page from list
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::Remove(void)
{
//Avoid using SetNext and SetPrev so we don't need to unbase and
// then rebase everything.
_pmpPrev->_pmpNext = _pmpNext;
_pmpNext->_pmpPrev = _pmpPrev;
_pmpNext = _pmpPrev = NULL;
}
#ifdef CODESEGMENTS
#pragma code_seg()
#endif
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::operator new, public
//
// Synopsis: Overloaded new operator for CMSFPage.
//
// Arguments: [size] -- Default size field
// [pMalloc] -- Allocator
// [sizeData] -- Size of byte array to allocate.
//
// Returns: Pointer to new CMSFPage object
//
// History: 20-Oct-92 PhilipLa Created
// 21-May-93 AlexT Added allocator
//
// Notes: *Finish This*
//
//----------------------------------------------------------------------------
inline void * CMSFPage::operator new(size_t size, IMalloc * const pMalloc,
size_t sizeData)
{
msfAssert(size == sizeof(CMSFPage));
return(CMallocBased::operator new(sizeData + sizeof(CMSFPage), pMalloc));
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetNext, public
//
// Synopsis: Returns the next page in the list
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline CMSFPage * CMSFPage::GetNext(void) const
{
return BP_TO_P(CMSFPage *, _pmpNext);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetPrev, public
//
// Synopsis: Returns the next page in the list
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline CMSFPage * CMSFPage::GetPrev(void) const
{
return BP_TO_P(CMSFPage *, _pmpPrev);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetSid, public
//
// Synopsis: Returns the SID for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline SID CMSFPage::GetSid(void) const
{
return _sid;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetOffset, public
//
// Synopsis: Returns the array offset for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline ULONG CMSFPage::GetOffset(void) const
{
return _ulOffset;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetSect, public
//
// Synopsis: Returns the SECT for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline SECT CMSFPage::GetSect(void) const
{
return _sect;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetFlags, public
//
// Synopsis: Returns the flags for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline DWORD CMSFPage::GetFlags(void) const
{
return _dwFlags;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetData, public
//
// Synopsis: Returns a pointer to the page storage for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void * CMSFPage::GetData(void) const
{
return (void *) _ab;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::GetVector, public
//
// Synopsis: Returns a pointer to the vector holding this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline CPagedVector * CMSFPage::GetVector(void) const
{
return BP_TO_P(CPagedVector *, _ppv);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetChain, public
//
// Synopsis: Sets the chain pointers for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetChain(
CMSFPage *const pmpPrev,
CMSFPage *const pmpNext)
{
_pmpPrev = P_TO_BP(CBasedMSFPagePtr, pmpPrev);
_pmpNext = P_TO_BP(CBasedMSFPagePtr, pmpNext);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetPrev, public
//
// Synopsis: Sets the prev pointer for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetPrev(CMSFPage *const pmpPrev)
{
_pmpPrev = P_TO_BP(CBasedMSFPagePtr, pmpPrev);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetNext, public
//
// Synopsis: Sets the next pointer for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetNext(CMSFPage *const pmpNext)
{
_pmpNext = P_TO_BP(CBasedMSFPagePtr, pmpNext);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetSid, public
//
// Synopsis: Sets the SID for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetSid(const SID sid)
{
_sid = sid;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetOffset, public
//
// Synopsis: Sets the offset for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetOffset(const ULONG ulOffset)
{
_ulOffset = ulOffset;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetSect, public
//
// Synopsis: Sets the SECT for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
#ifndef SORTPAGETABLE
inline void CMSFPage::SetSect(const SECT sect)
{
_sect = sect;
}
#endif
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetFlags, public
//
// Synopsis: Sets the flags for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetFlags(const DWORD dwFlags)
{
_dwFlags = dwFlags;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetVector, public
//
// Synopsis: Sets the pointer to the vector holding this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetVector(CPagedVector *ppv)
{
_ppv = P_TO_BP(CBasedPagedVectorPtr, ppv);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::SetDirty, public
//
// Synopsis: Sets the dirty bit for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::SetDirty(void)
{
_dwFlags = _dwFlags | FB_DIRTY;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::ResetDirty, public
//
// Synopsis: Resets the dirty bit for this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::ResetDirty(void)
{
_dwFlags = _dwFlags & ~FB_DIRTY;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::IsDirty, public
//
// Synopsis: Returns TRUE if the dirty bit is set on this page
//
// History: 20-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline BOOL CMSFPage::IsDirty(void) const
{
return (_dwFlags & FB_DIRTY) != 0;
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::IsInUse, public
//
// Synopsis: Returns TRUE if the page is currently in use
//
// History: 05-Nov-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline BOOL CMSFPage::IsInUse(void) const
{
return (_cReferences != 0);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::IsFlushable, public
//
// Synopsis: Returns TRUE if the page can be flushed to disk
//
// History: 05-Nov-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline BOOL CMSFPage::IsFlushable(void) const
{
return (IsDirty() && !IsInUse());
}
//+---------------------------------------------------------------------------
//
// Class: CMSFPageTable
//
// Purpose: Page allocator and handler for MSF
//
// Interface: See below
//
// History: 20-Oct-92 PhilipLa Created
//
// Notes:
//
//----------------------------------------------------------------------------
class CMSFPageTable : public CMallocBased
{
public:
CMSFPageTable(
CMStream *const pmsParent,
const ULONG _cMinPages,
const ULONG _cMaxPages);
~CMSFPageTable();
inline void AddRef();
inline void Release();
SCODE Init(void);
SCODE GetPage(
CPagedVector *ppv,
SID sid,
ULONG ulOffset,
SECT sectKnown,
CMSFPage **ppmp);
#ifndef REF
SCODE CopyPage(
CPagedVector *ppv,
CMSFPage *pmpOld,
CBasedMSFPagePtr *ppmp);
#endif //!REF
SCODE FindPage(
CPagedVector *ppv,
SID sid,
ULONG ulOffset,
CMSFPage **ppmp);
SCODE GetFreePage(CMSFPage **ppmp);
void ReleasePage(CPagedVector *ppv, SID sid, ULONG ulOffset);
void FreePages(CPagedVector *ppv);
#ifdef SORTPAGETABLE
void SetSect(CMSFPage *pmp, SECT sect);
#endif
SCODE Flush(void);
SCODE FlushPage(CMSFPage *pmp);
inline void SetParent(CMStream *pms);
#if DBG == 1
void AddPageRef(void);
void ReleasePageRef(void);
#endif
private:
inline CMSFPage * GetNewPage(void);
CMSFPage * FindSwapPage(void);
CBasedMStreamPtr _pmsParent;
const ULONG _cbSector;
const ULONG _cMinPages;
const ULONG _cMaxPages;
ULONG _cActivePages;
ULONG _cPages;
CBasedMSFPagePtr _pmpCurrent;
#ifdef SORTPAGETABLE
CBasedMSFPagePtr _pmpStart;
inline BOOL IsSorted(CMSFPage *pmp);
#endif
LONG _cReferences;
#if DBG == 1
ULONG _cCurrentPageRef;
ULONG _cMaxPageRef;
#endif
};
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::AddRef, public
//
// Synopsis: Increment the reference count
//
// History: 28-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::AddRef(void)
{
msfAssert(_cReferences >= 0);
#if DBG == 1
if (_cReferences == 0)
{
_pmpt->AddPageRef();
}
#endif
AtomicInc(&_cReferences);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPage::Release, public
//
// Synopsis: Decrement the reference count
//
// History: 28-Oct-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPage::Release(void)
{
LONG lRet;
msfAssert(_cReferences > 0);
lRet = AtomicDec(&_cReferences);
#if DBG == 1
if (lRet == 0)
{
_pmpt->ReleasePageRef();
}
#endif
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPageTable::AddRef, public
//
// Synopsis: Increment the ref coutn
//
// History: 05-Nov-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPageTable::AddRef(void)
{
AtomicInc(&_cReferences);
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPageTable::Release, public
//
// Synopsis: Decrement the ref count, delete if necessary
//
// History: 05-Nov-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPageTable::Release(void)
{
LONG lRet;
msfAssert(_cReferences > 0);
lRet = AtomicDec(&_cReferences);
if (lRet == 0)
{
delete this;
}
}
//+---------------------------------------------------------------------------
//
// Member: CMSFPageTable::SetParent, public
//
// Synopsis: Set the parent of this page table
//
// Arguments: [pms] -- Pointer to new parent
//
// History: 05-Nov-92 PhilipLa Created
//
//----------------------------------------------------------------------------
inline void CMSFPageTable::SetParent(CMStream *pms)
{
_pmsParent = P_TO_BP(CBasedMStreamPtr, pms);
}
#endif // #ifndef __PAGE_HXX__
|
