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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
|
/*
** 2007 September 14
**
** The author disclaims copyright to this source code. In place of
** a legal notice, here is a blessing:
**
** May you do good and not evil.
** May you find forgiveness for yourself and forgive others.
** May you share freely, never taking more than you give.
**
*************************************************************************
**
** OVERVIEW:
**
** This file contains some example code demonstrating how the SQLite
** vfs feature can be used to have SQLite operate directly on an
** embedded media, without using an intermediate file system.
**
** Because this is only a demo designed to run on a workstation, the
** underlying media is simulated using a regular file-system file. The
** size of the file is fixed when it is first created (default size 10 MB).
** From SQLite's point of view, this space is used to store a single
** database file and the journal file.
**
** Any statement journal created is stored in volatile memory obtained
** from sqlite3_malloc(). Any attempt to create a temporary database file
** will fail (SQLITE_IOERR). To prevent SQLite from attempting this,
** it should be configured to store all temporary database files in
** main memory (see pragma "temp_store" or the SQLITE_TEMP_STORE compile
** time option).
**
** ASSUMPTIONS:
**
** After it has been created, the blob file is accessed using the
** following three functions only:
**
** mediaRead(); - Read a 512 byte block from the file.
** mediaWrite(); - Write a 512 byte block to the file.
** mediaSync(); - Tell the media hardware to sync.
**
** It is assumed that these can be easily implemented by any "real"
** media vfs driver adapting this code.
**
** FILE FORMAT:
**
** The basic principle is that the "database file" is stored at the
** beginning of the 10 MB blob and grows in a forward direction. The
** "journal file" is stored at the end of the 10MB blob and grows
** in the reverse direction. If, during a transaction, insufficient
** space is available to expand either the journal or database file,
** an SQLITE_FULL error is returned. The database file is never allowed
** to consume more than 90% of the blob space. If SQLite tries to
** create a file larger than this, SQLITE_FULL is returned.
**
** No allowance is made for "wear-leveling", as is required by.
** embedded devices in the absence of equivalent hardware features.
**
** The first 512 block byte of the file is reserved for storing the
** size of the "database file". It is updated as part of the sync()
** operation. On startup, it can only be trusted if no journal file
** exists. If a journal-file does exist, then it stores the real size
** of the database region. The second and subsequent blocks store the
** actual database content.
**
** The size of the "journal file" is not stored persistently in the
** file. When the system is running, the size of the journal file is
** stored in volatile memory. When recovering from a crash, this vfs
** reports a very large size for the journal file. The normal journal
** header and checksum mechanisms serve to prevent SQLite from
** processing any data that lies past the logical end of the journal.
**
** When SQLite calls OsDelete() to delete the journal file, the final
** 512 bytes of the blob (the area containing the first journal header)
** are zeroed.
**
** LOCKING:
**
** File locking is a no-op. Only one connection may be open at any one
** time using this demo vfs.
*/
#include "sqlite3.h"
#include <assert.h>
#include <string.h>
/*
** Maximum pathname length supported by the fs backend.
*/
#define BLOCKSIZE 512
#define BLOBSIZE 10485760
/*
** Name used to identify this VFS.
*/
#define FS_VFS_NAME "fs"
typedef struct fs_real_file fs_real_file;
struct fs_real_file {
sqlite3_file *pFile;
const char *zName;
int nDatabase; /* Current size of database region */
int nJournal; /* Current size of journal region */
int nBlob; /* Total size of allocated blob */
int nRef; /* Number of pointers to this structure */
fs_real_file *pNext;
fs_real_file **ppThis;
};
typedef struct fs_file fs_file;
struct fs_file {
sqlite3_file base;
int eType;
fs_real_file *pReal;
};
typedef struct tmp_file tmp_file;
struct tmp_file {
sqlite3_file base;
int nSize;
int nAlloc;
char *zAlloc;
};
/* Values for fs_file.eType. */
#define DATABASE_FILE 1
#define JOURNAL_FILE 2
/*
** Method declarations for fs_file.
*/
static int fsClose(sqlite3_file*);
static int fsRead(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
static int fsWrite(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
static int fsTruncate(sqlite3_file*, sqlite3_int64 size);
static int fsSync(sqlite3_file*, int flags);
static int fsFileSize(sqlite3_file*, sqlite3_int64 *pSize);
static int fsLock(sqlite3_file*, int);
static int fsUnlock(sqlite3_file*, int);
static int fsCheckReservedLock(sqlite3_file*, int *pResOut);
static int fsFileControl(sqlite3_file*, int op, void *pArg);
static int fsSectorSize(sqlite3_file*);
static int fsDeviceCharacteristics(sqlite3_file*);
/*
** Method declarations for tmp_file.
*/
static int tmpClose(sqlite3_file*);
static int tmpRead(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
static int tmpWrite(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
static int tmpTruncate(sqlite3_file*, sqlite3_int64 size);
static int tmpSync(sqlite3_file*, int flags);
static int tmpFileSize(sqlite3_file*, sqlite3_int64 *pSize);
static int tmpLock(sqlite3_file*, int);
static int tmpUnlock(sqlite3_file*, int);
static int tmpCheckReservedLock(sqlite3_file*, int *pResOut);
static int tmpFileControl(sqlite3_file*, int op, void *pArg);
static int tmpSectorSize(sqlite3_file*);
static int tmpDeviceCharacteristics(sqlite3_file*);
/*
** Method declarations for fs_vfs.
*/
static int fsOpen(sqlite3_vfs*, const char *, sqlite3_file*, int , int *);
static int fsDelete(sqlite3_vfs*, const char *zName, int syncDir);
static int fsAccess(sqlite3_vfs*, const char *zName, int flags, int *);
static int fsFullPathname(sqlite3_vfs*, const char *zName, int nOut,char *zOut);
static void *fsDlOpen(sqlite3_vfs*, const char *zFilename);
static void fsDlError(sqlite3_vfs*, int nByte, char *zErrMsg);
static void (*fsDlSym(sqlite3_vfs*,void*, const char *zSymbol))(void);
static void fsDlClose(sqlite3_vfs*, void*);
static int fsRandomness(sqlite3_vfs*, int nByte, char *zOut);
static int fsSleep(sqlite3_vfs*, int microseconds);
static int fsCurrentTime(sqlite3_vfs*, double*);
typedef struct fs_vfs_t fs_vfs_t;
struct fs_vfs_t {
sqlite3_vfs base;
fs_real_file *pFileList;
sqlite3_vfs *pParent;
};
static fs_vfs_t fs_vfs = {
{
1, /* iVersion */
0, /* szOsFile */
0, /* mxPathname */
0, /* pNext */
FS_VFS_NAME, /* zName */
0, /* pAppData */
fsOpen, /* xOpen */
fsDelete, /* xDelete */
fsAccess, /* xAccess */
fsFullPathname, /* xFullPathname */
fsDlOpen, /* xDlOpen */
fsDlError, /* xDlError */
fsDlSym, /* xDlSym */
fsDlClose, /* xDlClose */
fsRandomness, /* xRandomness */
fsSleep, /* xSleep */
fsCurrentTime, /* xCurrentTime */
0 /* xCurrentTimeInt64 */
},
0, /* pFileList */
0 /* pParent */
};
static sqlite3_io_methods fs_io_methods = {
1, /* iVersion */
fsClose, /* xClose */
fsRead, /* xRead */
fsWrite, /* xWrite */
fsTruncate, /* xTruncate */
fsSync, /* xSync */
fsFileSize, /* xFileSize */
fsLock, /* xLock */
fsUnlock, /* xUnlock */
fsCheckReservedLock, /* xCheckReservedLock */
fsFileControl, /* xFileControl */
fsSectorSize, /* xSectorSize */
fsDeviceCharacteristics, /* xDeviceCharacteristics */
0, /* xShmMap */
0, /* xShmLock */
0, /* xShmBarrier */
0 /* xShmUnmap */
};
static sqlite3_io_methods tmp_io_methods = {
1, /* iVersion */
tmpClose, /* xClose */
tmpRead, /* xRead */
tmpWrite, /* xWrite */
tmpTruncate, /* xTruncate */
tmpSync, /* xSync */
tmpFileSize, /* xFileSize */
tmpLock, /* xLock */
tmpUnlock, /* xUnlock */
tmpCheckReservedLock, /* xCheckReservedLock */
tmpFileControl, /* xFileControl */
tmpSectorSize, /* xSectorSize */
tmpDeviceCharacteristics, /* xDeviceCharacteristics */
0, /* xShmMap */
0, /* xShmLock */
0, /* xShmBarrier */
0 /* xShmUnmap */
};
/* Useful macros used in several places */
#define MIN(x,y) ((x)<(y)?(x):(y))
#define MAX(x,y) ((x)>(y)?(x):(y))
/*
** Close a tmp-file.
*/
static int tmpClose(sqlite3_file *pFile){
tmp_file *pTmp = (tmp_file *)pFile;
sqlite3_free(pTmp->zAlloc);
return SQLITE_OK;
}
/*
** Read data from a tmp-file.
*/
static int tmpRead(
sqlite3_file *pFile,
void *zBuf,
int iAmt,
sqlite_int64 iOfst
){
tmp_file *pTmp = (tmp_file *)pFile;
if( (iAmt+iOfst)>pTmp->nSize ){
return SQLITE_IOERR_SHORT_READ;
}
memcpy(zBuf, &pTmp->zAlloc[iOfst], iAmt);
return SQLITE_OK;
}
/*
** Write data to a tmp-file.
*/
static int tmpWrite(
sqlite3_file *pFile,
const void *zBuf,
int iAmt,
sqlite_int64 iOfst
){
tmp_file *pTmp = (tmp_file *)pFile;
if( (iAmt+iOfst)>pTmp->nAlloc ){
int nNew = (int)(2*(iAmt+iOfst+pTmp->nAlloc));
char *zNew = sqlite3_realloc(pTmp->zAlloc, nNew);
if( !zNew ){
return SQLITE_NOMEM;
}
pTmp->zAlloc = zNew;
pTmp->nAlloc = nNew;
}
memcpy(&pTmp->zAlloc[iOfst], zBuf, iAmt);
pTmp->nSize = (int)MAX(pTmp->nSize, iOfst+iAmt);
return SQLITE_OK;
}
/*
** Truncate a tmp-file.
*/
static int tmpTruncate(sqlite3_file *pFile, sqlite_int64 size){
tmp_file *pTmp = (tmp_file *)pFile;
pTmp->nSize = (int)MIN(pTmp->nSize, size);
return SQLITE_OK;
}
/*
** Sync a tmp-file.
*/
static int tmpSync(sqlite3_file *pFile, int flags){
return SQLITE_OK;
}
/*
** Return the current file-size of a tmp-file.
*/
static int tmpFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
tmp_file *pTmp = (tmp_file *)pFile;
*pSize = pTmp->nSize;
return SQLITE_OK;
}
/*
** Lock a tmp-file.
*/
static int tmpLock(sqlite3_file *pFile, int eLock){
return SQLITE_OK;
}
/*
** Unlock a tmp-file.
*/
static int tmpUnlock(sqlite3_file *pFile, int eLock){
return SQLITE_OK;
}
/*
** Check if another file-handle holds a RESERVED lock on a tmp-file.
*/
static int tmpCheckReservedLock(sqlite3_file *pFile, int *pResOut){
*pResOut = 0;
return SQLITE_OK;
}
/*
** File control method. For custom operations on a tmp-file.
*/
static int tmpFileControl(sqlite3_file *pFile, int op, void *pArg){
return SQLITE_OK;
}
/*
** Return the sector-size in bytes for a tmp-file.
*/
static int tmpSectorSize(sqlite3_file *pFile){
return 0;
}
/*
** Return the device characteristic flags supported by a tmp-file.
*/
static int tmpDeviceCharacteristics(sqlite3_file *pFile){
return 0;
}
/*
** Close an fs-file.
*/
static int fsClose(sqlite3_file *pFile){
int rc = SQLITE_OK;
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
/* Decrement the real_file ref-count. */
pReal->nRef--;
assert(pReal->nRef>=0);
/* When the ref-count reaches 0, destroy the structure */
if( pReal->nRef==0 ){
*pReal->ppThis = pReal->pNext;
if( pReal->pNext ){
pReal->pNext->ppThis = pReal->ppThis;
}
rc = pReal->pFile->pMethods->xClose(pReal->pFile);
sqlite3_free(pReal);
}
return rc;
}
/*
** Read data from an fs-file.
*/
static int fsRead(
sqlite3_file *pFile,
void *zBuf,
int iAmt,
sqlite_int64 iOfst
){
int rc = SQLITE_OK;
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
sqlite3_file *pF = pReal->pFile;
if( (p->eType==DATABASE_FILE && (iAmt+iOfst)>pReal->nDatabase)
|| (p->eType==JOURNAL_FILE && (iAmt+iOfst)>pReal->nJournal)
){
rc = SQLITE_IOERR_SHORT_READ;
}else if( p->eType==DATABASE_FILE ){
rc = pF->pMethods->xRead(pF, zBuf, iAmt, iOfst+BLOCKSIZE);
}else{
/* Journal file. */
int iRem = iAmt;
int iBuf = 0;
int ii = (int)iOfst;
while( iRem>0 && rc==SQLITE_OK ){
int iRealOff = pReal->nBlob - BLOCKSIZE*((ii/BLOCKSIZE)+1) + ii%BLOCKSIZE;
int iRealAmt = MIN(iRem, BLOCKSIZE - (iRealOff%BLOCKSIZE));
rc = pF->pMethods->xRead(pF, &((char *)zBuf)[iBuf], iRealAmt, iRealOff);
ii += iRealAmt;
iBuf += iRealAmt;
iRem -= iRealAmt;
}
}
return rc;
}
/*
** Write data to an fs-file.
*/
static int fsWrite(
sqlite3_file *pFile,
const void *zBuf,
int iAmt,
sqlite_int64 iOfst
){
int rc = SQLITE_OK;
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
sqlite3_file *pF = pReal->pFile;
if( p->eType==DATABASE_FILE ){
if( (iAmt+iOfst+BLOCKSIZE)>(pReal->nBlob-pReal->nJournal) ){
rc = SQLITE_FULL;
}else{
rc = pF->pMethods->xWrite(pF, zBuf, iAmt, iOfst+BLOCKSIZE);
if( rc==SQLITE_OK ){
pReal->nDatabase = (int)MAX(pReal->nDatabase, iAmt+iOfst);
}
}
}else{
/* Journal file. */
int iRem = iAmt;
int iBuf = 0;
int ii = (int)iOfst;
while( iRem>0 && rc==SQLITE_OK ){
int iRealOff = pReal->nBlob - BLOCKSIZE*((ii/BLOCKSIZE)+1) + ii%BLOCKSIZE;
int iRealAmt = MIN(iRem, BLOCKSIZE - (iRealOff%BLOCKSIZE));
if( iRealOff<(pReal->nDatabase+BLOCKSIZE) ){
rc = SQLITE_FULL;
}else{
rc = pF->pMethods->xWrite(pF, &((char *)zBuf)[iBuf], iRealAmt,iRealOff);
ii += iRealAmt;
iBuf += iRealAmt;
iRem -= iRealAmt;
}
}
if( rc==SQLITE_OK ){
pReal->nJournal = (int)MAX(pReal->nJournal, iAmt+iOfst);
}
}
return rc;
}
/*
** Truncate an fs-file.
*/
static int fsTruncate(sqlite3_file *pFile, sqlite_int64 size){
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
if( p->eType==DATABASE_FILE ){
pReal->nDatabase = (int)MIN(pReal->nDatabase, size);
}else{
pReal->nJournal = (int)MIN(pReal->nJournal, size);
}
return SQLITE_OK;
}
/*
** Sync an fs-file.
*/
static int fsSync(sqlite3_file *pFile, int flags){
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
sqlite3_file *pRealFile = pReal->pFile;
int rc = SQLITE_OK;
if( p->eType==DATABASE_FILE ){
unsigned char zSize[4];
zSize[0] = (pReal->nDatabase&0xFF000000)>>24;
zSize[1] = (unsigned char)((pReal->nDatabase&0x00FF0000)>>16);
zSize[2] = (pReal->nDatabase&0x0000FF00)>>8;
zSize[3] = (pReal->nDatabase&0x000000FF);
rc = pRealFile->pMethods->xWrite(pRealFile, zSize, 4, 0);
}
if( rc==SQLITE_OK ){
rc = pRealFile->pMethods->xSync(pRealFile, flags&(~SQLITE_SYNC_DATAONLY));
}
return rc;
}
/*
** Return the current file-size of an fs-file.
*/
static int fsFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = p->pReal;
if( p->eType==DATABASE_FILE ){
*pSize = pReal->nDatabase;
}else{
*pSize = pReal->nJournal;
}
return SQLITE_OK;
}
/*
** Lock an fs-file.
*/
static int fsLock(sqlite3_file *pFile, int eLock){
return SQLITE_OK;
}
/*
** Unlock an fs-file.
*/
static int fsUnlock(sqlite3_file *pFile, int eLock){
return SQLITE_OK;
}
/*
** Check if another file-handle holds a RESERVED lock on an fs-file.
*/
static int fsCheckReservedLock(sqlite3_file *pFile, int *pResOut){
*pResOut = 0;
return SQLITE_OK;
}
/*
** File control method. For custom operations on an fs-file.
*/
static int fsFileControl(sqlite3_file *pFile, int op, void *pArg){
if( op==SQLITE_FCNTL_PRAGMA ) return SQLITE_NOTFOUND;
return SQLITE_OK;
}
/*
** Return the sector-size in bytes for an fs-file.
*/
static int fsSectorSize(sqlite3_file *pFile){
return BLOCKSIZE;
}
/*
** Return the device characteristic flags supported by an fs-file.
*/
static int fsDeviceCharacteristics(sqlite3_file *pFile){
return 0;
}
/*
** Open an fs file handle.
*/
static int fsOpen(
sqlite3_vfs *pVfs,
const char *zName,
sqlite3_file *pFile,
int flags,
int *pOutFlags
){
fs_vfs_t *pFsVfs = (fs_vfs_t *)pVfs;
fs_file *p = (fs_file *)pFile;
fs_real_file *pReal = 0;
int eType;
int nName;
int rc = SQLITE_OK;
if( 0==(flags&(SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_MAIN_JOURNAL)) ){
tmp_file *p2 = (tmp_file *)pFile;
memset(p2, 0, sizeof(*p2));
p2->base.pMethods = &tmp_io_methods;
return SQLITE_OK;
}
eType = ((flags&(SQLITE_OPEN_MAIN_DB))?DATABASE_FILE:JOURNAL_FILE);
p->base.pMethods = &fs_io_methods;
p->eType = eType;
assert(strlen("-journal")==8);
nName = (int)strlen(zName)-((eType==JOURNAL_FILE)?8:0);
pReal=pFsVfs->pFileList;
for(; pReal && strncmp(pReal->zName, zName, nName); pReal=pReal->pNext);
if( !pReal ){
int real_flags = (flags&~(SQLITE_OPEN_MAIN_DB))|SQLITE_OPEN_TEMP_DB;
sqlite3_int64 size;
sqlite3_file *pRealFile;
sqlite3_vfs *pParent = pFsVfs->pParent;
assert(eType==DATABASE_FILE);
pReal = (fs_real_file *)sqlite3_malloc(sizeof(*pReal)+pParent->szOsFile);
if( !pReal ){
rc = SQLITE_NOMEM;
goto open_out;
}
memset(pReal, 0, sizeof(*pReal)+pParent->szOsFile);
pReal->zName = zName;
pReal->pFile = (sqlite3_file *)(&pReal[1]);
rc = pParent->xOpen(pParent, zName, pReal->pFile, real_flags, pOutFlags);
if( rc!=SQLITE_OK ){
goto open_out;
}
pRealFile = pReal->pFile;
rc = pRealFile->pMethods->xFileSize(pRealFile, &size);
if( rc!=SQLITE_OK ){
goto open_out;
}
if( size==0 ){
rc = pRealFile->pMethods->xWrite(pRealFile, "\0", 1, BLOBSIZE-1);
pReal->nBlob = BLOBSIZE;
}else{
unsigned char zS[4];
pReal->nBlob = (int)size;
rc = pRealFile->pMethods->xRead(pRealFile, zS, 4, 0);
pReal->nDatabase = (zS[0]<<24)+(zS[1]<<16)+(zS[2]<<8)+zS[3];
if( rc==SQLITE_OK ){
rc = pRealFile->pMethods->xRead(pRealFile, zS, 4, pReal->nBlob-4);
if( zS[0] || zS[1] || zS[2] || zS[3] ){
pReal->nJournal = pReal->nBlob;
}
}
}
if( rc==SQLITE_OK ){
pReal->pNext = pFsVfs->pFileList;
if( pReal->pNext ){
pReal->pNext->ppThis = &pReal->pNext;
}
pReal->ppThis = &pFsVfs->pFileList;
pFsVfs->pFileList = pReal;
}
}
open_out:
if( pReal ){
if( rc==SQLITE_OK ){
p->pReal = pReal;
pReal->nRef++;
}else{
if( pReal->pFile->pMethods ){
pReal->pFile->pMethods->xClose(pReal->pFile);
}
sqlite3_free(pReal);
}
}
return rc;
}
/*
** Delete the file located at zPath. If the dirSync argument is true,
** ensure the file-system modifications are synced to disk before
** returning.
*/
static int fsDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
int rc = SQLITE_OK;
fs_vfs_t *pFsVfs = (fs_vfs_t *)pVfs;
fs_real_file *pReal;
sqlite3_file *pF;
int nName = (int)strlen(zPath) - 8;
assert(strlen("-journal")==8);
assert(strcmp("-journal", &zPath[nName])==0);
pReal = pFsVfs->pFileList;
for(; pReal && strncmp(pReal->zName, zPath, nName); pReal=pReal->pNext);
if( pReal ){
pF = pReal->pFile;
rc = pF->pMethods->xWrite(pF, "\0\0\0\0", 4, pReal->nBlob-BLOCKSIZE);
if( rc==SQLITE_OK ){
pReal->nJournal = 0;
}
}
return rc;
}
/*
** Test for access permissions. Return true if the requested permission
** is available, or false otherwise.
*/
static int fsAccess(
sqlite3_vfs *pVfs,
const char *zPath,
int flags,
int *pResOut
){
fs_vfs_t *pFsVfs = (fs_vfs_t *)pVfs;
fs_real_file *pReal;
int isJournal = 0;
int nName = (int)strlen(zPath);
if( flags!=SQLITE_ACCESS_EXISTS ){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xAccess(pParent, zPath, flags, pResOut);
}
assert(strlen("-journal")==8);
if( nName>8 && strcmp("-journal", &zPath[nName-8])==0 ){
nName -= 8;
isJournal = 1;
}
pReal = pFsVfs->pFileList;
for(; pReal && strncmp(pReal->zName, zPath, nName); pReal=pReal->pNext);
*pResOut = (pReal && (!isJournal || pReal->nJournal>0));
return SQLITE_OK;
}
/*
** Populate buffer zOut with the full canonical pathname corresponding
** to the pathname in zPath. zOut is guaranteed to point to a buffer
** of at least (FS_MAX_PATHNAME+1) bytes.
*/
static int fsFullPathname(
sqlite3_vfs *pVfs, /* Pointer to vfs object */
const char *zPath, /* Possibly relative input path */
int nOut, /* Size of output buffer in bytes */
char *zOut /* Output buffer */
){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xFullPathname(pParent, zPath, nOut, zOut);
}
/*
** Open the dynamic library located at zPath and return a handle.
*/
static void *fsDlOpen(sqlite3_vfs *pVfs, const char *zPath){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xDlOpen(pParent, zPath);
}
/*
** Populate the buffer zErrMsg (size nByte bytes) with a human readable
** utf-8 string describing the most recent error encountered associated
** with dynamic libraries.
*/
static void fsDlError(sqlite3_vfs *pVfs, int nByte, char *zErrMsg){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
pParent->xDlError(pParent, nByte, zErrMsg);
}
/*
** Return a pointer to the symbol zSymbol in the dynamic library pHandle.
*/
static void (*fsDlSym(sqlite3_vfs *pVfs, void *pH, const char *zSym))(void){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xDlSym(pParent, pH, zSym);
}
/*
** Close the dynamic library handle pHandle.
*/
static void fsDlClose(sqlite3_vfs *pVfs, void *pHandle){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
pParent->xDlClose(pParent, pHandle);
}
/*
** Populate the buffer pointed to by zBufOut with nByte bytes of
** random data.
*/
static int fsRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xRandomness(pParent, nByte, zBufOut);
}
/*
** Sleep for nMicro microseconds. Return the number of microseconds
** actually slept.
*/
static int fsSleep(sqlite3_vfs *pVfs, int nMicro){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xSleep(pParent, nMicro);
}
/*
** Return the current time as a Julian Day number in *pTimeOut.
*/
static int fsCurrentTime(sqlite3_vfs *pVfs, double *pTimeOut){
sqlite3_vfs *pParent = ((fs_vfs_t *)pVfs)->pParent;
return pParent->xCurrentTime(pParent, pTimeOut);
}
/*
** This procedure registers the fs vfs with SQLite. If the argument is
** true, the fs vfs becomes the new default vfs. It is the only publicly
** available function in this file.
*/
int fs_register(void){
if( fs_vfs.pParent ) return SQLITE_OK;
fs_vfs.pParent = sqlite3_vfs_find(0);
fs_vfs.base.mxPathname = fs_vfs.pParent->mxPathname;
fs_vfs.base.szOsFile = MAX(sizeof(tmp_file), sizeof(fs_file));
return sqlite3_vfs_register(&fs_vfs.base, 0);
}
#ifdef SQLITE_TEST
int SqlitetestOnefile_Init() {return fs_register();}
#endif
|