/src/gdal/port/cpl_vsisimple.cpp
Line  | Count  | Source (jump to first uncovered line)  | 
1  |  | /******************************************************************************  | 
2  |  |  *  | 
3  |  |  * Project:  Common Portability Library  | 
4  |  |  * Purpose:  Simple implementation of POSIX VSI functions.  | 
5  |  |  * Author:   Frank Warmerdam, warmerdam@pobox.com  | 
6  |  |  *  | 
7  |  |  ******************************************************************************  | 
8  |  |  * Copyright (c) 1998, Frank Warmerdam  | 
9  |  |  * Copyright (c) 2008-2012, Even Rouault <even dot rouault at spatialys.com>  | 
10  |  |  *  | 
11  |  |  * SPDX-License-Identifier: MIT  | 
12  |  |  ****************************************************************************  | 
13  |  |  *  | 
14  |  |  * NB: Note that in wrappers we are always saving the error state (errno  | 
15  |  |  * variable) to avoid side effects during debug prints or other possible  | 
16  |  |  * standard function calls (error states will be overwritten after such  | 
17  |  |  * a call).  | 
18  |  |  *  | 
19  |  |  ****************************************************************************/  | 
20  |  |  | 
21  |  | // Must be done before including cpl_port.h  | 
22  |  | // We need __MSVCRT_VERSION__ >= 0x0700 to have "_aligned_malloc"  | 
23  |  | // Latest versions of mingw32 define it, but with older ones,  | 
24  |  | // we need to define it manually.  | 
25  |  | #if defined(__MINGW32__)  | 
26  |  | #include <windows.h>  | 
27  |  | #ifndef __MSVCRT_VERSION__  | 
28  |  | #define __MSVCRT_VERSION__ 0x0700  | 
29  |  | #endif  | 
30  |  | #endif  | 
31  |  |  | 
32  |  | #include "cpl_port.h"  | 
33  |  | #include "cpl_vsi.h"  | 
34  |  |  | 
35  |  | #include <algorithm>  | 
36  |  | #include <cerrno>  | 
37  |  | #include <cstdarg>  | 
38  |  | #include <cstddef>  | 
39  |  | #include <cstdio>  | 
40  |  | #include <cstdlib>  | 
41  |  | #include <cstring>  | 
42  |  | #include <ctime>  | 
43  |  | #include <limits>  | 
44  |  | #if HAVE_SYS_STAT_H  | 
45  |  | #include <sys/stat.h>  | 
46  |  | #endif  | 
47  |  | #if HAVE_GETRLIMIT  | 
48  |  | #include <sys/time.h>  | 
49  |  | #include <sys/resource.h>  | 
50  |  | #endif  | 
51  |  |  | 
52  |  | #include "cpl_config.h"  | 
53  |  | #include "cpl_error.h"  | 
54  |  | #include "cpl_string.h"  | 
55  |  |  | 
56  |  | #ifdef _WIN32  | 
57  |  | #include <malloc.h>  // For _aligned_malloc  | 
58  |  | #endif  | 
59  |  |  | 
60  |  | // Uncomment to check consistent usage of VSIMalloc(), VSIRealloc(),  | 
61  |  | // VSICalloc(), VSIFree(), VSIStrdup().  | 
62  |  | // #define DEBUG_VSIMALLOC  | 
63  |  |  | 
64  |  | // Uncomment to compute memory usage statistics.  | 
65  |  | // DEBUG_VSIMALLOC must also be defined.  | 
66  |  | // #define DEBUG_VSIMALLOC_STATS  | 
67  |  |  | 
68  |  | // Highly experimental, and likely buggy. Do not use, except for fixing it!  | 
69  |  | // DEBUG_VSIMALLOC must also be defined.  | 
70  |  | // #define DEBUG_VSIMALLOC_MPROTECT  | 
71  |  |  | 
72  |  | #ifdef DEBUG_VSIMALLOC_MPROTECT  | 
73  |  | #include <sys/mman.h>  | 
74  |  | #endif  | 
75  |  |  | 
76  |  | // Uncomment to print every memory allocation or deallocation.  | 
77  |  | // DEBUG_VSIMALLOC must also be defined.  | 
78  |  | // #define DEBUG_VSIMALLOC_VERBOSE  | 
79  |  |  | 
80  |  | // Number of bytes of the malloc/calloc/free that triggers a debug trace.  | 
81  |  | // Can be 0 for all allocs.  | 
82  |  | #define THRESHOLD_PRINT 10000  | 
83  |  |  | 
84  |  | // Uncomment to print GDAL block cache use.  | 
85  |  | // Only used if DEBUG_VSIMALLOC_VERBOSE is enabled.  | 
86  |  | // #define DEBUG_BLOCK_CACHE_USE  | 
87  |  |  | 
88  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
89  |  | extern "C" GIntBig CPL_DLL CPL_STDCALL GDALGetCacheUsed64(void);  | 
90  |  | #endif  | 
91  |  |  | 
92  |  | /* Unix or Windows NT/2000/XP */  | 
93  |  | #if !defined(_WIN32)  | 
94  |  | #include <unistd.h>  | 
95  |  | #else  | 
96  |  | #include <io.h>  | 
97  |  | #include <fcntl.h>  | 
98  |  | #include <direct.h>  | 
99  |  | #endif  | 
100  |  |  | 
101  |  | /************************************************************************/  | 
102  |  | /*                              VSIFOpen()                              */  | 
103  |  | /************************************************************************/  | 
104  |  |  | 
105  |  | FILE *VSIFOpen(const char *pszFilename, const char *pszAccess)  | 
106  |  |  | 
107  | 0  | { | 
108  |  | #if defined(_WIN32)  | 
109  |  |     FILE *fp = nullptr;  | 
110  |  |     if (CPLTestBool(CPLGetConfigOption("GDAL_FILENAME_IS_UTF8", "YES"))) | 
111  |  |     { | 
112  |  |         wchar_t *pwszFilename =  | 
113  |  |             CPLRecodeToWChar(pszFilename, CPL_ENC_UTF8, CPL_ENC_UCS2);  | 
114  |  |         wchar_t *pwszAccess =  | 
115  |  |             CPLRecodeToWChar(pszAccess, CPL_ENC_UTF8, CPL_ENC_UCS2);  | 
116  |  |  | 
117  |  |         fp = _wfopen(pwszFilename, pwszAccess);  | 
118  |  |  | 
119  |  |         CPLFree(pwszFilename);  | 
120  |  |         CPLFree(pwszAccess);  | 
121  |  |     }  | 
122  |  |     else  | 
123  |  |     { | 
124  |  |         // Are the casts really necessary?  | 
125  |  |         fp = fopen(const_cast<char *>(pszFilename),  | 
126  |  |                    const_cast<char *>(pszAccess));  | 
127  |  |     }  | 
128  |  | #else  | 
129  | 0  |     FILE *fp = fopen(pszFilename, pszAccess);  | 
130  | 0  | #endif  | 
131  |  | 
  | 
132  |  | #ifdef VSI_DEBUG  | 
133  |  |     // Capture the error from fopen to avoid being overwritten by errors  | 
134  |  |     // from VSIDebug3.  | 
135  |  |     const int nError = errno;  | 
136  |  |     VSIDebug3("VSIFOpen(%s,%s) = %p", pszFilename, pszAccess, fp); | 
137  |  |     errno = nError;  | 
138  |  | #endif  | 
139  |  | 
  | 
140  | 0  |     return fp;  | 
141  | 0  | }  | 
142  |  |  | 
143  |  | /************************************************************************/  | 
144  |  | /*                             VSIFClose()                              */  | 
145  |  | /************************************************************************/  | 
146  |  |  | 
147  |  | int VSIFClose(FILE *fp)  | 
148  |  |  | 
149  | 0  | { | 
150  | 0  |     VSIDebug1("VSIClose(%p)", fp); | 
151  |  | 
  | 
152  | 0  |     return fclose(fp);  | 
153  | 0  | }  | 
154  |  |  | 
155  |  | /************************************************************************/  | 
156  |  | /*                              VSIFSeek()                              */  | 
157  |  | /************************************************************************/  | 
158  |  |  | 
159  |  | int VSIFSeek(FILE *fp, long nOffset, int nWhence)  | 
160  |  |  | 
161  | 0  | { | 
162  | 0  | #ifdef DEBUG  | 
163  |  |     // To workaround Coverity strange warning about potential negative seek  | 
164  |  |     // CID 1340084 when called from dgnwrite.cpp.  | 
165  | 0  |     if (nWhence == SEEK_SET && nOffset < 0)  | 
166  | 0  |         return -1;  | 
167  | 0  | #endif  | 
168  | 0  |     int nResult = fseek(fp, nOffset, nWhence);  | 
169  |  | 
  | 
170  |  | #ifdef VSI_DEBUG  | 
171  |  |     // Capture the error from fseek to avoid being overwritten by errors  | 
172  |  |     // from VSIDebug.  | 
173  |  |     const int nError = errno;  | 
174  |  |  | 
175  |  |     if (nWhence == SEEK_SET)  | 
176  |  |     { | 
177  |  |         VSIDebug3("VSIFSeek(%p,%ld,SEEK_SET) = %d", fp, nOffset, nResult); | 
178  |  |     }  | 
179  |  |     else if (nWhence == SEEK_END)  | 
180  |  |     { | 
181  |  |         VSIDebug3("VSIFSeek(%p,%ld,SEEK_END) = %d", fp, nOffset, nResult); | 
182  |  |     }  | 
183  |  |     else if (nWhence == SEEK_CUR)  | 
184  |  |     { | 
185  |  |         VSIDebug3("VSIFSeek(%p,%ld,SEEK_CUR) = %d", fp, nOffset, nResult); | 
186  |  |     }  | 
187  |  |     else  | 
188  |  |     { | 
189  |  |         VSIDebug4("VSIFSeek(%p,%ld,%d-Unknown) = %d", fp, nOffset, nWhence, | 
190  |  |                   nResult);  | 
191  |  |     }  | 
192  |  |  | 
193  |  |     errno = nError;  | 
194  |  | #endif  | 
195  |  | 
  | 
196  | 0  |     return nResult;  | 
197  | 0  | }  | 
198  |  |  | 
199  |  | /************************************************************************/  | 
200  |  | /*                              VSIFTell()                              */  | 
201  |  | /************************************************************************/  | 
202  |  |  | 
203  |  | long VSIFTell(FILE *fp)  | 
204  |  |  | 
205  | 0  | { | 
206  | 0  |     const long nOffset = ftell(fp);  | 
207  |  | 
  | 
208  |  | #ifdef VSI_DEBUG  | 
209  |  |     // Capture the error from ftell to avoid being overwritten by errors  | 
210  |  |     // from VSIDebug.  | 
211  |  |     const int nError = errno;  | 
212  |  |     VSIDebug2("VSIFTell(%p) = %ld", fp, nOffset); | 
213  |  |     errno = nError;  | 
214  |  | #endif  | 
215  |  | 
  | 
216  | 0  |     return nOffset;  | 
217  | 0  | }  | 
218  |  |  | 
219  |  | /************************************************************************/  | 
220  |  | /*                             VSIRewind()                              */  | 
221  |  | /************************************************************************/  | 
222  |  |  | 
223  |  | void VSIRewind(FILE *fp)  | 
224  |  |  | 
225  | 0  | { | 
226  | 0  |     VSIDebug1("VSIRewind(%p)", fp); | 
227  | 0  |     rewind(fp);  | 
228  |  | #ifdef VSI_DEBUG  | 
229  |  |     // Capture the error rewind ftell to avoid being overwritten by errors  | 
230  |  |     // from VSIDebug.  | 
231  |  |     const int nError = errno;  | 
232  |  |     VSIDebug2("VSIRewind(%p) errno = %d", fp, nError); | 
233  |  |     errno = nError;  | 
234  |  | #endif  | 
235  | 0  | }  | 
236  |  |  | 
237  |  | /************************************************************************/  | 
238  |  | /*                              VSIFRead()                              */  | 
239  |  | /************************************************************************/  | 
240  |  |  | 
241  |  | size_t VSIFRead(void *pBuffer, size_t nSize, size_t nCount, FILE *fp)  | 
242  |  |  | 
243  | 0  | { | 
244  | 0  |     const size_t nResult = fread(pBuffer, nSize, nCount, fp);  | 
245  |  | 
  | 
246  |  | #ifdef VSI_DEBUG  | 
247  |  |     // Capture the error from fread to avoid being overwritten by errors  | 
248  |  |     // from VSIDebug.  | 
249  |  |     const int nError = errno;  | 
250  |  |     VSIDebug4("VSIFRead(%p,%ld,%ld) = %ld", fp, static_cast<long>(nSize), | 
251  |  |               static_cast<long>(nCount), static_cast<long>(nResult));  | 
252  |  |     errno = nError;  | 
253  |  | #endif  | 
254  |  | 
  | 
255  | 0  |     return nResult;  | 
256  | 0  | }  | 
257  |  |  | 
258  |  | /************************************************************************/  | 
259  |  | /*                             VSIFWrite()                              */  | 
260  |  | /************************************************************************/  | 
261  |  |  | 
262  |  | size_t VSIFWrite(const void *pBuffer, size_t nSize, size_t nCount, FILE *fp)  | 
263  |  |  | 
264  | 0  | { | 
265  | 0  |     const size_t nResult = fwrite(pBuffer, nSize, nCount, fp);  | 
266  |  | 
  | 
267  |  | #ifdef VSI_DEBUG  | 
268  |  |     // Capture the error from fwrite to avoid being overwritten by errors  | 
269  |  |     // from VSIDebug.  | 
270  |  |     const int nError = errno;  | 
271  |  |     VSIDebug4("VSIFWrite(%p,%ld,%ld) = %ld", fp, static_cast<long>(nSize), | 
272  |  |               static_cast<long>(nCount), static_cast<long>(nResult));  | 
273  |  |     errno = nError;  | 
274  |  | #endif  | 
275  |  | 
  | 
276  | 0  |     return nResult;  | 
277  | 0  | }  | 
278  |  |  | 
279  |  | /************************************************************************/  | 
280  |  | /*                             VSIFFlush()                              */  | 
281  |  | /************************************************************************/  | 
282  |  |  | 
283  |  | void VSIFFlush(FILE *fp)  | 
284  |  |  | 
285  | 0  | { | 
286  |  | #ifdef VSI_DEBUG  | 
287  |  |     VSIDebug1("VSIFFlush(%p)", fp); | 
288  |  |     const int result =  | 
289  |  | #endif  | 
290  | 0  |         fflush(fp);  | 
291  |  | 
  | 
292  |  | #ifdef VSI_DEBUG  | 
293  |  |     // Capture the error rewind ftell to avoid being overwritten by errors  | 
294  |  |     // from VSIDebug.  | 
295  |  |     const int nError = errno;  | 
296  |  |     VSIDebug2("VSIRewind(%p) errno = %d", fp, nError); | 
297  |  |     if (result != 0)  | 
298  |  |     { | 
299  |  |         CPLError(CE_Failure, CPLE_FileIO, "Flush failed.  errno = %d", nError);  | 
300  |  |     }  | 
301  |  |     errno = nError;  | 
302  |  | #endif  | 
303  | 0  | }  | 
304  |  |  | 
305  |  | /************************************************************************/  | 
306  |  | /*                              VSIFGets()                              */  | 
307  |  | /************************************************************************/  | 
308  |  |  | 
309  |  | char *VSIFGets(char *pszBuffer, int nBufferSize, FILE *fp)  | 
310  |  |  | 
311  | 0  | { | 
312  | 0  |     return fgets(pszBuffer, nBufferSize, fp);  | 
313  | 0  | }  | 
314  |  |  | 
315  |  | /************************************************************************/  | 
316  |  | /*                              VSIFGetc()                              */  | 
317  |  | /************************************************************************/  | 
318  |  |  | 
319  |  | int VSIFGetc(FILE *fp)  | 
320  |  |  | 
321  | 0  | { | 
322  | 0  |     return fgetc(fp);  | 
323  | 0  | }  | 
324  |  |  | 
325  |  | /************************************************************************/  | 
326  |  | /*                             VSIUngetc()                              */  | 
327  |  | /************************************************************************/  | 
328  |  |  | 
329  |  | int VSIUngetc(int c, FILE *fp)  | 
330  |  |  | 
331  | 0  | { | 
332  | 0  |     return ungetc(c, fp);  | 
333  | 0  | }  | 
334  |  |  | 
335  |  | /************************************************************************/  | 
336  |  | /*                             VSIFPrintf()                             */  | 
337  |  | /*                                                                      */  | 
338  |  | /*      This is a little more complicated than just calling             */  | 
339  |  | /*      fprintf() because of the variable arguments.  Instead we        */  | 
340  |  | /*      have to use vfprintf().                                         */  | 
341  |  | /************************************************************************/  | 
342  |  |  | 
343  |  | int VSIFPrintf(FILE *fp, CPL_FORMAT_STRING(const char *pszFormat), ...)  | 
344  |  |  | 
345  | 0  | { | 
346  | 0  |     va_list args;  | 
347  |  | 
  | 
348  | 0  |     va_start(args, pszFormat);  | 
349  | 0  |     const int nReturn = vfprintf(fp, pszFormat, args);  | 
350  | 0  |     va_end(args);  | 
351  |  | 
  | 
352  | 0  |     return nReturn;  | 
353  | 0  | }  | 
354  |  |  | 
355  |  | /************************************************************************/  | 
356  |  | /*                              VSIFEof()                               */  | 
357  |  | /************************************************************************/  | 
358  |  |  | 
359  |  | int VSIFEof(FILE *fp)  | 
360  |  |  | 
361  | 0  | { | 
362  | 0  |     return feof(fp);  | 
363  | 0  | }  | 
364  |  |  | 
365  |  | /************************************************************************/  | 
366  |  | /*                              VSIFPuts()                              */  | 
367  |  | /************************************************************************/  | 
368  |  |  | 
369  |  | int VSIFPuts(const char *pszString, FILE *fp)  | 
370  |  |  | 
371  | 0  | { | 
372  | 0  |     return fputs(pszString, fp);  | 
373  | 0  | }  | 
374  |  |  | 
375  |  | /************************************************************************/  | 
376  |  | /*                              VSIFPutc()                              */  | 
377  |  | /************************************************************************/  | 
378  |  |  | 
379  |  | int VSIFPutc(int nChar, FILE *fp)  | 
380  |  |  | 
381  | 0  | { | 
382  | 0  |     return fputc(nChar, fp);  | 
383  | 0  | }  | 
384  |  |  | 
385  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
386  |  | #include "cpl_multiproc.h"  | 
387  |  |  | 
388  |  | static CPLMutex *hMemStatMutex = nullptr;  | 
389  |  | static size_t nCurrentTotalAllocs = 0;  | 
390  |  | static size_t nMaxTotalAllocs = 0;  | 
391  |  | static GUIntBig nVSIMallocs = 0;  | 
392  |  | static GUIntBig nVSICallocs = 0;  | 
393  |  | static GUIntBig nVSIReallocs = 0;  | 
394  |  | static GUIntBig nVSIFrees = 0;  | 
395  |  |  | 
396  |  | /************************************************************************/  | 
397  |  | /*                         VSIShowMemStats()                            */  | 
398  |  | /************************************************************************/  | 
399  |  |  | 
400  |  | void VSIShowMemStats();  | 
401  |  |  | 
402  |  | void VSIShowMemStats()  | 
403  |  | { | 
404  |  |     char *pszShowMemStats = getenv("CPL_SHOW_MEM_STATS"); | 
405  |  |     if (pszShowMemStats == nullptr || pszShowMemStats[0] == '\0')  | 
406  |  |         return;  | 
407  |  |     printf("Current VSI memory usage        : " CPL_FRMT_GUIB " bytes\n", /*ok*/ | 
408  |  |            static_cast<GUIntBig>(nCurrentTotalAllocs));  | 
409  |  |     printf("Maximum VSI memory usage        : " CPL_FRMT_GUIB " bytes\n", /*ok*/ | 
410  |  |            static_cast<GUIntBig>(nMaxTotalAllocs));  | 
411  |  |     printf("Number of calls to VSIMalloc()  : " CPL_FRMT_GUIB "\n", /*ok*/ | 
412  |  |            nVSIMallocs);  | 
413  |  |     printf("Number of calls to VSICalloc()  : " CPL_FRMT_GUIB "\n", /*ok*/ | 
414  |  |            nVSICallocs);  | 
415  |  |     printf("Number of calls to VSIRealloc() : " CPL_FRMT_GUIB "\n", /*ok*/ | 
416  |  |            nVSIReallocs);  | 
417  |  |     printf("Number of calls to VSIFree()    : " CPL_FRMT_GUIB "\n", /*ok*/ | 
418  |  |            nVSIFrees);  | 
419  |  |     printf("VSIMalloc + VSICalloc - VSIFree : " CPL_FRMT_GUIB "\n", /*ok*/ | 
420  |  |            nVSIMallocs + nVSICallocs - nVSIFrees);  | 
421  |  | }  | 
422  |  | #endif  | 
423  |  |  | 
424  |  | #ifdef DEBUG_VSIMALLOC  | 
425  |  | static GIntBig nMaxPeakAllocSize = -1;  | 
426  |  | static GIntBig nMaxCumulAllocSize = -1;  | 
427  |  | #endif  | 
428  |  |  | 
429  |  | /************************************************************************/  | 
430  |  | /*                             VSICalloc()                              */  | 
431  |  | /************************************************************************/  | 
432  |  |  | 
433  |  | #ifndef DEBUG_VSIMALLOC  | 
434  |  |  | 
435  |  | /** Analog of calloc(). Use VSIFree() to free */  | 
436  |  | void *VSICalloc(size_t nCount, size_t nSize)  | 
437  | 421  | { | 
438  |  |     // cppcheck-suppress invalidFunctionArg  | 
439  | 421  |     return calloc(nCount, nSize);  | 
440  | 421  | }  | 
441  |  |  | 
442  |  | #else  // DEBUG_VSIMALLOC  | 
443  |  |  | 
444  |  | void *VSICalloc(size_t nCount, size_t nSize)  | 
445  |  | { | 
446  |  |     size_t nMul = nCount * nSize;  | 
447  |  |     if (nCount != 0 && nMul / nCount != nSize)  | 
448  |  |     { | 
449  |  |         fprintf(stderr, "Overflow in VSICalloc(%d, %d)\n", /*ok*/  | 
450  |  |                 static_cast<int>(nCount), static_cast<int>(nSize));  | 
451  |  |         return nullptr;  | 
452  |  |     }  | 
453  |  |     if (nMaxPeakAllocSize < 0)  | 
454  |  |     { | 
455  |  |         char *pszMaxPeakAllocSize = getenv("CPL_MAX_PEAK_ALLOC_SIZE"); | 
456  |  |         nMaxPeakAllocSize = pszMaxPeakAllocSize ? atoi(pszMaxPeakAllocSize) : 0;  | 
457  |  |         char *pszMaxCumulAllocSize = getenv("CPL_MAX_CUMUL_ALLOC_SIZE"); | 
458  |  |         nMaxCumulAllocSize =  | 
459  |  |             pszMaxCumulAllocSize ? atoi(pszMaxCumulAllocSize) : 0;  | 
460  |  |     }  | 
461  |  |     if (nMaxPeakAllocSize > 0 && static_cast<GIntBig>(nMul) > nMaxPeakAllocSize)  | 
462  |  |         return nullptr;  | 
463  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
464  |  |     if (nMaxCumulAllocSize > 0 &&  | 
465  |  |         static_cast<GIntBig>(nCurrentTotalAllocs) + static_cast<GIntBig>(nMul) >  | 
466  |  |             nMaxCumulAllocSize)  | 
467  |  |         return nullptr;  | 
468  |  | #endif  | 
469  |  |  | 
470  |  | #ifdef DEBUG_VSIMALLOC_MPROTECT  | 
471  |  |     char *ptr = nullptr;  | 
472  |  |     const size_t nPageSize = getpagesize();  | 
473  |  |     const size_t nRequestedSize =  | 
474  |  |         (3 * sizeof(void *) + nMul + nPageSize - 1) & ~(nPageSize - 1);  | 
475  |  |     if (nRequestedSize < nMul)  | 
476  |  |         return nullptr;  | 
477  |  |     posix_memalign((void **)&ptr, nPageSize, nRequestedSize);  | 
478  |  |     if (ptr == nullptr)  | 
479  |  |         return nullptr;  | 
480  |  |     memset(ptr + 2 * sizeof(void *), 0, nMul);  | 
481  |  | #else  | 
482  |  |     const size_t nRequestedSize = 3 * sizeof(void *) + nMul;  | 
483  |  |     if (nRequestedSize < nMul)  | 
484  |  |         return nullptr;  | 
485  |  |     char *ptr = static_cast<char *>(calloc(1, nRequestedSize));  | 
486  |  |     if (ptr == nullptr)  | 
487  |  |         return nullptr;  | 
488  |  | #endif  | 
489  |  |  | 
490  |  |     ptr[0] = 'V';  | 
491  |  |     ptr[1] = 'S';  | 
492  |  |     ptr[2] = 'I';  | 
493  |  |     ptr[3] = 'M';  | 
494  |  |     // cppcheck-suppress pointerSize  | 
495  |  |     memcpy(ptr + sizeof(void *), &nMul, sizeof(void *));  | 
496  |  |     ptr[2 * sizeof(void *) + nMul + 0] = 'E';  | 
497  |  |     ptr[2 * sizeof(void *) + nMul + 1] = 'V';  | 
498  |  |     ptr[2 * sizeof(void *) + nMul + 2] = 'S';  | 
499  |  |     ptr[2 * sizeof(void *) + nMul + 3] = 'I';  | 
500  |  | #if defined(DEBUG_VSIMALLOC_STATS) || defined(DEBUG_VSIMALLOC_VERBOSE)  | 
501  |  |     { | 
502  |  |         CPLMutexHolderD(&hMemStatMutex);  | 
503  |  | #ifdef DEBUG_VSIMALLOC_VERBOSE  | 
504  |  |         if (nMul > THRESHOLD_PRINT)  | 
505  |  |         { | 
506  |  |             fprintf(stderr, /*ok*/  | 
507  |  |                     "Thread[%p] VSICalloc(%d,%d) = %p"  | 
508  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
509  |  |                     ", current_cumul = " CPL_FRMT_GUIB  | 
510  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
511  |  |                     ", block_cache_used = " CPL_FRMT_GIB  | 
512  |  | #endif  | 
513  |  |                     ", mal+cal-free = %d"  | 
514  |  | #endif  | 
515  |  |                     "\n",  | 
516  |  |                     (void *)CPLGetPID(), static_cast<int>(nCount),  | 
517  |  |                     static_cast<int>(nSize), ptr + 2 * sizeof(void *)  | 
518  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
519  |  |                                                  ,  | 
520  |  |                     static_cast<GUIntBig>(nCurrentTotalAllocs + nMul)  | 
521  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
522  |  |                         ,  | 
523  |  |                     GDALGetCacheUsed64()  | 
524  |  | #endif  | 
525  |  |                         ,  | 
526  |  |                     static_cast<int>(nVSIMallocs + nVSICallocs - nVSIFrees)  | 
527  |  | #endif  | 
528  |  |             );  | 
529  |  |         }  | 
530  |  | #endif  | 
531  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
532  |  |         nVSICallocs++;  | 
533  |  |         if (nMaxTotalAllocs == 0)  | 
534  |  |             atexit(VSIShowMemStats);  | 
535  |  |         nCurrentTotalAllocs += nMul;  | 
536  |  |         if (nCurrentTotalAllocs > nMaxTotalAllocs)  | 
537  |  |             nMaxTotalAllocs = nCurrentTotalAllocs;  | 
538  |  | #endif  | 
539  |  |     }  | 
540  |  | #endif  | 
541  |  |     // cppcheck-suppress memleak  | 
542  |  |     return ptr + 2 * sizeof(void *);  | 
543  |  | }  | 
544  |  | #endif  // DEBUG_VSIMALLOC  | 
545  |  |  | 
546  |  | /************************************************************************/  | 
547  |  | /*                             VSIMalloc()                              */  | 
548  |  | /************************************************************************/  | 
549  |  |  | 
550  |  | #ifndef DEBUG_VSIMALLOC  | 
551  |  | /** Analog of malloc(). Use VSIFree() to free */  | 
552  |  | void *VSIMalloc(size_t nSize)  | 
553  |  |  | 
554  | 121k  | { | 
555  | 121k  |     return malloc(nSize);  | 
556  | 121k  | }  | 
557  |  |  | 
558  |  | #else  // DEBUG_VSIMALLOC  | 
559  |  |  | 
560  |  | void *VSIMalloc(size_t nSize)  | 
561  |  |  | 
562  |  | { | 
563  |  |     if (nMaxPeakAllocSize < 0)  | 
564  |  |     { | 
565  |  |         char *pszMaxPeakAllocSize = getenv("CPL_MAX_PEAK_ALLOC_SIZE"); | 
566  |  |         nMaxPeakAllocSize = pszMaxPeakAllocSize ? atoi(pszMaxPeakAllocSize) : 0;  | 
567  |  |         char *pszMaxCumulAllocSize = getenv("CPL_MAX_CUMUL_ALLOC_SIZE"); | 
568  |  |         nMaxCumulAllocSize =  | 
569  |  |             pszMaxCumulAllocSize ? atoi(pszMaxCumulAllocSize) : 0;  | 
570  |  |     }  | 
571  |  |     if (nMaxPeakAllocSize > 0 &&  | 
572  |  |         static_cast<GIntBig>(nSize) > nMaxPeakAllocSize)  | 
573  |  |         return nullptr;  | 
574  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
575  |  |     if (nMaxCumulAllocSize > 0 && static_cast<GIntBig>(nCurrentTotalAllocs) +  | 
576  |  |                                           static_cast<GIntBig>(nSize) >  | 
577  |  |                                       nMaxCumulAllocSize)  | 
578  |  |         return nullptr;  | 
579  |  | #endif  // DEBUG_VSIMALLOC_STATS  | 
580  |  |  | 
581  |  | #ifdef DEBUG_VSIMALLOC_MPROTECT  | 
582  |  |     char *ptr = nullptr;  | 
583  |  |     const size_t nPageSize = getpagesize();  | 
584  |  |     const size_t nRequestedSize =  | 
585  |  |         (3 * sizeof(void *) + nSize + nPageSize - 1) & ~(nPageSize - 1);  | 
586  |  |     if (nRequestedSize < nSize)  | 
587  |  |         return nullptr;  | 
588  |  |     posix_memalign((void **)&ptr, nPageSize, nRequestedSize);  | 
589  |  | #else  | 
590  |  |     const size_t nRequestedSize = 3 * sizeof(void *) + nSize;  | 
591  |  |     if (nRequestedSize < nSize)  | 
592  |  |         return nullptr;  | 
593  |  |     char *ptr = static_cast<char *>(malloc(nRequestedSize));  | 
594  |  | #endif  // DEBUG_VSIMALLOC_MPROTECT  | 
595  |  |     if (ptr == nullptr)  | 
596  |  |         return nullptr;  | 
597  |  |     ptr[0] = 'V';  | 
598  |  |     ptr[1] = 'S';  | 
599  |  |     ptr[2] = 'I';  | 
600  |  |     ptr[3] = 'M';  | 
601  |  |     // cppcheck-suppress pointerSize  | 
602  |  |     memcpy(ptr + sizeof(void *), &nSize, sizeof(void *));  | 
603  |  |     ptr[2 * sizeof(void *) + nSize + 0] = 'E';  | 
604  |  |     ptr[2 * sizeof(void *) + nSize + 1] = 'V';  | 
605  |  |     ptr[2 * sizeof(void *) + nSize + 2] = 'S';  | 
606  |  |     ptr[2 * sizeof(void *) + nSize + 3] = 'I';  | 
607  |  | #if defined(DEBUG_VSIMALLOC_STATS) || defined(DEBUG_VSIMALLOC_VERBOSE)  | 
608  |  |     { | 
609  |  |         CPLMutexHolderD(&hMemStatMutex);  | 
610  |  | #ifdef DEBUG_VSIMALLOC_VERBOSE  | 
611  |  |         if (nSize > THRESHOLD_PRINT)  | 
612  |  |         { | 
613  |  |             fprintf(stderr, /*ok*/  | 
614  |  |                     "Thread[%p] VSIMalloc(%d) = %p"  | 
615  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
616  |  |                     ", current_cumul = " CPL_FRMT_GUIB  | 
617  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
618  |  |                     ", block_cache_used = " CPL_FRMT_GIB  | 
619  |  | #endif  | 
620  |  |                     ", mal+cal-free = %d"  | 
621  |  | #endif  | 
622  |  |                     "\n",  | 
623  |  |                     (void *)CPLGetPID(), static_cast<int>(nSize),  | 
624  |  |                     ptr + 2 * sizeof(void *)  | 
625  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
626  |  |                         ,  | 
627  |  |                     static_cast<GUIntBig>(nCurrentTotalAllocs + nSize)  | 
628  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
629  |  |                         ,  | 
630  |  |                     GDALGetCacheUsed64()  | 
631  |  | #endif  | 
632  |  |                         ,  | 
633  |  |                     static_cast<int>(nVSIMallocs + nVSICallocs - nVSIFrees)  | 
634  |  | #endif  | 
635  |  |             );  | 
636  |  |         }  | 
637  |  | #endif  // DEBUG_VSIMALLOC_VERBOSE  | 
638  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
639  |  |         nVSIMallocs++;  | 
640  |  |         if (nMaxTotalAllocs == 0)  | 
641  |  |             atexit(VSIShowMemStats);  | 
642  |  |         nCurrentTotalAllocs += nSize;  | 
643  |  |         if (nCurrentTotalAllocs > nMaxTotalAllocs)  | 
644  |  |             nMaxTotalAllocs = nCurrentTotalAllocs;  | 
645  |  | #endif  // DEBUG_VSIMALLOC_STATS  | 
646  |  |     }  | 
647  |  | #endif  // DEBUG_VSIMALLOC_STATS || DEBUG_VSIMALLOC_VERBOSE  | 
648  |  |     // cppcheck-suppress memleak  | 
649  |  |     return ptr + 2 * sizeof(void *);  | 
650  |  | }  | 
651  |  |  | 
652  |  | static void VSICheckMarkerBegin(char *ptr)  | 
653  |  | { | 
654  |  |     if (memcmp(ptr, "VSIM", 4) != 0)  | 
655  |  |     { | 
656  |  |         CPLError(CE_Fatal, CPLE_AppDefined,  | 
657  |  |                  "Inconsistent use of VSI memory allocation primitives "  | 
658  |  |                  "for %p : %c%c%c%c",  | 
659  |  |                  ptr, ptr[0], ptr[1], ptr[2], ptr[3]);  | 
660  |  |     }  | 
661  |  | }  | 
662  |  |  | 
663  |  | static void VSICheckMarkerEnd(char *ptr, size_t nEnd)  | 
664  |  | { | 
665  |  |     if (memcmp(ptr + nEnd, "EVSI", 4) != 0)  | 
666  |  |     { | 
667  |  |         CPLError(CE_Fatal, CPLE_AppDefined,  | 
668  |  |                  "Memory has been written after the end of %p", ptr);  | 
669  |  |     }  | 
670  |  | }  | 
671  |  |  | 
672  |  | #endif  // DEBUG_VSIMALLOC  | 
673  |  |  | 
674  |  | /************************************************************************/  | 
675  |  | /*                             VSIRealloc()                             */  | 
676  |  | /************************************************************************/  | 
677  |  |  | 
678  |  | /** Analog of realloc(). Use VSIFree() to free.  | 
679  |  |  *  | 
680  |  |  * If the pointer is NULL, VSIRealloc is equivalent to VSIMalloc.  | 
681  |  |  */  | 
682  |  | void *VSIRealloc(void *pData, size_t nNewSize)  | 
683  |  |  | 
684  | 4.68k  | { | 
685  |  | #ifdef DEBUG_VSIMALLOC  | 
686  |  |     if (pData == nullptr)  | 
687  |  |         return VSIMalloc(nNewSize);  | 
688  |  |  | 
689  |  |     char *ptr = ((char *)pData) - 2 * sizeof(void *);  | 
690  |  |     VSICheckMarkerBegin(ptr);  | 
691  |  |  | 
692  |  |     size_t nOldSize = 0;  | 
693  |  |     // cppcheck-suppress pointerSize  | 
694  |  |     memcpy(&nOldSize, ptr + sizeof(void *), sizeof(void *));  | 
695  |  |     VSICheckMarkerEnd(ptr, 2 * sizeof(void *) + nOldSize);  | 
696  |  |  | 
697  |  |     if (nMaxPeakAllocSize < 0)  | 
698  |  |     { | 
699  |  |         char *pszMaxPeakAllocSize = getenv("CPL_MAX_PEAK_ALLOC_SIZE"); | 
700  |  |         nMaxPeakAllocSize = pszMaxPeakAllocSize ? atoi(pszMaxPeakAllocSize) : 0;  | 
701  |  |     }  | 
702  |  |     if (nMaxPeakAllocSize > 0 &&  | 
703  |  |         static_cast<GIntBig>(nNewSize) > nMaxPeakAllocSize)  | 
704  |  |         return nullptr;  | 
705  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
706  |  |     if (nMaxCumulAllocSize > 0 && static_cast<GIntBig>(nCurrentTotalAllocs) +  | 
707  |  |                                           static_cast<GIntBig>(nNewSize) -  | 
708  |  |                                           static_cast<GIntBig>(nOldSize) >  | 
709  |  |                                       nMaxCumulAllocSize)  | 
710  |  |         return nullptr;  | 
711  |  | #endif  | 
712  |  |  | 
713  |  |     ptr[2 * sizeof(void *) + nOldSize + 0] = 'I';  | 
714  |  |     ptr[2 * sizeof(void *) + nOldSize + 1] = 'S';  | 
715  |  |     ptr[2 * sizeof(void *) + nOldSize + 2] = 'V';  | 
716  |  |     ptr[2 * sizeof(void *) + nOldSize + 3] = 'E';  | 
717  |  |  | 
718  |  | #ifdef DEBUG_VSIMALLOC_MPROTECT  | 
719  |  |     char *newptr = nullptr;  | 
720  |  |     const size_t nPageSize = getpagesize();  | 
721  |  |     const size_t nRequestedSize =  | 
722  |  |         (nNewSize + 3 * sizeof(void *) + nPageSize - 1) & ~(nPageSize - 1);  | 
723  |  |     if (nRequestedSize < nNewSize)  | 
724  |  |     { | 
725  |  |         ptr[2 * sizeof(void *) + nOldSize + 0] = 'E';  | 
726  |  |         ptr[2 * sizeof(void *) + nOldSize + 1] = 'V';  | 
727  |  |         ptr[2 * sizeof(void *) + nOldSize + 2] = 'S';  | 
728  |  |         ptr[2 * sizeof(void *) + nOldSize + 3] = 'I';  | 
729  |  |         return nullptr;  | 
730  |  |     }  | 
731  |  |     posix_memalign((void **)&newptr, nPageSize, nRequestedSize);  | 
732  |  |     if (newptr == nullptr)  | 
733  |  |     { | 
734  |  |         ptr[2 * sizeof(void *) + nOldSize + 0] = 'E';  | 
735  |  |         ptr[2 * sizeof(void *) + nOldSize + 1] = 'V';  | 
736  |  |         ptr[2 * sizeof(void *) + nOldSize + 2] = 'S';  | 
737  |  |         ptr[2 * sizeof(void *) + nOldSize + 3] = 'I';  | 
738  |  |         return nullptr;  | 
739  |  |     }  | 
740  |  |     memcpy(newptr + 2 * sizeof(void *), pData, nOldSize);  | 
741  |  |     ptr[0] = 'M';  | 
742  |  |     ptr[1] = 'I';  | 
743  |  |     ptr[2] = 'S';  | 
744  |  |     ptr[3] = 'V';  | 
745  |  |     free(ptr);  | 
746  |  |     newptr[0] = 'V';  | 
747  |  |     newptr[1] = 'S';  | 
748  |  |     newptr[2] = 'I';  | 
749  |  |     newptr[3] = 'M';  | 
750  |  | #else  | 
751  |  |     const size_t nRequestedSize = 3 * sizeof(void *) + nNewSize;  | 
752  |  |     if (nRequestedSize < nNewSize)  | 
753  |  |     { | 
754  |  |         ptr[2 * sizeof(void *) + nOldSize + 0] = 'E';  | 
755  |  |         ptr[2 * sizeof(void *) + nOldSize + 1] = 'V';  | 
756  |  |         ptr[2 * sizeof(void *) + nOldSize + 2] = 'S';  | 
757  |  |         ptr[2 * sizeof(void *) + nOldSize + 3] = 'I';  | 
758  |  |         return nullptr;  | 
759  |  |     }  | 
760  |  |     void *newptr = realloc(ptr, nRequestedSize);  | 
761  |  |     if (newptr == nullptr)  | 
762  |  |     { | 
763  |  |         ptr[2 * sizeof(void *) + nOldSize + 0] = 'E';  | 
764  |  |         ptr[2 * sizeof(void *) + nOldSize + 1] = 'V';  | 
765  |  |         ptr[2 * sizeof(void *) + nOldSize + 2] = 'S';  | 
766  |  |         ptr[2 * sizeof(void *) + nOldSize + 3] = 'I';  | 
767  |  |         return nullptr;  | 
768  |  |     }  | 
769  |  | #endif  | 
770  |  |     ptr = static_cast<char *>(newptr);  | 
771  |  |     // cppcheck-suppress pointerSize  | 
772  |  |     memcpy(ptr + sizeof(void *), &nNewSize, sizeof(void *));  | 
773  |  |     ptr[2 * sizeof(void *) + nNewSize + 0] = 'E';  | 
774  |  |     ptr[2 * sizeof(void *) + nNewSize + 1] = 'V';  | 
775  |  |     ptr[2 * sizeof(void *) + nNewSize + 2] = 'S';  | 
776  |  |     ptr[2 * sizeof(void *) + nNewSize + 3] = 'I';  | 
777  |  |  | 
778  |  | #if defined(DEBUG_VSIMALLOC_STATS) || defined(DEBUG_VSIMALLOC_VERBOSE)  | 
779  |  |     { | 
780  |  |         CPLMutexHolderD(&hMemStatMutex);  | 
781  |  | #ifdef DEBUG_VSIMALLOC_VERBOSE  | 
782  |  |         if (nNewSize > THRESHOLD_PRINT)  | 
783  |  |         { | 
784  |  |             fprintf(  | 
785  |  |                 stderr,  | 
786  |  |                 "Thread[%p] VSIRealloc(%p, %d) = %p" /*ok*/  | 
787  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
788  |  |                 ", current_cumul = " CPL_FRMT_GUIB  | 
789  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
790  |  |                 ", block_cache_used = " CPL_FRMT_GIB  | 
791  |  | #endif  | 
792  |  |                 ", mal+cal-free = %d"  | 
793  |  | #endif  | 
794  |  |                 "\n",  | 
795  |  |                 (void *)CPLGetPID(), pData, static_cast<int>(nNewSize),  | 
796  |  |                 ptr + 2 * sizeof(void *)  | 
797  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
798  |  |                     ,  | 
799  |  |                 static_cast<GUIntBig>(nCurrentTotalAllocs - nOldSize + nNewSize)  | 
800  |  | #ifdef DEBUG_BLOCK_CACHE_USE  | 
801  |  |                     ,  | 
802  |  |                 GDALGetCacheUsed64()  | 
803  |  | #endif  | 
804  |  |                     ,  | 
805  |  |                 static_cast<int>(nVSIMallocs + nVSICallocs - nVSIFrees)  | 
806  |  | #endif  | 
807  |  |             );  | 
808  |  |         }  | 
809  |  | #endif  | 
810  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
811  |  |         nVSIReallocs++;  | 
812  |  |         nCurrentTotalAllocs -= nOldSize;  | 
813  |  |         nCurrentTotalAllocs += nNewSize;  | 
814  |  |         if (nCurrentTotalAllocs > nMaxTotalAllocs)  | 
815  |  |             nMaxTotalAllocs = nCurrentTotalAllocs;  | 
816  |  | #endif  | 
817  |  |     }  | 
818  |  | #endif  | 
819  |  |     return ptr + 2 * sizeof(void *);  | 
820  |  | #else  | 
821  | 4.68k  |     return realloc(pData, nNewSize);  | 
822  | 4.68k  | #endif  | 
823  | 4.68k  | }  | 
824  |  |  | 
825  |  | /************************************************************************/  | 
826  |  | /*                              VSIFree()                               */  | 
827  |  | /************************************************************************/  | 
828  |  |  | 
829  |  | /** Analog of free() for data allocated with VSIMalloc(), VSICalloc(),  | 
830  |  |  * VSIRealloc().  | 
831  |  |  *  | 
832  |  |  * It is not an error to call VSIFree with a NULL pointer, and it will  | 
833  |  |  * have no effect.  | 
834  |  |  */  | 
835  |  | void VSIFree(void *pData)  | 
836  |  |  | 
837  | 117k  | { | 
838  |  | #ifdef DEBUG_VSIMALLOC  | 
839  |  |     if (pData == nullptr)  | 
840  |  |         return;  | 
841  |  |  | 
842  |  |     char *ptr = ((char *)pData) - 2 * sizeof(void *);  | 
843  |  |     VSICheckMarkerBegin(ptr);  | 
844  |  |     size_t nOldSize = 0;  | 
845  |  |     // cppcheck-suppress pointerSize  | 
846  |  |     memcpy(&nOldSize, ptr + sizeof(void *), sizeof(void *));  | 
847  |  |     VSICheckMarkerEnd(ptr, 2 * sizeof(void *) + nOldSize);  | 
848  |  |     ptr[0] = 'M';  | 
849  |  |     ptr[1] = 'I';  | 
850  |  |     ptr[2] = 'S';  | 
851  |  |     ptr[3] = 'V';  | 
852  |  |     ptr[2 * sizeof(void *) + nOldSize + 0] = 'I';  | 
853  |  |     ptr[2 * sizeof(void *) + nOldSize + 1] = 'S';  | 
854  |  |     ptr[2 * sizeof(void *) + nOldSize + 2] = 'V';  | 
855  |  |     ptr[2 * sizeof(void *) + nOldSize + 3] = 'E';  | 
856  |  | #if defined(DEBUG_VSIMALLOC_STATS) || defined(DEBUG_VSIMALLOC_VERBOSE)  | 
857  |  |     { | 
858  |  |         CPLMutexHolderD(&hMemStatMutex);  | 
859  |  | #ifdef DEBUG_VSIMALLOC_VERBOSE  | 
860  |  |         if (nOldSize > THRESHOLD_PRINT)  | 
861  |  |         { | 
862  |  |             fprintf(stderr, "Thread[%p] VSIFree(%p, (%d bytes))\n", /*ok*/  | 
863  |  |                     (void *)CPLGetPID(), pData, static_cast<int>(nOldSize));  | 
864  |  |         }  | 
865  |  | #endif  | 
866  |  | #ifdef DEBUG_VSIMALLOC_STATS  | 
867  |  |         nVSIFrees++;  | 
868  |  |         nCurrentTotalAllocs -= nOldSize;  | 
869  |  | #endif  | 
870  |  |     }  | 
871  |  | #endif  | 
872  |  |  | 
873  |  | #ifdef DEBUG_VSIMALLOC_MPROTECT  | 
874  |  |     mprotect(ptr, nOldSize + 2 * sizeof(void *), PROT_NONE);  | 
875  |  | #else  | 
876  |  |     free(ptr);  | 
877  |  | #endif  | 
878  |  |  | 
879  |  | #else  | 
880  | 117k  |     if (pData != nullptr)  | 
881  | 117k  |         free(pData);  | 
882  | 117k  | #endif  | 
883  | 117k  | }  | 
884  |  |  | 
885  |  | /************************************************************************/  | 
886  |  | /*                      VSIMallocAligned()                              */  | 
887  |  | /************************************************************************/  | 
888  |  |  | 
889  |  | /** Allocates a buffer with an alignment constraint.  | 
890  |  |  *  | 
891  |  |  * The return value must be freed with VSIFreeAligned().  | 
892  |  |  *  | 
893  |  |  * @param nAlignment Must be a power of 2, multiple of sizeof(void*), and  | 
894  |  |  *                   lesser than 256.  | 
895  |  |  * @param nSize Size of the buffer to allocate.  | 
896  |  |  * @return a buffer aligned on nAlignment and of size nSize, or NULL  | 
897  |  |  * @since GDAL 2.2  | 
898  |  |  */  | 
899  |  |  | 
900  |  | void *VSIMallocAligned(size_t nAlignment, size_t nSize)  | 
901  | 0  | { | 
902  |  |     // In particular for posix_memalign() where behavior when passing  | 
903  |  |     // nSize == 0 is technically implementation defined (Valgrind complains),  | 
904  |  |     // so let's always return NULL.  | 
905  | 0  |     if (nSize == 0)  | 
906  | 0  |         return nullptr;  | 
907  | 0  | #if defined(HAVE_POSIX_MEMALIGN) && !defined(DEBUG_VSIMALLOC)  | 
908  | 0  |     void *pRet = nullptr;  | 
909  | 0  |     if (posix_memalign(&pRet, nAlignment, nSize) != 0)  | 
910  | 0  |     { | 
911  | 0  |         pRet = nullptr;  | 
912  | 0  |     }  | 
913  | 0  |     return pRet;  | 
914  |  | #elif defined(_WIN32) && !defined(DEBUG_VSIMALLOC)  | 
915  |  |     return _aligned_malloc(nSize, nAlignment);  | 
916  |  | #else  | 
917  |  |     // Check constraints on alignment.  | 
918  |  |     if (nAlignment < sizeof(void *) || nAlignment >= 256 ||  | 
919  |  |         (nAlignment & (nAlignment - 1)) != 0)  | 
920  |  |         return nullptr;  | 
921  |  |     // Detect overflow.  | 
922  |  |     if (nSize + nAlignment < nSize)  | 
923  |  |         return nullptr;  | 
924  |  |     GByte *pabyData = static_cast<GByte *>(VSIMalloc(nSize + nAlignment));  | 
925  |  |     if (pabyData == nullptr)  | 
926  |  |         return nullptr;  | 
927  |  |     size_t nShift =  | 
928  |  |         nAlignment - (reinterpret_cast<size_t>(pabyData) % nAlignment);  | 
929  |  |     GByte *pabyAligned = pabyData + nShift;  | 
930  |  |     // Guaranteed to fit on a byte since nAlignment < 256.  | 
931  |  |     pabyAligned[-1] = static_cast<GByte>(nShift);  | 
932  |  |     return pabyAligned;  | 
933  |  | #endif  | 
934  | 0  | }  | 
935  |  |  | 
936  |  | /************************************************************************/  | 
937  |  | /*                     VSIMallocAlignedAuto()                           */  | 
938  |  | /************************************************************************/  | 
939  |  |  | 
940  |  | /** Allocates a buffer with an alignment constraint such that it can be  | 
941  |  |  * used by the most demanding vector instruction set on that platform.  | 
942  |  |  *  | 
943  |  |  * The return value must be freed with VSIFreeAligned().  | 
944  |  |  *  | 
945  |  |  * @param nSize Size of the buffer to allocate.  | 
946  |  |  * @return an aligned buffer of size nSize, or NULL  | 
947  |  |  * @since GDAL 2.2  | 
948  |  |  */  | 
949  |  |  | 
950  |  | void *VSIMallocAlignedAuto(size_t nSize)  | 
951  | 0  | { | 
952  |  |     // We could potentially dynamically detect the capability of the CPU  | 
953  |  |     // but to simplify use 64 for AVX512 requirements (we use only AVX256  | 
954  |  |     // currently).  | 
955  | 0  |     return VSIMallocAligned(64, nSize);  | 
956  | 0  | }  | 
957  |  |  | 
958  |  | /************************************************************************/  | 
959  |  | /*                        VSIMallocAlignedAutoVerbose()                 */  | 
960  |  | /************************************************************************/  | 
961  |  |  | 
962  |  | /** See VSIMallocAlignedAuto() */  | 
963  |  | void *VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)  | 
964  | 0  | { | 
965  | 0  |     void *pRet = VSIMallocAlignedAuto(nSize);  | 
966  | 0  |     if (pRet == nullptr && nSize != 0)  | 
967  | 0  |     { | 
968  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
969  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
970  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
971  | 0  |                  static_cast<GUIntBig>(nSize));  | 
972  | 0  |     }  | 
973  | 0  |     return pRet;  | 
974  | 0  | }  | 
975  |  |  | 
976  |  | /************************************************************************/  | 
977  |  | /*                        VSIFreeAligned()                              */  | 
978  |  | /************************************************************************/  | 
979  |  |  | 
980  |  | /** Free a buffer allocated with VSIMallocAligned().  | 
981  |  |  *  | 
982  |  |  * @param ptr Buffer to free.  | 
983  |  |  * @since GDAL 2.2  | 
984  |  |  */  | 
985  |  |  | 
986  |  | void VSIFreeAligned(void *ptr)  | 
987  | 0  | { | 
988  | 0  | #if defined(HAVE_POSIX_MEMALIGN) && !defined(DEBUG_VSIMALLOC)  | 
989  | 0  |     free(ptr);  | 
990  |  | #elif defined(_WIN32) && !defined(DEBUG_VSIMALLOC)  | 
991  |  |     _aligned_free(ptr);  | 
992  |  | #else  | 
993  |  |     if (ptr == nullptr)  | 
994  |  |         return;  | 
995  |  |     GByte *pabyAligned = static_cast<GByte *>(ptr);  | 
996  |  |     size_t nShift = pabyAligned[-1];  | 
997  |  |     VSIFree(pabyAligned - nShift);  | 
998  |  | #endif  | 
999  | 0  | }  | 
1000  |  |  | 
1001  |  | /************************************************************************/  | 
1002  |  | /*                             VSIStrdup()                              */  | 
1003  |  | /************************************************************************/  | 
1004  |  |  | 
1005  |  | /** Analog of strdup(). Use VSIFree() to free */  | 
1006  |  | char *VSIStrdup(const char *pszString)  | 
1007  |  |  | 
1008  | 101k  | { | 
1009  | 101k  |     const size_t nSize = strlen(pszString) + 1;  | 
1010  | 101k  |     char *ptr = static_cast<char *>(VSIMalloc(nSize));  | 
1011  | 101k  |     if (ptr == nullptr)  | 
1012  | 0  |         return nullptr;  | 
1013  | 101k  |     memcpy(ptr, pszString, nSize);  | 
1014  | 101k  |     return ptr;  | 
1015  | 101k  | }  | 
1016  |  |  | 
1017  |  | /************************************************************************/  | 
1018  |  | /*                          VSICheckMul2()                              */  | 
1019  |  | /************************************************************************/  | 
1020  |  |  | 
1021  |  | CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW  | 
1022  |  | static size_t VSICheckMul2(size_t mul1, size_t mul2, bool *pbOverflowFlag,  | 
1023  |  |                            const char *pszFile, int nLine)  | 
1024  | 867  | { | 
1025  | 867  |     const size_t res = mul1 * mul2;  | 
1026  | 867  |     if (mul1 != 0)  | 
1027  | 867  |     { | 
1028  | 867  |         if (res / mul1 == mul2)  | 
1029  | 867  |         { | 
1030  | 867  |             if (pbOverflowFlag)  | 
1031  | 867  |                 *pbOverflowFlag = FALSE;  | 
1032  | 867  |             return res;  | 
1033  | 867  |         }  | 
1034  | 0  |         else  | 
1035  | 0  |         { | 
1036  | 0  |             if (pbOverflowFlag)  | 
1037  | 0  |                 *pbOverflowFlag = TRUE;  | 
1038  | 0  |             CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1039  | 0  |                      "%s: %d: Multiplication overflow : " CPL_FRMT_GUIB  | 
1040  | 0  |                      " * " CPL_FRMT_GUIB,  | 
1041  | 0  |                      pszFile ? pszFile : "(unknown file)", nLine,  | 
1042  | 0  |                      static_cast<GUIntBig>(mul1), static_cast<GUIntBig>(mul2));  | 
1043  | 0  |         }  | 
1044  | 867  |     }  | 
1045  | 0  |     else  | 
1046  | 0  |     { | 
1047  | 0  |         if (pbOverflowFlag)  | 
1048  | 0  |             *pbOverflowFlag = FALSE;  | 
1049  | 0  |     }  | 
1050  | 0  |     return 0;  | 
1051  | 867  | }  | 
1052  |  |  | 
1053  |  | /************************************************************************/  | 
1054  |  | /*                          VSICheckMul3()                              */  | 
1055  |  | /************************************************************************/  | 
1056  |  |  | 
1057  |  | CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW  | 
1058  |  | static size_t VSICheckMul3(size_t mul1, size_t mul2, size_t mul3,  | 
1059  |  |                            bool *pbOverflowFlag, const char *pszFile, int nLine)  | 
1060  | 0  | { | 
1061  | 0  |     if (mul1 != 0)  | 
1062  | 0  |     { | 
1063  | 0  |         const size_t res = mul1 * mul2;  | 
1064  | 0  |         if (res / mul1 == mul2)  | 
1065  | 0  |         { | 
1066  | 0  |             const size_t res2 = res * mul3;  | 
1067  | 0  |             if (mul3 != 0)  | 
1068  | 0  |             { | 
1069  | 0  |                 if (res2 / mul3 == res)  | 
1070  | 0  |                 { | 
1071  | 0  |                     if (pbOverflowFlag)  | 
1072  | 0  |                         *pbOverflowFlag = false;  | 
1073  | 0  |                     return res2;  | 
1074  | 0  |                 }  | 
1075  | 0  |                 else  | 
1076  | 0  |                 { | 
1077  | 0  |                     if (pbOverflowFlag)  | 
1078  | 0  |                         *pbOverflowFlag = true;  | 
1079  | 0  |                     CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1080  | 0  |                              "%s: %d: Multiplication overflow : " CPL_FRMT_GUIB  | 
1081  | 0  |                              " * " CPL_FRMT_GUIB " * " CPL_FRMT_GUIB,  | 
1082  | 0  |                              pszFile ? pszFile : "(unknown file)", nLine,  | 
1083  | 0  |                              static_cast<GUIntBig>(mul1),  | 
1084  | 0  |                              static_cast<GUIntBig>(mul2),  | 
1085  | 0  |                              static_cast<GUIntBig>(mul3));  | 
1086  | 0  |                 }  | 
1087  | 0  |             }  | 
1088  | 0  |             else  | 
1089  | 0  |             { | 
1090  | 0  |                 if (pbOverflowFlag)  | 
1091  | 0  |                     *pbOverflowFlag = false;  | 
1092  | 0  |             }  | 
1093  | 0  |         }  | 
1094  | 0  |         else  | 
1095  | 0  |         { | 
1096  | 0  |             if (pbOverflowFlag)  | 
1097  | 0  |                 *pbOverflowFlag = true;  | 
1098  | 0  |             CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1099  | 0  |                      "%s: %d: Multiplication overflow : " CPL_FRMT_GUIB  | 
1100  | 0  |                      " * " CPL_FRMT_GUIB " * " CPL_FRMT_GUIB,  | 
1101  | 0  |                      pszFile ? pszFile : "(unknown file)", nLine,  | 
1102  | 0  |                      static_cast<GUIntBig>(mul1), static_cast<GUIntBig>(mul2),  | 
1103  | 0  |                      static_cast<GUIntBig>(mul3));  | 
1104  | 0  |         }  | 
1105  | 0  |     }  | 
1106  | 0  |     else  | 
1107  | 0  |     { | 
1108  | 0  |         if (pbOverflowFlag)  | 
1109  | 0  |             *pbOverflowFlag = false;  | 
1110  | 0  |     }  | 
1111  | 0  |     return 0;  | 
1112  | 0  | }  | 
1113  |  |  | 
1114  |  | /**  | 
1115  |  |  VSIMalloc2 allocates (nSize1 * nSize2) bytes.  | 
1116  |  |  In case of overflow of the multiplication, or if memory allocation fails, a  | 
1117  |  |  NULL pointer is returned and a CE_Failure error is raised with CPLError().  | 
1118  |  |  If nSize1 == 0 || nSize2 == 0, a NULL pointer will also be returned.  | 
1119  |  |  CPLFree() or VSIFree() can be used to free memory allocated by this function.  | 
1120  |  | */  | 
1121  |  | void CPL_DLL *VSIMalloc2(size_t nSize1, size_t nSize2)  | 
1122  | 0  | { | 
1123  | 0  |     return VSIMalloc2Verbose(nSize1, nSize2, nullptr, 0);  | 
1124  | 0  | }  | 
1125  |  |  | 
1126  |  | /**  | 
1127  |  |  VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.  | 
1128  |  |  In case of overflow of the multiplication, or if memory allocation fails, a  | 
1129  |  |  NULL pointer is returned and a CE_Failure error is raised with CPLError().  | 
1130  |  |  If nSize1 == 0 || nSize2 == 0 || nSize3 == 0, a NULL pointer will also be  | 
1131  |  |  returned.  CPLFree() or VSIFree() can be used to free memory allocated by this  | 
1132  |  |  function.  | 
1133  |  | */  | 
1134  |  | void CPL_DLL *VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)  | 
1135  | 0  | { | 
1136  | 0  |     return VSIMalloc3Verbose(nSize1, nSize2, nSize3, nullptr, 0);  | 
1137  | 0  | }  | 
1138  |  |  | 
1139  |  | /************************************************************************/  | 
1140  |  | /*                          VSIMallocVerbose()                          */  | 
1141  |  | /************************************************************************/  | 
1142  |  |  | 
1143  |  | void *VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)  | 
1144  | 0  | { | 
1145  | 0  |     void *pRet = VSIMalloc(nSize);  | 
1146  | 0  |     if (pRet == nullptr && nSize != 0)  | 
1147  | 0  |     { | 
1148  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1149  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
1150  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1151  | 0  |                  static_cast<GUIntBig>(nSize));  | 
1152  | 0  |     }  | 
1153  | 0  |     return pRet;  | 
1154  | 0  | }  | 
1155  |  |  | 
1156  |  | /************************************************************************/  | 
1157  |  | /*                          VSIMalloc2Verbose()                         */  | 
1158  |  | /************************************************************************/  | 
1159  |  |  | 
1160  |  | void *VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile,  | 
1161  |  |                         int nLine)  | 
1162  | 867  | { | 
1163  | 867  |     bool bOverflowFlag = false;  | 
1164  | 867  |     const size_t nSizeToAllocate =  | 
1165  | 867  |         VSICheckMul2(nSize1, nSize2, &bOverflowFlag, pszFile, nLine);  | 
1166  | 867  |     if (bOverflowFlag || nSizeToAllocate == 0)  | 
1167  | 0  |         return nullptr;  | 
1168  |  |  | 
1169  | 867  |     void *pRet = VSIMalloc(nSizeToAllocate);  | 
1170  | 867  |     if (pRet == nullptr)  | 
1171  | 0  |     { | 
1172  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1173  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
1174  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1175  | 0  |                  static_cast<GUIntBig>(nSize1) * static_cast<GUIntBig>(nSize2));  | 
1176  | 0  |     }  | 
1177  | 867  |     return pRet;  | 
1178  | 867  | }  | 
1179  |  |  | 
1180  |  | /************************************************************************/  | 
1181  |  | /*                          VSIMalloc3Verbose()                         */  | 
1182  |  | /************************************************************************/  | 
1183  |  |  | 
1184  |  | void *VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3,  | 
1185  |  |                         const char *pszFile, int nLine)  | 
1186  | 0  | { | 
1187  | 0  |     bool bOverflowFlag = false;  | 
1188  | 0  |     size_t nSizeToAllocate =  | 
1189  | 0  |         VSICheckMul3(nSize1, nSize2, nSize3, &bOverflowFlag, pszFile, nLine);  | 
1190  | 0  |     if (bOverflowFlag || nSizeToAllocate == 0)  | 
1191  | 0  |         return nullptr;  | 
1192  |  |  | 
1193  | 0  |     void *pRet = VSIMalloc(nSizeToAllocate);  | 
1194  | 0  |     if (pRet == nullptr)  | 
1195  | 0  |     { | 
1196  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1197  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
1198  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1199  | 0  |                  static_cast<GUIntBig>(nSize1) * static_cast<GUIntBig>(nSize2) *  | 
1200  | 0  |                      static_cast<GUIntBig>(nSize3));  | 
1201  | 0  |     }  | 
1202  | 0  |     return pRet;  | 
1203  | 0  | }  | 
1204  |  |  | 
1205  |  | /************************************************************************/  | 
1206  |  | /*                          VSICallocVerbose()                          */  | 
1207  |  | /************************************************************************/  | 
1208  |  |  | 
1209  |  | void *VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile,  | 
1210  |  |                        int nLine)  | 
1211  | 418  | { | 
1212  | 418  |     void *pRet = VSICalloc(nCount, nSize);  | 
1213  | 418  |     if (pRet == nullptr && nCount != 0 && nSize != 0)  | 
1214  | 0  |     { | 
1215  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1216  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB "x" CPL_FRMT_GUIB  | 
1217  | 0  |                  " bytes",  | 
1218  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1219  | 0  |                  static_cast<GUIntBig>(nCount), static_cast<GUIntBig>(nSize));  | 
1220  | 0  |     }  | 
1221  | 418  |     return pRet;  | 
1222  | 418  | }  | 
1223  |  |  | 
1224  |  | /************************************************************************/  | 
1225  |  | /*                          VSIReallocVerbose()                         */  | 
1226  |  | /************************************************************************/  | 
1227  |  |  | 
1228  |  | void *VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile,  | 
1229  |  |                         int nLine)  | 
1230  | 4.67k  | { | 
1231  | 4.67k  |     void *pRet = VSIRealloc(pOldPtr, nNewSize);  | 
1232  | 4.67k  |     if (pRet == nullptr && nNewSize != 0)  | 
1233  | 0  |     { | 
1234  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1235  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
1236  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1237  | 0  |                  static_cast<GUIntBig>(nNewSize));  | 
1238  | 0  |     }  | 
1239  | 4.67k  |     return pRet;  | 
1240  | 4.67k  | }  | 
1241  |  |  | 
1242  |  | /************************************************************************/  | 
1243  |  | /*                          VSIStrdupVerbose()                          */  | 
1244  |  | /************************************************************************/  | 
1245  |  |  | 
1246  |  | char *VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)  | 
1247  | 101k  | { | 
1248  | 101k  |     char *pRet = VSIStrdup(pszStr);  | 
1249  | 101k  |     if (pRet == nullptr)  | 
1250  | 0  |     { | 
1251  | 0  |         CPLError(CE_Failure, CPLE_OutOfMemory,  | 
1252  | 0  |                  "%s, %d: cannot allocate " CPL_FRMT_GUIB " bytes",  | 
1253  | 0  |                  pszFile ? pszFile : "(unknown file)", nLine,  | 
1254  | 0  |                  static_cast<GUIntBig>(strlen(pszStr) + 1));  | 
1255  | 0  |     }  | 
1256  | 101k  |     return pRet;  | 
1257  | 101k  | }  | 
1258  |  |  | 
1259  |  | /************************************************************************/  | 
1260  |  | /*                              VSIStat()                               */  | 
1261  |  | /************************************************************************/  | 
1262  |  |  | 
1263  |  | int VSIStat(const char *pszFilename, VSIStatBuf *pStatBuf)  | 
1264  |  |  | 
1265  | 0  | { | 
1266  |  | #if defined(_WIN32)  | 
1267  |  |     if (CPLTestBool(CPLGetConfigOption("GDAL_FILENAME_IS_UTF8", "YES"))) | 
1268  |  |     { | 
1269  |  |         wchar_t *pwszFilename =  | 
1270  |  |             CPLRecodeToWChar(pszFilename, CPL_ENC_UTF8, CPL_ENC_UCS2);  | 
1271  |  |  | 
1272  |  |         int nResult =  | 
1273  |  |             _wstat(pwszFilename, reinterpret_cast<struct _stat *>(pStatBuf));  | 
1274  |  |  | 
1275  |  |         CPLFree(pwszFilename);  | 
1276  |  |  | 
1277  |  |         return nResult;  | 
1278  |  |     }  | 
1279  |  |  | 
1280  |  | #endif  | 
1281  | 0  |     return stat(pszFilename, pStatBuf);  | 
1282  | 0  | }  | 
1283  |  |  | 
1284  |  | /************************************************************************/  | 
1285  |  | /*                              VSITime()                               */  | 
1286  |  | /************************************************************************/  | 
1287  |  |  | 
1288  |  | unsigned long VSITime(unsigned long *pnTimeToSet)  | 
1289  |  |  | 
1290  | 0  | { | 
1291  | 0  |     time_t tTime;  | 
1292  |  | 
  | 
1293  | 0  |     tTime = time(nullptr);  | 
1294  |  | 
  | 
1295  | 0  |     if (pnTimeToSet != nullptr)  | 
1296  | 0  |         *pnTimeToSet = static_cast<unsigned long>(tTime);  | 
1297  |  | 
  | 
1298  | 0  |     return static_cast<unsigned long>(tTime);  | 
1299  | 0  | }  | 
1300  |  |  | 
1301  |  | /************************************************************************/  | 
1302  |  | /*                              VSICTime()                              */  | 
1303  |  | /************************************************************************/  | 
1304  |  |  | 
1305  |  | const char *VSICTime(unsigned long nTime)  | 
1306  |  |  | 
1307  | 2.54k  | { | 
1308  | 2.54k  |     time_t tTime = static_cast<time_t>(nTime);  | 
1309  | 2.54k  | #if HAVE_CTIME_R  | 
1310  |  |     // Cf https://linux.die.net/man/3/ctime_r:  | 
1311  |  |     // "The reentrant version ctime_r() does the same, but stores the string in  | 
1312  |  |     // a user-supplied buffer which should have room for at least 26 bytes"  | 
1313  | 2.54k  |     char buffer[26];  | 
1314  | 2.54k  |     char *ret = ctime_r(&tTime, buffer);  | 
1315  | 2.54k  |     return ret ? CPLSPrintf("%s", ret) : nullptr; | 
1316  |  | #elif defined(_WIN32)  | 
1317  |  |     char buffer[26];  | 
1318  |  |     return ctime_s(buffer, sizeof(buffer), &tTime) == 0  | 
1319  |  |                ? CPLSPrintf("%s", buffer) | 
1320  |  |                : nullptr;  | 
1321  |  | #else  | 
1322  |  |     return reinterpret_cast<const char *>(ctime(&tTime));  | 
1323  |  | #endif  | 
1324  | 2.54k  | }  | 
1325  |  |  | 
1326  |  | /************************************************************************/  | 
1327  |  | /*                             VSIGMTime()                              */  | 
1328  |  | /************************************************************************/  | 
1329  |  |  | 
1330  |  | struct tm *VSIGMTime(const time_t *pnTime, struct tm *poBrokenTime)  | 
1331  | 0  | { | 
1332  |  | 
  | 
1333  | 0  | #if HAVE_GMTIME_R  | 
1334  | 0  |     gmtime_r(pnTime, poBrokenTime);  | 
1335  | 0  |     return poBrokenTime;  | 
1336  |  | #elif defined(_WIN32)  | 
1337  |  |     return gmtime_s(poBrokenTime, pnTime) == 0 ? poBrokenTime : nullptr;  | 
1338  |  | #else  | 
1339  |  |     struct tm *poTime = gmtime(pnTime);  | 
1340  |  |     memcpy(poBrokenTime, poTime, sizeof(tm));  | 
1341  |  |     return poBrokenTime;  | 
1342  |  | #endif  | 
1343  | 0  | }  | 
1344  |  |  | 
1345  |  | /************************************************************************/  | 
1346  |  | /*                             VSILocalTime()                           */  | 
1347  |  | /************************************************************************/  | 
1348  |  |  | 
1349  |  | struct tm *VSILocalTime(const time_t *pnTime, struct tm *poBrokenTime)  | 
1350  | 0  | { | 
1351  |  | 
  | 
1352  | 0  | #if HAVE_LOCALTIME_R  | 
1353  | 0  |     localtime_r(pnTime, poBrokenTime);  | 
1354  | 0  |     return poBrokenTime;  | 
1355  |  | #elif defined(_WIN32)  | 
1356  |  |     return localtime_s(poBrokenTime, pnTime) == 0 ? poBrokenTime : nullptr;  | 
1357  |  | #else  | 
1358  |  |     struct tm *poTime = localtime(pnTime);  | 
1359  |  |     memcpy(poBrokenTime, poTime, sizeof(tm));  | 
1360  |  |     return poBrokenTime;  | 
1361  |  | #endif  | 
1362  | 0  | }  | 
1363  |  |  | 
1364  |  | /************************************************************************/  | 
1365  |  | /*                            VSIStrerror()                             */  | 
1366  |  | /************************************************************************/  | 
1367  |  |  | 
1368  |  | /** Return the error string corresponding to the error number. Do not free it */  | 
1369  |  | char *VSIStrerror(int nErrno)  | 
1370  |  |  | 
1371  | 0  | { | 
1372  | 0  |     return strerror(nErrno);  | 
1373  | 0  | }  | 
1374  |  |  | 
1375  |  | /************************************************************************/  | 
1376  |  | /*                        CPLGetPhysicalRAM()                           */  | 
1377  |  | /************************************************************************/  | 
1378  |  |  | 
1379  |  | #if HAVE_SC_PHYS_PAGES  | 
1380  |  |  | 
1381  |  | /** Return the total physical RAM in bytes.  | 
1382  |  |  *  | 
1383  |  |  * In the context of a container using cgroups (typically Docker), this  | 
1384  |  |  * will take into account that limitation (starting with GDAL 2.4.0 and  | 
1385  |  |  * with extra fixes in GDAL 3.6.3)  | 
1386  |  |  *  | 
1387  |  |  * You should generally use CPLGetUsablePhysicalRAM() instead.  | 
1388  |  |  *  | 
1389  |  |  * @return the total physical RAM in bytes (or 0 in case of failure).  | 
1390  |  |  * @since GDAL 2.0  | 
1391  |  |  */  | 
1392  |  | GIntBig CPLGetPhysicalRAM(void)  | 
1393  | 0  | { | 
1394  | 0  |     static const GIntBig nPhysicalRAM = []() -> GIntBig  | 
1395  | 0  |     { | 
1396  | 0  |         const long nPhysPages = sysconf(_SC_PHYS_PAGES);  | 
1397  | 0  |         const long nPageSize = sysconf(_SC_PAGESIZE);  | 
1398  | 0  |         if (nPhysPages <= 0 || nPageSize <= 0 ||  | 
1399  | 0  |             nPhysPages > std::numeric_limits<GIntBig>::max() / nPageSize)  | 
1400  | 0  |         { | 
1401  | 0  |             return 0;  | 
1402  | 0  |         }  | 
1403  |  |  | 
1404  | 0  |         GIntBig nVal = static_cast<GIntBig>(nPhysPages) * nPageSize;  | 
1405  |  | 
  | 
1406  | 0  | #ifdef __linux  | 
1407  | 0  |         { | 
1408  |  |             // Take into account MemTotal in /proc/meminfo  | 
1409  |  |             // which seems to be necessary for some container solutions  | 
1410  |  |             // Cf https://lists.osgeo.org/pipermail/gdal-dev/2023-January/056784.html  | 
1411  | 0  |             FILE *f = fopen("/proc/meminfo", "rb"); | 
1412  | 0  |             if (f)  | 
1413  | 0  |             { | 
1414  | 0  |                 char szLine[256];  | 
1415  | 0  |                 while (fgets(szLine, sizeof(szLine), f))  | 
1416  | 0  |                 { | 
1417  |  |                     // Find line like "MemTotal:       32525176 kB"  | 
1418  | 0  |                     if (strncmp(szLine, "MemTotal:", strlen("MemTotal:")) == 0) | 
1419  | 0  |                     { | 
1420  | 0  |                         char *pszVal = szLine + strlen("MemTotal:"); | 
1421  | 0  |                         pszVal += strspn(pszVal, " ");  | 
1422  | 0  |                         char *pszEnd = strstr(pszVal, " kB");  | 
1423  | 0  |                         if (pszEnd)  | 
1424  | 0  |                         { | 
1425  | 0  |                             *pszEnd = 0;  | 
1426  | 0  |                             if (CPLGetValueType(pszVal) == CPL_VALUE_INTEGER)  | 
1427  | 0  |                             { | 
1428  | 0  |                                 const GUIntBig nLimit =  | 
1429  | 0  |                                     CPLScanUIntBig(  | 
1430  | 0  |                                         pszVal,  | 
1431  | 0  |                                         static_cast<int>(strlen(pszVal))) *  | 
1432  | 0  |                                     1024;  | 
1433  | 0  |                                 nVal = static_cast<GIntBig>(std::min(  | 
1434  | 0  |                                     static_cast<GUIntBig>(nVal), nLimit));  | 
1435  | 0  |                             }  | 
1436  | 0  |                         }  | 
1437  | 0  |                         break;  | 
1438  | 0  |                     }  | 
1439  | 0  |                 }  | 
1440  | 0  |                 fclose(f);  | 
1441  | 0  |             }  | 
1442  | 0  |         }  | 
1443  |  | 
  | 
1444  | 0  |         char szGroupName[256];  | 
1445  | 0  |         bool bFromMemory = false;  | 
1446  | 0  |         szGroupName[0] = 0;  | 
1447  | 0  |         { | 
1448  | 0  |             FILE *f = fopen("/proc/self/cgroup", "rb"); | 
1449  | 0  |             if (f)  | 
1450  | 0  |             { | 
1451  | 0  |                 char szLine[256];  | 
1452  |  |                 // Find line like "6:memory:/user.slice/user-1000.slice/user@1000.service"  | 
1453  |  |                 // and store "/user.slice/user-1000.slice/user@1000.service" in  | 
1454  |  |                 // szMemoryPath for cgroup V1 or single line "0::/...." for cgroup V2.  | 
1455  | 0  |                 while (fgets(szLine, sizeof(szLine), f))  | 
1456  | 0  |                 { | 
1457  | 0  |                     const char *pszMemory = strstr(szLine, ":memory:");  | 
1458  | 0  |                     if (pszMemory)  | 
1459  | 0  |                     { | 
1460  | 0  |                         bFromMemory = true;  | 
1461  | 0  |                         snprintf(szGroupName, sizeof(szGroupName), "%s",  | 
1462  | 0  |                                  pszMemory + strlen(":memory:")); | 
1463  | 0  |                         char *pszEOL = strchr(szGroupName, '\n');  | 
1464  | 0  |                         if (pszEOL)  | 
1465  | 0  |                             *pszEOL = '\0';  | 
1466  | 0  |                         break;  | 
1467  | 0  |                     }  | 
1468  | 0  |                     if (strncmp(szLine, "0::", strlen("0::")) == 0) | 
1469  | 0  |                     { | 
1470  | 0  |                         snprintf(szGroupName, sizeof(szGroupName), "%s",  | 
1471  | 0  |                                  szLine + strlen("0::")); | 
1472  | 0  |                         char *pszEOL = strchr(szGroupName, '\n');  | 
1473  | 0  |                         if (pszEOL)  | 
1474  | 0  |                             *pszEOL = '\0';  | 
1475  | 0  |                         break;  | 
1476  | 0  |                     }  | 
1477  | 0  |                 }  | 
1478  | 0  |                 fclose(f);  | 
1479  | 0  |             }  | 
1480  | 0  |         }  | 
1481  | 0  |         if (szGroupName[0])  | 
1482  | 0  |         { | 
1483  | 0  |             char szFilename[256 + 64];  | 
1484  | 0  |             if (bFromMemory)  | 
1485  | 0  |             { | 
1486  |  |                 // cgroup V1  | 
1487  |  |                 // Read memory.limit_in_byte in the whole szGroupName hierarchy  | 
1488  |  |                 // Make sure to end up by reading  | 
1489  |  |                 // /sys/fs/cgroup/memory/memory.limit_in_bytes itself, for  | 
1490  |  |                 // scenarios like https://github.com/OSGeo/gdal/issues/8968  | 
1491  | 0  |                 while (true)  | 
1492  | 0  |                 { | 
1493  | 0  |                     snprintf(szFilename, sizeof(szFilename),  | 
1494  | 0  |                              "/sys/fs/cgroup/memory/%s/memory.limit_in_bytes",  | 
1495  | 0  |                              szGroupName);  | 
1496  | 0  |                     FILE *f = fopen(szFilename, "rb");  | 
1497  | 0  |                     if (f)  | 
1498  | 0  |                     { | 
1499  |  |                         // If no limitation, on 64 bit, 9223372036854771712 is returned.  | 
1500  | 0  |                         char szBuffer[32];  | 
1501  | 0  |                         const int nRead = static_cast<int>(  | 
1502  | 0  |                             fread(szBuffer, 1, sizeof(szBuffer) - 1, f));  | 
1503  | 0  |                         szBuffer[nRead] = 0;  | 
1504  | 0  |                         fclose(f);  | 
1505  | 0  |                         const GUIntBig nLimit = CPLScanUIntBig(szBuffer, nRead);  | 
1506  | 0  |                         nVal = static_cast<GIntBig>(  | 
1507  | 0  |                             std::min(static_cast<GUIntBig>(nVal), nLimit));  | 
1508  | 0  |                     }  | 
1509  | 0  |                     char *pszLastSlash = strrchr(szGroupName, '/');  | 
1510  | 0  |                     if (!pszLastSlash)  | 
1511  | 0  |                         break;  | 
1512  | 0  |                     *pszLastSlash = '\0';  | 
1513  | 0  |                 }  | 
1514  | 0  |             }  | 
1515  | 0  |             else  | 
1516  | 0  |             { | 
1517  |  |                 // cgroup V2  | 
1518  |  |                 // Read memory.max in the whole szGroupName hierarchy  | 
1519  | 0  |                 while (true)  | 
1520  | 0  |                 { | 
1521  | 0  |                     snprintf(szFilename, sizeof(szFilename),  | 
1522  | 0  |                              "/sys/fs/cgroup/%s/memory.max", szGroupName);  | 
1523  | 0  |                     FILE *f = fopen(szFilename, "rb");  | 
1524  | 0  |                     if (f)  | 
1525  | 0  |                     { | 
1526  |  |                         // If no limitation, "max" is returned.  | 
1527  | 0  |                         char szBuffer[32];  | 
1528  | 0  |                         int nRead = static_cast<int>(  | 
1529  | 0  |                             fread(szBuffer, 1, sizeof(szBuffer) - 1, f));  | 
1530  | 0  |                         szBuffer[nRead] = 0;  | 
1531  | 0  |                         if (nRead > 0 && szBuffer[nRead - 1] == '\n')  | 
1532  | 0  |                         { | 
1533  | 0  |                             nRead--;  | 
1534  | 0  |                             szBuffer[nRead] = 0;  | 
1535  | 0  |                         }  | 
1536  | 0  |                         fclose(f);  | 
1537  | 0  |                         if (CPLGetValueType(szBuffer) == CPL_VALUE_INTEGER)  | 
1538  | 0  |                         { | 
1539  | 0  |                             const GUIntBig nLimit =  | 
1540  | 0  |                                 CPLScanUIntBig(szBuffer, nRead);  | 
1541  | 0  |                             nVal = static_cast<GIntBig>(  | 
1542  | 0  |                                 std::min(static_cast<GUIntBig>(nVal), nLimit));  | 
1543  | 0  |                         }  | 
1544  | 0  |                     }  | 
1545  | 0  |                     char *pszLastSlash = strrchr(szGroupName, '/');  | 
1546  | 0  |                     if (!pszLastSlash || pszLastSlash == szGroupName)  | 
1547  | 0  |                         break;  | 
1548  | 0  |                     *pszLastSlash = '\0';  | 
1549  | 0  |                 }  | 
1550  | 0  |             }  | 
1551  | 0  |         }  | 
1552  | 0  | #endif  | 
1553  |  | 
  | 
1554  | 0  |         return nVal;  | 
1555  | 0  |     }();  | 
1556  |  | 
  | 
1557  | 0  |     return nPhysicalRAM;  | 
1558  | 0  | }  | 
1559  |  |  | 
1560  |  | #elif defined(__MACH__) && defined(__APPLE__)  | 
1561  |  |  | 
1562  |  | #include <sys/types.h>  | 
1563  |  | #include <sys/sysctl.h>  | 
1564  |  |  | 
1565  |  | GIntBig CPLGetPhysicalRAM(void)  | 
1566  |  | { | 
1567  |  |     GIntBig nPhysMem = 0;  | 
1568  |  |  | 
1569  |  |     int mib[2] = {CTL_HW, HW_MEMSIZE}; | 
1570  |  |     size_t nLengthRes = sizeof(nPhysMem);  | 
1571  |  |     sysctl(mib, CPL_ARRAYSIZE(mib), &nPhysMem, &nLengthRes, nullptr, 0);  | 
1572  |  |  | 
1573  |  |     return nPhysMem;  | 
1574  |  | }  | 
1575  |  |  | 
1576  |  | #elif defined(_WIN32)  | 
1577  |  |  | 
1578  |  | // GlobalMemoryStatusEx requires _WIN32_WINNT >= 0x0500.  | 
1579  |  | #ifndef _WIN32_WINNT  | 
1580  |  | #define _WIN32_WINNT 0x0500  | 
1581  |  | #endif  | 
1582  |  | #include <windows.h>  | 
1583  |  |  | 
1584  |  | GIntBig CPLGetPhysicalRAM(void)  | 
1585  |  | { | 
1586  |  |     MEMORYSTATUSEX statex;  | 
1587  |  |     statex.ullTotalPhys = 0;  | 
1588  |  |     statex.dwLength = sizeof(statex);  | 
1589  |  |     GlobalMemoryStatusEx(&statex);  | 
1590  |  |     return static_cast<GIntBig>(statex.ullTotalPhys);  | 
1591  |  | }  | 
1592  |  |  | 
1593  |  | #else  | 
1594  |  |  | 
1595  |  | GIntBig CPLGetPhysicalRAM(void)  | 
1596  |  | { | 
1597  |  |     static bool bOnce = false;  | 
1598  |  |     if (!bOnce)  | 
1599  |  |     { | 
1600  |  |         bOnce = true;  | 
1601  |  |         CPLDebug("PORT", "No implementation for CPLGetPhysicalRAM()"); | 
1602  |  |     }  | 
1603  |  |     return 0;  | 
1604  |  | }  | 
1605  |  | #endif  | 
1606  |  |  | 
1607  |  | /************************************************************************/  | 
1608  |  | /*                       CPLGetUsablePhysicalRAM()                      */  | 
1609  |  | /************************************************************************/  | 
1610  |  |  | 
1611  |  | /** Return the total physical RAM, usable by a process, in bytes.  | 
1612  |  |  *  | 
1613  |  |  * This is the same as CPLGetPhysicalRAM() except it will limit to 2 GB  | 
1614  |  |  * for 32 bit processes.  | 
1615  |  |  *  | 
1616  |  |  * Starting with GDAL 2.4.0, it will also take account resource limits (virtual  | 
1617  |  |  * memory) on Posix systems. Starting with GDAL 3.6.1, it will also take into  | 
1618  |  |  * account RLIMIT_RSS on Linux.  | 
1619  |  |  *  | 
1620  |  |  * Note: This memory may already be partly used by other processes.  | 
1621  |  |  *  | 
1622  |  |  * @return the total physical RAM, usable by a process, in bytes (or 0  | 
1623  |  |  * in case of failure).  | 
1624  |  |  * @since GDAL 2.0  | 
1625  |  |  */  | 
1626  |  | GIntBig CPLGetUsablePhysicalRAM(void)  | 
1627  | 0  | { | 
1628  | 0  |     GIntBig nRAM = CPLGetPhysicalRAM();  | 
1629  |  | #if SIZEOF_VOIDP == 4  | 
1630  |  |     if (nRAM > INT_MAX)  | 
1631  |  |         nRAM = INT_MAX;  | 
1632  |  | #endif  | 
1633  | 0  | #if HAVE_GETRLIMIT  | 
1634  | 0  |     struct rlimit sLimit;  | 
1635  | 0  | #if HAVE_RLIMIT_AS  | 
1636  | 0  |     const int res = RLIMIT_AS;  | 
1637  |  | #else  | 
1638  |  |     // OpenBSD currently doesn't support RLIMIT_AS (mandated by Posix though)  | 
1639  |  |     const int res = RLIMIT_DATA;  | 
1640  |  | #endif  | 
1641  | 0  |     if (getrlimit(res, &sLimit) == 0 && sLimit.rlim_cur != RLIM_INFINITY &&  | 
1642  | 0  |         static_cast<GIntBig>(sLimit.rlim_cur) < nRAM)  | 
1643  | 0  |     { | 
1644  | 0  |         nRAM = static_cast<GIntBig>(sLimit.rlim_cur);  | 
1645  | 0  |     }  | 
1646  | 0  | #ifdef RLIMIT_RSS  | 
1647  |  |     // Helps with RSS limit set by the srun utility. Cf  | 
1648  |  |     // https://github.com/OSGeo/gdal/issues/6669  | 
1649  | 0  |     if (getrlimit(RLIMIT_RSS, &sLimit) == 0 &&  | 
1650  | 0  |         sLimit.rlim_cur != RLIM_INFINITY &&  | 
1651  | 0  |         static_cast<GIntBig>(sLimit.rlim_cur) < nRAM)  | 
1652  | 0  |     { | 
1653  | 0  |         nRAM = static_cast<GIntBig>(sLimit.rlim_cur);  | 
1654  | 0  |     }  | 
1655  | 0  | #endif  | 
1656  | 0  | #endif  | 
1657  | 0  |     return nRAM;  | 
1658  | 0  | }  |