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
88int CPL_DLL VSIFClose(FILE *);
89int CPL_DLL VSIFSeek(FILE *,
long,
int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91void CPL_DLL VSIRewind(FILE *);
92void CPL_DLL VSIFFlush(FILE *);
94size_t CPL_DLL VSIFRead(
void *,
size_t,
size_t,
95 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96size_t CPL_DLL VSIFWrite(
const void *,
size_t,
size_t,
97 FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
98char CPL_DLL *VSIFGets(
char *,
int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99int CPL_DLL VSIFPuts(
const char *, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
101 ...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
104int CPL_DLL VSIFGetc(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
105int CPL_DLL VSIFPutc(
int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
106int CPL_DLL VSIUngetc(
int, FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
107int CPL_DLL VSIFEof(FILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
116typedef 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;
163size_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;
169size_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);
268 const char *pszValue)
270 CPL_WARN_DEPRECATED(
"Use VSISetPathSpecificOption instead")
275 CPL_WARN_DEPRECATED(
"Use VSIClearPathSpecificOptions instead")
278const char CPL_DLL *
VSIGetCredential(
const char *pszPath,
const char *pszKey,
279 const char *pszDefault)
281 CPL_WARN_DEPRECATED(
"Use VSIGetPathSpecificOption instead")
295#if defined(__cplusplus) && defined(GDAL_COMPILATION)
299 struct CPL_DLL VSIFreeReleaser
301 void operator()(
void *p)
const
319#define VSI_MALLOC_ALIGNED_AUTO_VERBOSE(size) \
320 VSIMallocAlignedAutoVerbose(size, __FILE__, __LINE__)
339void CPL_DLL *
VSIMalloc3(
size_t nSize1,
size_t nSize2,
346#define VSI_MALLOC_VERBOSE(size) VSIMallocVerbose(size, __FILE__, __LINE__)
353#define VSI_MALLOC2_VERBOSE(nSize1, nSize2) \
354 VSIMalloc2Verbose(nSize1, nSize2, __FILE__, __LINE__)
361#define VSI_MALLOC3_VERBOSE(nSize1, nSize2, nSize3) \
362 VSIMalloc3Verbose(nSize1, nSize2, nSize3, __FILE__, __LINE__)
365void CPL_DLL *
VSICallocVerbose(
size_t nCount,
size_t nSize,
const char *pszFile,
368#define VSI_CALLOC_VERBOSE(nCount, nSize) \
369 VSICallocVerbose(nCount, nSize, __FILE__, __LINE__)
376#define VSI_REALLOC_VERBOSE(pOldPtr, nNewSize) \
377 VSIReallocVerbose(pOldPtr, nNewSize, __FILE__, __LINE__)
383#define VSI_STRDUP_VERBOSE(pszStr) VSIStrdupVerbose(pszStr, __FILE__, __LINE__)
393#define CPLReadDir VSIReadDir
396char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles);
405 const char *
const *papszOptions);
432#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
445int CPL_DLL
VSIMkdir(
const char *pszPathname,
long mode);
447int CPL_DLL
VSIRmdir(
const char *pszDirname);
449int CPL_DLL
VSIUnlink(
const char *pszFilename);
451int CPL_DLL
VSIRename(
const char *oldpath,
const char *newpath);
452int CPL_DLL
VSICopyFile(
const char *pszSource,
const char *pszTarget,
454 const char *
const *papszOptions,
455 GDALProgressFunc pProgressFunc,
void *pProgressData);
456int CPL_DLL
VSISync(
const char *pszSource,
const char *pszTarget,
457 const char *
const *papszOptions,
458 GDALProgressFunc pProgressFunc,
void *pProgressData,
459 char ***ppapszOutputs);
473void CPL_DLL VSIInstallLargeFileHandler(
void);
505void CPL_DLL VSICleanupFileManager(
void);
509 const char *pszNewFSName);
517 int bUnlinkAndSeize);
529 const char *pszFilename,
537 const char *pszFilename);
544 const char *newpath);
550 const char *pszDirname,
557 const char *pszDirname);
562typedef char **(*VSIFilesystemPluginReadDirCallback)(
void *pUserData,
563 const char *pszDirname,
574typedef char **(*VSIFilesystemPluginSiblingFilesCallback)(
575 void *pUserData,
const char *pszDirname);
582typedef void *(*VSIFilesystemPluginOpenCallback)(
void *pUserData,
583 const char *pszFilename,
584 const char *pszAccess);
603 size_t nSize,
size_t nCount);
610 void *pFile,
int nRanges,
void **ppData,
const vsi_l_offset *panOffsets,
611 const size_t *panSizes);
629 size_t nSize,
size_t nCount);
661 void *pFile,
int nRanges,
const vsi_l_offset *panOffsets,
662 const size_t *panSizes);
757unsigned long CPL_DLL VSITime(
unsigned long *);
758const char CPL_DLL *VSICTime(
unsigned long);
759struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
struct tm *poBrokenTime);
760struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
struct tm *poBrokenTime);
776#define VSIDebug4(f, a1, a2, a3, a4) CPLDebug("VSI", f, a1, a2, a3, a4);
777#define VSIDebug3(f, a1, a2, a3) CPLDebug("VSI", f, a1, a2, a3);
778#define VSIDebug2(f, a1, a2) CPLDebug("VSI", f, a1, a2);
779#define VSIDebug1(f, a1) CPLDebug("VSI", f, a1);
781#define VSIDebug4(f, a1, a2, a3, a4) \
784#define VSIDebug3(f, a1, a2, a3) \
787#define VSIDebug2(f, a1, a2) \
790#define VSIDebug1(f, a1) \
CPL error handling services.
Core portability definitions for CPL.
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:218
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:299
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:295
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:966
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:950
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1183
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:976
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:185
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:215
#define VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:203
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1213
int VSISetFileMetadata(const char *pszFilename, CSLConstList papszMetadata, const char *pszDomain, CSLConstList papszOptions)
Set metadata on files.
Definition: cpl_vsil.cpp:987
int * VSIUnlinkBatch(CSLConstList papszFiles)
Delete several files, possibly in a batch.
Definition: cpl_vsil.cpp:481
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:2605
void VSINetworkStatsReset(void)
Clear network related statistics.
Definition: cpl_vsil_curl.cpp:6174
void VSIInstallCachedFileHandler(void)
Install /vsicached? file system handler.
Definition: cpl_vsil_cache.cpp:723
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:520
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2091
char ** VSISiblingFiles(const char *pszPath)
Return related filenames.
Definition: cpl_vsil.cpp:151
int VSIFFlushL(VSILFILE *)
Flush pending writes to disk.
Definition: cpl_vsil.cpp:2219
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:609
const char * VSIGetDirectorySeparator(const char *pszPath)
Return the directory separator for the specified path.
Definition: cpl_vsil.cpp:170
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:2150
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:525
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:2971
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:567
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *)
Write bytes to file.
Definition: cpl_vsil.cpp:2379
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:182
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:184
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:185
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:183
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:602
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:667
bool VSISupportsRandomWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports random write.
Definition: cpl_vsil.cpp:1151
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1396
int VSIFTruncateL(VSILFILE *, vsi_l_offset)
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:2463
void * VSICalloc(size_t, size_t)
Analog of calloc().
Definition: cpl_vsisimple.cpp:451
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:589
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:1021
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:3279
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1164
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:1176
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:660
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:562
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:489
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:542
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:3008
int VSIRemovePluginHandler(const char *pszPrefix)
Unregister a handler previously installed with VSIInstallPluginHandler() on the given prefix.
Definition: cpl_vsil_plugin.cpp:476
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:6088
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1147
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1212
bool VSISupportsSequentialWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports sequential write.
Definition: cpl_vsil.cpp:1127
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:4901
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:471
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2059
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2927
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2816
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streaming/ OpenStack Swif Object Storage (Swift) file system handler (requires libc...
Definition: cpl_vsil_curl_streaming.cpp:2175
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:204
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:967
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:448
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:399
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:969
int VSIFPutcL(int, VSILFILE *)
Write a single byte to the file.
Definition: cpl_vsil.cpp:2553
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:671
void * VSIMalloc2(size_t nSize1, size_t nSize2)
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1125
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:644
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:402
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:6112
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:6151
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2640
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:1939
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:1050
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:549
void * VSIRealloc(void *, size_t)
Analog of realloc().
Definition: cpl_vsisimple.cpp:694
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:638
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:483
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:627
char **(* VSIFilesystemPluginSiblingFilesCallback)(void *pUserData, const char *pszDirname)
List related files.
Definition: cpl_vsi.h:574
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:352
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:450
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1138
int VSIFCloseL(VSILFILE *)
Close file.
Definition: cpl_vsil.cpp:2051
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:293
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:1086
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:747
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:4876
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:3076
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:616
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2887
char * VSIGetCanonicalFilename(const char *pszPath)
Returns the canonical filename.
Definition: cpl_vsil.cpp:1103
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:594
void VSIClearCredentials(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:3035
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:528
void VSIInstallOSSStreamingFileHandler(void)
Install /vsiaz_streaming/ Alibaba Cloud Object Storage Service (OSS) (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2154
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:123
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:908
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:1249
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:466
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:1205
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:774
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:377
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1232
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:582
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *)
Read bytes from file.
Definition: cpl_vsil.cpp:2269
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:2327
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2071
char * VSIStrdup(const char *)
Analog of strdup().
Definition: cpl_vsisimple.cpp:1010
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:1286
int VSIFEofL(VSILFILE *)
Test for end of file.
Definition: cpl_vsil.cpp:2423
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:555
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:501
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:2170
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:89
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1188
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:536
void VSIInstallRarFileHandler(void)
Install /vsirar/ RAR file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:65
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1373
bool VSIDuplicateFileSystemHandler(const char *pszSourceFSName, const char *pszNewFSName)
Duplicate an existing file system handler.
Definition: cpl_vsil.cpp:3135
void VSIInstallADLSFileHandler(void)
Install /vsiaz/ Microsoft Azure Data Lake Storage Gen2 file system handler (requires libcurl)
Definition: cpl_vsil_adls.cpp:2223
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1613
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:810
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:210
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2112
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:622
int VSIFPrintfL(VSILFILE *, const char *,...)
Formatted write to file.
Definition: cpl_vsil.cpp:2487
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:850
char * VSINetworkStatsGetAsSerializedJSON(char **papszOptions)
Return network related statistics, as a JSON serialized object.
Definition: cpl_vsil_curl.cpp:6274
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:332
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2906
VSILFILE * VSIFOpenEx2L(const char *, const char *, int, CSLConstList)
Open file.
Definition: cpl_vsil.cpp:1996
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:671
void VSIInstall7zFileHandler(void)
Install /vsi7z/ 7zip file system handler (requires libarchive)
Definition: cpl_vsil_libarchive.cpp:47
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:2947
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:990
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 VSIAbortPendingUploads(const char *pszFilename)
Abort ongoing multi-part uploads.
Definition: cpl_vsil.cpp:721
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
const char * VSIGetPathSpecificOption(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value a path specific option.
Definition: cpl_vsil.cpp:3095
void * VSIMalloc(size_t)
Analog of malloc().
Definition: cpl_vsisimple.cpp:567
int VSIFSeekL(VSILFILE *, vsi_l_offset, int)
Seek to requested offset.
Definition: cpl_vsil.cpp:2109
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:634
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:1002
bool VSIIsLocal(const char *pszPath)
Returns if the file/filesystem is "local".
Definition: cpl_vsil.cpp:1078
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:748
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:2633
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:843
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1250
void VSIClearPathSpecificOptions(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:3053
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:146
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:333
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:827
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2133
char ** VSIGetFileMetadata(const char *pszFilename, const char *pszDomain, CSLConstList papszOptions)
Get metadata on files.
Definition: cpl_vsil.cpp:917
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:556
Directory entry.
Definition: cpl_vsi.h:414
char * pszName
Filename.
Definition: cpl_vsi.h:416
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:422
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:428
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:426
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:424
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:430
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:420
int nMode
File mode.
Definition: cpl_vsi.h:418
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:672
VSIFilesystemPluginAdviseReadCallback advise_read
The following optional member has been added in GDAL 3.7:
Definition: cpl_vsi.h:708
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:698
size_t nBufferSize
buffer small reads (makes handler read only)
Definition: cpl_vsi.h:702
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:680
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:692
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:679
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:682
size_t nCacheSize
max mem to use per file when buffering
Definition: cpl_vsi.h:703
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:696
VSIFilesystemPluginSiblingFilesCallback sibling_files
list related files
Definition: cpl_vsi.h:705
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:685
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:689
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:694
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:701
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:690
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:699
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:684
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:677
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:700
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:681
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:678
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:687
Virtual file handle.
Definition: cpl_vsi_virtual.h:63