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