jmemsys.h 7.6 KB

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