nuclear@14: /*
nuclear@14:  * jmemsys.h
nuclear@14:  *
nuclear@14:  * Copyright (C) 1992-1997, Thomas G. Lane.
nuclear@14:  * This file is part of the Independent JPEG Group's software.
nuclear@14:  * For conditions of distribution and use, see the accompanying README file.
nuclear@14:  *
nuclear@14:  * This include file defines the interface between the system-independent
nuclear@14:  * and system-dependent portions of the JPEG memory manager.  No other
nuclear@14:  * modules need include it.  (The system-independent portion is jmemmgr.c;
nuclear@14:  * there are several different versions of the system-dependent portion.)
nuclear@14:  *
nuclear@14:  * This file works as-is for the system-dependent memory managers supplied
nuclear@14:  * in the IJG distribution.  You may need to modify it if you write a
nuclear@14:  * custom memory manager.  If system-dependent changes are needed in
nuclear@14:  * this file, the best method is to #ifdef them based on a configuration
nuclear@14:  * symbol supplied in jconfig.h, as we have done with USE_MSDOS_MEMMGR
nuclear@14:  * and USE_MAC_MEMMGR.
nuclear@14:  */
nuclear@14: 
nuclear@14: 
nuclear@14: /* Short forms of external names for systems with brain-damaged linkers. */
nuclear@14: 
nuclear@14: #ifdef NEED_SHORT_EXTERNAL_NAMES
nuclear@14: #define jpeg_get_small		jGetSmall
nuclear@14: #define jpeg_free_small		jFreeSmall
nuclear@14: #define jpeg_get_large		jGetLarge
nuclear@14: #define jpeg_free_large		jFreeLarge
nuclear@14: #define jpeg_mem_available	jMemAvail
nuclear@14: #define jpeg_open_backing_store	jOpenBackStore
nuclear@14: #define jpeg_mem_init		jMemInit
nuclear@14: #define jpeg_mem_term		jMemTerm
nuclear@14: #endif /* NEED_SHORT_EXTERNAL_NAMES */
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * These two functions are used to allocate and release small chunks of
nuclear@14:  * memory.  (Typically the total amount requested through jpeg_get_small is
nuclear@14:  * no more than 20K or so; this will be requested in chunks of a few K each.)
nuclear@14:  * Behavior should be the same as for the standard library functions malloc
nuclear@14:  * and free; in particular, jpeg_get_small must return NULL on failure.
nuclear@14:  * On most systems, these ARE malloc and free.  jpeg_free_small is passed the
nuclear@14:  * size of the object being freed, just in case it's needed.
nuclear@14:  * On an 80x86 machine using small-data memory model, these manage near heap.
nuclear@14:  */
nuclear@14: 
nuclear@14: EXTERN(void *) jpeg_get_small JPP((j_common_ptr cinfo, size_t sizeofobject));
nuclear@14: EXTERN(void) jpeg_free_small JPP((j_common_ptr cinfo, void * object,
nuclear@14: 				  size_t sizeofobject));
nuclear@14: 
nuclear@14: /*
nuclear@14:  * These two functions are used to allocate and release large chunks of
nuclear@14:  * memory (up to the total free space designated by jpeg_mem_available).
nuclear@14:  * The interface is the same as above, except that on an 80x86 machine,
nuclear@14:  * far pointers are used.  On most other machines these are identical to
nuclear@14:  * the jpeg_get/free_small routines; but we keep them separate anyway,
nuclear@14:  * in case a different allocation strategy is desirable for large chunks.
nuclear@14:  */
nuclear@14: 
nuclear@14: EXTERN(void FAR *) jpeg_get_large JPP((j_common_ptr cinfo,
nuclear@14: 				       size_t sizeofobject));
nuclear@14: EXTERN(void) jpeg_free_large JPP((j_common_ptr cinfo, void FAR * object,
nuclear@14: 				  size_t sizeofobject));
nuclear@14: 
nuclear@14: /*
nuclear@14:  * The macro MAX_ALLOC_CHUNK designates the maximum number of bytes that may
nuclear@14:  * be requested in a single call to jpeg_get_large (and jpeg_get_small for that
nuclear@14:  * matter, but that case should never come into play).  This macro is needed
nuclear@14:  * to model the 64Kb-segment-size limit of far addressing on 80x86 machines.
nuclear@14:  * On those machines, we expect that jconfig.h will provide a proper value.
nuclear@14:  * On machines with 32-bit flat address spaces, any large constant may be used.
nuclear@14:  *
nuclear@14:  * NB: jmemmgr.c expects that MAX_ALLOC_CHUNK will be representable as type
nuclear@14:  * size_t and will be a multiple of sizeof(align_type).
nuclear@14:  */
nuclear@14: 
nuclear@14: #ifndef MAX_ALLOC_CHUNK		/* may be overridden in jconfig.h */
nuclear@14: #define MAX_ALLOC_CHUNK  1000000000L
nuclear@14: #endif
nuclear@14: 
nuclear@14: /*
nuclear@14:  * This routine computes the total space still available for allocation by
nuclear@14:  * jpeg_get_large.  If more space than this is needed, backing store will be
nuclear@14:  * used.  NOTE: any memory already allocated must not be counted.
nuclear@14:  *
nuclear@14:  * There is a minimum space requirement, corresponding to the minimum
nuclear@14:  * feasible buffer sizes; jmemmgr.c will request that much space even if
nuclear@14:  * jpeg_mem_available returns zero.  The maximum space needed, enough to hold
nuclear@14:  * all working storage in memory, is also passed in case it is useful.
nuclear@14:  * Finally, the total space already allocated is passed.  If no better
nuclear@14:  * method is available, cinfo->mem->max_memory_to_use - already_allocated
nuclear@14:  * is often a suitable calculation.
nuclear@14:  *
nuclear@14:  * It is OK for jpeg_mem_available to underestimate the space available
nuclear@14:  * (that'll just lead to more backing-store access than is really necessary).
nuclear@14:  * However, an overestimate will lead to failure.  Hence it's wise to subtract
nuclear@14:  * a slop factor from the true available space.  5% should be enough.
nuclear@14:  *
nuclear@14:  * On machines with lots of virtual memory, any large constant may be returned.
nuclear@14:  * Conversely, zero may be returned to always use the minimum amount of memory.
nuclear@14:  */
nuclear@14: 
nuclear@14: EXTERN(long) jpeg_mem_available JPP((j_common_ptr cinfo,
nuclear@14: 				     long min_bytes_needed,
nuclear@14: 				     long max_bytes_needed,
nuclear@14: 				     long already_allocated));
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * This structure holds whatever state is needed to access a single
nuclear@14:  * backing-store object.  The read/write/close method pointers are called
nuclear@14:  * by jmemmgr.c to manipulate the backing-store object; all other fields
nuclear@14:  * are private to the system-dependent backing store routines.
nuclear@14:  */
nuclear@14: 
nuclear@14: #define TEMP_NAME_LENGTH   64	/* max length of a temporary file's name */
nuclear@14: 
nuclear@14: 
nuclear@14: #ifdef USE_MSDOS_MEMMGR		/* DOS-specific junk */
nuclear@14: 
nuclear@14: typedef unsigned short XMSH;	/* type of extended-memory handles */
nuclear@14: typedef unsigned short EMSH;	/* type of expanded-memory handles */
nuclear@14: 
nuclear@14: typedef union {
nuclear@14:   short file_handle;		/* DOS file handle if it's a temp file */
nuclear@14:   XMSH xms_handle;		/* handle if it's a chunk of XMS */
nuclear@14:   EMSH ems_handle;		/* handle if it's a chunk of EMS */
nuclear@14: } handle_union;
nuclear@14: 
nuclear@14: #endif /* USE_MSDOS_MEMMGR */
nuclear@14: 
nuclear@14: #ifdef USE_MAC_MEMMGR		/* Mac-specific junk */
nuclear@14: #include <Files.h>
nuclear@14: #endif /* USE_MAC_MEMMGR */
nuclear@14: 
nuclear@14: 
nuclear@14: typedef struct backing_store_struct * backing_store_ptr;
nuclear@14: 
nuclear@14: typedef struct backing_store_struct {
nuclear@14:   /* Methods for reading/writing/closing this backing-store object */
nuclear@14:   JMETHOD(void, read_backing_store, (j_common_ptr cinfo,
nuclear@14: 				     backing_store_ptr info,
nuclear@14: 				     void FAR * buffer_address,
nuclear@14: 				     long file_offset, long byte_count));
nuclear@14:   JMETHOD(void, write_backing_store, (j_common_ptr cinfo,
nuclear@14: 				      backing_store_ptr info,
nuclear@14: 				      void FAR * buffer_address,
nuclear@14: 				      long file_offset, long byte_count));
nuclear@14:   JMETHOD(void, close_backing_store, (j_common_ptr cinfo,
nuclear@14: 				      backing_store_ptr info));
nuclear@14: 
nuclear@14:   /* Private fields for system-dependent backing-store management */
nuclear@14: #ifdef USE_MSDOS_MEMMGR
nuclear@14:   /* For the MS-DOS manager (jmemdos.c), we need: */
nuclear@14:   handle_union handle;		/* reference to backing-store storage object */
nuclear@14:   char temp_name[TEMP_NAME_LENGTH]; /* name if it's a file */
nuclear@14: #else
nuclear@14: #ifdef USE_MAC_MEMMGR
nuclear@14:   /* For the Mac manager (jmemmac.c), we need: */
nuclear@14:   short temp_file;		/* file reference number to temp file */
nuclear@14:   FSSpec tempSpec;		/* the FSSpec for the temp file */
nuclear@14:   char temp_name[TEMP_NAME_LENGTH]; /* name if it's a file */
nuclear@14: #else
nuclear@14:   /* For a typical implementation with temp files, we need: */
nuclear@14:   FILE * temp_file;		/* stdio reference to temp file */
nuclear@14:   char temp_name[TEMP_NAME_LENGTH]; /* name of temp file */
nuclear@14: #endif
nuclear@14: #endif
nuclear@14: } backing_store_info;
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * Initial opening of a backing-store object.  This must fill in the
nuclear@14:  * read/write/close pointers in the object.  The read/write routines
nuclear@14:  * may take an error exit if the specified maximum file size is exceeded.
nuclear@14:  * (If jpeg_mem_available always returns a large value, this routine can
nuclear@14:  * just take an error exit.)
nuclear@14:  */
nuclear@14: 
nuclear@14: EXTERN(void) jpeg_open_backing_store JPP((j_common_ptr cinfo,
nuclear@14: 					  backing_store_ptr info,
nuclear@14: 					  long total_bytes_needed));
nuclear@14: 
nuclear@14: 
nuclear@14: /*
nuclear@14:  * These routines take care of any system-dependent initialization and
nuclear@14:  * cleanup required.  jpeg_mem_init will be called before anything is
nuclear@14:  * allocated (and, therefore, nothing in cinfo is of use except the error
nuclear@14:  * manager pointer).  It should return a suitable default value for
nuclear@14:  * max_memory_to_use; this may subsequently be overridden by the surrounding
nuclear@14:  * application.  (Note that max_memory_to_use is only important if
nuclear@14:  * jpeg_mem_available chooses to consult it ... no one else will.)
nuclear@14:  * jpeg_mem_term may assume that all requested memory has been freed and that
nuclear@14:  * all opened backing-store objects have been closed.
nuclear@14:  */
nuclear@14: 
nuclear@14: EXTERN(long) jpeg_mem_init JPP((j_common_ptr cinfo));
nuclear@14: EXTERN(void) jpeg_mem_term JPP((j_common_ptr cinfo));