GDAL

cpl_vsi.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: CPL - Common Portability Library
5 * Author: Frank Warmerdam, warmerdam@pobox.com
6 * Purpose: Include file defining Virtual File System (VSI) functions, a
7 * layer over POSIX file and other system services.
8 *
9 ******************************************************************************
10 * Copyright (c) 1998, Frank Warmerdam
11 * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a
14 * copy of this software and associated documentation files (the "Software"),
15 * to deal in the Software without restriction, including without limitation
16 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 * and/or sell copies of the Software, and to permit persons to whom the
18 * Software is furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included
21 * in all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 * DEALINGS IN THE SOFTWARE.
30 ****************************************************************************/
31
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
34
35 #include "cpl_port.h"
36 #include "cpl_progress.h"
37
38 #include <stdbool.h>
39
58 /* -------------------------------------------------------------------- */
59 /* We need access to ``struct stat''. */
60 /* -------------------------------------------------------------------- */
61
62 /* Unix */
63 #if !defined(_WIN32)
64 #include <unistd.h>
65 #endif
66
67 /* Windows */
68 #include <sys/stat.h>
69
70 CPL_C_START
71
73 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
74 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
75 #else
76 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
77 #endif
78
80 /* ==================================================================== */
81 /* stdio file access functions. These do not support large */
82 /* files, and do not go through the virtualization API. */
83 /* ==================================================================== */
84
87 FILE CPL_DLL *VSIFOpen(const char *, const char *) CPL_WARN_UNUSED_RESULT;
88 int CPL_DLL VSIFClose(FILE *);
89 int CPL_DLL VSIFSeek(FILE *, long, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
90 long CPL_DLL VSIFTell(FILE *) CPL_WARN_UNUSED_RESULT;
91 void CPL_DLL VSIRewind(FILE *);
92 void CPL_DLL VSIFFlush(FILE *);
93
94 size_t CPL_DLL VSIFRead(void *, size_t, size_t,
95 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96 size_t CPL_DLL VSIFWrite(const void *, size_t, size_t,
97 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
98 char CPL_DLL *VSIFGets(char *, int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99 int CPL_DLL VSIFPuts(const char *, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
100 int CPL_DLL VSIFPrintf(FILE *, CPL_FORMAT_STRING(const char *),
101 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
102 CPL_PRINT_FUNC_FORMAT(2, 3);
103
104 int CPL_DLL VSIFGetc(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
105 int CPL_DLL VSIFPutc(int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
106 int CPL_DLL VSIUngetc(int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
107 int CPL_DLL VSIFEof(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
108
111 /* ==================================================================== */
112 /* VSIStat() related. */
113 /* ==================================================================== */
114
116 typedef struct stat VSIStatBuf;
117 int CPL_DLL VSIStat(const char *, VSIStatBuf *) CPL_WARN_UNUSED_RESULT;
120 #ifdef _WIN32
121 #define VSI_ISLNK(x) (0) /* N/A on Windows */
122 #define VSI_ISREG(x) ((x)&S_IFREG)
123 #define VSI_ISDIR(x) ((x)&S_IFDIR)
124 #define VSI_ISCHR(x) ((x)&S_IFCHR)
125 #define VSI_ISBLK(x) (0) /* N/A on Windows */
126 #else
127
128 #define VSI_ISLNK(x) S_ISLNK(x)
129
130 #define VSI_ISREG(x) S_ISREG(x)
131
132 #define VSI_ISDIR(x) S_ISDIR(x)
133
134 #define VSI_ISCHR(x) S_ISCHR(x)
135 #define VSI_ISBLK(x) S_ISBLK(x)
136
137 #endif
138
139 /* ==================================================================== */
140 /* 64bit stdio file access functions. If we have a big size */
141 /* defined, then provide prototypes for the large file API, */
142 /* otherwise redefine to use the regular api. */
143 /* ==================================================================== */
144
146 typedef GUIntBig vsi_l_offset;
148 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
149
151 typedef struct VSIVirtualHandle VSILFILE;
152
153 VSILFILE CPL_DLL *VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT;
154 VSILFILE CPL_DLL *VSIFOpenExL(const char *, const char *,
155 int) CPL_WARN_UNUSED_RESULT;
156 VSILFILE CPL_DLL *VSIFOpenEx2L(const char *, const char *, int,
157 CSLConstList) CPL_WARN_UNUSED_RESULT;
158 int CPL_DLL VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
159 int CPL_DLL VSIFSeekL(VSILFILE *, vsi_l_offset,
160 int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
161 vsi_l_offset CPL_DLL VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT;
162 void CPL_DLL VSIRewindL(VSILFILE *);
163 size_t CPL_DLL VSIFReadL(void *, size_t, size_t,
164 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
165 int CPL_DLL VSIFReadMultiRangeL(int nRanges, void **ppData,
166 const vsi_l_offset *panOffsets,
167 const size_t *panSizes,
168 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
169 size_t CPL_DLL VSIFWriteL(const void *, size_t, size_t,
170 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
171 int CPL_DLL VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
172 int CPL_DLL VSIFTruncateL(VSILFILE *,
173 vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
174 int CPL_DLL VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
175 int CPL_DLL VSIFPrintfL(VSILFILE *, CPL_FORMAT_STRING(const char *),
176 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
177 CPL_PRINT_FUNC_FORMAT(2, 3);
178 int CPL_DLL VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
179
181 typedef enum
182 {
183 VSI_RANGE_STATUS_UNKNOWN,
184 VSI_RANGE_STATUS_DATA,
185 VSI_RANGE_STATUS_HOLE
186 } VSIRangeStatus;
187
188 VSIRangeStatus CPL_DLL VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart,
189 vsi_l_offset nLength);
190
191 int CPL_DLL VSIIngestFile(VSILFILE *fp, const char *pszFilename,
192 GByte **ppabyRet, vsi_l_offset *pnSize,
193 GIntBig nMaxSize) CPL_WARN_UNUSED_RESULT;
194
195 int CPL_DLL VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
196 CPL_WARN_UNUSED_RESULT;
197
198 #if defined(VSI_STAT64_T)
199
200 typedef struct VSI_STAT64_T VSIStatBufL;
201 #else
202
203 #define VSIStatBufL VSIStatBuf
204 #endif
205
206 int CPL_DLL VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT;
207
209 #define VSI_STAT_EXISTS_FLAG 0x1
210
211 #define VSI_STAT_NATURE_FLAG 0x2
212
213 #define VSI_STAT_SIZE_FLAG 0x4
214
215 #define VSI_STAT_SET_ERROR_FLAG 0x8
216
219 #define VSI_STAT_CACHE_ONLY 0x10
220
221 int CPL_DLL VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf,
222 int nFlags) CPL_WARN_UNUSED_RESULT;
223
224 int CPL_DLL VSIIsCaseSensitiveFS(const char *pszFilename);
225
226 int CPL_DLL VSISupportsSparseFiles(const char *pszPath);
227
228 bool CPL_DLL VSIIsLocal(const char *pszPath);
229
230 bool CPL_DLL VSISupportsSequentialWrite(const char *pszPath,
231 bool bAllowLocalTempFile);
232
233 bool CPL_DLL VSISupportsRandomWrite(const char *pszPath,
234 bool bAllowLocalTempFile);
235
236 int CPL_DLL VSIHasOptimizedReadMultiRange(const char *pszPath);
237
238 const char CPL_DLL *VSIGetActualURL(const char *pszFilename);
239
240 char CPL_DLL *VSIGetSignedURL(const char *pszFilename,
241 CSLConstList papszOptions);
242
243 const char CPL_DLL *VSIGetFileSystemOptions(const char *pszFilename);
244
245 char CPL_DLL **VSIGetFileSystemsPrefixes(void);
246
247 void CPL_DLL *VSIFGetNativeFileDescriptorL(VSILFILE *);
248
249 char CPL_DLL **
250 VSIGetFileMetadata(const char *pszFilename, const char *pszDomain,
251 CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
252
253 int CPL_DLL VSISetFileMetadata(const char *pszFilename,
254 CSLConstList papszMetadata,
255 const char *pszDomain,
256 CSLConstList papszOptions);
257
258 void CPL_DLL VSISetPathSpecificOption(const char *pszPathPrefix,
259 const char *pszKey, const char *pszValue);
260 void CPL_DLL VSIClearPathSpecificOptions(const char *pszPathPrefix);
261 const char CPL_DLL *VSIGetPathSpecificOption(const char *pszPath,
262 const char *pszKey,
263 const char *pszDefault);
264
265 void CPL_DLL VSISetCredential(const char *pszPathPrefix, const char *pszKey,
266 const char *pszValue)
268 CPL_WARN_DEPRECATED("Use VSISetPathSpecificOption instead")
270 ;
271 void CPL_DLL VSIClearCredentials(const char *pszPathPrefix)
273 CPL_WARN_DEPRECATED("Use VSIClearPathSpecificOptions instead")
275 ;
276 const char CPL_DLL *VSIGetCredential(const char *pszPath, const char *pszKey,
277 const char *pszDefault)
279 CPL_WARN_DEPRECATED("Use VSIGetPathSpecificOption instead")
281 ;
282
283 /* ==================================================================== */
284 /* Memory allocation */
285 /* ==================================================================== */
286
287 void CPL_DLL *VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT;
288 void CPL_DLL *VSIMalloc(size_t) CPL_WARN_UNUSED_RESULT;
289 void CPL_DLL VSIFree(void *);
290 void CPL_DLL *VSIRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT;
291 char CPL_DLL *VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT;
292
293 void CPL_DLL *VSIMallocAligned(size_t nAlignment,
294 size_t nSize) CPL_WARN_UNUSED_RESULT;
295 void CPL_DLL *VSIMallocAlignedAuto(size_t nSize) CPL_WARN_UNUSED_RESULT;
296 void CPL_DLL VSIFreeAligned(void *ptr);
297
298 void CPL_DLL *VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile,
299 int nLine) CPL_WARN_UNUSED_RESULT;
301 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE(size) \
302 VSIMallocAlignedAutoVerbose(size, __FILE__, __LINE__)
303
311 void CPL_DLL *VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT;
312
321 void CPL_DLL *VSIMalloc3(size_t nSize1, size_t nSize2,
322 size_t nSize3) CPL_WARN_UNUSED_RESULT;
323
325 void CPL_DLL *VSIMallocVerbose(size_t nSize, const char *pszFile,
326 int nLine) CPL_WARN_UNUSED_RESULT;
328 #define VSI_MALLOC_VERBOSE(size) VSIMallocVerbose(size, __FILE__, __LINE__)
329
331 void CPL_DLL *VSIMalloc2Verbose(size_t nSize1, size_t nSize2,
332 const char *pszFile,
333 int nLine) CPL_WARN_UNUSED_RESULT;
335 #define VSI_MALLOC2_VERBOSE(nSize1, nSize2) \
336 VSIMalloc2Verbose(nSize1, nSize2, __FILE__, __LINE__)
337
339 void CPL_DLL *VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3,
340 const char *pszFile,
341 int nLine) CPL_WARN_UNUSED_RESULT;
343 #define VSI_MALLOC3_VERBOSE(nSize1, nSize2, nSize3) \
344 VSIMalloc3Verbose(nSize1, nSize2, nSize3, __FILE__, __LINE__)
345
347 void CPL_DLL *VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile,
348 int nLine) CPL_WARN_UNUSED_RESULT;
350 #define VSI_CALLOC_VERBOSE(nCount, nSize) \
351 VSICallocVerbose(nCount, nSize, __FILE__, __LINE__)
352
354 void CPL_DLL *VSIReallocVerbose(void *pOldPtr, size_t nNewSize,
355 const char *pszFile,
356 int nLine) CPL_WARN_UNUSED_RESULT;
358 #define VSI_REALLOC_VERBOSE(pOldPtr, nNewSize) \
359 VSIReallocVerbose(pOldPtr, nNewSize, __FILE__, __LINE__)
360
362 char CPL_DLL *VSIStrdupVerbose(const char *pszStr, const char *pszFile,
363 int nLine) CPL_WARN_UNUSED_RESULT;
365 #define VSI_STRDUP_VERBOSE(pszStr) VSIStrdupVerbose(pszStr, __FILE__, __LINE__)
366
367 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
368 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
369
370 /* ==================================================================== */
371 /* Other... */
372 /* ==================================================================== */
373
375 #define CPLReadDir VSIReadDir
376 char CPL_DLL **VSIReadDir(const char *);
377 char CPL_DLL **VSIReadDirRecursive(const char *pszPath);
378 char CPL_DLL **VSIReadDirEx(const char *pszPath, int nMaxFiles);
379 char CPL_DLL **VSISiblingFiles(const char *pszPath);
380
382 typedef struct VSIDIR VSIDIR;
383
384 VSIDIR CPL_DLL *VSIOpenDir(const char *pszPath, int nRecurseDepth,
385 const char *const *papszOptions);
386
388 typedef struct VSIDIREntry VSIDIREntry;
392 struct VSIDIREntry
393 {
395 char *pszName;
397 int nMode;
399 vsi_l_offset nSize;
401 GIntBig nMTime;
403 char bModeKnown;
405 char bSizeKnown;
407 char bMTimeKnown;
409 char **papszExtra;
410
411 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
412
413 VSIDIREntry();
414 ~VSIDIREntry();
415 VSIDIREntry(const VSIDIREntry &);
416 VSIDIREntry &operator=(VSIDIREntry &) = delete;
418 #endif
419 };
420
421 const VSIDIREntry CPL_DLL *VSIGetNextDirEntry(VSIDIR *dir);
422 void CPL_DLL VSICloseDir(VSIDIR *dir);
423
424 int CPL_DLL VSIMkdir(const char *pszPathname, long mode);
425 int CPL_DLL VSIMkdirRecursive(const char *pszPathname, long mode);
426 int CPL_DLL VSIRmdir(const char *pszDirname);
427 int CPL_DLL VSIRmdirRecursive(const char *pszDirname);
428 int CPL_DLL VSIUnlink(const char *pszFilename);
429 int CPL_DLL *VSIUnlinkBatch(CSLConstList papszFiles);
430 int CPL_DLL VSIRename(const char *oldpath, const char *newpath);
431 int CPL_DLL VSICopyFile(const char *pszSource, const char *pszTarget,
432 VSILFILE *fpSource, vsi_l_offset nSourceSize,
433 const char *const *papszOptions,
434 GDALProgressFunc pProgressFunc, void *pProgressData);
435 int CPL_DLL VSISync(const char *pszSource, const char *pszTarget,
436 const char *const *papszOptions,
437 GDALProgressFunc pProgressFunc, void *pProgressData,
438 char ***ppapszOutputs);
439 int CPL_DLL VSIAbortPendingUploads(const char *pszFilename);
440
441 char CPL_DLL *VSIStrerror(int);
442 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
443
444 void CPL_DLL VSINetworkStatsReset(void);
445 char CPL_DLL *VSINetworkStatsGetAsSerializedJSON(char **papszOptions);
446
447 /* ==================================================================== */
448 /* Install special file access handlers. */
449 /* ==================================================================== */
450 void CPL_DLL VSIInstallMemFileHandler(void);
452 void CPL_DLL VSIInstallLargeFileHandler(void);
454 void CPL_DLL VSIInstallSubFileHandler(void);
455 void VSIInstallCurlFileHandler(void);
456 void CPL_DLL VSICurlClearCache(void);
457 void CPL_DLL VSICurlPartialClearCache(const char *pszFilenamePrefix);
458 void VSIInstallCurlStreamingFileHandler(void);
459 void VSIInstallS3FileHandler(void);
460 void VSIInstallS3StreamingFileHandler(void);
461 void VSIInstallGSFileHandler(void);
462 void VSIInstallGSStreamingFileHandler(void);
463 void VSIInstallAzureFileHandler(void);
464 void VSIInstallAzureStreamingFileHandler(void);
465 void VSIInstallADLSFileHandler(void);
466 void VSIInstallOSSFileHandler(void);
467 void VSIInstallOSSStreamingFileHandler(void);
468 void VSIInstallSwiftFileHandler(void);
469 void VSIInstallSwiftStreamingFileHandler(void);
470 void VSIInstall7zFileHandler(void); /* No reason to export that */
471 void VSIInstallRarFileHandler(void); /* No reason to export that */
472 void VSIInstallGZipFileHandler(void); /* No reason to export that */
473 void VSIInstallZipFileHandler(void); /* No reason to export that */
474 void VSIInstallStdinHandler(void); /* No reason to export that */
475 void VSIInstallHdfsHandler(void); /* No reason to export that */
476 void VSIInstallWebHdfsHandler(void); /* No reason to export that */
477 void VSIInstallStdoutHandler(void); /* No reason to export that */
478 void CPL_DLL VSIInstallSparseFileHandler(void);
479 void VSIInstallTarFileHandler(void); /* No reason to export that */
480 void CPL_DLL VSIInstallCryptFileHandler(void);
481 void CPL_DLL VSISetCryptKey(const GByte *pabyKey, int nKeySize);
483 void CPL_DLL VSICleanupFileManager(void);
486 bool CPL_DLL VSIDuplicateFileSystemHandler(const char *pszSourceFSName,
487 const char *pszNewFSName);
488
489 VSILFILE CPL_DLL *
490 VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData,
491 vsi_l_offset nDataLength,
492 int bTakeOwnership) CPL_WARN_UNUSED_RESULT;
493 GByte CPL_DLL *VSIGetMemFileBuffer(const char *pszFilename,
494 vsi_l_offset *pnDataLength,
495 int bUnlinkAndSeize);
496
498 typedef size_t (*VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb,
499 FILE *stream);
500 void CPL_DLL VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream);
501
506 typedef int (*VSIFilesystemPluginStatCallback)(void *pUserData,
507 const char *pszFilename,
508 VSIStatBufL *pStatBuf,
509 int nFlags);
514 typedef int (*VSIFilesystemPluginUnlinkCallback)(void *pUserData,
515 const char *pszFilename);
520 typedef int (*VSIFilesystemPluginRenameCallback)(void *pUserData,
521 const char *oldpath,
522 const char *newpath);
527 typedef int (*VSIFilesystemPluginMkdirCallback)(void *pUserData,
528 const char *pszDirname,
529 long nMode);
534 typedef int (*VSIFilesystemPluginRmdirCallback)(void *pUserData,
535 const char *pszDirname);
540 typedef char **(*VSIFilesystemPluginReadDirCallback)(void *pUserData,
541 const char *pszDirname,
542 int nMaxFiles);
552 typedef char **(*VSIFilesystemPluginSiblingFilesCallback)(
553 void *pUserData, const char *pszDirname);
560 typedef void *(*VSIFilesystemPluginOpenCallback)(void *pUserData,
561 const char *pszFilename,
562 const char *pszAccess);
567 typedef vsi_l_offset (*VSIFilesystemPluginTellCallback)(void *pFile);
572 typedef int (*VSIFilesystemPluginSeekCallback)(void *pFile,
573 vsi_l_offset nOffset,
574 int nWhence);
580 typedef size_t (*VSIFilesystemPluginReadCallback)(void *pFile, void *pBuffer,
581 size_t nSize, size_t nCount);
587 typedef int (*VSIFilesystemPluginReadMultiRangeCallback)(
588 void *pFile, int nRanges, void **ppData, const vsi_l_offset *panOffsets,
589 const size_t *panSizes);
594 typedef VSIRangeStatus (*VSIFilesystemPluginGetRangeStatusCallback)(
595 void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength);
600 typedef int (*VSIFilesystemPluginEofCallback)(void *pFile);
605 typedef size_t (*VSIFilesystemPluginWriteCallback)(void *pFile,
606 const void *pBuffer,
607 size_t nSize, size_t nCount);
612 typedef int (*VSIFilesystemPluginFlushCallback)(void *pFile);
616 typedef int (*VSIFilesystemPluginTruncateCallback)(void *pFile,
617 vsi_l_offset nNewSize);
622 typedef int (*VSIFilesystemPluginCloseCallback)(void *pFile);
623
638 typedef void (*VSIFilesystemPluginAdviseReadCallback)(
639 void *pFile, int nRanges, const vsi_l_offset *panOffsets,
640 const size_t *panSizes);
641
649 typedef struct
650 {
655 void *pUserData;
656 VSIFilesystemPluginStatCallback stat;
657 VSIFilesystemPluginUnlinkCallback unlink;
658 VSIFilesystemPluginRenameCallback rename;
659 VSIFilesystemPluginMkdirCallback mkdir;
660 VSIFilesystemPluginRmdirCallback rmdir;
661 VSIFilesystemPluginReadDirCallback
662 read_dir;
663 VSIFilesystemPluginOpenCallback open;
664 VSIFilesystemPluginTellCallback
665 tell;
666 VSIFilesystemPluginSeekCallback
667 seek;
668 VSIFilesystemPluginReadCallback read;
669 VSIFilesystemPluginReadMultiRangeCallback
670 read_multi_range;
671 VSIFilesystemPluginGetRangeStatusCallback
672 get_range_status;
673 VSIFilesystemPluginEofCallback
674 eof;
675 VSIFilesystemPluginWriteCallback
676 write;
677 VSIFilesystemPluginFlushCallback flush;
678 VSIFilesystemPluginTruncateCallback truncate;
679 VSIFilesystemPluginCloseCallback close;
680 size_t nBufferSize;
681 size_t nCacheSize;
682 VSIFilesystemPluginSiblingFilesCallback
683 sibling_files;
686 VSIFilesystemPluginAdviseReadCallback advise_read;
687 /*
688 Callbacks are defined as a struct allocated by a call to
689 VSIAllocFilesystemPluginCallbacksStruct in order to try to maintain ABI
690 stability when eventually adding a new member. Any callbacks added to
691 this struct SHOULD be added to the END of this struct
692 */
693 } VSIFilesystemPluginCallbacksStruct;
694
700 VSIFilesystemPluginCallbacksStruct CPL_DLL *
701 VSIAllocFilesystemPluginCallbacksStruct(void);
702
707 void CPL_DLL VSIFreeFilesystemPluginCallbacksStruct(
708 VSIFilesystemPluginCallbacksStruct *poCb);
709
716 int CPL_DLL VSIInstallPluginHandler(
717 const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb);
718
719 /* ==================================================================== */
720 /* Time querying. */
721 /* ==================================================================== */
722
724 unsigned long CPL_DLL VSITime(unsigned long *);
725 const char CPL_DLL *VSICTime(unsigned long);
726 struct tm CPL_DLL *VSIGMTime(const time_t *pnTime, struct tm *poBrokenTime);
727 struct tm CPL_DLL *VSILocalTime(const time_t *pnTime, struct tm *poBrokenTime);
731 /* -------------------------------------------------------------------- */
732 /* the following can be turned on for detailed logging of */
733 /* almost all IO calls. */
734 /* -------------------------------------------------------------------- */
735 #ifdef VSI_DEBUG
736
737 #ifndef DEBUG
738 #define DEBUG
739 #endif
740
741 #include "cpl_error.h"
742
743 #define VSIDebug4(f, a1, a2, a3, a4) CPLDebug("VSI", f, a1, a2, a3, a4);
744 #define VSIDebug3(f, a1, a2, a3) CPLDebug("VSI", f, a1, a2, a3);
745 #define VSIDebug2(f, a1, a2) CPLDebug("VSI", f, a1, a2);
746 #define VSIDebug1(f, a1) CPLDebug("VSI", f, a1);
747 #else
748 #define VSIDebug4(f, a1, a2, a3, a4) \
749 { \
750 }
751 #define VSIDebug3(f, a1, a2, a3) \
752 { \
753 }
754 #define VSIDebug2(f, a1, a2) \
755 { \
756 }
757 #define VSIDebug1(f, a1) \
758 { \
759 }
760 #endif
761
763 CPL_C_END
764
765 #endif /* ndef CPL_VSI_H_INCLUDED */
VSIDIREntry::bMTimeKnown
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:407
VSIGetNextDirEntry
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:299
VSIFilesystemPluginCallbacksStruct::nBufferSize
size_t nBufferSize
buffer small reads (makes handler read only)
Definition: cpl_vsi.h:680
VSIOpenDir
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:264
VSIOverwriteFile
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2679
VSIInstallSwiftFileHandler
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:790
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:959
VSI_RANGE_STATUS_HOLE
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:185
VSIFilesystemPluginCallbacksStruct::close
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:679
VSIRmdirRecursive
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:731
VSIInstallAzureFileHandler
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:2558
VSIStdoutSetRedirection
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Set an alternative write function and output file handle instead of fwrite() / stdout.
Definition: cpl_vsil_stdout.cpp:62
VSIFilesystemPluginAdviseReadCallback
void(* VSIFilesystemPluginAdviseReadCallback)(void *pFile, int nRanges, const vsi_l_offset *panOffsets, const size_t *panSizes)
This optional method is called when code plans to access soon one or several ranges in a file.
Definition: cpl_vsi.h:638
VSIClearCredentials
void VSIClearCredentials(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2898
CPLGetUsablePhysicalRAM
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1581
VSIFilesystemPluginRenameCallback
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:520
VSIFreeAligned
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:979
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:205
VSISiblingFiles
char ** VSISiblingFiles(const char *pszPath)
Return related filenames.
Definition: cpl_vsil.cpp:150
VSIMallocVerbose
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1136
VSIGetMemFileBuffer
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:1016
VSIFilesystemPluginEofCallback
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:600
VSIRmdir
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:705
VSISupportsRandomWrite
bool VSISupportsRandomWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports random write.
Definition: cpl_vsil.cpp:1083
cpl_error.h
VSIReallocVerbose
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1220
VSIInstallWebHdfsHandler
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1253
VSIFreeFilesystemPluginCallbacksStruct
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:479
VSIFilesystemPluginCallbacksStruct::seek
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:667
VSIInstallStdoutHandler
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:448
VSIFilesystemPluginStatCallback
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:506
VSIDIREntry::nMode
int nMode
File mode.
Definition: cpl_vsi.h:397
VSIGetSignedURL
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:1181
VSIFTruncateL
int VSIFTruncateL(VSILFILE *, vsi_l_offset)
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:2355
VSICloseDir
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:318
VSIFileFromMemBuffer
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:952
VSIInstallAzureStreamingFileHandler
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2139
VSIRealloc
void * VSIRealloc(void *, size_t)
Analog of realloc().
Definition: cpl_vsisimple.cpp:683
VSIInstallSubFileHandler
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:500
VSIFilesystemPluginFlushCallback
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:612
VSIDIREntry::pszName
char * pszName
Filename.
Definition: cpl_vsi.h:395
VSIInstallPluginHandler
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:463
VSIRangeStatus
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:181
CPLGetPhysicalRAM
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1367
VSIFilesystemPluginTellCallback
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:567
VSIMkdir
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:343
VSIFilesystemPluginCallbacksStruct::flush
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:677
VSIGetFileMetadata
char ** VSIGetFileMetadata(const char *pszFilename, const char *pszDomain, CSLConstList papszOptions)
Get metadata on files.
Definition: cpl_vsil.cpp:874
VSIRename
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:491
VSIMkdirRecursive
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:365
VSIInstallRarFileHandler
void VSIInstallRarFileHandler(void)
Install /vsirar/ RAR file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:65
VSIFOpenExL
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:1847
VSISync
int VSISync(const char *pszSource, const char *pszTarget, const char *const *papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData, char ***ppapszOutputs)
Synchronize a source file/directory with a target file/directory.
Definition: cpl_vsil.cpp:628
VSIRewindL
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:2070
VSIFilesystemPluginCallbacksStruct::read
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:668
VSIIsCaseSensitiveFS
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:978
VSIFilesystemPluginReadDirCallback
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:540
VSIWriteFunction
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:498
VSIHasOptimizedReadMultiRange
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:1108
VSIFilesystemPluginCallbacksStruct::tell
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:665
VSIFilesystemPluginCallbacksStruct::nCacheSize
size_t nCacheSize
max mem to use per file when buffering
Definition: cpl_vsi.h:681
VSIGetPathSpecificOption
const char * VSIGetPathSpecificOption(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value a path specific option.
Definition: cpl_vsil.cpp:2958
VSIFilesystemPluginCallbacksStruct
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:649
VSIFPrintfL
int VSIFPrintfL(VSILFILE *, const char *,...)
Formatted write to file.
Definition: cpl_vsil.cpp:2379
VSIFOpenEx2L
VSILFILE * VSIFOpenEx2L(const char *, const char *, int, CSLConstList)
Open file.
Definition: cpl_vsil.cpp:1896
VSIInstallSparseFileHandler
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:552
VSIFilesystemPluginSeekCallback
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:572
VSIInstallADLSFileHandler
void VSIInstallADLSFileHandler(void)
Install /vsiaz/ Microsoft Azure Data Lake Storage Gen2 file system handler (requires libcurl)
Definition: cpl_vsil_adls.cpp:2256
VSIDIREntry::nSize
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:399
VSIFilesystemPluginGetRangeStatusCallback
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:594
VSIGetFileSystemOptions
const char * VSIGetFileSystemOptions(const char *pszFilename)
Return the list of options associated with a virtual file system handler as a serialized XML string.
Definition: cpl_vsil.cpp:2810
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:315
VSI_RANGE_STATUS_UNKNOWN
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:183
VSIUnlinkBatch
int * VSIUnlinkBatch(CSLConstList papszFiles)
Delete several files, possibly in a batch.
Definition: cpl_vsil.cpp:447
VSIFGetRangeStatusL
VSIRangeStatus VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsil.cpp:2468
VSIDIREntry::papszExtra
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:409
VSIInstallS3FileHandler
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:4811
VSIAllocFilesystemPluginCallbacksStruct
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:474
VSIClearPathSpecificOptions
void VSIClearPathSpecificOptions(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2916
VSIInstallGZipFileHandler
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:3263
VSIReadDirEx
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:122
VSIFilesystemPluginReadCallback
size_t(* VSIFilesystemPluginReadCallback)(void *pFile, void *pBuffer, size_t nSize, size_t nCount)
Read data from current position, returns the number of blocks correctly read.
Definition: cpl_vsi.h:580
VSIFilesystemPluginCallbacksStruct::unlink
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:657
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1195
VSIFTellL
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:2050
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:238
VSIFilesystemPluginCallbacksStruct::get_range_status
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:672
VSIFilesystemPluginCallbacksStruct::rename
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:658
VSIFSeekL
int VSIFSeekL(VSILFILE *, vsi_l_offset, int)
Seek to requested offset.
Definition: cpl_vsil.cpp:2009
VSIInstall7zFileHandler
void VSIInstall7zFileHandler(void)
Install /vsi7z/ 7zip file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:47
VSIFilesystemPluginUnlinkCallback
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:514
VSIInstallGSFileHandler
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:866
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:319
VSIInstallStdinHandler
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:664
VSIInstallHdfsHandler
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:470
VSIFilesystemPluginCallbacksStruct::advise_read
VSIFilesystemPluginAdviseReadCallback advise_read
The following optional member has been added in GDAL 3.7:
Definition: cpl_vsi.h:686
VSIFilesystemPluginMkdirCallback
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:527
VSIMalloc3Verbose
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1177
VSIDIREntry
Directory entry.
Definition: cpl_vsi.h:392
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:767
VSIUnlink
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:416
VSIInstallCryptFileHandler
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2058
VSIInstallGSStreamingFileHandler
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2118
VSIFilesystemPluginRmdirCallback
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:534
VSISupportsSparseFiles
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:1007
VSIMalloc2Verbose
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1153
VSIGetFileSystemsPrefixes
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2790
VSIInstallCurlStreamingFileHandler
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2077
VSIFilesystemPluginTruncateCallback
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:616
VSIInstallCurlFileHandler
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5873
VSIStrerror
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1344
VSISetCredential
void VSISetCredential(const char *pszPathPrefix, const char *pszKey, const char *pszValue)
Set a credential (or more generally an option related to a virtual file system) for a given path pref...
Definition: cpl_vsil.cpp:2834
VSIInstallTarFileHandler
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:666
VSIFFlushL
int VSIFFlushL(VSILFILE *)
Flush pending writes to disk.
Definition: cpl_vsil.cpp:2111
VSIVirtualHandle
Virtual file handle.
Definition: cpl_vsi_virtual.h:61
VSIFilesystemPluginReadMultiRangeCallback
int(* VSIFilesystemPluginReadMultiRangeCallback)(void *pFile, int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Read from multiple offsets.
Definition: cpl_vsi.h:587
VSIFilesystemPluginSiblingFilesCallback
char **(* VSIFilesystemPluginSiblingFilesCallback)(void *pUserData, const char *pszDirname)
List related files.
Definition: cpl_vsi.h:552
VSINetworkStatsGetAsSerializedJSON
char * VSINetworkStatsGetAsSerializedJSON(char **papszOptions)
Return network related statistics, as a JSON serialized object.
Definition: cpl_vsil_curl.cpp:6059
VSIInstallMemFileHandler
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:919
VSIInstallZipFileHandler
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:4845
vsi_l_offset
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:146
VSIFree
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:832
VSIFilesystemPluginCallbacksStruct::stat
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:656
VSIInstallOSSFileHandler
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:419
VSIMalloc2
void * VSIMalloc2(size_t nSize1, size_t nSize2)
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1114
VSIStrdup
char * VSIStrdup(const char *)
Analog of strdup().
Definition: cpl_vsisimple.cpp:999
VSICalloc
void * VSICalloc(size_t, size_t)
Analog of calloc().
Definition: cpl_vsisimple.cpp:440
VSIStrdupVerbose
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1238
VSIMallocAlignedAuto
void * VSIMallocAlignedAuto(size_t nSize)
Allocates a buffer with an alignment constraint such that it can be used by the most demanding vector...
Definition: cpl_vsisimple.cpp:943
VSIFCloseL
int VSIFCloseL(VSILFILE *)
Close file.
Definition: cpl_vsil.cpp:1951
VSIFilesystemPluginCallbacksStruct::mkdir
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:659
VSIFilesystemPluginCallbacksStruct::rmdir
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:660
VSISetPathSpecificOption
void VSISetPathSpecificOption(const char *pszPathPrefix, const char *pszKey, const char *pszValue)
Set a path specific option for a given path prefix.
Definition: cpl_vsil.cpp:2871
VSIGetCredential
const char * VSIGetCredential(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value of a credential (or more generally an option related to a virtual file system) for a gi...
Definition: cpl_vsil.cpp:2939
VSIFReadMultiRangeL
int VSIFReadMultiRangeL(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes, VSILFILE *)
Read several ranges of bytes from file.
Definition: cpl_vsil.cpp:2219
VSIMalloc
void * VSIMalloc(size_t)
Analog of malloc().
Definition: cpl_vsisimple.cpp:556
VSIReadDirRecursive
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:183
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:235
VSIFilesystemPluginOpenCallback
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:560
VSIStatExL
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:807
VSIDIREntry::nMTime
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:401
VSIFilesystemPluginCallbacksStruct::sibling_files
VSIFilesystemPluginSiblingFilesCallback sibling_files
list related files
Definition: cpl_vsi.h:683
VSIDIREntry::bModeKnown
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:403
VSIDIR
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:382
VSIFilesystemPluginCallbacksStruct::read_dir
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:662
VSIDuplicateFileSystemHandler
bool VSIDuplicateFileSystemHandler(const char *pszSourceFSName, const char *pszNewFSName)
Duplicate an existing file system handler.
Definition: cpl_vsil.cpp:2998
VSISupportsSequentialWrite
bool VSISupportsSequentialWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports sequential write.
Definition: cpl_vsil.cpp:1059
VSISetCryptKey
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:204
CPL_WARN_UNUSED_RESULT
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:985
VSIStatBufL
#define VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:203
VSIFWriteL
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *)
Write bytes to file.
Definition: cpl_vsil.cpp:2271
VSIGetDiskFreeSpace
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2769
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:975
cpl_port.h
VSIInstallOSSStreamingFileHandler
void VSIInstallOSSStreamingFileHandler(void)
Install /vsiaz_streaming/ Alibaba Cloud Object Storage Service (OSS) (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2160
VSIInstallSwiftStreamingFileHandler
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streaming/ OpenStack Swif Object Storage (Swift) file system handler (requires libc...
Definition: cpl_vsil_curl_streaming.cpp:2181
VSICurlPartialClearCache
void VSICurlPartialClearCache(const char *pszFilenamePrefix)
Clean local cache associated with /vsicurl/ (and related file systems) for a given filename (and its ...
Definition: cpl_vsil_curl.cpp:5936
VSIInstallS3StreamingFileHandler
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2097
VSIMallocAlignedAutoVerbose
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:956
VSIFEofL
int VSIFEofL(VSILFILE *)
Test for end of file.
Definition: cpl_vsil.cpp:2315
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:1218
VSIIsLocal
bool VSIIsLocal(const char *pszPath)
Returns if the file/filesystem is "local".
Definition: cpl_vsil.cpp:1035
VSIMallocAligned
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:897
VSIReadDir
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:88
VSINetworkStatsReset
void VSINetworkStatsReset(void)
Clear network related statistics.
Definition: cpl_vsil_curl.cpp:5959
VSIFilesystemPluginCallbacksStruct::eof
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:674
VSIFilesystemPluginCallbacksStruct::read_multi_range
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:670
VSIFilesystemPluginCallbacksStruct::truncate
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:678
VSIFilesystemPluginCallbacksStruct::open
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:663
VSICopyFile
int VSICopyFile(const char *pszSource, const char *pszTarget, VSILFILE *fpSource, vsi_l_offset nSourceSize, const char *const *papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData)
Copy a source file into a target file.
Definition: cpl_vsil.cpp:525
VSICurlClearCache
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:5897
VSISetFileMetadata
int VSISetFileMetadata(const char *pszFilename, CSLConstList papszMetadata, const char *pszDomain, CSLConstList papszOptions)
Set metadata on files.
Definition: cpl_vsil.cpp:944
VSIDIREntry::bSizeKnown
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:405
VSIIngestFile
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2503
VSIFPutcL
int VSIFPutcL(int, VSILFILE *)
Write a single byte to the file.
Definition: cpl_vsil.cpp:2416
VSIFilesystemPluginCallbacksStruct::pUserData
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:655
VSIFilesystemPluginWriteCallback
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:605
VSIGetActualURL
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:1137
VSIAbortPendingUploads
int VSIAbortPendingUploads(const char *pszFilename)
Abort ongoing multi-part uploads.
Definition: cpl_vsil.cpp:678
VSIMalloc3
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1127
VSIFilesystemPluginCallbacksStruct::write
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:676
VSI_RANGE_STATUS_DATA
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:184
VSIFGetNativeFileDescriptorL
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2750
VSIFilesystemPluginCloseCallback
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:622
VSICallocVerbose
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1201
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *)
Read bytes from file.
Definition: cpl_vsil.cpp:2161