OGR
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
76 
78 /* ==================================================================== */
79 /* stdio file access functions. These do not support large */
80 /* files, and do not go through the virtualization API. */
81 /* ==================================================================== */
82 
85 FILE CPL_DLL * VSIFOpen( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
86 int CPL_DLL VSIFClose( FILE * );
87 int CPL_DLL VSIFSeek( FILE *, long, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
88 long CPL_DLL VSIFTell( FILE * ) CPL_WARN_UNUSED_RESULT;
89 void CPL_DLL VSIRewind( FILE * );
90 void CPL_DLL VSIFFlush( FILE * );
91 
92 size_t CPL_DLL VSIFRead( void *, size_t, size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
93 size_t CPL_DLL VSIFWrite( const void *, size_t, size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
94 char CPL_DLL *VSIFGets( char *, int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
95 int CPL_DLL VSIFPuts( const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96 int CPL_DLL VSIFPrintf( FILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
97 
98 int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
99 int CPL_DLL VSIFPutc( int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
100 int CPL_DLL VSIUngetc( int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
101 int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
102 
105 /* ==================================================================== */
106 /* VSIStat() related. */
107 /* ==================================================================== */
108 
110 typedef struct stat VSIStatBuf;
111 int 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
121 
122 # define VSI_ISLNK(x) S_ISLNK(x)
123 
124 # define VSI_ISREG(x) S_ISREG(x)
125 
126 # define VSI_ISDIR(x) S_ISDIR(x)
127 
128 # define VSI_ISCHR(x) S_ISCHR(x)
129 # define VSI_ISBLK(x) S_ISBLK(x)
130 
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
149 
151 #ifdef VSIL_STRICT_ENFORCE
152 
153 typedef struct _VSILFILE VSILFILE;
154 #else
155 
156 typedef FILE VSILFILE;
157 #endif
158 
159 VSILFILE CPL_DLL * VSIFOpenL( const char *, const char * ) CPL_WARN_UNUSED_RESULT;
160 VSILFILE CPL_DLL * VSIFOpenExL( const char *, const char *, int ) CPL_WARN_UNUSED_RESULT;
161 int CPL_DLL VSIFCloseL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
162 int CPL_DLL VSIFSeekL( VSILFILE *, vsi_l_offset, int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
164 void CPL_DLL VSIRewindL( VSILFILE * );
165 size_t CPL_DLL VSIFReadL( void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
166 int CPL_DLL VSIFReadMultiRangeL( int nRanges, void ** ppData, const vsi_l_offset* panOffsets, const size_t* panSizes, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
167 size_t CPL_DLL VSIFWriteL( const void *, size_t, size_t, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
168 int CPL_DLL VSIFEofL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
169 int CPL_DLL VSIFTruncateL( VSILFILE *, vsi_l_offset ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
170 int CPL_DLL VSIFFlushL( VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
171 int CPL_DLL VSIFPrintfL( VSILFILE *, CPL_FORMAT_STRING(const char *), ... ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_PRINT_FUNC_FORMAT(2, 3);
172 int CPL_DLL VSIFPutcL( int, VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
173 
175 typedef enum
176 {
181 
182 VSIRangeStatus CPL_DLL VSIFGetRangeStatusL( VSILFILE * fp, vsi_l_offset nStart, vsi_l_offset nLength );
183 
184 int CPL_DLL VSIIngestFile( VSILFILE* fp,
185  const char* pszFilename,
186  GByte** ppabyRet,
187  vsi_l_offset* pnSize,
188  GIntBig nMaxSize ) CPL_WARN_UNUSED_RESULT;
189 
190 int CPL_DLL VSIOverwriteFile( VSILFILE* fpTarget, const char* pszSourceFilename ) CPL_WARN_UNUSED_RESULT;
191 
192 #if defined(VSI_STAT64_T)
193 
194 typedef struct VSI_STAT64_T VSIStatBufL;
195 #else
196 
197 #define VSIStatBufL VSIStatBuf
198 #endif
199 
200 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
201 
203 #define VSI_STAT_EXISTS_FLAG 0x1
204 
205 #define VSI_STAT_NATURE_FLAG 0x2
206 
207 #define VSI_STAT_SIZE_FLAG 0x4
208 
209 #define VSI_STAT_SET_ERROR_FLAG 0x8
210 
211 int CPL_DLL VSIStatExL( const char * pszFilename, VSIStatBufL * psStatBuf, int nFlags ) CPL_WARN_UNUSED_RESULT;
212 
213 int CPL_DLL VSIIsCaseSensitiveFS( const char * pszFilename );
214 
215 int CPL_DLL VSISupportsSparseFiles( const char* pszPath );
216 
217 int CPL_DLL VSIHasOptimizedReadMultiRange( const char* pszPath );
218 
219 const char CPL_DLL *VSIGetActualURL( const char* pszFilename );
220 
221 char CPL_DLL *VSIGetSignedURL( const char* pszFilename, CSLConstList papszOptions );
222 
223 const char CPL_DLL *VSIGetFileSystemOptions( const char* pszFilename );
224 
225 char CPL_DLL **VSIGetFileSystemsPrefixes( void );
226 
227 void CPL_DLL *VSIFGetNativeFileDescriptorL( VSILFILE* );
228 
229 /* ==================================================================== */
230 /* Memory allocation */
231 /* ==================================================================== */
232 
233 void CPL_DLL *VSICalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
234 void CPL_DLL *VSIMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
235 void CPL_DLL VSIFree( void * );
236 void CPL_DLL *VSIRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
237 char CPL_DLL *VSIStrdup( const char * ) CPL_WARN_UNUSED_RESULT;
238 
239 void CPL_DLL *VSIMallocAligned( size_t nAlignment, size_t nSize ) CPL_WARN_UNUSED_RESULT;
240 void CPL_DLL *VSIMallocAlignedAuto( size_t nSize ) CPL_WARN_UNUSED_RESULT;
241 void CPL_DLL VSIFreeAligned( void* ptr );
242 
243 void 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 
254 void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
255 
263 void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
264 
266 void 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 
271 void 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 
276 void 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 
281 void 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 
286 void 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 
291 char 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 
295 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
296 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
297 
298 /* ==================================================================== */
299 /* Other... */
300 /* ==================================================================== */
301 
303 #define CPLReadDir VSIReadDir
304 char CPL_DLL **VSIReadDir( const char * );
305 char CPL_DLL **VSIReadDirRecursive( const char *pszPath );
306 char CPL_DLL **VSIReadDirEx( const char *pszPath, int nMaxFiles );
307 
309 typedef struct VSIDIR VSIDIR;
310 
311 VSIDIR CPL_DLL *VSIOpenDir( const char *pszPath,
312  int nRecurseDepth,
313  const char* const *papszOptions);
314 
316 typedef struct VSIDIREntry
317 {
319  char* pszName;
321  int nMode;
333  char** papszExtra;
334 
335 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
336 
337  VSIDIREntry();
338  ~VSIDIREntry();
339  VSIDIREntry(const VSIDIREntry&) = delete;
340  VSIDIREntry& operator=(VSIDIREntry&) = delete;
342 #endif
343 } VSIDIREntry;
344 
345 const VSIDIREntry CPL_DLL *VSIGetNextDirEntry(VSIDIR* dir);
346 void CPL_DLL VSICloseDir(VSIDIR* dir);
347 
348 int CPL_DLL VSIMkdir( const char * pszPathname, long mode );
349 int CPL_DLL VSIMkdirRecursive( const char * pszPathname, long mode );
350 int CPL_DLL VSIRmdir( const char * pszDirname );
351 int CPL_DLL VSIRmdirRecursive( const char * pszDirname );
352 int CPL_DLL VSIUnlink( const char * pszFilename );
353 int CPL_DLL VSIRename( const char * oldpath, const char * newpath );
354 int CPL_DLL VSISync( const char* pszSource, const char* pszTarget,
355  const char* const * papszOptions,
356  GDALProgressFunc pProgressFunc,
357  void *pProgressData,
358  char*** ppapszOutputs );
359 
360 char CPL_DLL *VSIStrerror( int );
361 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
362 
363 /* ==================================================================== */
364 /* Install special file access handlers. */
365 /* ==================================================================== */
366 void CPL_DLL VSIInstallMemFileHandler(void);
368 void CPL_DLL VSIInstallLargeFileHandler(void);
370 void CPL_DLL VSIInstallSubFileHandler(void);
371 void VSIInstallCurlFileHandler(void);
372 void CPL_DLL VSICurlClearCache(void);
373 void CPL_DLL VSICurlPartialClearCache(const char* pszFilenamePrefix);
375 void VSIInstallS3FileHandler(void);
377 void VSIInstallGSFileHandler(void);
379 void VSIInstallAzureFileHandler(void);
381 void VSIInstallOSSFileHandler(void);
383 void VSIInstallSwiftFileHandler(void);
385 void VSIInstallGZipFileHandler(void); /* No reason to export that */
386 void VSIInstallZipFileHandler(void); /* No reason to export that */
387 void VSIInstallStdinHandler(void); /* No reason to export that */
388 void VSIInstallHdfsHandler(void); /* No reason to export that */
389 void VSIInstallWebHdfsHandler(void); /* No reason to export that */
390 void VSIInstallStdoutHandler(void); /* No reason to export that */
391 void CPL_DLL VSIInstallSparseFileHandler(void);
392 void VSIInstallTarFileHandler(void); /* No reason to export that */
393 void CPL_DLL VSIInstallCryptFileHandler(void);
394 void CPL_DLL VSISetCryptKey(const GByte* pabyKey, int nKeySize);
396 void CPL_DLL VSICleanupFileManager(void);
399 VSILFILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename,
400  GByte *pabyData,
401  vsi_l_offset nDataLength,
402  int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
403 GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename,
404  vsi_l_offset *pnDataLength,
405  int bUnlinkAndSeize );
406 
408 typedef size_t (*VSIWriteFunction)(const void* ptr, size_t size, size_t nmemb, FILE* stream);
409 void CPL_DLL VSIStdoutSetRedirection( VSIWriteFunction pFct, FILE* stream );
410 
415 typedef int (*VSIFilesystemPluginStatCallback) ( void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags );
420 typedef int (*VSIFilesystemPluginUnlinkCallback) ( void *pUserData, const char *pszFilename );
425 typedef int (*VSIFilesystemPluginRenameCallback) ( void *pUserData, const char *oldpath, const char *newpath );
430 typedef int (*VSIFilesystemPluginMkdirCallback) ( void *pUserData, const char *pszDirname, long nMode );
435 typedef int (*VSIFilesystemPluginRmdirCallback) ( void *pUserData, const char *pszDirname );
440 typedef char** (*VSIFilesystemPluginReadDirCallback) ( void *pUserData, const char *pszDirname, int nMaxFiles );
446 typedef void* (*VSIFilesystemPluginOpenCallback) ( void *pUserData, const char *pszFilename, const char *pszAccess );
456 typedef int (*VSIFilesystemPluginSeekCallback) ( void *pFile, vsi_l_offset nOffset, int nWhence );
462 typedef size_t (*VSIFilesystemPluginReadCallback) ( void *pFile, void *pBuffer, size_t nSize, size_t nCount );
467 typedef int (*VSIFilesystemPluginReadMultiRangeCallback)( void *pFile, int nRanges, void ** ppData,
468  const vsi_l_offset* panOffsets, const size_t* panSizes );
478 typedef int (*VSIFilesystemPluginEofCallback) ( void *pFile );
483 typedef size_t (*VSIFilesystemPluginWriteCallback) ( void *pFile, const void *pBuffer, size_t nSize,size_t nCount);
488 typedef int (*VSIFilesystemPluginFlushCallback) ( void *pFile );
492 typedef int (*VSIFilesystemPluginTruncateCallback) ( void *pFile, vsi_l_offset nNewSize );
497 typedef int (*VSIFilesystemPluginCloseCallback) ( void *pFile );
498 
506 typedef struct {
510  void *pUserData;
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 
553 int CPL_DLL VSIInstallPluginHandler( const char* pszPrefix, const VSIFilesystemPluginCallbacksStruct* poCb);
554 
555 /* ==================================================================== */
556 /* Time querying. */
557 /* ==================================================================== */
558 
560 unsigned long CPL_DLL VSITime( unsigned long * );
561 const char CPL_DLL *VSICTime( unsigned long );
562 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime,
563  struct tm *poBrokenTime );
564 struct 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
591 
593 CPL_C_END
594 
595 #endif /* ndef CPL_VSI_H_INCLUDED */
VSIFPutcL
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1955
VSIDIREntry::bMTimeKnown
char bMTimeKnown
Definition: cpl_vsi.h:331
VSIGetNextDirEntry
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:379
VSIOpenDir
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:342
VSIOverwriteFile
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2225
VSIInstallSwiftFileHandler
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:706
CPL_PRINT_FUNC_FORMAT
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Definition: cpl_port.h:914
VSI_RANGE_STATUS_HOLE
@ VSI_RANGE_STATUS_HOLE
Definition: cpl_vsi.h:179
VSIFilesystemPluginCallbacksStruct::close
VSIFilesystemPluginCloseCallback close
Definition: cpl_vsi.h:527
VSIRmdirRecursive
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:669
VSIInstallAzureFileHandler
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:1219
VSIStdoutSetRedirection
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Definition: cpl_vsil_stdout.cpp:64
CPLGetUsablePhysicalRAM
GIntBig CPLGetUsablePhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1460
VSIFilesystemPluginRenameCallback
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Definition: cpl_vsi.h:425
VSIFreeAligned
void VSIFreeAligned(void *ptr)
Definition: cpl_vsisimple.cpp:975
GByte
unsigned char GByte
Definition: cpl_port.h:215
VSIMallocVerbose
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1138
VSIGetMemFileBuffer
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:959
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1690
VSIFilesystemPluginEofCallback
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Definition: cpl_vsi.h:478
VSIRmdir
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:647
cpl_error.h
VSIReallocVerbose
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1224
VSIInstallWebHdfsHandler
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1188
VSIFreeFilesystemPluginCallbacksStruct
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
Definition: cpl_vsil_plugin.cpp:354
VSIFilesystemPluginCallbacksStruct::seek
VSIFilesystemPluginSeekCallback seek
Definition: cpl_vsi.h:519
VSIInstallStdoutHandler
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:444
VSIFilesystemPluginStatCallback
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Definition: cpl_vsi.h:415
VSIDIREntry::nMode
int nMode
Definition: cpl_vsi.h:321
VSIGetSignedURL
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:959
VSICloseDir
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:398
VSIFileFromMemBuffer
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:898
VSIInstallAzureStreamingFileHandler
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2139
VSIRealloc
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:681
VSIInstallSubFileHandler
void VSIInstallSubFileHandler(void)
Definition: cpl_vsil_subfile.cpp:492
VSIFilesystemPluginFlushCallback
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Definition: cpl_vsi.h:488
VSIDIREntry::pszName
char * pszName
Definition: cpl_vsi.h:319
VSIDIREntry
struct VSIDIREntry VSIDIREntry
VSIInstallPluginHandler
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
Definition: cpl_vsil_plugin.cpp:344
VSIRangeStatus
VSIRangeStatus
Definition: cpl_vsi.h:175
CPLGetPhysicalRAM
GIntBig CPLGetPhysicalRAM(void)
Definition: cpl_vsisimple.cpp:1369
VSIFilesystemPluginTellCallback
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Definition: cpl_vsi.h:451
VSIMkdir
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:423
VSIFilesystemPluginCallbacksStruct::flush
VSIFilesystemPluginFlushCallback flush
Definition: cpl_vsi.h:525
VSIRename
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:529
VSIMkdirRecursive
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:446
VSIFOpenExL
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:1416
VSISync
int VSISync(const char *pszSource, const char *pszTarget, const char *const *papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData, char ***ppapszOutputs)
Synchronize a source file/directory with a target file/directory.
Definition: cpl_vsil.cpp:595
VSIRewindL
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1597
VSIFilesystemPluginCallbacksStruct::read
VSIFilesystemPluginReadCallback read
Definition: cpl_vsi.h:520
VSIIsCaseSensitiveFS
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:826
VSIFWriteL
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1804
VSIFilesystemPluginReadDirCallback
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
Definition: cpl_vsi.h:440
VSIWriteFunction
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Definition: cpl_vsi.h:408
VSIHasOptimizedReadMultiRange
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:882
VSIFilesystemPluginCallbacksStruct::tell
VSIFilesystemPluginTellCallback tell
Definition: cpl_vsi.h:518
VSIFilesystemPluginCallbacksStruct
Definition: cpl_vsi.h:506
VSIFCloseL
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:1472
VSIInstallSparseFileHandler
void VSIInstallSparseFileHandler(void)
Definition: cpl_vsil_sparsefile.cpp:547
VSIFilesystemPluginSeekCallback
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Definition: cpl_vsi.h:456
VSIDIREntry::nSize
vsi_l_offset nSize
Definition: cpl_vsi.h:323
VSIFilesystemPluginGetRangeStatusCallback
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Definition: cpl_vsi.h:473
VSIGetFileSystemOptions
const char * VSIGetFileSystemOptions(const char *pszFilename)
Return the list of options associated with a virtual file system handler as a serialized XML string.
Definition: cpl_vsil.cpp:2360
CPL_C_START
#define CPL_C_START
Definition: cpl_port.h:337
VSI_RANGE_STATUS_UNKNOWN
@ VSI_RANGE_STATUS_UNKNOWN
Definition: cpl_vsi.h:177
VSIFGetRangeStatusL
VSIRangeStatus VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsil.cpp:2007
VSIFEofL
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1850
VSIDIREntry::papszExtra
char ** papszExtra
Definition: cpl_vsi.h:333
VSIInstallS3FileHandler
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:2750
VSIAllocFilesystemPluginCallbacksStruct
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
Definition: cpl_vsil_plugin.cpp:351
VSIInstallGZipFileHandler
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:2449
VSIReadDirEx
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
VSIFilesystemPluginReadCallback
size_t(* VSIFilesystemPluginReadCallback)(void *pFile, void *pBuffer, size_t nSize, size_t nCount)
Definition: cpl_vsi.h:462
VSIFilesystemPluginCallbacksStruct::unlink
VSIFilesystemPluginUnlinkCallback unlink
Definition: cpl_vsi.h:512
CSLConstList
char ** CSLConstList
Definition: cpl_port.h:1194
VSIFTellL
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:1575
GUIntBig
unsigned long long GUIntBig
Definition: cpl_port.h:251
VSIFilesystemPluginCallbacksStruct::get_range_status
VSIFilesystemPluginGetRangeStatusCallback get_range_status
Definition: cpl_vsi.h:522
VSIFilesystemPluginCallbacksStruct::rename
VSIFilesystemPluginRenameCallback rename
Definition: cpl_vsi.h:513
VSIFFlushL
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1638
VSIFilesystemPluginUnlinkCallback
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Definition: cpl_vsi.h:420
VSIInstallGSFileHandler
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:329
CPL_C_END
#define CPL_C_END
Definition: cpl_port.h:339
VSIInstallStdinHandler
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
VSIInstallHdfsHandler
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (non-functional stub)
Definition: cpl_vsil_hdfs.cpp:431
VSIFilesystemPluginMkdirCallback
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Definition: cpl_vsi.h:430
VSIMalloc3Verbose
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1180
VSIDIREntry
Definition: cpl_vsi.h:316
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:737
VSIUnlink
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:498
VSIInstallCryptFileHandler
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2024
VSIInstallGSStreamingFileHandler
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2121
VSIFilesystemPluginRmdirCallback
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Definition: cpl_vsi.h:435
VSISupportsSparseFiles
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:856
VSIFTruncateL
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1892
VSIMalloc2Verbose
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1155
VSIGetFileSystemsPrefixes
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2340
VSIInstallCurlStreamingFileHandler
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2084
VSIFilesystemPluginTruncateCallback
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Definition: cpl_vsi.h:492
VSIInstallCurlFileHandler
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4300
VSIStrerror
char * VSIStrerror(int)
Definition: cpl_vsisimple.cpp:1347
VSIInstallTarFileHandler
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:619
VSIFSeekL
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:1532
VSIFilesystemPluginReadMultiRangeCallback
int(* VSIFilesystemPluginReadMultiRangeCallback)(void *pFile, int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Definition: cpl_vsi.h:467
VSIInstallMemFileHandler
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:868
VSIInstallZipFileHandler
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:3320
vsi_l_offset
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:140
VSIFree
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:827
VSIFilesystemPluginCallbacksStruct::stat
VSIFilesystemPluginStatCallback stat
Definition: cpl_vsi.h:511
VSIInstallOSSFileHandler
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:388
VSIMalloc2
void * VSIMalloc2(size_t nSize1, size_t nSize2)
Definition: cpl_vsisimple.cpp:1116
VSIStrdup
char * VSIStrdup(const char *)
Definition: cpl_vsisimple.cpp:995
VSIFReadMultiRangeL
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
VSICalloc
void * VSICalloc(size_t, size_t)
Definition: cpl_vsisimple.cpp:444
VSIStrdupVerbose
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1242
VSIMallocAlignedAuto
void * VSIMallocAlignedAuto(size_t nSize)
Definition: cpl_vsisimple.cpp:938
VSIFilesystemPluginCallbacksStruct::mkdir
VSIFilesystemPluginMkdirCallback mkdir
Definition: cpl_vsi.h:514
VSIFilesystemPluginCallbacksStruct::rmdir
VSIFilesystemPluginRmdirCallback rmdir
Definition: cpl_vsi.h:515
VSIMalloc
void * VSIMalloc(size_t)
Definition: cpl_vsisimple.cpp:558
VSIReadDirRecursive
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
GIntBig
long long GIntBig
Definition: cpl_port.h:248
VSIFilesystemPluginOpenCallback
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Definition: cpl_vsi.h:446
VSIStatExL
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:776
VSIDIREntry::nMTime
GIntBig nMTime
Definition: cpl_vsi.h:325
VSIDIREntry::bModeKnown
char bModeKnown
Definition: cpl_vsi.h:327
VSIDIR
struct VSIDIR VSIDIR
Definition: cpl_vsi.h:309
VSIFilesystemPluginCallbacksStruct::read_dir
VSIFilesystemPluginReadDirCallback read_dir
Definition: cpl_vsi.h:516
VSISetCryptKey
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Definition: cpl_vsil_crypt.cpp:205
CPL_WARN_UNUSED_RESULT
#define CPL_WARN_UNUSED_RESULT
Definition: cpl_port.h:939
VSIGetDiskFreeSpace
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2318
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:929
VSIStatBufL
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:194
cpl_port.h
VSIInstallOSSStreamingFileHandler
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2158
VSIInstallSwiftStreamingFileHandler
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2177
VSICurlPartialClearCache
void VSICurlPartialClearCache(const char *pszFilenamePrefix)
Clean local cache associated with /vsicurl/ (and related file systems) for a given filename (and its ...
Definition: cpl_vsil_curl.cpp:4378
VSIInstallS3StreamingFileHandler
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2102
VSIMallocAlignedAutoVerbose
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:951
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:997
VSIMallocAligned
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Definition: cpl_vsisimple.cpp:892
VSIReadDir
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
VSIFilesystemPluginCallbacksStruct::eof
VSIFilesystemPluginEofCallback eof
Definition: cpl_vsi.h:523
VSIFilesystemPluginCallbacksStruct::read_multi_range
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
Definition: cpl_vsi.h:521
VSIFilesystemPluginCallbacksStruct::truncate
VSIFilesystemPluginTruncateCallback truncate
Definition: cpl_vsi.h:526
VSIFilesystemPluginCallbacksStruct::open
VSIFilesystemPluginOpenCallback open
Definition: cpl_vsi.h:517
VSICurlClearCache
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:4338
VSIDIREntry::bSizeKnown
char bSizeKnown
Definition: cpl_vsi.h:329
VSIIngestFile
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2044
VSIFilesystemPluginCallbacksStruct::pUserData
void * pUserData
Definition: cpl_vsi.h:510
VSIFilesystemPluginWriteCallback
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Definition: cpl_vsi.h:483
VSIGetActualURL
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:912
VSIMalloc3
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
Definition: cpl_vsisimple.cpp:1129
VSIFilesystemPluginCallbacksStruct::write
VSIFilesystemPluginWriteCallback write
Definition: cpl_vsi.h:524
VSI_RANGE_STATUS_DATA
@ VSI_RANGE_STATUS_DATA
Definition: cpl_vsi.h:178
VSIFGetNativeFileDescriptorL
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2297
VSIFPrintfL
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1918
VSIFilesystemPluginCloseCallback
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Definition: cpl_vsi.h:497
VSICallocVerbose
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
Definition: cpl_vsisimple.cpp:1205
VSILFILE
FILE VSILFILE
Definition: cpl_vsi.h:156

Generated for GDAL by doxygen 1.8.17.