baa7b7f993d6602c76097f3417fc24a3cbd9e161
[pdfium.git] / core / src / fxcodec / libjpeg / jmemsys.h
1 /*\r
2  * jmemsys.h\r
3  *\r
4  * Copyright (C) 1992-1997, Thomas G. Lane.\r
5  * This file is part of the Independent JPEG Group's software.\r
6  * For conditions of distribution and use, see the accompanying README file.\r
7  *\r
8  * This include file defines the interface between the system-independent\r
9  * and system-dependent portions of the JPEG memory manager.  No other\r
10  * modules need include it.  (The system-independent portion is jmemmgr.c;\r
11  * there are several different versions of the system-dependent portion.)\r
12  *\r
13  * This file works as-is for the system-dependent memory managers supplied\r
14  * in the IJG distribution.  You may need to modify it if you write a\r
15  * custom memory manager.  If system-dependent changes are needed in\r
16  * this file, the best method is to #ifdef them based on a configuration\r
17  * symbol supplied in jconfig.h, as we have done with USE_MSDOS_MEMMGR\r
18  * and USE_MAC_MEMMGR.\r
19  */\r
20 \r
21 \r
22 /* Short forms of external names for systems with brain-damaged linkers. */\r
23 \r
24 #ifdef NEED_SHORT_EXTERNAL_NAMES\r
25 #define jpeg_get_small          jGetSmall\r
26 #define jpeg_free_small         jFreeSmall\r
27 #define jpeg_get_large          jGetLarge\r
28 #define jpeg_free_large         jFreeLarge\r
29 #define jpeg_mem_available      jMemAvail\r
30 #define jpeg_open_backing_store jOpenBackStore\r
31 #define jpeg_mem_init           jMemInit\r
32 #define jpeg_mem_term           jMemTerm\r
33 #endif /* NEED_SHORT_EXTERNAL_NAMES */\r
34 \r
35 \r
36 /*\r
37  * These two functions are used to allocate and release small chunks of\r
38  * memory.  (Typically the total amount requested through jpeg_get_small is\r
39  * no more than 20K or so; this will be requested in chunks of a few K each.)\r
40  * Behavior should be the same as for the standard library functions malloc\r
41  * and free; in particular, jpeg_get_small must return NULL on failure.\r
42  * On most systems, these ARE malloc and free.  jpeg_free_small is passed the\r
43  * size of the object being freed, just in case it's needed.\r
44  * On an 80x86 machine using small-data memory model, these manage near heap.\r
45  */\r
46 \r
47 EXTERN(void *) jpeg_get_small JPP((j_common_ptr cinfo, size_t sizeofobject));\r
48 EXTERN(void) jpeg_free_small JPP((j_common_ptr cinfo, void * object,\r
49                                   size_t sizeofobject));\r
50 \r
51 /*\r
52  * These two functions are used to allocate and release large chunks of\r
53  * memory (up to the total free space designated by jpeg_mem_available).\r
54  * The interface is the same as above, except that on an 80x86 machine,\r
55  * far pointers are used.  On most other machines these are identical to\r
56  * the jpeg_get/free_small routines; but we keep them separate anyway,\r
57  * in case a different allocation strategy is desirable for large chunks.\r
58  */\r
59 \r
60 EXTERN(void FAR *) jpeg_get_large JPP((j_common_ptr cinfo,\r
61                                        size_t sizeofobject));\r
62 EXTERN(void) jpeg_free_large JPP((j_common_ptr cinfo, void FAR * object,\r
63                                   size_t sizeofobject));\r
64 \r
65 /*\r
66  * The macro MAX_ALLOC_CHUNK designates the maximum number of bytes that may\r
67  * be requested in a single call to jpeg_get_large (and jpeg_get_small for that\r
68  * matter, but that case should never come into play).  This macro is needed\r
69  * to model the 64Kb-segment-size limit of far addressing on 80x86 machines.\r
70  * On those machines, we expect that jconfig.h will provide a proper value.\r
71  * On machines with 32-bit flat address spaces, any large constant may be used.\r
72  *\r
73  * NB: jmemmgr.c expects that MAX_ALLOC_CHUNK will be representable as type\r
74  * size_t and will be a multiple of sizeof(align_type).\r
75  */\r
76 \r
77 #ifndef MAX_ALLOC_CHUNK         /* may be overridden in jconfig.h */\r
78 #define MAX_ALLOC_CHUNK  1000000000L\r
79 #endif\r
80 \r
81 /*\r
82  * This routine computes the total space still available for allocation by\r
83  * jpeg_get_large.  If more space than this is needed, backing store will be\r
84  * used.  NOTE: any memory already allocated must not be counted.\r
85  *\r
86  * There is a minimum space requirement, corresponding to the minimum\r
87  * feasible buffer sizes; jmemmgr.c will request that much space even if\r
88  * jpeg_mem_available returns zero.  The maximum space needed, enough to hold\r
89  * all working storage in memory, is also passed in case it is useful.\r
90  * Finally, the total space already allocated is passed.  If no better\r
91  * method is available, cinfo->mem->max_memory_to_use - already_allocated\r
92  * is often a suitable calculation.\r
93  *\r
94  * It is OK for jpeg_mem_available to underestimate the space available\r
95  * (that'll just lead to more backing-store access than is really necessary).\r
96  * However, an overestimate will lead to failure.  Hence it's wise to subtract\r
97  * a slop factor from the true available space.  5% should be enough.\r
98  *\r
99  * On machines with lots of virtual memory, any large constant may be returned.\r
100  * Conversely, zero may be returned to always use the minimum amount of memory.\r
101  */\r
102 \r
103 EXTERN(long) jpeg_mem_available JPP((j_common_ptr cinfo,\r
104                                      long min_bytes_needed,\r
105                                      long max_bytes_needed,\r
106                                      long already_allocated));\r
107 \r
108 \r
109 /*\r
110  * This structure holds whatever state is needed to access a single\r
111  * backing-store object.  The read/write/close method pointers are called\r
112  * by jmemmgr.c to manipulate the backing-store object; all other fields\r
113  * are private to the system-dependent backing store routines.\r
114  */\r
115 \r
116 #define TEMP_NAME_LENGTH   64   /* max length of a temporary file's name */\r
117 \r
118 \r
119 #ifdef USE_MSDOS_MEMMGR         /* DOS-specific junk */\r
120 \r
121 typedef unsigned short XMSH;    /* type of extended-memory handles */\r
122 typedef unsigned short EMSH;    /* type of expanded-memory handles */\r
123 \r
124 typedef union {\r
125   short file_handle;            /* DOS file handle if it's a temp file */\r
126   XMSH xms_handle;              /* handle if it's a chunk of XMS */\r
127   EMSH ems_handle;              /* handle if it's a chunk of EMS */\r
128 } handle_union;\r
129 \r
130 #endif /* USE_MSDOS_MEMMGR */\r
131 \r
132 #ifdef USE_MAC_MEMMGR           /* Mac-specific junk */\r
133 #include <Files.h>\r
134 #endif /* USE_MAC_MEMMGR */\r
135 \r
136 \r
137 typedef struct backing_store_struct * backing_store_ptr;\r
138 \r
139 typedef struct backing_store_struct {\r
140   /* Methods for reading/writing/closing this backing-store object */\r
141   JMETHOD(void, read_backing_store, (j_common_ptr cinfo,\r
142                                      backing_store_ptr info,\r
143                                      void FAR * buffer_address,\r
144                                      long file_offset, long byte_count));\r
145   JMETHOD(void, write_backing_store, (j_common_ptr cinfo,\r
146                                       backing_store_ptr info,\r
147                                       void FAR * buffer_address,\r
148                                       long file_offset, long byte_count));\r
149   JMETHOD(void, close_backing_store, (j_common_ptr cinfo,\r
150                                       backing_store_ptr info));\r
151 \r
152   /* Private fields for system-dependent backing-store management */\r
153 #ifdef USE_MSDOS_MEMMGR\r
154   /* For the MS-DOS manager (jmemdos.c), we need: */\r
155   handle_union handle;          /* reference to backing-store storage object */\r
156   char temp_name[TEMP_NAME_LENGTH]; /* name if it's a file */\r
157 #else\r
158 #ifdef USE_MAC_MEMMGR\r
159   /* For the Mac manager (jmemmac.c), we need: */\r
160   short temp_file;              /* file reference number to temp file */\r
161   FSSpec tempSpec;              /* the FSSpec for the temp file */\r
162   char temp_name[TEMP_NAME_LENGTH]; /* name if it's a file */\r
163 #else\r
164   /* For a typical implementation with temp files, we need: */\r
165 #ifndef _FPDFAPI_MINI_\r
166   FXSYS_FILE * temp_file;               /* stdio reference to temp file */\r
167   char temp_name[TEMP_NAME_LENGTH]; /* name of temp file */\r
168 #endif\r
169 #endif\r
170 #endif\r
171 } backing_store_info;\r
172 \r
173 \r
174 /*\r
175  * Initial opening of a backing-store object.  This must fill in the\r
176  * read/write/close pointers in the object.  The read/write routines\r
177  * may take an error exit if the specified maximum file size is exceeded.\r
178  * (If jpeg_mem_available always returns a large value, this routine can\r
179  * just take an error exit.)\r
180  */\r
181 \r
182 EXTERN(void) jpeg_open_backing_store JPP((j_common_ptr cinfo,\r
183                                           backing_store_ptr info,\r
184                                           long total_bytes_needed));\r
185 \r
186 \r
187 /*\r
188  * These routines take care of any system-dependent initialization and\r
189  * cleanup required.  jpeg_mem_init will be called before anything is\r
190  * allocated (and, therefore, nothing in cinfo is of use except the error\r
191  * manager pointer).  It should return a suitable default value for\r
192  * max_memory_to_use; this may subsequently be overridden by the surrounding\r
193  * application.  (Note that max_memory_to_use is only important if\r
194  * jpeg_mem_available chooses to consult it ... no one else will.)\r
195  * jpeg_mem_term may assume that all requested memory has been freed and that\r
196  * all opened backing-store objects have been closed.\r
197  */\r
198 \r
199 EXTERN(long) jpeg_mem_init JPP((j_common_ptr cinfo));\r
200 EXTERN(void) jpeg_mem_term JPP((j_common_ptr cinfo));\r