Go to the documentation of this file.
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
36 #include "cpl_progress.h"
73 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
74 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
76 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
88 int CPL_DLL VSIFClose(FILE *);
89 int CPL_DLL VSIFSeek(FILE *,
long,
int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91 void CPL_DLL VSIRewind(FILE *);
92 void CPL_DLL VSIFFlush(FILE *);
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;
101 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
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;
116 typedef struct stat VSIStatBuf;
121 #define VSI_ISLNK(x) (0)
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)
128 #define VSI_ISLNK(x) S_ISLNK(x)
130 #define VSI_ISREG(x) S_ISREG(x)
132 #define VSI_ISDIR(x) S_ISDIR(x)
134 #define VSI_ISCHR(x) S_ISCHR(x)
135 #define VSI_ISBLK(x) S_ISBLK(x)
148 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
160 int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
163 size_t CPL_DLL
VSIFReadL(
void *,
size_t,
size_t,
164 VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
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;
176 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
198 #if defined(VSI_STAT64_T)
203 #define VSIStatBufL VSIStatBuf
209 #define VSI_STAT_EXISTS_FLAG 0x1
211 #define VSI_STAT_NATURE_FLAG 0x2
213 #define VSI_STAT_SIZE_FLAG 0x4
215 #define VSI_STAT_SET_ERROR_FLAG 0x8
219 #define VSI_STAT_CACHE_ONLY 0x10
233 bool bAllowLocalTempFile);
236 bool bAllowLocalTempFile);
257 const char *pszDomain,
261 const char *pszKey,
const char *pszValue);
265 const char *pszDefault);
267 void CPL_DLL
VSISetCredential(
const char *pszPathPrefix,
const char *pszKey,
268 const char *pszValue)
270 CPL_WARN_DEPRECATED(
"Use VSISetPathSpecificOption instead")
275 CPL_WARN_DEPRECATED(
"Use VSIClearPathSpecificOptions instead")
278 const char CPL_DLL *
VSIGetCredential(
const char *pszPath,
const char *pszKey,
279 const char *pszDefault)
281 CPL_WARN_DEPRECATED(
"Use VSIGetPathSpecificOption instead")
303 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE(size) \
304 VSIMallocAlignedAutoVerbose(size, __FILE__, __LINE__)
323 void CPL_DLL *
VSIMalloc3(
size_t nSize1,
size_t nSize2,
330 #define VSI_MALLOC_VERBOSE(size) VSIMallocVerbose(size, __FILE__, __LINE__)
337 #define VSI_MALLOC2_VERBOSE(nSize1, nSize2) \
338 VSIMalloc2Verbose(nSize1, nSize2, __FILE__, __LINE__)
345 #define VSI_MALLOC3_VERBOSE(nSize1, nSize2, nSize3) \
346 VSIMalloc3Verbose(nSize1, nSize2, nSize3, __FILE__, __LINE__)
349 void CPL_DLL *
VSICallocVerbose(
size_t nCount,
size_t nSize,
const char *pszFile,
352 #define VSI_CALLOC_VERBOSE(nCount, nSize) \
353 VSICallocVerbose(nCount, nSize, __FILE__, __LINE__)
360 #define VSI_REALLOC_VERBOSE(pOldPtr, nNewSize) \
361 VSIReallocVerbose(pOldPtr, nNewSize, __FILE__, __LINE__)
367 #define VSI_STRDUP_VERBOSE(pszStr) VSIStrdupVerbose(pszStr, __FILE__, __LINE__)
377 #define CPLReadDir VSIReadDir
380 char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles);
387 const char *
const *papszOptions);
413 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
426 int CPL_DLL
VSIMkdir(
const char *pszPathname,
long mode);
428 int CPL_DLL
VSIRmdir(
const char *pszDirname);
430 int CPL_DLL
VSIUnlink(
const char *pszFilename);
432 int CPL_DLL
VSIRename(
const char *oldpath,
const char *newpath);
433 int CPL_DLL
VSICopyFile(
const char *pszSource,
const char *pszTarget,
435 const char *
const *papszOptions,
436 GDALProgressFunc pProgressFunc,
void *pProgressData);
437 int CPL_DLL
VSISync(
const char *pszSource,
const char *pszTarget,
438 const char *
const *papszOptions,
439 GDALProgressFunc pProgressFunc,
void *pProgressData,
440 char ***ppapszOutputs);
454 void CPL_DLL VSIInstallLargeFileHandler(
void);
486 void CPL_DLL VSICleanupFileManager(
void);
490 const char *pszNewFSName);
498 int bUnlinkAndSeize);
510 const char *pszFilename,
518 const char *pszFilename);
525 const char *newpath);
531 const char *pszDirname,
538 const char *pszDirname);
543 typedef char **(*VSIFilesystemPluginReadDirCallback)(
void *pUserData,
544 const char *pszDirname,
555 typedef char **(*VSIFilesystemPluginSiblingFilesCallback)(
556 void *pUserData,
const char *pszDirname);
563 typedef void *(*VSIFilesystemPluginOpenCallback)(
void *pUserData,
564 const char *pszFilename,
565 const char *pszAccess);
584 size_t nSize,
size_t nCount);
591 void *pFile,
int nRanges,
void **ppData,
const vsi_l_offset *panOffsets,
592 const size_t *panSizes);
610 size_t nSize,
size_t nCount);
642 void *pFile,
int nRanges,
const vsi_l_offset *panOffsets,
643 const size_t *panSizes);
727 unsigned long CPL_DLL VSITime(
unsigned long *);
728 const char CPL_DLL *VSICTime(
unsigned long);
729 struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
struct tm *poBrokenTime);
730 struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
struct tm *poBrokenTime);
746 #define VSIDebug4(f, a1, a2, a3, a4) CPLDebug("VSI", f, a1, a2, a3, a4);
747 #define VSIDebug3(f, a1, a2, a3) CPLDebug("VSI", f, a1, a2, a3);
748 #define VSIDebug2(f, a1, a2) CPLDebug("VSI", f, a1, a2);
749 #define VSIDebug1(f, a1) CPLDebug("VSI", f, a1);
751 #define VSIDebug4(f, a1, a2, a3, a4) \
754 #define VSIDebug3(f, a1, a2, a3) \
757 #define VSIDebug2(f, a1, a2) \
760 #define VSIDebug1(f, a1) \
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:409
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:300
size_t nBufferSize
buffer small reads (makes handler read only)
Definition: cpl_vsi.h:683
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:265
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2743
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:744
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:950
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:185
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:682
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:741
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:2623
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
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:641
void VSIClearCredentials(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2962
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1592
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:523
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:990
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:196
char ** VSISiblingFiles(const char *pszPath)
Return related filenames.
Definition: cpl_vsil.cpp:151
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1147
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:1083
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:603
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:715
bool VSISupportsRandomWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports random write.
Definition: cpl_vsil.cpp:1118
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1231
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1208
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:479
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:670
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:448
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:509
int nMode
File mode.
Definition: cpl_vsi.h:399
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:1216
int VSIFTruncateL(VSILFILE *, vsi_l_offset)
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:2419
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:319
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:999
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2125
void * VSIRealloc(void *, size_t)
Analog of realloc().
Definition: cpl_vsisimple.cpp:694
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:501
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:615
char * pszName
Filename.
Definition: cpl_vsi.h:397
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:463
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:181
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1378
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:570
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:344
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:680
char ** VSIGetFileMetadata(const char *pszFilename, const char *pszDomain, CSLConstList papszOptions)
Get metadata on files.
Definition: cpl_vsil.cpp:884
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:492
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:366
void VSIInstallRarFileHandler(void)
Install /vsirar/ RAR file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:65
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:1895
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:638
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:2126
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:671
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:988
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:543
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:501
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:1143
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:668
size_t nCacheSize
max mem to use per file when buffering
Definition: cpl_vsi.h:684
const char * VSIGetPathSpecificOption(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value a path specific option.
Definition: cpl_vsil.cpp:3022
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:652
int VSIFPrintfL(VSILFILE *, const char *,...)
Formatted write to file.
Definition: cpl_vsil.cpp:2443
VSILFILE * VSIFOpenEx2L(const char *, const char *, int, CSLConstList)
Open file.
Definition: cpl_vsil.cpp:1952
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:553
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:575
void VSIInstallADLSFileHandler(void)
Install /vsiaz/ Microsoft Azure Data Lake Storage Gen2 file system handler (requires libcurl)
Definition: cpl_vsil_adls.cpp:2215
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:401
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:597
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:2874
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:306
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:183
int * VSIUnlinkBatch(CSLConstList papszFiles)
Delete several files, possibly in a batch.
Definition: cpl_vsil.cpp:448
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:2532
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:411
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:4844
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:474
void VSIClearPathSpecificOptions(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2980
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:3263
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:123
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:583
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:660
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1178
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:2106
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:229
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:675
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:661
int VSIFSeekL(VSILFILE *, vsi_l_offset, int)
Seek to requested offset.
Definition: cpl_vsil.cpp:2065
void VSIInstall7zFileHandler(void)
Install /vsi7z/ 7zip file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:47
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:517
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:823
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:310
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:664
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:471
VSIFilesystemPluginAdviseReadCallback advise_read
The following optional member has been added in GDAL 3.7:
Definition: cpl_vsi.h:689
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:530
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1188
Directory entry.
Definition: cpl_vsi.h:394
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:777
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:417
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2058
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2104
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:537
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:1017
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1164
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2854
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2063
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:619
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:6049
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1355
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:2898
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:666
int VSIFFlushL(VSILFILE *)
Flush pending writes to disk.
Definition: cpl_vsil.cpp:2175
Virtual file handle.
Definition: cpl_vsi_virtual.h:62
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:590
char **(* VSIFilesystemPluginSiblingFilesCallback)(void *pUserData, const char *pszDirname)
List related files.
Definition: cpl_vsi.h:555
char * VSIGetCanonicalFilename(const char *pszPath)
Returns the canonical filename.
Definition: cpl_vsil.cpp:1070
char * VSINetworkStatsGetAsSerializedJSON(char **papszOptions)
Return network related statistics, as a JSON serialized object.
Definition: cpl_vsil_curl.cpp:6235
void VSIInstallCachedFileHandler(void)
Install /vsicached? file system handler.
Definition: cpl_vsil_cache.cpp:713
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:966
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:4845
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:146
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:843
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:659
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:331
void * VSIMalloc2(size_t nSize1, size_t nSize2)
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1125
char * VSIStrdup(const char *)
Analog of strdup().
Definition: cpl_vsisimple.cpp:1010
void * VSICalloc(size_t, size_t)
Analog of calloc().
Definition: cpl_vsisimple.cpp:451
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1249
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:954
int VSIFCloseL(VSILFILE *)
Close file.
Definition: cpl_vsil.cpp:2007
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:662
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:663
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:2935
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:3003
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:2283
void * VSIMalloc(size_t)
Analog of malloc().
Definition: cpl_vsisimple.cpp:567
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:184
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:226
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:563
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:817
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:403
VSIFilesystemPluginSiblingFilesCallback sibling_files
list related files
Definition: cpl_vsi.h:686
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:405
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:384
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:665
bool VSIDuplicateFileSystemHandler(const char *pszSourceFSName, const char *pszNewFSName)
Duplicate an existing file system handler.
Definition: cpl_vsil.cpp:3062
bool VSISupportsSequentialWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports sequential write.
Definition: cpl_vsil.cpp:1094
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:204
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:976
#define VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:203
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *)
Write bytes to file.
Definition: cpl_vsil.cpp:2335
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2833
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:966
void VSIInstallOSSStreamingFileHandler(void)
Install /vsiaz_streaming/ Alibaba Cloud Object Storage Service (OSS) (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2146
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streaming/ OpenStack Swif Object Storage (Swift) file system handler (requires libc...
Definition: cpl_vsil_curl_streaming.cpp:2167
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:6112
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2083
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:967
int VSIFEofL(VSILFILE *)
Test for end of file.
Definition: cpl_vsil.cpp:2379
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:1253
bool VSIIsLocal(const char *pszPath)
Returns if the file/filesystem is "local".
Definition: cpl_vsil.cpp:1045
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:908
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:89
void VSINetworkStatsReset(void)
Clear network related statistics.
Definition: cpl_vsil_curl.cpp:6135
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:677
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:673
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:681
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:666
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:534
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:6073
int VSISetFileMetadata(const char *pszFilename, CSLConstList papszMetadata, const char *pszDomain, CSLConstList papszOptions)
Set metadata on files.
Definition: cpl_vsil.cpp:954
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:407
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2567
int VSIFPutcL(int, VSILFILE *)
Write a single byte to the file.
Definition: cpl_vsil.cpp:2480
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:658
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:608
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:1172
int VSIAbortPendingUploads(const char *pszFilename)
Abort ongoing multi-part uploads.
Definition: cpl_vsil.cpp:688
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1138
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:679
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:184
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2814
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:625
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1212
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *)
Read bytes from file.
Definition: cpl_vsil.cpp:2225