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 * SPDX-License-Identifier: MIT
14 ****************************************************************************/
15
16#ifndef CPL_VSI_H_INCLUDED
17#define CPL_VSI_H_INCLUDED
18
19#include "cpl_port.h"
20#include "cpl_progress.h"
21
22#include <stdbool.h>
23
42/* -------------------------------------------------------------------- */
43/* We need access to ``struct stat''. */
44/* -------------------------------------------------------------------- */
45
46/* Unix */
47#if !defined(_WIN32)
48#include <unistd.h>
49#endif
50
51/* Windows */
52#include <sys/stat.h>
53
54 CPL_C_START
55
57#ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
58#define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
59#else
60#define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
61#endif
64/* ==================================================================== */
65/* stdio file access functions. These do not support large */
66/* files, and do not go through the virtualization API. */
67/* ==================================================================== */
68
71FILE CPL_DLL *VSIFOpen(const char *, const char *) CPL_WARN_UNUSED_RESULT;
72 int CPL_DLL VSIFClose(FILE *);
73 int CPL_DLL VSIFSeek(FILE *, long, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
74 long CPL_DLL VSIFTell(FILE *) CPL_WARN_UNUSED_RESULT;
75 void CPL_DLL VSIRewind(FILE *);
76 void CPL_DLL VSIFFlush(FILE *);
77
78 size_t CPL_DLL VSIFRead(void *, size_t, size_t,
79 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
80 size_t CPL_DLL VSIFWrite(const void *, size_t, size_t,
81 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
82 char CPL_DLL *VSIFGets(char *, int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
83 int CPL_DLL VSIFPuts(const char *, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
84 int CPL_DLL VSIFPrintf(FILE *, CPL_FORMAT_STRING(const char *),
85 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
86 CPL_PRINT_FUNC_FORMAT(2, 3);
87
88 int CPL_DLL VSIFGetc(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
89 int CPL_DLL VSIFPutc(int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
90 int CPL_DLL VSIUngetc(int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91 int CPL_DLL VSIFEof(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
92
95/* ==================================================================== */
96/* VSIStat() related. */
97/* ==================================================================== */
98
100typedef struct stat VSIStatBuf;
101 int CPL_DLL VSIStat(const char *, VSIStatBuf *) CPL_WARN_UNUSED_RESULT;
104#ifdef _WIN32
105#define VSI_ISLNK(x) (0) /* N/A on Windows */
106#define VSI_ISREG(x) ((x)&S_IFREG)
107#define VSI_ISDIR(x) ((x)&S_IFDIR)
108#define VSI_ISCHR(x) ((x)&S_IFCHR)
109#define VSI_ISBLK(x) (0) /* N/A on Windows */
110#else
112#define VSI_ISLNK(x) S_ISLNK(x)
114#define VSI_ISREG(x) S_ISREG(x)
116#define VSI_ISDIR(x) S_ISDIR(x)
118#define VSI_ISCHR(x) S_ISCHR(x)
119#define VSI_ISBLK(x) S_ISBLK(x)
121#endif
122
123/* ==================================================================== */
124/* 64bit stdio file access functions. If we have a big size */
125/* defined, then provide prototypes for the large file API, */
126/* otherwise redefine to use the regular api. */
127/* ==================================================================== */
128
130 typedef GUIntBig vsi_l_offset;
132#define VSI_L_OFFSET_MAX GUINTBIG_MAX
133
135 typedef struct VSIVirtualHandle VSILFILE;
136
137 VSILFILE CPL_DLL *VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT;
138 VSILFILE CPL_DLL *VSIFOpenExL(const char *, const char *,
139 int) CPL_WARN_UNUSED_RESULT;
140 VSILFILE CPL_DLL *VSIFOpenEx2L(const char *, const char *, int,
141 CSLConstList) CPL_WARN_UNUSED_RESULT;
142 int CPL_DLL VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
143 int CPL_DLL VSIFSeekL(VSILFILE *, vsi_l_offset,
144 int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
145 vsi_l_offset CPL_DLL VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT;
146 void CPL_DLL VSIRewindL(VSILFILE *);
147 size_t CPL_DLL VSIFReadL(void *, size_t, size_t,
148 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
149 int CPL_DLL VSIFReadMultiRangeL(int nRanges, void **ppData,
150 const vsi_l_offset *panOffsets,
151 const size_t *panSizes,
152 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
153 size_t CPL_DLL VSIFWriteL(const void *, size_t, size_t,
154 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
155 void CPL_DLL VSIFClearErrL(VSILFILE *);
156 int CPL_DLL VSIFErrorL(VSILFILE *) CPL_WARN_UNUSED_RESULT;
157 int CPL_DLL VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
158 int CPL_DLL VSIFTruncateL(VSILFILE *,
159 vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
160 int CPL_DLL VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
161 int CPL_DLL VSIFPrintfL(VSILFILE *, CPL_FORMAT_STRING(const char *),
162 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
163 CPL_PRINT_FUNC_FORMAT(2, 3);
164 int CPL_DLL VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
165
167typedef enum
168{
169 VSI_RANGE_STATUS_UNKNOWN,
170 VSI_RANGE_STATUS_DATA,
171 VSI_RANGE_STATUS_HOLE
172} VSIRangeStatus;
173
174 VSIRangeStatus CPL_DLL VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart,
175 vsi_l_offset nLength);
176
177 int CPL_DLL VSIIngestFile(VSILFILE *fp, const char *pszFilename,
178 GByte **ppabyRet, vsi_l_offset *pnSize,
179 GIntBig nMaxSize) CPL_WARN_UNUSED_RESULT;
180
181 int CPL_DLL VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
182 CPL_WARN_UNUSED_RESULT;
183
184#if defined(VSI_STAT64_T)
186 typedef struct VSI_STAT64_T VSIStatBufL;
187#else
189#define VSIStatBufL VSIStatBuf
190#endif
191
192 int CPL_DLL VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT;
193
195#define VSI_STAT_EXISTS_FLAG 0x1
197#define VSI_STAT_NATURE_FLAG 0x2
199#define VSI_STAT_SIZE_FLAG 0x4
201#define VSI_STAT_SET_ERROR_FLAG 0x8
205#define VSI_STAT_CACHE_ONLY 0x10
206
207 int CPL_DLL VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf,
208 int nFlags) CPL_WARN_UNUSED_RESULT;
209
210 int CPL_DLL VSIIsCaseSensitiveFS(const char *pszFilename);
211
212 int CPL_DLL VSISupportsSparseFiles(const char *pszPath);
213
214 bool CPL_DLL VSIIsLocal(const char *pszPath);
215
216 char CPL_DLL *VSIGetCanonicalFilename(const char *pszPath);
217
218 bool CPL_DLL VSISupportsSequentialWrite(const char *pszPath,
219 bool bAllowLocalTempFile);
220
221 bool CPL_DLL VSISupportsRandomWrite(const char *pszPath,
222 bool bAllowLocalTempFile);
223
224 int CPL_DLL VSIHasOptimizedReadMultiRange(const char *pszPath);
225
226 const char CPL_DLL *VSIGetActualURL(const char *pszFilename);
227
228 char CPL_DLL *VSIGetSignedURL(const char *pszFilename,
229 CSLConstList papszOptions);
230
231 const char CPL_DLL *VSIGetFileSystemOptions(const char *pszFilename);
232
233 char CPL_DLL **VSIGetFileSystemsPrefixes(void);
234
235 void CPL_DLL *VSIFGetNativeFileDescriptorL(VSILFILE *);
236
237 char CPL_DLL **
238 VSIGetFileMetadata(const char *pszFilename, const char *pszDomain,
239 CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
240
241 int CPL_DLL VSISetFileMetadata(const char *pszFilename,
242 CSLConstList papszMetadata,
243 const char *pszDomain,
244 CSLConstList papszOptions);
245
246 void CPL_DLL VSISetPathSpecificOption(const char *pszPathPrefix,
247 const char *pszKey, const char *pszValue);
248 void CPL_DLL VSIClearPathSpecificOptions(const char *pszPathPrefix);
249 const char CPL_DLL *VSIGetPathSpecificOption(const char *pszPath,
250 const char *pszKey,
251 const char *pszDefault);
252
253 void CPL_DLL VSISetCredential(const char *pszPathPrefix, const char *pszKey,
254 const char *pszValue)
256 CPL_WARN_DEPRECATED("Use VSISetPathSpecificOption instead")
258 ;
259 void CPL_DLL VSIClearCredentials(const char *pszPathPrefix)
261 CPL_WARN_DEPRECATED("Use VSIClearPathSpecificOptions instead")
263 ;
264 const char CPL_DLL *VSIGetCredential(const char *pszPath, const char *pszKey,
265 const char *pszDefault)
267 CPL_WARN_DEPRECATED("Use VSIGetPathSpecificOption instead")
269 ;
270
271/* ==================================================================== */
272/* Memory allocation */
273/* ==================================================================== */
274
275 void CPL_DLL *VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT;
276 void CPL_DLL *VSIMalloc(size_t) CPL_WARN_UNUSED_RESULT;
277 void CPL_DLL VSIFree(void *);
278 void CPL_DLL *VSIRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT;
279 char CPL_DLL *VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT;
280
281#if defined(__cplusplus) && defined(GDAL_COMPILATION)
282 extern "C++"
283{
285 struct CPL_DLL VSIFreeReleaser
286 {
287 void operator()(void *p) const
288 {
289 VSIFree(p);
290 }
291 };
292
294}
295#endif
296
297 void CPL_DLL *VSIMallocAligned(size_t nAlignment,
298 size_t nSize) CPL_WARN_UNUSED_RESULT;
299 void CPL_DLL *VSIMallocAlignedAuto(size_t nSize) CPL_WARN_UNUSED_RESULT;
300 void CPL_DLL VSIFreeAligned(void *ptr);
301
302 void CPL_DLL *VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile,
303 int nLine) CPL_WARN_UNUSED_RESULT;
305#define VSI_MALLOC_ALIGNED_AUTO_VERBOSE(size) \
306 VSIMallocAlignedAutoVerbose(size, __FILE__, __LINE__)
307
315 void CPL_DLL *VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT;
316
325 void CPL_DLL *VSIMalloc3(size_t nSize1, size_t nSize2,
326 size_t nSize3) CPL_WARN_UNUSED_RESULT;
327
329 void CPL_DLL *VSIMallocVerbose(size_t nSize, const char *pszFile,
330 int nLine) CPL_WARN_UNUSED_RESULT;
332#define VSI_MALLOC_VERBOSE(size) VSIMallocVerbose(size, __FILE__, __LINE__)
333
335 void CPL_DLL *VSIMalloc2Verbose(size_t nSize1, size_t nSize2,
336 const char *pszFile,
337 int nLine) CPL_WARN_UNUSED_RESULT;
339#define VSI_MALLOC2_VERBOSE(nSize1, nSize2) \
340 VSIMalloc2Verbose(nSize1, nSize2, __FILE__, __LINE__)
341
343 void CPL_DLL *VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3,
344 const char *pszFile,
345 int nLine) CPL_WARN_UNUSED_RESULT;
347#define VSI_MALLOC3_VERBOSE(nSize1, nSize2, nSize3) \
348 VSIMalloc3Verbose(nSize1, nSize2, nSize3, __FILE__, __LINE__)
349
351 void CPL_DLL *VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile,
352 int nLine) CPL_WARN_UNUSED_RESULT;
354#define VSI_CALLOC_VERBOSE(nCount, nSize) \
355 VSICallocVerbose(nCount, nSize, __FILE__, __LINE__)
356
358 void CPL_DLL *VSIReallocVerbose(void *pOldPtr, size_t nNewSize,
359 const char *pszFile,
360 int nLine) CPL_WARN_UNUSED_RESULT;
362#define VSI_REALLOC_VERBOSE(pOldPtr, nNewSize) \
363 VSIReallocVerbose(pOldPtr, nNewSize, __FILE__, __LINE__)
364
366 char CPL_DLL *VSIStrdupVerbose(const char *pszStr, const char *pszFile,
367 int nLine) CPL_WARN_UNUSED_RESULT;
369#define VSI_STRDUP_VERBOSE(pszStr) VSIStrdupVerbose(pszStr, __FILE__, __LINE__)
370
371 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
372 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
373
374/* ==================================================================== */
375/* Other... */
376/* ==================================================================== */
377
379#define CPLReadDir VSIReadDir
380 char CPL_DLL **VSIReadDir(const char *);
381 char CPL_DLL **VSIReadDirRecursive(const char *pszPath);
382 char CPL_DLL **VSIReadDirEx(const char *pszPath, int nMaxFiles);
383 char CPL_DLL **VSISiblingFiles(const char *pszPath);
384
385 const char CPL_DLL *VSIGetDirectorySeparator(const char *pszPath);
386
388 typedef struct VSIDIR VSIDIR;
389
390 VSIDIR CPL_DLL *VSIOpenDir(const char *pszPath, int nRecurseDepth,
391 const char *const *papszOptions);
392
394 typedef struct VSIDIREntry VSIDIREntry;
395
399 struct VSIDIREntry
400{
402 char *pszName;
404 int nMode;
406 vsi_l_offset nSize;
408 GIntBig nMTime;
410 char bModeKnown;
412 char bSizeKnown;
414 char bMTimeKnown;
416 char **papszExtra;
417
418#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
420 VSIDIREntry();
421 ~VSIDIREntry();
422 VSIDIREntry(const VSIDIREntry &);
423 VSIDIREntry &operator=(VSIDIREntry &) = delete;
425#endif
426};
427
428 const VSIDIREntry CPL_DLL *VSIGetNextDirEntry(VSIDIR *dir);
429 void CPL_DLL VSICloseDir(VSIDIR *dir);
430
431 int CPL_DLL VSIMkdir(const char *pszPathname, long mode);
432 int CPL_DLL VSIMkdirRecursive(const char *pszPathname, long mode);
433 int CPL_DLL VSIRmdir(const char *pszDirname);
434 int CPL_DLL VSIRmdirRecursive(const char *pszDirname);
435 int CPL_DLL VSIUnlink(const char *pszFilename);
436 int CPL_DLL *VSIUnlinkBatch(CSLConstList papszFiles);
437 int CPL_DLL VSIRename(const char *oldpath, const char *newpath);
438 int CPL_DLL VSICopyFile(const char *pszSource, const char *pszTarget,
439 VSILFILE *fpSource, vsi_l_offset nSourceSize,
440 const char *const *papszOptions,
441 GDALProgressFunc pProgressFunc, void *pProgressData);
442 int CPL_DLL VSICopyFileRestartable(const char *pszSource, const char *pszTarget,
443 const char *pszInputPayload,
444 char **ppszOutputPayload,
445 const char *const *papszOptions,
446 GDALProgressFunc pProgressFunc,
447 void *pProgressData);
448 int CPL_DLL VSISync(const char *pszSource, const char *pszTarget,
449 const char *const *papszOptions,
450 GDALProgressFunc pProgressFunc, void *pProgressData,
451 char ***ppapszOutputs);
452
453 int CPL_DLL VSIMultipartUploadGetCapabilities(
454 const char *pszFilename, int *pbNonSequentialUploadSupported,
455 int *pbParallelUploadSupported, int *pbAbortSupported,
456 size_t *pnMinPartSize, size_t *pnMaxPartSize, int *pnMaxPartCount);
457
458 char CPL_DLL *VSIMultipartUploadStart(const char *pszFilename,
459 CSLConstList papszOptions);
460 char CPL_DLL *VSIMultipartUploadAddPart(const char *pszFilename,
461 const char *pszUploadId,
462 int nPartNumber,
463 vsi_l_offset nFileOffset,
464 const void *pData, size_t nDataLength,
465 CSLConstList papszOptions);
466 int CPL_DLL VSIMultipartUploadEnd(const char *pszFilename,
467 const char *pszUploadId, size_t nPartIdsCount,
468 const char *const *apszPartIds,
469 vsi_l_offset nTotalSize,
470 CSLConstList papszOptions);
471 int CPL_DLL VSIMultipartUploadAbort(const char *pszFilename,
472 const char *pszUploadId,
473 CSLConstList papszOptions);
474
475 int CPL_DLL VSIAbortPendingUploads(const char *pszFilename);
476
477 char CPL_DLL *VSIStrerror(int);
478 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
479
480 void CPL_DLL VSINetworkStatsReset(void);
481 char CPL_DLL *VSINetworkStatsGetAsSerializedJSON(char **papszOptions);
482
483/* ==================================================================== */
484/* Install special file access handlers. */
485/* ==================================================================== */
486 void CPL_DLL VSIInstallMemFileHandler(void);
488 void CPL_DLL VSIInstallLargeFileHandler(void);
490 void CPL_DLL VSIInstallSubFileHandler(void);
491 void VSIInstallCurlFileHandler(void);
492 void CPL_DLL VSICurlClearCache(void);
493 void CPL_DLL VSICurlPartialClearCache(const char *pszFilenamePrefix);
494 void VSIInstallCurlStreamingFileHandler(void);
495 void VSIInstallS3FileHandler(void);
496 void VSIInstallS3StreamingFileHandler(void);
497 void VSIInstallGSFileHandler(void);
498 void VSIInstallGSStreamingFileHandler(void);
499 void VSIInstallAzureFileHandler(void);
500 void VSIInstallAzureStreamingFileHandler(void);
501 void VSIInstallADLSFileHandler(void);
502 void VSIInstallOSSFileHandler(void);
503 void VSIInstallOSSStreamingFileHandler(void);
504 void VSIInstallSwiftFileHandler(void);
505 void VSIInstallSwiftStreamingFileHandler(void);
506 void VSIInstall7zFileHandler(void); /* No reason to export that */
507 void VSIInstallRarFileHandler(void); /* No reason to export that */
508 void VSIInstallGZipFileHandler(void); /* No reason to export that */
509 void VSIInstallZipFileHandler(void); /* No reason to export that */
510 void VSIInstallStdinHandler(void); /* No reason to export that */
511 void VSIInstallHdfsHandler(void); /* No reason to export that */
512 void VSIInstallWebHdfsHandler(void); /* No reason to export that */
513 void VSIInstallStdoutHandler(void); /* No reason to export that */
514 void CPL_DLL VSIInstallSparseFileHandler(void);
515 void VSIInstallTarFileHandler(void); /* No reason to export that */
516 void VSIInstallCachedFileHandler(void); /* No reason to export that */
517 void CPL_DLL VSIInstallCryptFileHandler(void);
518 void CPL_DLL VSISetCryptKey(const GByte *pabyKey, int nKeySize);
520 void CPL_DLL VSICleanupFileManager(void);
523 bool CPL_DLL VSIDuplicateFileSystemHandler(const char *pszSourceFSName,
524 const char *pszNewFSName);
525
526 VSILFILE CPL_DLL *
527 VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData,
528 vsi_l_offset nDataLength,
529 int bTakeOwnership) CPL_WARN_UNUSED_RESULT;
530 GByte CPL_DLL *VSIGetMemFileBuffer(const char *pszFilename,
531 vsi_l_offset *pnDataLength,
532 int bUnlinkAndSeize);
533
534 const char CPL_DLL *VSIMemGenerateHiddenFilename(const char *pszFilename);
535
537 typedef size_t (*VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb,
538 FILE *stream);
539 void CPL_DLL VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream);
540
545 typedef int (*VSIFilesystemPluginStatCallback)(void *pUserData,
546 const char *pszFilename,
547 VSIStatBufL *pStatBuf,
548 int nFlags);
553 typedef int (*VSIFilesystemPluginUnlinkCallback)(void *pUserData,
554 const char *pszFilename);
559 typedef int (*VSIFilesystemPluginRenameCallback)(void *pUserData,
560 const char *oldpath,
561 const char *newpath);
566 typedef int (*VSIFilesystemPluginMkdirCallback)(void *pUserData,
567 const char *pszDirname,
568 long nMode);
573 typedef int (*VSIFilesystemPluginRmdirCallback)(void *pUserData,
574 const char *pszDirname);
579 typedef char **(*VSIFilesystemPluginReadDirCallback)(void *pUserData,
580 const char *pszDirname,
581 int nMaxFiles);
591 typedef char **(*VSIFilesystemPluginSiblingFilesCallback)(
592 void *pUserData, const char *pszDirname);
599 typedef void *(*VSIFilesystemPluginOpenCallback)(void *pUserData,
600 const char *pszFilename,
601 const char *pszAccess);
606 typedef vsi_l_offset (*VSIFilesystemPluginTellCallback)(void *pFile);
611 typedef int (*VSIFilesystemPluginSeekCallback)(void *pFile,
612 vsi_l_offset nOffset,
613 int nWhence);
619 typedef size_t (*VSIFilesystemPluginReadCallback)(void *pFile, void *pBuffer,
620 size_t nSize, size_t nCount);
626 typedef int (*VSIFilesystemPluginReadMultiRangeCallback)(
627 void *pFile, int nRanges, void **ppData, const vsi_l_offset *panOffsets,
628 const size_t *panSizes);
633 typedef VSIRangeStatus (*VSIFilesystemPluginGetRangeStatusCallback)(
634 void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength);
639 typedef int (*VSIFilesystemPluginEofCallback)(void *pFile);
644 typedef size_t (*VSIFilesystemPluginWriteCallback)(void *pFile,
645 const void *pBuffer,
646 size_t nSize, size_t nCount);
651 typedef int (*VSIFilesystemPluginFlushCallback)(void *pFile);
655 typedef int (*VSIFilesystemPluginTruncateCallback)(void *pFile,
656 vsi_l_offset nNewSize);
661 typedef int (*VSIFilesystemPluginCloseCallback)(void *pFile);
662
677 typedef void (*VSIFilesystemPluginAdviseReadCallback)(
678 void *pFile, int nRanges, const vsi_l_offset *panOffsets,
679 const size_t *panSizes);
680
685 typedef int (*VSIFilesystemPluginErrorCallback)(void *pFile);
686
691 typedef void (*VSIFilesystemPluginClearErrCallback)(void *pFile);
692
700 typedef struct
701{
706 void *pUserData;
707 VSIFilesystemPluginStatCallback stat;
708 VSIFilesystemPluginUnlinkCallback unlink;
709 VSIFilesystemPluginRenameCallback rename;
710 VSIFilesystemPluginMkdirCallback mkdir;
711 VSIFilesystemPluginRmdirCallback rmdir;
712 VSIFilesystemPluginReadDirCallback
713 read_dir;
714 VSIFilesystemPluginOpenCallback open;
715 VSIFilesystemPluginTellCallback
716 tell;
717 VSIFilesystemPluginSeekCallback
718 seek;
719 VSIFilesystemPluginReadCallback read;
720 VSIFilesystemPluginReadMultiRangeCallback
721 read_multi_range;
722 VSIFilesystemPluginGetRangeStatusCallback
723 get_range_status;
724 VSIFilesystemPluginEofCallback
725 eof;
726 VSIFilesystemPluginWriteCallback
727 write;
728 VSIFilesystemPluginFlushCallback flush;
729 VSIFilesystemPluginTruncateCallback truncate;
730 VSIFilesystemPluginCloseCallback close;
731 size_t nBufferSize;
732 size_t nCacheSize;
733 VSIFilesystemPluginSiblingFilesCallback
734 sibling_files;
737 VSIFilesystemPluginAdviseReadCallback advise_read;
739 VSIFilesystemPluginErrorCallback error;
740 VSIFilesystemPluginClearErrCallback clear_err;
741 /*
742 Callbacks are defined as a struct allocated by a call to
743 VSIAllocFilesystemPluginCallbacksStruct in order to try to maintain ABI
744 stability when eventually adding a new member. Any callbacks added to
745 this struct SHOULD be added to the END of this struct
746 */
747} VSIFilesystemPluginCallbacksStruct;
748
754 VSIFilesystemPluginCallbacksStruct CPL_DLL *
755 VSIAllocFilesystemPluginCallbacksStruct(void);
756
761 void CPL_DLL VSIFreeFilesystemPluginCallbacksStruct(
762 VSIFilesystemPluginCallbacksStruct *poCb);
763
770 int CPL_DLL VSIInstallPluginHandler(
771 const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb);
772
782 int CPL_DLL VSIRemovePluginHandler(const char *pszPrefix);
783
784/* ==================================================================== */
785/* Time querying. */
786/* ==================================================================== */
787
789 unsigned long CPL_DLL VSITime(unsigned long *);
790 const char CPL_DLL *VSICTime(unsigned long);
791 struct tm CPL_DLL *VSIGMTime(const time_t *pnTime, struct tm *poBrokenTime);
792 struct tm CPL_DLL *VSILocalTime(const time_t *pnTime, struct tm *poBrokenTime);
796/* -------------------------------------------------------------------- */
797/* the following can be turned on for detailed logging of */
798/* almost all IO calls. */
799/* -------------------------------------------------------------------- */
800#ifdef VSI_DEBUG
801
802#ifndef DEBUG
803#define DEBUG
804#endif
805
806#include "cpl_error.h"
807
808#define VSIDebug4(f, a1, a2, a3, a4) CPLDebug("VSI", f, a1, a2, a3, a4);
809#define VSIDebug3(f, a1, a2, a3) CPLDebug("VSI", f, a1, a2, a3);
810#define VSIDebug2(f, a1, a2) CPLDebug("VSI", f, a1, a2);
811#define VSIDebug1(f, a1) CPLDebug("VSI", f, a1);
812#else
813#define VSIDebug4(f, a1, a2, a3, a4) \
814 { \
815 }
816#define VSIDebug3(f, a1, a2, a3) \
817 { \
818 }
819#define VSIDebug2(f, a1, a2) \
820 { \
821 }
822#define VSIDebug1(f, a1) \
823 { \
824 }
825#endif
828 CPL_C_END
829
830#endif /* ndef CPL_VSI_H_INCLUDED */
cpl_error.h
CPL error handling services.
cpl_port.h
Core portability definitions for CPL.
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:202
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:283
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:279
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:954
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:938
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1179
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:964
GByte
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:169
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:199
VSIStatBufL
#define VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:189
VSICallocVerbose
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1202
VSISetFileMetadata
int VSISetFileMetadata(const char *pszFilename, CSLConstList papszMetadata, const char *pszDomain, CSLConstList papszOptions)
Set metadata on files.
Definition: cpl_vsil.cpp:1335
VSIUnlinkBatch
int * VSIUnlinkBatch(CSLConstList papszFiles)
Delete several files, possibly in a batch.
Definition: cpl_vsil.cpp:465
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:3094
VSINetworkStatsReset
void VSINetworkStatsReset(void)
Clear network related statistics.
Definition: cpl_vsil_curl.cpp:6273
VSIInstallCachedFileHandler
void VSIInstallCachedFileHandler(void)
Install /vsicached? file system handler.
Definition: cpl_vsil_cache.cpp:736
VSIWriteFunction
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:537
VSIInstallS3StreamingFileHandler
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2127
VSISiblingFiles
char ** VSISiblingFiles(const char *pszPath)
Return related filenames.
Definition: cpl_vsil.cpp:135
VSIFFlushL
int VSIFFlushL(VSILFILE *)
Flush pending writes to disk.
Definition: cpl_vsil.cpp:2622
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:626
VSIGetDirectorySeparator
const char * VSIGetDirectorySeparator(const char *pszPath)
Return the directory separator for the specified path.
Definition: cpl_vsil.cpp:154
VSIFTellL
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:2553
VSIRename
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:509
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:3460
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:551
VSIFWriteL
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *)
Write bytes to file.
Definition: cpl_vsil.cpp:2786
VSIRangeStatus
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:168
VSI_RANGE_STATUS_DATA
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:170
VSI_RANGE_STATUS_HOLE
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:171
VSI_RANGE_STATUS_UNKNOWN
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:169
VSIMultipartUploadEnd
int VSIMultipartUploadEnd(const char *pszFilename, const char *pszUploadId, size_t nPartIdsCount, const char *const *apszPartIds, vsi_l_offset nTotalSize, CSLConstList papszOptions)
Completes a multi-part file upload.
Definition: cpl_vsil.cpp:932
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:619
VSIInstallStdinHandler
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:682
VSISupportsRandomWrite
bool VSISupportsRandomWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports random write.
Definition: cpl_vsil.cpp:1499
CPLGetPhysicalRAM
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1385
VSIFTruncateL
int VSIFTruncateL(VSILFILE *, vsi_l_offset)
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:2952
VSICalloc
void * VSICalloc(size_t, size_t)
Analog of calloc().
Definition: cpl_vsisimple.cpp:436
VSIFilesystemPluginTellCallback
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:606
VSIIsCaseSensitiveFS
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:1369
VSIInstallGZipFileHandler
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:3350
VSIMalloc2Verbose
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1153
VSIFClearErrL
void VSIFClearErrL(VSILFILE *)
Reset the error and end-of-file indicators.
Definition: cpl_vsil.cpp:2912
VSIHasOptimizedReadMultiRange
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:1524
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:677
VSIFilesystemPluginReadDirCallback
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:579
VSIFreeFilesystemPluginCallbacksStruct
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:505
VSIFilesystemPluginRenameCallback
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:559
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:3497
VSIRemovePluginHandler
int VSIRemovePluginHandler(const char *pszPrefix)
Unregister a handler previously installed with VSIInstallPluginHandler() on the given prefix.
Definition: cpl_vsil_plugin.cpp:492
VSIInstallCurlFileHandler
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:6187
VSIMallocVerbose
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1136
VSIInstallWebHdfsHandler
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1191
VSISupportsSequentialWrite
bool VSISupportsSequentialWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports sequential write.
Definition: cpl_vsil.cpp:1475
VSIFErrorL
int VSIFErrorL(VSILFILE *)
Test the error indicator.
Definition: cpl_vsil.cpp:2877
VSIInstallS3FileHandler
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:5163
VSIInstallHdfsHandler
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:466
VSIInstallCryptFileHandler
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2067
VSIGetFileSystemsPrefixes
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:3416
VSIOverwriteFile
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:3305
VSIInstallSwiftStreamingFileHandler
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streaming/ OpenStack Swif Object Storage (Swift) file system handler (requires libc...
Definition: cpl_vsil_curl_streaming.cpp:2211
VSISetCryptKey
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:188
VSIMallocAlignedAutoVerbose
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:956
VSIInstallStdoutHandler
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:452
VSIMkdirRecursive
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:383
VSIInstallMemFileHandler
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:1168
VSIFPutcL
int VSIFPutcL(int, VSILFILE *)
Write a single byte to the file.
Definition: cpl_vsil.cpp:3042
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:751
VSIMalloc2
void * VSIMalloc2(size_t nSize1, size_t nSize2)
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1114
VSIFilesystemPluginCloseCallback
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:661
VSIDIR
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:388
VSICurlClearCache
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:6211
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:6250
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:3129
VSIFOpenExL
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open/create file.
Definition: cpl_vsil.cpp:2325
VSISupportsSparseFiles
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:1398
VSIMultipartUploadAbort
int VSIMultipartUploadAbort(const char *pszFilename, const char *pszUploadId, CSLConstList papszOptions)
Aborts a multi-part file upload.
Definition: cpl_vsil.cpp:967
VSIMultipartUploadAddPart
char * VSIMultipartUploadAddPart(const char *pszFilename, const char *pszUploadId, int nPartNumber, vsi_l_offset nFileOffset, const void *pData, size_t nDataLength, CSLConstList papszOptions)
Uploads a new part to a multi-part uploaded file.
Definition: cpl_vsil.cpp:895
VSIFilesystemPluginMkdirCallback
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:566
VSIRealloc
void * VSIRealloc(void *, size_t)
Analog of realloc().
Definition: cpl_vsisimple.cpp:679
VSIFilesystemPluginTruncateCallback
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:655
VSIAllocFilesystemPluginCallbacksStruct
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:499
VSIFilesystemPluginWriteCallback
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:644
VSIFilesystemPluginSiblingFilesCallback
char **(* VSIFilesystemPluginSiblingFilesCallback)(void *pUserData, const char *pszDirname)
List related files.
Definition: cpl_vsi.h:591
VSIMultipartUploadGetCapabilities
int VSIMultipartUploadGetCapabilities(const char *pszFilename, int *pbNonSequentialUploadSupported, int *pbParallelUploadSupported, int *pbAbortSupported, size_t *pnMinPartSize, size_t *pnMaxPartSize, int *pnMaxPartCount)
Return capabilities for multiple part file upload.
Definition: cpl_vsil.cpp:808
VSICloseDir
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:336
VSIUnlink
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:434
VSIMalloc3
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1127
VSIFCloseL
int VSIFCloseL(VSILFILE *)
Close file.
Definition: cpl_vsil.cpp:2454
VSIOpenDir
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:277
VSIGetMemFileBuffer
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:1286
VSIInstallSwiftFileHandler
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:724
VSIInstallZipFileHandler
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:4978
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:3565
VSIFilesystemPluginGetRangeStatusCallback
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:633
VSIFGetNativeFileDescriptorL
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:3376
VSIGetCanonicalFilename
char * VSIGetCanonicalFilename(const char *pszPath)
Returns the canonical filename.
Definition: cpl_vsil.cpp:1451
VSIFilesystemPluginSeekCallback
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:611
VSIClearCredentials
void VSIClearCredentials(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:3524
VSIFilesystemPluginStatCallback
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:545
VSIInstallOSSStreamingFileHandler
void VSIInstallOSSStreamingFileHandler(void)
Install /vsiaz_streaming/ Alibaba Cloud Object Storage Service (OSS) (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2190
VSIReadDirEx
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:107
VSIMallocAligned
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:893
VSIGetSignedURL
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:1597
VSIFilesystemPluginClearErrCallback
void(* VSIFilesystemPluginClearErrCallback)(void *pFile)
Clear error and end-of-file flags.
Definition: cpl_vsi.h:691
VSIInstallPluginHandler
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:482
VSIGetActualURL
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:1553
VSIRmdirRecursive
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:1122
VSIMkdir
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:361
VSIReallocVerbose
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1221
VSIFilesystemPluginOpenCallback
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:599
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *)
Read bytes from file.
Definition: cpl_vsil.cpp:2676
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:2734
VSIInstallCurlStreamingFileHandler
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2107
VSIStrdup
char * VSIStrdup(const char *)
Analog of strdup().
Definition: cpl_vsisimple.cpp:999
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:1634
VSIFEofL
int VSIFEofL(VSILFILE *)
Test for end of file.
Definition: cpl_vsil.cpp:2830
VSIInstallSparseFileHandler
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:582
VSIInstallSubFileHandler
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:515
VSIRewindL
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:2573
VSIReadDir
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:73
VSIMalloc3Verbose
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1177
VSIFilesystemPluginUnlinkCallback
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:553
VSIInstallRarFileHandler
void VSIInstallRarFileHandler(void)
Install /vsirar/ RAR file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:49
VSIStrerror
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1362
VSIDuplicateFileSystemHandler
bool VSIDuplicateFileSystemHandler(const char *pszSourceFSName, const char *pszNewFSName)
Duplicate an existing file system handler.
Definition: cpl_vsil.cpp:3624
VSIInstallADLSFileHandler
void VSIInstallADLSFileHandler(void)
Install /vsiaz/ Microsoft Azure Data Lake Storage Gen2 file system handler (requires libcurl)
Definition: cpl_vsil_adls.cpp:2183
CPLGetUsablePhysicalRAM
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1605
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:1158
VSIReadDirRecursive
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:194
VSICopyFileRestartable
int VSICopyFileRestartable(const char *pszSource, const char *pszTarget, const char *pszInputPayload, char **ppszOutputPayload, const char *const *papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData)
Copy a source file into a target file in a way that can (potentially) be restarted.
Definition: cpl_vsil.cpp:644
VSIInstallGSStreamingFileHandler
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2148
VSIFilesystemPluginEofCallback
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:639
VSIFPrintfL
int VSIFPrintfL(VSILFILE *, const char *,...)
Formatted write to file.
Definition: cpl_vsil.cpp:2976
VSIStatExL
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:1198
VSINetworkStatsGetAsSerializedJSON
char * VSINetworkStatsGetAsSerializedJSON(char **papszOptions)
Return network related statistics, as a JSON serialized object.
Definition: cpl_vsil_curl.cpp:6373
VSIInstallOSSFileHandler
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:322
VSIGetDiskFreeSpace
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:3395
VSIFOpenEx2L
VSILFILE * VSIFOpenEx2L(const char *, const char *, int, CSLConstList)
Open/create file.
Definition: cpl_vsil.cpp:2399
VSIInstallTarFileHandler
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:655
VSIInstall7zFileHandler
void VSIInstall7zFileHandler(void)
Install /vsi7z/ 7zip file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:31
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:3436
VSIFreeAligned
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:979
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
VSIAbortPendingUploads
int VSIAbortPendingUploads(const char *pszFilename)
Abort all ongoing multi-part uploads.
Definition: cpl_vsil.cpp:1069
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:46
VSIGetPathSpecificOption
const char * VSIGetPathSpecificOption(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value a path specific option.
Definition: cpl_vsil.cpp:3584
VSIMalloc
void * VSIMalloc(size_t)
Analog of malloc().
Definition: cpl_vsisimple.cpp:552
VSIFSeekL
int VSIFSeekL(VSILFILE *, vsi_l_offset, int)
Seek to requested offset.
Definition: cpl_vsil.cpp:2512
VSIFilesystemPluginFlushCallback
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:651
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:1201
VSIIsLocal
bool VSIIsLocal(const char *pszPath)
Returns if the file/filesystem is "local".
Definition: cpl_vsil.cpp:1426
VSIMemGenerateHiddenFilename
const char * VSIMemGenerateHiddenFilename(const char *pszFilename)
Generates a unique filename that can be used with the /vsimem/ virtual file system.
Definition: cpl_vsi_mem.cpp:1364
VSIRmdir
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:1096
VSIInstallAzureFileHandler
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:2608
VSIFree
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:828
VSIStrdupVerbose
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1239
VSIClearPathSpecificOptions
void VSIClearPathSpecificOptions(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:3542
vsi_l_offset
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:130
VSIGetNextDirEntry
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:317
VSIMultipartUploadStart
char * VSIMultipartUploadStart(const char *pszFilename, CSLConstList papszOptions)
Initiates the upload a (big) file in a piece-wise way.
Definition: cpl_vsil.cpp:857
VSIInstallGSFileHandler
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:812
VSIFilesystemPluginErrorCallback
int(* VSIFilesystemPluginErrorCallback)(void *pFile)
Has a read error (non end-of-file related) has occurred?
Definition: cpl_vsi.h:685
VSIInstallAzureStreamingFileHandler
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2169
VSIGetFileMetadata
char ** VSIGetFileMetadata(const char *pszFilename, const char *pszDomain, CSLConstList papszOptions)
Get metadata on files.
Definition: cpl_vsil.cpp:1265
VSIFilesystemPluginRmdirCallback
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:573
VSIDIREntry
Directory entry.
Definition: cpl_vsi.h:400
VSIDIREntry::pszName
char * pszName
Filename.
Definition: cpl_vsi.h:402
VSIDIREntry::nMTime
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:408
VSIDIREntry::bMTimeKnown
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:414
VSIDIREntry::bSizeKnown
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:412
VSIDIREntry::bModeKnown
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:410
VSIDIREntry::papszExtra
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:416
VSIDIREntry::nSize
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:406
VSIDIREntry::nMode
int nMode
File mode.
Definition: cpl_vsi.h:404
VSIFilesystemPluginCallbacksStruct
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:701
VSIFilesystemPluginCallbacksStruct::advise_read
VSIFilesystemPluginAdviseReadCallback advise_read
The following optional member has been added in GDAL 3.7:
Definition: cpl_vsi.h:737
VSIFilesystemPluginCallbacksStruct::write
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:727
VSIFilesystemPluginCallbacksStruct::nBufferSize
size_t nBufferSize
buffer small reads (makes handler read only)
Definition: cpl_vsi.h:731
VSIFilesystemPluginCallbacksStruct::rename
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:709
VSIFilesystemPluginCallbacksStruct::read_multi_range
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:721
VSIFilesystemPluginCallbacksStruct::unlink
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:708
VSIFilesystemPluginCallbacksStruct::rmdir
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:711
VSIFilesystemPluginCallbacksStruct::clear_err
VSIFilesystemPluginClearErrCallback clear_err
clear error flags(r)
Definition: cpl_vsi.h:740
VSIFilesystemPluginCallbacksStruct::nCacheSize
size_t nCacheSize
max mem to use per file when buffering
Definition: cpl_vsi.h:732
VSIFilesystemPluginCallbacksStruct::eof
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:725
VSIFilesystemPluginCallbacksStruct::sibling_files
VSIFilesystemPluginSiblingFilesCallback sibling_files
list related files
Definition: cpl_vsi.h:734
VSIFilesystemPluginCallbacksStruct::open
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:714
VSIFilesystemPluginCallbacksStruct::seek
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:718
VSIFilesystemPluginCallbacksStruct::get_range_status
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:723
VSIFilesystemPluginCallbacksStruct::close
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:730
VSIFilesystemPluginCallbacksStruct::read
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:719
VSIFilesystemPluginCallbacksStruct::flush
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:728
VSIFilesystemPluginCallbacksStruct::read_dir
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:713
VSIFilesystemPluginCallbacksStruct::pUserData
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:706
VSIFilesystemPluginCallbacksStruct::error
VSIFilesystemPluginErrorCallback error
has read error occurred (r)
Definition: cpl_vsi.h:739
VSIFilesystemPluginCallbacksStruct::truncate
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:729
VSIFilesystemPluginCallbacksStruct::mkdir
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:710
VSIFilesystemPluginCallbacksStruct::stat
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:707
VSIFilesystemPluginCallbacksStruct::tell
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:716
VSIVirtualHandle
Virtual file handle.
Definition: cpl_vsi_virtual.h:47