libs/jpeg6/jmemsys.h

   1 /*
   2
   3  * jmemsys.h
   4
   5  *
   6
   7  * Copyright (C) 1992-1994, Thomas G. Lane.
   8
   9  * This file is part of the Independent JPEG Group's software.
  10
  11  * For conditions of distribution and use, see the accompanying README file.
  12
  13  *
  14
  15  * This include file defines the interface between the system-independent
  16
  17  * and system-dependent portions of the JPEG memory manager.  No other
  18
  19  * modules need include it.  (The system-independent portion is jmemmgr.c;
  20
  21  * there are several different versions of the system-dependent portion.)
  22
  23  *
  24
  25  * This file works as-is for the system-dependent memory managers supplied
  26
  27  * in the IJG distribution.  You may need to modify it if you write a
  28
  29  * custom memory manager.  If system-dependent changes are needed in
  30
  31  * this file, the best method is to #ifdef them based on a configuration
  32
  33  * symbol supplied in jconfig.h, as we have done with USE_MSDOS_MEMMGR.
  34
  35  */
  36
  37
  38
  39
  40
  41 /* Short forms of external names for systems with brain-damaged linkers. */
  42
  43
  44
  45 #ifdef NEED_SHORT_EXTERNAL_NAMES
  46
  47 #define jpeg_get_small          jGetSmall
  48
  49 #define jpeg_free_small         jFreeSmall
  50
  51 #define jpeg_get_large          jGetLarge
  52
  53 #define jpeg_free_large         jFreeLarge
  54
  55 #define jpeg_mem_available      jMemAvail
  56
  57 #define jpeg_open_backing_store jOpenBackStore
  58
  59 #define jpeg_mem_init           jMemInit
  60
  61 #define jpeg_mem_term           jMemTerm
  62
  63 #endif /* NEED_SHORT_EXTERNAL_NAMES */
  64
  65
  66
  67
  68
  69 /*
  70
  71  * These two functions are used to allocate and release small chunks of
  72
  73  * memory.  (Typically the total amount requested through jpeg_get_small is
  74
  75  * no more than 20K or so; this will be requested in chunks of a few K each.)
  76
  77  * Behavior should be the same as for the standard library functions malloc
  78
  79  * and free; in particular, jpeg_get_small must return NULL on failure.
  80
  81  * On most systems, these ARE malloc and free.  jpeg_free_small is passed the
  82
  83  * size of the object being freed, just in case it's needed.
  84
  85  * On an 80x86 machine using small-data memory model, these manage near heap.
  86
  87  */
  88
  89
  90
  91 EXTERN void * jpeg_get_small JPP((j_common_ptr cinfo, size_t sizeofobject));
  92
  93 EXTERN void jpeg_free_small JPP((j_common_ptr cinfo, void * object,
  94
  95                                  size_t sizeofobject));
  96
  97
  98
  99 /*
 100
 101  * These two functions are used to allocate and release large chunks of
 102
 103  * memory (up to the total free space designated by jpeg_mem_available).
 104
 105  * The interface is the same as above, except that on an 80x86 machine,
 106
 107  * far pointers are used.  On most other machines these are identical to
 108
 109  * the jpeg_get/free_small routines; but we keep them separate anyway,
 110
 111  * in case a different allocation strategy is desirable for large chunks.
 112
 113  */
 114
 115
 116
 117 EXTERN void FAR * jpeg_get_large JPP((j_common_ptr cinfo,size_t sizeofobject));
 118
 119 EXTERN void jpeg_free_large JPP((j_common_ptr cinfo, void FAR * object,
 120
 121                                  size_t sizeofobject));
 122
 123
 124
 125 /*
 126
 127  * The macro MAX_ALLOC_CHUNK designates the maximum number of bytes that may
 128
 129  * be requested in a single call to jpeg_get_large (and jpeg_get_small for that
 130
 131  * matter, but that case should never come into play).  This macro is needed
 132
 133  * to model the 64Kb-segment-size limit of far addressing on 80x86 machines.
 134
 135  * On those machines, we expect that jconfig.h will provide a proper value.
 136
 137  * On machines with 32-bit flat address spaces, any large constant may be used.
 138
 139  *
 140
 141  * NB: jmemmgr.c expects that MAX_ALLOC_CHUNK will be representable as type
 142
 143  * size_t and will be a multiple of sizeof(align_type).
 144
 145  */
 146
 147
 148
 149 #ifndef MAX_ALLOC_CHUNK         /* may be overridden in jconfig.h */
 150
 151 #define MAX_ALLOC_CHUNK  1000000000L
 152
 153 #endif
 154
 155
 156
 157 /*
 158
 159  * This routine computes the total space still available for allocation by
 160
 161  * jpeg_get_large.  If more space than this is needed, backing store will be
 162
 163  * used.  NOTE: any memory already allocated must not be counted.
 164
 165  *
 166
 167  * There is a minimum space requirement, corresponding to the minimum
 168
 169  * feasible buffer sizes; jmemmgr.c will request that much space even if
 170
 171  * jpeg_mem_available returns zero.  The maximum space needed, enough to hold
 172
 173  * all working storage in memory, is also passed in case it is useful.
 174
 175  * Finally, the total space already allocated is passed.  If no better
 176
 177  * method is available, cinfo->mem->max_memory_to_use - already_allocated
 178
 179  * is often a suitable calculation.
 180
 181  *
 182
 183  * It is OK for jpeg_mem_available to underestimate the space available
 184
 185  * (that'll just lead to more backing-store access than is really necessary).
 186
 187  * However, an overestimate will lead to failure.  Hence it's wise to subtract
 188
 189  * a slop factor from the true available space.  5% should be enough.
 190
 191  *
 192
 193  * On machines with lots of virtual memory, any large constant may be returned.
 194
 195  * Conversely, zero may be returned to always use the minimum amount of memory.
 196
 197  */
 198
 199
 200
 201 EXTERN long jpeg_mem_available JPP((j_common_ptr cinfo,
 202
 203                                     long min_bytes_needed,
 204
 205                                     long max_bytes_needed,
 206
 207                                     long already_allocated));
 208
 209
 210
 211
 212
 213 /*
 214
 215  * This structure holds whatever state is needed to access a single
 216
 217  * backing-store object.  The read/write/close method pointers are called
 218
 219  * by jmemmgr.c to manipulate the backing-store object; all other fields
 220
 221  * are private to the system-dependent backing store routines.
 222
 223  */
 224
 225
 226
 227 #define TEMP_NAME_LENGTH   64   /* max length of a temporary file's name */
 228
 229
 230
 231 #ifdef USE_MSDOS_MEMMGR         /* DOS-specific junk */
 232
 233
 234
 235 typedef unsigned short XMSH;    /* type of extended-memory handles */
 236
 237 typedef unsigned short EMSH;    /* type of expanded-memory handles */
 238
 239
 240
 241 typedef union {
 242
 243   short file_handle;            /* DOS file handle if it's a temp file */
 244
 245   XMSH xms_handle;              /* handle if it's a chunk of XMS */
 246
 247   EMSH ems_handle;              /* handle if it's a chunk of EMS */
 248
 249 } handle_union;
 250
 251
 252
 253 #endif /* USE_MSDOS_MEMMGR */
 254
 255
 256
 257 typedef struct backing_store_struct * backing_store_ptr;
 258
 259
 260
 261 typedef struct backing_store_struct {
 262
 263   /* Methods for reading/writing/closing this backing-store object */
 264
 265   JMETHOD(void, read_backing_store, (j_common_ptr cinfo,
 266
 267                                      backing_store_ptr info,
 268
 269                                      void FAR * buffer_address,
 270
 271                                      long file_offset, long byte_count));
 272
 273   JMETHOD(void, write_backing_store, (j_common_ptr cinfo,
 274
 275                                       backing_store_ptr info,
 276
 277                                       void FAR * buffer_address,
 278
 279                                       long file_offset, long byte_count));
 280
 281   JMETHOD(void, close_backing_store, (j_common_ptr cinfo,
 282
 283                                       backing_store_ptr info));
 284
 285
 286
 287   /* Private fields for system-dependent backing-store management */
 288
 289 #ifdef USE_MSDOS_MEMMGR
 290
 291   /* For the MS-DOS manager (jmemdos.c), we need: */
 292
 293   handle_union handle;          /* reference to backing-store storage object */
 294
 295   char temp_name[TEMP_NAME_LENGTH]; /* name if it's a file */
 296
 297 #else
 298
 299   /* For a typical implementation with temp files, we need: */
 300
 301   FILE * temp_file;             /* stdio reference to temp file */
 302
 303   char temp_name[TEMP_NAME_LENGTH]; /* name of temp file */
 304
 305 #endif
 306
 307 } backing_store_info;
 308
 309
 310
 311 /*
 312
 313  * Initial opening of a backing-store object.  This must fill in the
 314
 315  * read/write/close pointers in the object.  The read/write routines
 316
 317  * may take an error exit if the specified maximum file size is exceeded.
 318
 319  * (If jpeg_mem_available always returns a large value, this routine can
 320
 321  * just take an error exit.)
 322
 323  */
 324
 325
 326
 327 EXTERN void jpeg_open_backing_store JPP((j_common_ptr cinfo,
 328
 329                                          backing_store_ptr info,
 330
 331                                          long total_bytes_needed));
 332
 333
 334
 335
 336
 337 /*
 338
 339  * These routines take care of any system-dependent initialization and
 340
 341  * cleanup required.  jpeg_mem_init will be called before anything is
 342
 343  * allocated (and, therefore, nothing in cinfo is of use except the error
 344
 345  * manager pointer).  It should return a suitable default value for
 346
 347  * max_memory_to_use; this may subsequently be overridden by the surrounding
 348
 349  * application.  (Note that max_memory_to_use is only important if
 350
 351  * jpeg_mem_available chooses to consult it ... no one else will.)
 352
 353  * jpeg_mem_term may assume that all requested memory has been freed and that
 354
 355  * all opened backing-store objects have been closed.
 356
 357  */
 358
 359
 360
 361 EXTERN long jpeg_mem_init JPP((j_common_ptr cinfo));
 362
 363 EXTERN void jpeg_mem_term JPP((j_common_ptr cinfo));
 364