GDAL
cpl_vsi.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id$
3  *
4  * Project: CPL - Common Portability Library
5  * Author: Frank Warmerdam, warmerdam@pobox.com
6  * Purpose: Include file defining Virtual File System (VSI) functions, a
7  * layer over POSIX file and other system services.
8  *
9  ******************************************************************************
10  * Copyright (c) 1998, Frank Warmerdam
11  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at 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;
163 vsi_l_offset CPL_DLL VSIFTellL( VSILFILE * ) 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 #if defined(VSI_STAT64_T)
191 
192 typedef struct VSI_STAT64_T VSIStatBufL;
193 #else
194 
195 #define VSIStatBufL VSIStatBuf
196 #endif
197 
198 int CPL_DLL VSIStatL( const char *, VSIStatBufL * ) CPL_WARN_UNUSED_RESULT;
199 
201 #define VSI_STAT_EXISTS_FLAG 0x1
202 
203 #define VSI_STAT_NATURE_FLAG 0x2
204 
205 #define VSI_STAT_SIZE_FLAG 0x4
206 
207 #define VSI_STAT_SET_ERROR_FLAG 0x8
208 
209 int CPL_DLL VSIStatExL( const char * pszFilename, VSIStatBufL * psStatBuf, int nFlags ) CPL_WARN_UNUSED_RESULT;
210 
211 int CPL_DLL VSIIsCaseSensitiveFS( const char * pszFilename );
212 
213 int CPL_DLL VSISupportsSparseFiles( const char* pszPath );
214 
215 int CPL_DLL VSIHasOptimizedReadMultiRange( const char* pszPath );
216 
217 const char CPL_DLL *VSIGetActualURL( const char* pszFilename );
218 
219 char CPL_DLL *VSIGetSignedURL( const char* pszFilename, CSLConstList papszOptions );
220 
221 const char CPL_DLL *VSIGetFileSystemOptions( const char* pszFilename );
222 
223 char CPL_DLL **VSIGetFileSystemsPrefixes( void );
224 
225 void CPL_DLL *VSIFGetNativeFileDescriptorL( VSILFILE* );
226 
227 /* ==================================================================== */
228 /* Memory allocation */
229 /* ==================================================================== */
230 
231 void CPL_DLL *VSICalloc( size_t, size_t ) CPL_WARN_UNUSED_RESULT;
232 void CPL_DLL *VSIMalloc( size_t ) CPL_WARN_UNUSED_RESULT;
233 void CPL_DLL VSIFree( void * );
234 void CPL_DLL *VSIRealloc( void *, size_t ) CPL_WARN_UNUSED_RESULT;
235 char CPL_DLL *VSIStrdup( const char * ) CPL_WARN_UNUSED_RESULT;
236 
237 void CPL_DLL *VSIMallocAligned( size_t nAlignment, size_t nSize ) CPL_WARN_UNUSED_RESULT;
238 void CPL_DLL *VSIMallocAlignedAuto( size_t nSize ) CPL_WARN_UNUSED_RESULT;
239 void CPL_DLL VSIFreeAligned( void* ptr );
240 
241 void CPL_DLL *VSIMallocAlignedAutoVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
243 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
244 
252 void CPL_DLL *VSIMalloc2( size_t nSize1, size_t nSize2 ) CPL_WARN_UNUSED_RESULT;
253 
261 void CPL_DLL *VSIMalloc3( size_t nSize1, size_t nSize2, size_t nSize3 ) CPL_WARN_UNUSED_RESULT;
262 
264 void CPL_DLL *VSIMallocVerbose( size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
266 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
267 
269 void CPL_DLL *VSIMalloc2Verbose( size_t nSize1, size_t nSize2, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
271 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
272 
274 void CPL_DLL *VSIMalloc3Verbose( size_t nSize1, size_t nSize2, size_t nSize3, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
276 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
277 
279 void CPL_DLL *VSICallocVerbose( size_t nCount, size_t nSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
281 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
282 
284 void CPL_DLL *VSIReallocVerbose( void* pOldPtr, size_t nNewSize, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
286 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
287 
289 char CPL_DLL *VSIStrdupVerbose( const char* pszStr, const char* pszFile, int nLine ) CPL_WARN_UNUSED_RESULT;
291 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
292 
293 GIntBig CPL_DLL CPLGetPhysicalRAM(void);
294 GIntBig CPL_DLL CPLGetUsablePhysicalRAM(void);
295 
296 /* ==================================================================== */
297 /* Other... */
298 /* ==================================================================== */
299 
301 #define CPLReadDir VSIReadDir
302 char CPL_DLL **VSIReadDir( const char * );
303 char CPL_DLL **VSIReadDirRecursive( const char *pszPath );
304 char CPL_DLL **VSIReadDirEx( const char *pszPath, int nMaxFiles );
305 
307 typedef struct VSIDIR VSIDIR;
308 
309 VSIDIR CPL_DLL *VSIOpenDir( const char *pszPath,
310  int nRecurseDepth,
311  const char* const *papszOptions);
312 
314 typedef struct VSIDIREntry
315 {
317  char* pszName;
319  int nMode;
321  vsi_l_offset nSize;
331  char** papszExtra;
332 
333 #ifdef __cplusplus
334 
335  VSIDIREntry();
336  ~VSIDIREntry();
337  VSIDIREntry(const VSIDIREntry&) = delete;
338  VSIDIREntry& operator=(VSIDIREntry&) = delete;
340 #endif
341 } VSIDIREntry;
342 
343 const VSIDIREntry CPL_DLL *VSIGetNextDirEntry(VSIDIR* dir);
344 void CPL_DLL VSICloseDir(VSIDIR* dir);
345 
346 int CPL_DLL VSIMkdir( const char * pszPathname, long mode );
347 int CPL_DLL VSIMkdirRecursive( const char * pszPathname, long mode );
348 int CPL_DLL VSIRmdir( const char * pszDirname );
349 int CPL_DLL VSIRmdirRecursive( const char * pszDirname );
350 int CPL_DLL VSIUnlink( const char * pszFilename );
351 int CPL_DLL VSIRename( const char * oldpath, const char * newpath );
352 int CPL_DLL VSISync( const char* pszSource, const char* pszTarget,
353  const char* const * papszOptions,
354  GDALProgressFunc pProgressFunc,
355  void *pProgressData,
356  char*** ppapszOutputs );
357 
358 char CPL_DLL *VSIStrerror( int );
359 GIntBig CPL_DLL VSIGetDiskFreeSpace(const char *pszDirname);
360 
361 /* ==================================================================== */
362 /* Install special file access handlers. */
363 /* ==================================================================== */
364 void CPL_DLL VSIInstallMemFileHandler(void);
366 void CPL_DLL VSIInstallLargeFileHandler(void);
368 void CPL_DLL VSIInstallSubFileHandler(void);
369 void VSIInstallCurlFileHandler(void);
370 void CPL_DLL VSICurlClearCache(void);
371 void CPL_DLL VSICurlPartialClearCache(const char* pszFilenamePrefix);
373 void VSIInstallS3FileHandler(void);
375 void VSIInstallGSFileHandler(void);
377 void VSIInstallAzureFileHandler(void);
379 void VSIInstallOSSFileHandler(void);
381 void VSIInstallSwiftFileHandler(void);
383 void VSIInstallGZipFileHandler(void); /* No reason to export that */
384 void VSIInstallZipFileHandler(void); /* No reason to export that */
385 void VSIInstallStdinHandler(void); /* No reason to export that */
386 void VSIInstallHdfsHandler(void); /* No reason to export that */
387 void VSIInstallWebHdfsHandler(void); /* No reason to export that */
388 void VSIInstallStdoutHandler(void); /* No reason to export that */
389 void CPL_DLL VSIInstallSparseFileHandler(void);
390 void VSIInstallTarFileHandler(void); /* No reason to export that */
391 void CPL_DLL VSIInstallCryptFileHandler(void);
392 void CPL_DLL VSISetCryptKey(const GByte* pabyKey, int nKeySize);
394 void CPL_DLL VSICleanupFileManager(void);
397 VSILFILE CPL_DLL *VSIFileFromMemBuffer( const char *pszFilename,
398  GByte *pabyData,
399  vsi_l_offset nDataLength,
400  int bTakeOwnership ) CPL_WARN_UNUSED_RESULT;
401 GByte CPL_DLL *VSIGetMemFileBuffer( const char *pszFilename,
402  vsi_l_offset *pnDataLength,
403  int bUnlinkAndSeize );
404 
406 typedef size_t (*VSIWriteFunction)(const void* ptr, size_t size, size_t nmemb, FILE* stream);
407 void CPL_DLL VSIStdoutSetRedirection( VSIWriteFunction pFct, FILE* stream );
408 
409 /* ==================================================================== */
410 /* Time querying. */
411 /* ==================================================================== */
412 
414 unsigned long CPL_DLL VSITime( unsigned long * );
415 const char CPL_DLL *VSICTime( unsigned long );
416 struct tm CPL_DLL *VSIGMTime( const time_t *pnTime,
417  struct tm *poBrokenTime );
418 struct tm CPL_DLL *VSILocalTime( const time_t *pnTime,
419  struct tm *poBrokenTime );
423 /* -------------------------------------------------------------------- */
424 /* the following can be turned on for detailed logging of */
425 /* almost all IO calls. */
426 /* -------------------------------------------------------------------- */
427 #ifdef VSI_DEBUG
428 
429 #ifndef DEBUG
430 # define DEBUG
431 #endif
432 
433 #include "cpl_error.h"
434 
435 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
436 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
437 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
438 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
439 #else
440 #define VSIDebug4( f, a1, a2, a3, a4 ) {}
441 #define VSIDebug3( f, a1, a2, a3 ) {}
442 #define VSIDebug2( f, a1, a2 ) {}
443 #define VSIDebug1( f, a1 ) {}
444 #endif
445 
447 CPL_C_END
448 
449 #endif /* ndef CPL_VSI_H_INCLUDED */
Directory entry.
Definition: cpl_vsi.h:314
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:175
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1369
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1155
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:529
void * VSIMalloc(size_t) CPL_WARN_UNUSED_RESULT
Analog of malloc().
Definition: cpl_vsisimple.cpp:558
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
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1597
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:776
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2240
Core portability definitions for CPL.
vsi_l_offset VSIFTellL(VSILFILE *) CPL_WARN_UNUSED_RESULT
Tell current file offset.
Definition: cpl_vsil.cpp:1575
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
int nMode
File mode.
Definition: cpl_vsi.h:319
Hole.
Definition: cpl_vsi.h:179
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:2303
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:669
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1850
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:156
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
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:2485
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:975
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:321
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1955
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:379
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1690
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:951
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
char * pszName
Filename.
Definition: cpl_vsi.h:317
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1460
Data present.
Definition: cpl_vsi.h:178
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:215
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 VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:647
void * VSIRealloc(void *, size_t) CPL_WARN_UNUSED_RESULT
Analog of realloc().
Definition: cpl_vsisimple.cpp:681
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:325
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:906
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:398
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2114
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
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:856
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1892
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:444
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:492
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:331
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:329
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2077
VSILFILE * VSIFOpenL(const char *, const char *) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:997
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2283
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1224
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1347
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:578
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:3312
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:826
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:423
struct VSI_STAT64_T VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:192
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:446
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:1472
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1804
Unknown.
Definition: cpl_vsi.h:177
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:882
void * VSIMalloc2(size_t nSize1, size_t nSize2) CPL_WARN_UNUSED_RESULT
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1116
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
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2261
CPL error handling services.
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:547
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1205
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1186
void * VSIMallocAligned(size_t nAlignment, size_t nSize) CPL_WARN_UNUSED_RESULT
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:892
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:2442
int VSIStatL(const char *, VSIStatBufL *) CPL_WARN_UNUSED_RESULT
Get filesystem object info.
Definition: cpl_vsil.cpp:737
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:394
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
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1242
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1638
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:4224
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:406
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:323
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:498
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2022
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:1532
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:912
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4186
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:921
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine) CPL_WARN_UNUSED_RESULT
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1138
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
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:140
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl) ...
Definition: cpl_vsil_oss.cpp:388
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:342
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
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1918
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl) ...
Definition: cpl_vsil_swift.cpp:672
void * VSICalloc(size_t, size_t) CPL_WARN_UNUSED_RESULT
Analog of calloc().
Definition: cpl_vsisimple.cpp:444
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:1181
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:868
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:827
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:959
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:329
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:307
VSILFILE * VSIFOpenExL(const char *, const char *, int) CPL_WARN_UNUSED_RESULT
Open file.
Definition: cpl_vsil.cpp:1416
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:205
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl) ...
Definition: cpl_vsil_webhdfs.cpp:1185
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2151
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2170
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:4264
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:327
struct VSIDIREntry VSIDIREntry
Directory entry.
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl) ...
Definition: cpl_vsil_curl_streaming.cpp:2132
char * VSIStrdup(const char *) CPL_WARN_UNUSED_RESULT
Analog of strdup().
Definition: cpl_vsisimple.cpp:995
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2095
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:931
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:959

Generated for GDAL by doxygen 1.8.8.