Merge to XFA: Add safe FX_Alloc2D() macro
[pdfium.git] / core / include / fxcrt / fx_memory.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef _FX_MEMORY_H_
8 #define _FX_MEMORY_H_
9
10 #include "fx_system.h"
11
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 // For external C libraries to malloc through PDFium. These may return NULL.
16 void*   FXMEM_DefaultAlloc(size_t byte_size, int flags);
17 void*   FXMEM_DefaultRealloc(void* pointer, size_t new_size, int flags);
18 void    FXMEM_DefaultFree(void* pointer, int flags);
19 #ifdef __cplusplus
20 }  // extern "C"
21
22 #include <stdlib.h>
23 #include <limits>
24 #include <new>
25
26 #define FX_NEW new
27
28 NEVER_INLINE void FX_OutOfMemoryTerminate();
29
30 inline void* FX_SafeRealloc(void* ptr, size_t num_members, size_t member_size) {
31     if (num_members < std::numeric_limits<size_t>::max() / member_size) {
32         return realloc(ptr, num_members * member_size);
33     }
34     return nullptr;
35 }
36
37 inline void* FX_AllocOrDie(size_t num_members, size_t member_size) {
38     // TODO(tsepez): See if we can avoid the implicit memset(0).
39     if (void* result = calloc(num_members, member_size)) {
40         return result;
41     }
42     FX_OutOfMemoryTerminate();  // Never returns.
43     return nullptr;  // Suppress compiler warning.
44 }
45
46 inline void* FX_AllocOrDie2D(size_t w, size_t h, size_t member_size) {
47     if (w < std::numeric_limits<size_t>::max() / h) {
48         return FX_AllocOrDie(w * h, member_size);
49     }
50     FX_OutOfMemoryTerminate();  // Never returns.
51     return nullptr;  // Suppress compiler warning.
52 }
53
54 inline void* FX_ReallocOrDie(void* ptr, size_t num_members, size_t member_size) {
55     if (void* result = FX_SafeRealloc(ptr, num_members, member_size)) {
56         return result;
57     }
58     FX_OutOfMemoryTerminate();  // Never returns.
59     return nullptr;  // Suppress compiler warning.
60 }
61
62 // Never returns NULL.
63 #define FX_Alloc(type, size) (type*)FX_AllocOrDie(size, sizeof(type))
64 #define FX_Alloc2D(type, w, h) (type*)FX_AllocOrDie2D(w, h, sizeof(type))
65 #define FX_Realloc(type, ptr, size) \
66     (type*)FX_ReallocOrDie(ptr, size, sizeof(type))
67
68 // May return NULL.
69 #define FX_TryAlloc(type, size) (type*)calloc(size, sizeof(type))
70 #define FX_TryRealloc(type, ptr, size) \
71     (type*)FX_SafeRealloc(ptr, size, sizeof(type))
72
73 #define FX_Free(ptr) free(ptr)
74
75 class CFX_DestructObject 
76 {
77 public:
78
79     virtual ~CFX_DestructObject() {}
80 };
81 class CFX_GrowOnlyPool 
82 {
83 public:
84
85     CFX_GrowOnlyPool(size_t trunk_size = 16384);
86
87     ~CFX_GrowOnlyPool();
88
89     void        SetTrunkSize(size_t trunk_size)
90     {
91         m_TrunkSize = trunk_size;
92     }
93
94     void*       AllocDebug(size_t size, FX_LPCSTR file, int line)
95     {
96         return Alloc(size);
97     }
98
99     void*       Alloc(size_t size);
100
101     void*       ReallocDebug(void* p, size_t new_size, FX_LPCSTR file, int line)
102     {
103         return NULL;
104     }
105
106     void*       Realloc(void* p, size_t new_size)
107     {
108         return NULL;
109     }
110
111     void        Free(void*) {}
112
113     void        FreeAll();
114 private:
115
116     size_t      m_TrunkSize;
117
118     void*       m_pFirstTrunk;
119 };
120 #endif  // __cplusplust
121 #endif  // _FX_MEMORY_H_