GDAL
cpl_vsi.h
Go to the documentation of this file.
1/******************************************************************************
2 * $Id: cpl_vsi.h 22d95175f375d90d8f598436d1187fd143e00b67 2019-09-17 23:06:11 +0200 Even Rouault $
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 mines-paris dot org>
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a
14 * copy of this software and associated documentation files (the "Software"),
15 * to deal in the Software without restriction, including without limitation
16 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 * and/or sell copies of the Software, and to permit persons to whom the
18 * Software is furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included
21 * in all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 * DEALINGS IN THE SOFTWARE.
30 ****************************************************************************/
31
32#ifndef CPL_VSI_H_INCLUDED
33#define CPL_VSI_H_INCLUDED
34
35#include "cpl_port.h"
36#include "cpl_progress.h"
37
56/* -------------------------------------------------------------------- */
57/* We need access to ``struct stat''. */
58/* -------------------------------------------------------------------- */
59
60/* Unix */
61#if !defined(_WIN32)
62# include <unistd.h>
63#endif
64
65/* Windows */
66#include <sys/stat.h>
67
69
71#ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
72#define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
73#else
74#define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
75#endif
78/* ==================================================================== */
79/* stdio file access functions. These do not support large */
80/* files, and do not go through the virtualization API. */
81/* ==================================================================== */
82
85FILE CPL_DLL * VSIFOpen( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
86int CPL_DLL VSIFClose( FILE * );
87int CPL_DLL VSIFSeek( FILE *, long, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
88long CPL_DLL VSIFTell( FILE * ) CPL_WARN_UNUSED_RESULT;
89void CPL_DLL VSIRewind( FILE * );
90void CPL_DLL VSIFFlush( FILE * );
91
92size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
93size_t CPL_DLL VSIFWrite( const void *, size_t, size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
94char CPL_DLL *VSIFGets( char *, int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
95int CPL_DLL VSIFPuts( const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96int CPL_DLL VSIFPrintf( FILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
97
98int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99int CPL_DLL VSIFPutc( int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
100int CPL_DLL VSIUngetc( int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
101int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
102
105/* ==================================================================== */
106/* VSIStat() related. */
107/* ==================================================================== */
108
110typedef struct stat VSIStatBuf;
111int CPL_DLL VSIStat( const char *, VSIStatBuf * ) CPL_WARN_UNUSED_RESULT;
114#ifdef _WIN32
115# define VSI_ISLNK(x) ( 0 ) /* N/A on Windows */
116# define VSI_ISREG(x) ((x) & S_IFREG)
117# define VSI_ISDIR(x) ((x) & S_IFDIR)
118# define VSI_ISCHR(x) ((x) & S_IFCHR)
119# define VSI_ISBLK(x) ( 0 ) /* N/A on Windows */
120#else
122# define VSI_ISLNK(x) S_ISLNK(x)
124# define VSI_ISREG(x) S_ISREG(x)
126# define VSI_ISDIR(x) S_ISDIR(x)
128# define VSI_ISCHR(x) S_ISCHR(x)
129# define VSI_ISBLK(x) S_ISBLK(x)
131#endif
132
133/* ==================================================================== */
134/* 64bit stdio file access functions. If we have a big size */
135/* defined, then provide prototypes for the large file API, */
136/* otherwise redefine to use the regular api. */
137/* ==================================================================== */
138
142#define VSI_L_OFFSET_MAX GUINTBIG_MAX
143
145/* Make VSIL_STRICT_ENFORCE active in DEBUG builds */
146#ifdef DEBUG
147#define VSIL_STRICT_ENFORCE
148#endif
151#ifdef VSIL_STRICT_ENFORCE
153typedef struct _VSILFILE VSILFILE;
154#else
156typedef FILE VSILFILE;
157#endif
158
159VSILFILE CPL_DLL * VSIFOpenL( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
160VSILFILE CPL_DLL * VSIFOpenExL( const char *, const char *, int ) CPL_WARN_UNUSED_RESULT;
161int CPL_DLL VSIFCloseL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
162int CPL_DLL VSIFSeekL( VSILFILE *, vsi_l_offset, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
164void CPL_DLL VSIRewindL( VSILFILE * );
165size_t CPL_DLL VSIFReadL( void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
166int CPL_DLL VSIFReadMultiRangeL( int nRanges, void ** ppData, const vsi_l_offset* panOffsets, const size_t* panSizes, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
167size_t CPL_DLL VSIFWriteL( const void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
168int CPL_DLL VSIFEofL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
169int CPL_DLL VSIFTruncateL( VSILFILE *, vsi_l_offset ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
170int CPL_DLL VSIFFlushL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
171int CPL_DLL VSIFPrintfL( VSILFILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
172int CPL_DLL VSIFPutcL( int, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
173
175typedef enum
176{
181
183
184int CPL_DLL VSIIngestFile( VSILFILE* fp,
185 const char* pszFilename,
186 GByte** ppabyRet,
187 vsi_l_offset* pnSize,
189
190int CPL_DLL VSIOverwriteFile( VSILFILE* fpTarget, const char* pszSourceFilename ) CPL_WARN_UNUSED_RESULT;
191
192#if defined(VSI_STAT64_T)
194typedef struct VSI_STAT64_T VSIStatBufL;
195#else
197#define VSIStatBufL VSIStatBuf
198#endif
199
200int CPL_DLL VSIStatL( const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
201
203#define VSI_STAT_EXISTS_FLAG 0x1
205#define VSI_STAT_NATURE_FLAG 0x2
207#define VSI_STAT_SIZE_FLAG 0x4
209#define VSI_STAT_SET_ERROR_FLAG 0x8
210
211int CPL_DLL VSIStatExL( const char * pszFilename, VSIStatBufL * psStatBuf, int nFlags ) CPL_WARN_UNUSED_RESULT;
212
213int CPL_DLL VSIIsCaseSensitiveFS( const char * pszFilename );
214
215int CPL_DLL VSISupportsSparseFiles( const char* pszPath );
216
217int CPL_DLL VSIHasOptimizedReadMultiRange( const char* pszPath );
218
219const char CPL_DLL *VSIGetActualURL( const char* pszFilename );
220
221char CPL_DLL *VSIGetSignedURL( const char* pszFilename, CSLConstList papszOptions );
222
223const char CPL_DLL *VSIGetFileSystemOptions( const char* pszFilename );
224
225char CPL_DLL **VSIGetFileSystemsPrefixes( void );
226
227void CPL_DLL *VSIFGetNativeFileDescriptorL( VSILFILE* );
228
229/* ==================================================================== */
230/* Memory allocation */
231/* ==================================================================== */
232
233void CPL_DLL *VSICalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
234void CPL_DLL *VSIMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
235void CPL_DLL VSIFree( void * );
236void CPL_DLL *VSIRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
237char CPL_DLL *VSIStrdup( const char * ) CPL_WARN_UNUSED_RESULT;
238
239void CPL_DLL *VSIMallocAligned( size_t nAlignment, size_t nSize ) CPL_WARN_UNUSED_RESULT;
240void CPL_DLL *VSIMallocAlignedAuto( size_t nSize ) CPL_WARN_UNUSED_RESULT;
241void CPL_DLL VSIFreeAligned( void* ptr );
242
243void CPL_DLL *VSIMallocAlignedAutoVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
245#define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
246
254void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
255
263void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
264
266void CPL_DLL *VSIMallocVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
268#define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
269
271void CPL_DLL *VSIMalloc2Verbose( size_t nSize1, size_t nSize2, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
273#define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
274
276void CPL_DLL *VSIMalloc3Verbose( size_t nSize1, size_t nSize2, size_t nSize3, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
278#define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
279
281void CPL_DLL *VSICallocVerbose( size_t nCount, size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
283#define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
284
286void CPL_DLL *VSIReallocVerbose( void* pOldPtr, size_t nNewSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
288#define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
289
291char CPL_DLL *VSIStrdupVerbose( const char* pszStr, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
293#define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
294
295GIntBig CPL_DLL CPLGetPhysicalRAM(void);
296GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
297
298/* ==================================================================== */
299/* Other... */
300/* ==================================================================== */
301
303#define CPLReadDir VSIReadDir
304char CPL_DLL **VSIReadDir( const char * );
305char CPL_DLL **VSIReadDirRecursive( const char *pszPath );
306char CPL_DLL **VSIReadDirEx( const char *pszPath, int nMaxFiles );
307
309typedef struct VSIDIR VSIDIR;
310
311VSIDIR CPL_DLL *VSIOpenDir( const char *pszPath,
312 int nRecurseDepth,
313 const char* const *papszOptions);
314
316typedef struct VSIDIREntry
317{
319 char* pszName;
321 int nMode;
334
335#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
337 VSIDIREntry();
338 ~VSIDIREntry();
339 VSIDIREntry(const VSIDIREntry&) = delete;
340 VSIDIREntry& operator=(VSIDIREntry&) = delete;
342#endif
344
345const VSIDIREntry CPL_DLL *VSIGetNextDirEntry(VSIDIR* dir);
346void CPL_DLL VSICloseDir(VSIDIR* dir);
347
348int CPL_DLL VSIMkdir( const char * pszPathname, long mode );
349int CPL_DLL VSIMkdirRecursive( const char * pszPathname, long mode );
350int CPL_DLL VSIRmdir( const char * pszDirname );
351int CPL_DLL VSIRmdirRecursive( const char * pszDirname );
352int CPL_DLL VSIUnlink( const char * pszFilename );
353int CPL_DLL VSIRename( const char * oldpath, const char * newpath );
354int CPL_DLL VSISync( const char* pszSource, const char* pszTarget,
355 const char* const * papszOptions,
356 GDALProgressFunc pProgressFunc,
357 void *pProgressData,
358 char*** ppapszOutputs );
359
360char CPL_DLL *VSIStrerror( int );
361GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
362
363/* ==================================================================== */
364/* Install special file access handlers. */
365/* ==================================================================== */
366void CPL_DLL VSIInstallMemFileHandler(void);
368void CPL_DLL VSIInstallLargeFileHandler(void);
370void CPL_DLL VSIInstallSubFileHandler(void);
372void CPL_DLL VSICurlClearCache(void);
373void CPL_DLL VSICurlPartialClearCache(const char* pszFilenamePrefix);
375void VSIInstallS3FileHandler(void);
377void VSIInstallGSFileHandler(void);
381void VSIInstallOSSFileHandler(void);
385void VSIInstallGZipFileHandler(void); /* No reason to export that */
386void VSIInstallZipFileHandler(void); /* No reason to export that */
387void VSIInstallStdinHandler(void); /* No reason to export that */
388void VSIInstallHdfsHandler(void); /* No reason to export that */
389void VSIInstallWebHdfsHandler(void); /* No reason to export that */
390void VSIInstallStdoutHandler(void); /* No reason to export that */
391void CPL_DLL VSIInstallSparseFileHandler(void);
392void VSIInstallTarFileHandler(void); /* No reason to export that */
393void CPL_DLL VSIInstallCryptFileHandler(void);
394void CPL_DLL VSISetCryptKey(const GByte* pabyKey, int nKeySize);
396void CPL_DLL VSICleanupFileManager(void);
399VSILFILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename,
400 GByte *pabyData,
401 vsi_l_offset nDataLength,
402 int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
403GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename,
404 vsi_l_offset *pnDataLength,
405 int bUnlinkAndSeize );
406
408typedef size_t (*VSIWriteFunction)(const void* ptr, size_t size, size_t nmemb, FILE* stream);
409void CPL_DLL VSIStdoutSetRedirection( VSIWriteFunction pFct, FILE* stream );
410
415typedef int (*VSIFilesystemPluginStatCallback) ( void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags );
420typedef int (*VSIFilesystemPluginUnlinkCallback) ( void *pUserData, const char *pszFilename );
425typedef int (*VSIFilesystemPluginRenameCallback) ( void *pUserData, const char *oldpath, const char *newpath );
430typedef int (*VSIFilesystemPluginMkdirCallback) ( void *pUserData, const char *pszDirname, long nMode );
435typedef int (*VSIFilesystemPluginRmdirCallback) ( void *pUserData, const char *pszDirname );
440typedef char** (*VSIFilesystemPluginReadDirCallback) ( void *pUserData, const char *pszDirname, int nMaxFiles );
446typedef void* (*VSIFilesystemPluginOpenCallback) ( void *pUserData, const char *pszFilename, const char *pszAccess );
456typedef int (*VSIFilesystemPluginSeekCallback) ( void *pFile, vsi_l_offset nOffset, int nWhence );
462typedef size_t (*VSIFilesystemPluginReadCallback) ( void *pFile, void *pBuffer, size_t nSize, size_t nCount );
467typedef int (*VSIFilesystemPluginReadMultiRangeCallback)( void *pFile, int nRanges, void ** ppData,
468 const vsi_l_offset* panOffsets, const size_t* panSizes );
478typedef int (*VSIFilesystemPluginEofCallback) ( void *pFile );
483typedef size_t (*VSIFilesystemPluginWriteCallback) ( void *pFile, const void *pBuffer, size_t nSize,size_t nCount);
488typedef int (*VSIFilesystemPluginFlushCallback) ( void *pFile );
492typedef int (*VSIFilesystemPluginTruncateCallback) ( void *pFile, vsi_l_offset nNewSize );
497typedef int (*VSIFilesystemPluginCloseCallback) ( void *pFile );
498
506typedef struct {
528/*
529 Callbacks are defined as a struct allocated by a call to VSIAllocFilesystemPluginCallbacksStruct
530 in order to try to maintain ABI stability when eventually adding a new member.
531 Any callbacks added to this struct SHOULD be added to the END of this struct
532*/
534
540
546
553int CPL_DLL VSIInstallPluginHandler( const char* pszPrefix, const VSIFilesystemPluginCallbacksStruct* poCb);
554
555/* ==================================================================== */
556/* Time querying. */
557/* ==================================================================== */
558
560unsigned long CPL_DLL VSITime( unsigned long * );
561const char CPL_DLL *VSICTime( unsigned long );
562struct tm CPL_DLL *VSIGMTime( const time_t *pnTime,
563 struct tm *poBrokenTime );
564struct tm CPL_DLL *VSILocalTime( const time_t *pnTime,
565 struct tm *poBrokenTime );
569/* -------------------------------------------------------------------- */
570/* the following can be turned on for detailed logging of */
571/* almost all IO calls. */
572/* -------------------------------------------------------------------- */
573#ifdef VSI_DEBUG
574
575#ifndef DEBUG
576# define DEBUG
577#endif
578
579#include "cpl_error.h"
580
581#define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
582#define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
583#define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
584#define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
585#else
586#define VSIDebug4( f, a1, a2, a3, a4 ) {}
587#define VSIDebug3( f, a1, a2, a3 ) {}
588#define VSIDebug2( f, a1, a2 ) {}
589#define VSIDebug1( f, a1 ) {}
590#endif
594
595#endif /* ndef CPL_VSI_H_INCLUDED */
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:251
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:929
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:914
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1194
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:939
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1804
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1242
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:2007
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:408
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2102
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1155
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:467
VSILFILE * VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:997
void * VSIMalloc(size_t) CPL_WARN_UNUSED_RESULT
Analog of malloc().
Definition: cpl_vsisimple.cpp:558
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:529
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership) CPL_WARN_UNUSED_RESULT
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:898
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:176
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:178
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:179
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:177
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:462
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1892
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1369
int VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:737
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:451
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:826
void * VSIMallocAlignedAuto(size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint such that it can be used by the most demanding vector...
Definition: cpl_vsisimple.cpp:938
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:2449
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1690
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:882
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1850
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:440
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:354
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:425
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4300
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1188
void * VSIRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Analog of realloc().
Definition: cpl_vsisimple.cpp:681
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:2750
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1224
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:415
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2024
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2340
VSILFILE * VSIFOpenExL(const char *, const char *, int) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:1416
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2177
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:205
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:444
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:446
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:868
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:595
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:497
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:309
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:4338
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1918
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:4378
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:856
void * VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1116
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:430
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:492
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:351
int VSIFReadMultiRangeL(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read several ranges of bytes from file.
Definition: cpl_vsil.cpp:1750
char * VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT
Analog of strdup().
Definition: cpl_vsisimple.cpp:995
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:483
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:398
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1205
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:498
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:342
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:959
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:706
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:3320
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:473
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2297
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:456
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:415
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2158
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:776
struct VSIDIREntry VSIDIREntry
Directory entry.
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize) CPL_WARN_UNUSED_RESULT
Ingest a file into memory.
Definition: cpl_vsil.cpp:2044
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:959
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:344
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:912
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:669
void * VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Analog of calloc().
Definition: cpl_vsisimple.cpp:444
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:423
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:446
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2084
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:1532
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:547
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:492
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1597
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:951
void * VSIMallocAligned(size_t nAlignment, size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:892
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:420
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1955
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1638
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1347
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1460
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2121
struct VSI_STAT64_T VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:194
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:478
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:388
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2318
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:619
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1180
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:2360
vsi_l_offset VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT
Tell current file offset.
Definition: cpl_vsil.cpp:1575
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:975
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Set an alternative write function and output file handle instead of fwrite() / stdout.
Definition: cpl_vsil_stdout.cpp:64
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1138
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:1472
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:488
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename) CPL_WARN_UNUSED_RESULT
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2225
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:647
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:1219
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:827
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:140
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:379
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:329
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2139
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3) CPL_WARN_UNUSED_RESULT
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1129
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:435
Directory entry.
Definition: cpl_vsi.h:317
char * pszName
Filename.
Definition: cpl_vsi.h:319
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:325
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:331
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:329
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:327
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:333
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:323
int nMode
File mode.
Definition: cpl_vsi.h:321
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:506
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:524
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:513
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:521
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:512
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:515
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:523
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:517
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:519
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:522
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:527
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:520
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:525
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:516
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:510
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:526
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:514
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:511
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:518

Generated for GDAL by doxygen 1.9.4.