/* Copyright (C) 2001-2024 Artifex Software, Inc.

   All Rights Reserved.

   This software is provided AS-IS with no warranty, either express or

   implied.

   This software is distributed under license and may not be copied,

   modified or distributed except as expressly authorized under the terms

   of the license contained in the file LICENSE in this distribution.

   Refer to licensing information at http://www.artifex.com or contact

   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,

   CA 94129, USA, for further information.

*/

/* Command list document- and page-level code. */

#include "memory_.h"

#include "string_.h"

#include "gx.h"

#include "gp.h"

#include "gpcheck.h"

#include "gserrors.h"

#include "gxdevice.h"

#include "gxdevmem.h"           /* must precede gxcldev.h */

#include "gxcldev.h"

#include "gxclpath.h"

#include "gsparams.h"

#include "gxdcolor.h"

#include "gscms.h"

#include "gsicc_manage.h"

#include "gsicc_cache.h"

#include "gxdevsop.h"

#include "gxobj.h"

#include "valgrind.h"

extern dev_proc_open_device(pattern_clist_open_device);

/* GC information */

/*  Where is the GC information for the common objects that are

    shared between the reader and writer.  I see pointers in

    there, but they don't seem to be GC.  This is why I have

    put the icc_table and the link cache in the reader and the

    writer rather than the common.   fixme: Also, if icc_cache_cl is not

    included in the writer, 64bit builds will seg fault */

extern_st(st_gs_gstate);

static

ENUM_PTRS_WITH(device_clist_enum_ptrs, gx_device_clist *cdev)

    if (index < st_device_forward_max_ptrs) {

        gs_ptr_type_t ret = ENUM_USING_PREFIX(st_device_forward, st_device_max_ptrs);

        return (ret ? ret : ENUM_OBJ(0));

    }

    index -= st_device_forward_max_ptrs;

    /* RJW: We do not enumerate icc_cache_cl or icc_cache_list as they

     * are allocated in non gc space */

    if (CLIST_IS_WRITER(cdev)) {

        switch (index) {

        case 0: return ENUM_OBJ((cdev->writer.image_enum_id != gs_no_id ?

                     cdev->writer.clip_path : 0));

        case 1: return ENUM_OBJ((cdev->writer.image_enum_id != gs_no_id ?

                     cdev->writer.color_space.space : 0));

        case 2: return ENUM_OBJ(cdev->writer.pinst);

        case 3: return ENUM_OBJ(cdev->writer.cropping_stack);

        case 4: return ENUM_OBJ(cdev->writer.icc_table);

        default:

        return ENUM_USING(st_gs_gstate, &cdev->writer.gs_gstate,

                  sizeof(gs_gstate), index - 5);

        }

    }

    else {

        /* 041207

         * clist is reader.

         * We don't expect this code to be exercised at this time as the reader

         * runs under gdev_prn_output_page which is an atomic function of the

         * interpreter. We do this as this situation may change in the future.

         */

        if (index == 0)

            return ENUM_OBJ(cdev->reader.offset_map);

        else if (index == 1)

            return ENUM_OBJ(cdev->reader.icc_table);

        else if (index == 2)

            return ENUM_OBJ(cdev->reader.color_usage_array);

        else

            return 0;

    }

ENUM_PTRS_END

static

RELOC_PTRS_WITH(device_clist_reloc_ptrs, gx_device_clist *cdev)

{

    RELOC_PREFIX(st_device_forward);

    if (CLIST_IS_WRITER(cdev)) {

        if (cdev->writer.image_enum_id != gs_no_id) {

            RELOC_VAR(cdev->writer.clip_path);

            RELOC_VAR(cdev->writer.color_space.space);

        }

        RELOC_VAR(cdev->writer.pinst);

        RELOC_VAR(cdev->writer.cropping_stack);

        RELOC_VAR(cdev->writer.icc_table);

        RELOC_USING(st_gs_gstate, &cdev->writer.gs_gstate,

            sizeof(gs_gstate));

    } else {

        /* 041207

         * clist is reader.

         * See note above in ENUM_PTRS_WITH section.

         */

        RELOC_VAR(cdev->reader.offset_map);

        RELOC_VAR(cdev->reader.icc_table);

        RELOC_VAR(cdev->reader.color_usage_array);

    }

} RELOC_PTRS_END

public_st_device_clist();

private_st_clist_writer_cropping_buffer();

private_st_clist_icctable_entry();

private_st_clist_icctable();

/* Forward declarations of driver procedures */

dev_proc_open_device(clist_open);

dev_proc_output_page(clist_output_page);

dev_proc_close_device(clist_close);

/* Driver procedures defined in other files are declared in gxcldev.h. */

/* Other forward declarations */

static int clist_put_current_params(gx_device_clist_writer *cldev);

void

clist_initialize_device_procs(gx_device *dev)

{

    set_dev_proc(dev, open_device, clist_open);

    set_dev_proc(dev, get_initial_matrix, gx_forward_get_initial_matrix);

    set_dev_proc(dev, sync_output, gx_default_sync_output);

    set_dev_proc(dev, output_page, clist_output_page);

    set_dev_proc(dev, close_device, clist_close);

    set_dev_proc(dev, map_rgb_color, gx_forward_map_rgb_color);

    set_dev_proc(dev, map_color_rgb, gx_forward_map_color_rgb);

    set_dev_proc(dev, fill_rectangle, clist_fill_rectangle);

    set_dev_proc(dev, copy_mono, clist_copy_mono);

    set_dev_proc(dev, copy_color, clist_copy_color);

    set_dev_proc(dev, get_params, gx_forward_get_params);

    set_dev_proc(dev, put_params, gx_forward_put_params);

    set_dev_proc(dev, map_cmyk_color, gx_forward_map_cmyk_color);

    set_dev_proc(dev, get_page_device, gx_forward_get_page_device);

    set_dev_proc(dev, get_alpha_bits, gx_forward_get_alpha_bits);

    set_dev_proc(dev, copy_alpha, clist_copy_alpha);

    set_dev_proc(dev, fill_path, clist_fill_path);

    set_dev_proc(dev, stroke_path, clist_stroke_path);

    set_dev_proc(dev, fill_mask, clist_fill_mask);

    set_dev_proc(dev, fill_trapezoid, clist_fill_trapezoid);

    set_dev_proc(dev, fill_parallelogram, clist_fill_parallelogram);

    set_dev_proc(dev, fill_triangle, clist_fill_triangle);

    set_dev_proc(dev, strip_tile_rectangle, clist_strip_tile_rectangle);

    set_dev_proc(dev, get_clipping_box, gx_forward_get_clipping_box);

    set_dev_proc(dev, begin_typed_image, clist_begin_typed_image);

    set_dev_proc(dev, get_bits_rectangle, clist_get_bits_rectangle);

    set_dev_proc(dev, composite, clist_composite);

    set_dev_proc(dev, get_hardware_params, gx_forward_get_hardware_params);

    set_dev_proc(dev, get_color_mapping_procs, gx_forward_get_color_mapping_procs);

    set_dev_proc(dev, get_color_comp_index, gx_forward_get_color_comp_index);

    set_dev_proc(dev, encode_color, gx_forward_encode_color);

    set_dev_proc(dev, decode_color, gx_forward_decode_color);

    set_dev_proc(dev, fill_rectangle_hl_color, clist_fill_rectangle_hl_color);

    set_dev_proc(dev, fill_linear_color_trapezoid, clist_fill_linear_color_trapezoid);

    set_dev_proc(dev, fill_linear_color_triangle, clist_fill_linear_color_triangle);

    set_dev_proc(dev, update_spot_equivalent_colors, gx_forward_update_spot_equivalent_colors);

    set_dev_proc(dev, ret_devn_params, gx_forward_ret_devn_params);

    set_dev_proc(dev, fillpage, clist_fillpage);

    set_dev_proc(dev, dev_spec_op, clist_dev_spec_op);

    set_dev_proc(dev, copy_planes, clist_copy_planes);

    set_dev_proc(dev, strip_copy_rop2, clist_strip_copy_rop2);

    set_dev_proc(dev, strip_tile_rect_devn, clist_strip_tile_rect_devn);

    set_dev_proc(dev, copy_alpha_hl_color, clist_copy_alpha_hl_color);

    set_dev_proc(dev, process_page, clist_process_page);

    set_dev_proc(dev, fill_stroke_path, clist_fill_stroke_path);

    set_dev_proc(dev, lock_pattern, clist_lock_pattern);

}

/*------------------- Choose the implementation -----------------------

   For choosing the clist i/o implementation by makefile options we

   define global variables (in gs_lib_ctx_core_t), which are

   initialized with file/memory io procs when they are included into

   the build.

*/

void

clist_init_io_procs(gx_device_clist *pclist_dev, bool in_memory)

{

    gs_lib_ctx_core_t *core = pclist_dev->common.memory->gs_lib_ctx->core;

#ifdef PACIFY_VALGRIND

    VALGRIND_HG_DISABLE_CHECKING(&core->clist_io_procs_file, sizeof(core->clist_io_procs_file));

    VALGRIND_HG_DISABLE_CHECKING(&core->clist_io_procs_memory, sizeof(core->clist_io_procs_memory));

#endif

    /* if core->clist_io_procs_file is NULL, then BAND_LIST_STORAGE=memory */

    /* was specified in the build, and "file" is not available */

    if (in_memory || core->clist_io_procs_file == NULL)

        pclist_dev->common.page_info.io_procs = core->clist_io_procs_memory;

    else

        pclist_dev->common.page_info.io_procs = core->clist_io_procs_file;

}

/* ------ Define the command set and syntax ------ */

/*

 * The buffer area (data, data_size) holds a bitmap cache when both writing

 * and reading.  The rest of the space is used for the command buffer and

 * band state bookkeeping when writing, and for the rendering buffer (image

 * device) when reading.  For the moment, we divide the space up

 * arbitrarily, except that we allocate less space for the bitmap cache if

 * the device doesn't need halftoning.

 *

 * All the routines for allocating tables in the buffer are idempotent, so

 * they can be used to check whether a given-size buffer is large enough.

 */

/*

 * Calculate the desired size for the tile cache.

 */

static size_t

clist_tile_cache_size(const gx_device * target, size_t data_size)

{

    size_t bits_size =

    (data_size / 5) & ~(align_cached_bits_mod-1);   /* arbitrary */

    if (!gx_device_must_halftone(target)) {     /* No halftones -- cache holds only Patterns & characters. */

        bits_size -= bits_size >> 2;

    }

#define min_bits_size 1024

    if (bits_size < min_bits_size)

        bits_size = min_bits_size;

#undef min_bits_size

    return bits_size;

}

/*

 * Initialize the allocation for the tile cache.  Sets: tile_hash_mask,

 * tile_max_count, tile_table, chunk (structure), bits (structure).

 */

static int

clist_init_tile_cache(gx_device * dev, byte * init_data, size_t data_size)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    byte *data = init_data;

    size_t bits_size = data_size;

    /*

     * Partition the bits area between the hash table and the actual

     * bitmaps.  The per-bitmap overhead is about 24 bytes; if the

     * average character size is 10 points, its bitmap takes about 24 +

     * 0.5 * 10/72 * xdpi * 10/72 * ydpi / 8 bytes (the 0.5 being a

     * fudge factor to account for characters being narrower than they

     * are tall), which gives us a guideline for the size of the hash

     * table.

     */

    size_t avg_char_size =

        (size_t)(dev->HWResolution[0] * dev->HWResolution[1] *

               (0.5 * 10 / 72 * 10 / 72 / 8)) + 24;

    size_t hc = bits_size / avg_char_size;

    size_t hsize;

    while ((hc + 1) & hc)

        hc |= hc >> 1;          /* make mask (power of 2 - 1) */

    if (hc < 0xff)

        hc = 0xff;              /* make allowance for halftone tiles */

    else if (hc > 0xfff)

        hc = 0xfff;             /* cmd_op_set_tile_index has 12-bit operand */

    /* Make sure the tables will fit. */

    while (hc >= 3 && (hsize = (hc + 1) * sizeof(tile_hash)) >= bits_size)

        hc >>= 1;

    if (hc < 3)

        return_error(gs_error_rangecheck);

    cdev->tile_hash_mask = hc;

    cdev->tile_max_count = hc - (hc >> 2);

    cdev->tile_table = (tile_hash *) data;

    data += hsize;

    bits_size -= hsize;

    gx_bits_cache_chunk_init(cdev->cache_chunk, data, bits_size);

    gx_bits_cache_init(&cdev->bits, cdev->cache_chunk);

    return 0;

}

/*

 * Initialize the allocation for the bands.  Requires: target.  Sets:

 * page_info.band_params.BandHeight (=page_info.band_params.BandHeight), nbands.

 */

static int

clist_init_bands(gx_device * dev, gx_device_memory *bdev, size_t data_size,

                 int band_width, int band_height)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    int nbands;

    size_t space;

    if (dev_proc(dev, open_device) == pattern_clist_open_device) {

        /* We don't need bands really. */

        cdev->page_info.band_params.BandHeight = dev->height;

        cdev->nbands = 1;

        return 0;

    }

    if (gdev_mem_data_size(bdev, band_width, band_height, &space) < 0 ||

        space > data_size)

        return_error(gs_error_rangecheck);

    cdev->page_info.band_params.BandHeight = band_height;

    nbands = (cdev->target->height + band_height - 1) / band_height;

    cdev->nbands = nbands;

#ifdef DEBUG

    if (gs_debug_c('l') | gs_debug_c(':'))

        dmlprintf4(dev->memory, "[:]width=%d, band_width=%d, band_height=%d, nbands=%d\n",

                   bdev->width, band_width, band_height, nbands);

#endif

    return 0;

}

/* Minimum BufferSpace needed when writing the clist */

/* This is an exported function because it is used to set up render threads */

size_t

clist_minimum_buffer(int nbands) {

    /* Leave enough room after states for commands that write a reasonable

     * amount of data. The cmd_largest_size and the data_bits_size should  be

     * enough to buffer command operands. The data_bits_size is the level

     * at which commands should expect to split data across buffers. If this

     * extra space is a little large, it doesn't really hurt.

     */

    return (nbands * (ulong) sizeof(gx_clist_state) +

            sizeof(cmd_prefix) +

            cmd_largest_size +

            data_bits_size);

}

/*

 * Initialize the allocation for the band states, which are used only

 * when writing.  Requires: nbands.  Sets: states, cbuf, cend, band_range_list.

 */

static int

clist_init_states(gx_device * dev, byte * init_data, size_t data_size)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    size_t state_size = cdev->nbands * sizeof(gx_clist_state);

    /* Align to the natural boundary for ARM processors, bug 689600 */

    intptr_t alignment = (-(intptr_t)init_data) & (sizeof(init_data) - 1);

    if (clist_minimum_buffer(cdev->nbands) > data_size)

        return_error(gs_error_rangecheck);

    /* The end buffer position is not affected by alignment */

    cdev->cend = init_data + data_size;

    init_data +=  alignment;

    cdev->states = (gx_clist_state *) init_data;

    cdev->band_range_list =  (cmd_list *)(init_data + state_size);

    cdev->cbuf = init_data + state_size + sizeof(cmd_list);

    return 0;

}

/*

 * Initialize all the data allocations.  Requires: target.  Sets:

 * page_info.tile_cache_size, page_info.band_params.BandWidth,

 * page_info.band_params.BandBufferSpace, + see above.

 */

static int

clist_init_data(gx_device * dev, byte * init_data, size_t data_size)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    gx_device *target = cdev->target;

    /* BandWidth can't be smaller than target device width */

    const int band_width =

        cdev->page_info.band_params.BandWidth = max(target->width, cdev->band_params.BandWidth);

    int band_height = cdev->band_params.BandHeight;

    bool page_uses_transparency = cdev->page_uses_transparency;

    const size_t band_space =

    cdev->page_info.band_params.BandBufferSpace =

        (cdev->band_params.BandBufferSpace ?

         cdev->band_params.BandBufferSpace : data_size);

    byte *data = init_data;

    size_t size = band_space;

    size_t bits_size;

    gx_device_memory bdev;

    gx_device *pbdev = (gx_device *)&bdev;

    int code;

    int align = 1 << (target->log2_align_mod > log2_align_bitmap_mod ? target->log2_align_mod : log2_align_bitmap_mod);

    align = align < obj_align_mod ? obj_align_mod : align;

    /* the clist writer has its own color info that depends upon the

       transparency group color space (if transparency exists).  The data that is

       used in the clist writing. Here it is initialized with

       the target device color info.  The values will be pushed and popped

       in a stack if we have changing color spaces in the transparency groups. */

    cdev->clist_color_info.depth = dev->color_info.depth;

    cdev->clist_color_info.polarity = dev->color_info.polarity;

    cdev->clist_color_info.num_components = dev->color_info.num_components;

    cdev->graphics_type_tag = target->graphics_type_tag;  /* initialize to same as target */

    /* Call create_buf_device to get the memory planarity set up. */

    code = cdev->buf_procs.create_buf_device(&pbdev, target, 0, NULL, NULL, NULL);

    if (code < 0)

        return code;

    /* HACK - if the buffer device can't do copy_alpha, disallow */

    /* copy_alpha in the commmand list device as well. */

    if (dev_proc(pbdev, copy_alpha) == gx_no_copy_alpha)

        cdev->disable_mask |= clist_disable_copy_alpha;

    if (dev_proc(cdev, open_device) == pattern_clist_open_device) {

        bits_size = data_size / 2;

        cdev->page_info.line_ptrs_offset = 0;

    } else {

        if (band_height) {

            /*

             * The band height is fixed, so the band buffer requirement

             * is completely determined.

             */

            size_t band_data_size;

            int adjusted;

            adjusted = (dev_proc(dev, dev_spec_op)(dev, gxdso_adjust_bandheight, NULL, band_height));

            if (adjusted > 0)

                band_height = adjusted;

            if (gdev_mem_data_size(&bdev, band_width, band_height, &band_data_size) < 0 ||

                band_data_size >= band_space) {

                if (pbdev->finalize)

                    pbdev->finalize(pbdev);

                return_error(gs_error_rangecheck);

            }

            /* If the tile_cache_size is specified, use it */

            if (cdev->space_params.band.tile_cache_size == 0) {

                bits_size = min(band_space - band_data_size, data_size >> 1);

            } else {

                bits_size = cdev->space_params.band.tile_cache_size;

            }

            /* The top of the tile_cache is the bottom of the imagable band buffer,

             * which needs to be appropriately aligned. Because the band height is

             * fixed, we must round *down* the size of the cache to a appropriate

             * value. See clist_render_thread() and clist_rasterize_lines()

             * for where the value is used.

             */

            bits_size = ROUND_DOWN(bits_size, align);

        } else {

            int adjusted;

            /*

             * Choose the largest band height that will fit in the

             * rendering-time buffer.

             */

            bits_size = clist_tile_cache_size(target, band_space);

            bits_size = min(bits_size, data_size >> 1);

            /* The top of the tile_cache is the bottom of the imagable band buffer,

             * which needs to be appropriately aligned. Because the band height is

             * fixed, here we round up the size of the cache, since the band height

             * is variable, and it should only be a few bytes. See clist_render_thread()

             * and clist_rasterize_lines() for where the value is used.

             */

            bits_size = ROUND_UP(bits_size, align);

            band_height = gdev_mem_max_height(&bdev, band_width,

                              band_space - bits_size, page_uses_transparency);

            if (band_height == 0) {

                if (pbdev->finalize)

                    pbdev->finalize(pbdev);

                return_error(gs_error_rangecheck);

            }

            adjusted = (dev_proc(dev, dev_spec_op)(dev, gxdso_adjust_bandheight, NULL, band_height));

            if (adjusted > 0)

                band_height = adjusted;

        }

        /* The above calculated bits_size's include space for line ptrs. What is

         * the offset for the line_ptrs within the buffer? */

        if (gdev_mem_bits_size(&bdev, band_width, band_height, &cdev->page_info.line_ptrs_offset) < 0)

            return_error(gs_error_VMerror);

    }

    cdev->pdf14_trans_group_level = -1; /* to prevent any initial op except PUSH_DEVICE */

    cdev->ins_count = 0;

    code = clist_init_tile_cache(dev, data, bits_size);

    if (code < 0) {

        if (pbdev->finalize)

            pbdev->finalize(pbdev);

        return code;

    }

    cdev->page_info.tile_cache_size = bits_size;

    data += bits_size;

    size -= bits_size;

    code = clist_init_bands(dev, &bdev, size, band_width, band_height);

    if (code < 0) {

        if (pbdev->finalize)

            pbdev->finalize(pbdev);

        return code;

    }

    if (pbdev->finalize)

        pbdev->finalize(pbdev);

    return clist_init_states(dev, data, data_size - bits_size);

}

/*

 * Reset the device state (for writing).  This routine requires only

 * data, data_size, and target to be set, and is idempotent.

 */

static int

clist_reset(gx_device * dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    int code = clist_init_data(dev, cdev->data, cdev->data_size);

    int nbands;

    if (code < 0)

        return (cdev->permanent_error = code);

    /* Now initialize the rest of the state. */

    cdev->permanent_error = 0;

    nbands = cdev->nbands;

    cdev->ymin = cdev->ymax = -1;       /* render_init not done yet */

    memset(cdev->tile_table, 0, (cdev->tile_hash_mask + 1) *

       sizeof(*cdev->tile_table));

    cdev->cnext = cdev->cbuf;

    cdev->ccl = 0;

    cdev->band_range_list->head = cdev->band_range_list->tail = 0;

    cdev->band_range_min = 0;

    cdev->band_range_max = nbands - 1;

    if_debug2m('L', cdev->memory, "[L]Resetting: Band range(%d,%d)\n",

               cdev->band_range_min, cdev->band_range_max);

    {

        int band;

        gx_clist_state *states = cdev->states;

        for (band = 0; band < nbands; band++, states++) {

            static const gx_clist_state cls_initial = { cls_initial_values };

            *states = cls_initial;

        }

    }

    /*

     * Round up the size of the per-tile band mask so that the bits,

     * which follow it, stay aligned.

     */

    cdev->tile_band_mask_size =

        ((nbands + (align_bitmap_mod * 8 - 1)) >> 3) &

        ~(align_bitmap_mod - 1);

    /*

     * Initialize the all-band parameters to impossible values,

     * to force them to be written the first time they are used.

     */

    memset(&cdev->tile_params, 0, sizeof(cdev->tile_params));

    cdev->tile_depth = 0;

    cdev->tile_known_min = nbands;

    cdev->tile_known_max = -1;

    GS_STATE_INIT_VALUES_CLIST((&cdev->gs_gstate));

    cdev->clip_path = NULL;

    cdev->clip_path_id = gs_no_id;

    cdev->color_space.byte1 = 0;

    cdev->color_space.id = gs_no_id;

    cdev->color_space.space = 0;

    {

        int i;

        for (i = 0; i < countof(cdev->transfer_ids); ++i)

            cdev->transfer_ids[i] = gs_no_id;

    }

    cdev->black_generation_id = gs_no_id;

    cdev->undercolor_removal_id = gs_no_id;

    cdev->device_halftone_id = gs_no_id;

    cdev->image_enum_id = gs_no_id;

    cdev->cropping_min = cdev->save_cropping_min = 0;

    cdev->cropping_max = cdev->save_cropping_max = cdev->height;

    cdev->cropping_saved = false;

    cdev->cropping_stack = NULL;

    cdev->cropping_level = 0;

    cdev->mask_id_count = cdev->mask_id = cdev->temp_mask_id = 0;

    cdev->icc_table = NULL;

    cdev->op_fill_active = false;

    cdev->op_stroke_active = false;

    return 0;

}

/*

 * Initialize the device state (for writing).  This routine requires only

 * data, data_size, and target to be set, and is idempotent.

 */

static int

clist_init(gx_device * dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    int code = clist_reset(dev);

    if (code >= 0) {

        cdev->image_enum_id = gs_no_id;

        cdev->ignore_lo_mem_warnings = 0;

    }

    return code;

}

/* Write out the current parameters that must be at the head of each page */

/* if async rendering is in effect */

static int

clist_emit_page_header(gx_device *dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    int code = 0;

    if ((cdev->disable_mask & clist_disable_pass_thru_params)) {

        code = clist_put_current_params(cdev);

        cdev->permanent_error = (code < 0 ? code : 0);

    }

    return code;

}

/* Reset parameters for the beginning of a page. */

static void

clist_reset_page(gx_device_clist_writer *cwdev)

{

    cwdev->page_info.bfile_end_pos = 0;

}

/* Open the device's bandfiles */

static int

clist_open_output_file(gx_device *dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    char fmode[4];

    int code;

    if (cdev->do_not_open_or_close_bandfiles)

        return 0; /* external bandfile open/close managed externally */

    cdev->page_info.cfile = 0;       /* in case of failure */

    cdev->page_info.bfile = 0;       /* ditto */

    code = clist_init(dev);

    if (code < 0)

        return code;

    snprintf(fmode, sizeof(fmode), "w+%s", gp_fmode_binary_suffix);

    cdev->page_info.cfname[0] = 0;   /* create a new file */

    cdev->page_info.bfname[0] = 0;   /* ditto */

    clist_reset_page(cdev);

    if ((code = cdev->page_info.io_procs->fopen(cdev->page_info.cfname, fmode, &cdev->page_info.cfile,

                            cdev->bandlist_memory, cdev->bandlist_memory,

                            true)) < 0 ||

        (code = cdev->page_info.io_procs->fopen(cdev->page_info.bfname, fmode, &cdev->page_info.bfile,

                            cdev->bandlist_memory, cdev->bandlist_memory,

                            false)) < 0

        ) {

        clist_close_output_file(dev);

        cdev->permanent_error = code;

    }

    return code;

}

/* Close, and free the contents of, the temporary files of a page. */

/* Note that this does not deallocate the buffer. */

int

clist_close_page_info(gx_band_page_info_t *ppi)

{

    if (ppi->cfile != NULL) {

        ppi->io_procs->fclose(ppi->cfile, ppi->cfname, true);

        ppi->cfile = NULL;

        ppi->cfname[0] = 0;     /* prevent re-use in case this is a fake path */

    }

    if (ppi->bfile != NULL) {

        ppi->io_procs->fclose(ppi->bfile, ppi->bfname, true);

        ppi->bfile = NULL;

        ppi->bfname[0] = 0;     /* prevent re-use in case this is a fake path */

    }

    return 0;

}

/* Close the device by freeing the temporary files. */

/* Note that this does not deallocate the buffer. */

int

clist_close_output_file(gx_device *dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    return clist_close_page_info(&cdev->page_info);

}

/* Open the device by initializing the device state and opening the */

/* scratch files. */

int

clist_open(gx_device *dev)

{

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    bool save_is_open = dev->is_open;

    int code;

    cdev->permanent_error = 0;

    cdev->is_open = false;

    cdev->cache_chunk = (gx_bits_cache_chunk *)gs_alloc_bytes(cdev->memory->non_gc_memory, sizeof(gx_bits_cache_chunk), "alloc tile cache for clist");

    if (!cdev->cache_chunk)

        return_error(gs_error_VMerror);

    memset(cdev->cache_chunk, 0x00, sizeof(gx_bits_cache_chunk));

    code = clist_init(dev);

    if (code < 0)

        goto errxit;

    cdev->icc_cache_list_len = 0;

    cdev->icc_cache_list = NULL;

    code = clist_open_output_file(dev);

    if ( code >= 0)

        code = clist_emit_page_header(dev);

    if (code >= 0) {

        dev->is_open = save_is_open;

        return code;    /* success */

    }

    /* fall through to clean up and return error code */

errxit:

    /* prevent leak */

    gs_free_object(cdev->memory->non_gc_memory, cdev->cache_chunk, "free tile cache for clist");

    dev->is_open = save_is_open;

    cdev->cache_chunk = NULL;

    return code;

}

int

clist_close(gx_device *dev)

{

    int i;

    gx_device_clist_writer * const cdev =

        &((gx_device_clist *)dev)->writer;

    /* I'd like to free the cache chunk in here, but we can't, because the pattern clist

     * device gets closed, but not discarded, later it gets run. So we have to free the memory

     * in *2* places, once in gdev_prn_tear_down() for regular clists, and once in

     * gx_pattern_cache_free_entry() for pattern clists....

     */

    for(i = 0; i < cdev->icc_cache_list_len; i++) {

        rc_decrement(cdev->icc_cache_list[i], "clist_close");

    }

    cdev->icc_cache_list_len = 0;

    gs_free_object(cdev->memory->thread_safe_memory, cdev->icc_cache_list, "clist_close");

    cdev->icc_cache_list = NULL;

    /* So despite the comment above, it seems necessary to free the cache_chunk here,

     * if the device is not being retained.  The code in gx_pattern_cache_free_entry() doesn't

     * actually free it, in at least some cases.

     * TODO: Is it sufficient to only free it here, and not in the places mentioned above?

     */

    if (!cdev->retained) {

        gs_free_object(cdev->memory->non_gc_memory, cdev->cache_chunk,

                       "clist_close(cache_chunk)");

        cdev->cache_chunk = NULL;

    }

    if (cdev->do_not_open_or_close_bandfiles)

        return 0;

    if (dev_proc(cdev, open_device) == pattern_clist_open_device) {

        gs_free_object(cdev->bandlist_memory, cdev->data, "clist_close");

        cdev->data = NULL;

    }

    return clist_close_output_file(dev);

}

/* The output_page procedure should never be called! */

int

clist_output_page(gx_device * dev, int num_copies, int flush)

{

    return_error(gs_error_Fatal);

}

/* Reset (or prepare to append to) the command list after printing a page. */

int

clist_finish_page(gx_device *dev, bool flush)

{

    gx_device_clist_writer *const cdev = &((gx_device_clist *)dev)->writer;

    int code;

    /* If this is a reader clist, which is about to be reset to a writer,

     * free any color_usage array used by same.

     * since we have been rendering, shut down threads

     * Also free the icc_table at this time and the icc_cache

     */

    if (!CLIST_IS_WRITER((gx_device_clist *)dev)) {

        gx_device_clist_reader * const crdev =  &((gx_device_clist *)dev)->reader;

        clist_teardown_render_threads(dev);

        gs_free_object(cdev->memory, crdev->color_usage_array, "clist_color_usage_array");

        crdev->color_usage_array = NULL;

       /* Free the icc table associated with this device.

           The threads that may have pointed to this were destroyed in

           the above call to clist_teardown_render_threads.  Since they

           all maintained a copy of the cache and the table there should not

           be any issues. */

        clist_free_icc_table(crdev->icc_table, crdev->memory);

        crdev->icc_table = NULL;

    }

    if (flush) {

        if (cdev->page_info.cfile != 0) {

            code = cdev->page_info.io_procs->rewind(cdev->page_info.cfile, true, cdev->page_info.cfname);

            if (code < 0) return code;

        }

        if (cdev->page_info.bfile != 0) {

            code = cdev->page_info.io_procs->rewind(cdev->page_info.bfile, true, cdev->page_info.bfname);

            if (code < 0) return code;

        }

        cdev->page_info.bfile_end_pos = 0;

        clist_reset_page(cdev);

    } else {

        if (cdev->page_info.cfile != 0)

            cdev->page_info.io_procs->fseek(cdev->page_info.cfile, 0L, SEEK_END, cdev->page_info.cfname);

        if (cdev->page_info.bfile != 0)

            cdev->page_info.io_procs->fseek(cdev->page_info.bfile, 0L, SEEK_END, cdev->page_info.bfname);

    }

    code = clist_init(dev);             /* reinitialize */

    if (code >= 0)

        code = clist_emit_page_header(dev);

    return code;

}

/* ------ Writing ------ */

/* End a page by flushing the buffer and terminating the command list. */

int     /* ret 0 all-ok, -ve error code, or +1 ok w/low-mem warning */

clist_end_page(gx_device_clist_writer * cldev)

{

    int code;

    cmd_block cb;

    int ecode = 0;

    code = cmd_write_buffer(cldev, cmd_opv_end_page);

    if (code >= 0)

        ecode |= code;

    else

        ecode = code;

    /* If we have ICC profiles present in the cfile save the table now,

       along with the ICC profiles. Table is stored in band maxband + 1. */

    if ( cldev->icc_table != NULL ) {

        /* Save the table */

        code = clist_icc_writetable(cldev);

        /* Free the table */

        clist_free_icc_table(cldev->icc_table, cldev->memory);

        cldev->icc_table = NULL;

    }

    if (code >= 0) {

        code = clist_write_color_usage_array(cldev);

        if (code >= 0) {

            ecode |= code;

            /*

             * Write the terminating entry in the block file.

             * Note that because of copypage, there may be many such entries.

             */

            memset(&cb, 0, sizeof(cb)); /* Zero the block, including any padding */

            cb.band_min = cb.band_max = cmd_band_end;

            cb.pos = (cldev->page_info.cfile == 0 ? 0 : cldev->page_info.io_procs->ftell(cldev->page_info.cfile));

            if_debug3m('l', cldev->memory, "[l]writing end for bands (%d,%d) at %"PRId64"\n",

                       cb.band_min, cb.band_max, cb.pos);

            code = cldev->page_info.io_procs->fwrite_chars(&cb, sizeof(cb), cldev->page_info.bfile);

            if (code > 0)

                code = 0;

        }

    }

    if (code >= 0) {

        ecode |= code;

        cldev->page_info.bfile_end_pos = cldev->page_info.io_procs->ftell(cldev->page_info.bfile);

    } else

        ecode = code;

    /* Reset warning margin to 0 to release reserve memory if mem files */

    if (cldev->page_info.bfile != 0)

        cldev->page_info.io_procs->set_memory_warning(cldev->page_info.bfile, 0);

    if (cldev->page_info.cfile != 0)

        cldev->page_info.io_procs->set_memory_warning(cldev->page_info.cfile, 0);

#ifdef DEBUG

    if (gs_debug_c('l') | gs_debug_c(':')) {

        if (cb.pos <= 0xFFFFFFFF)

            dmlprintf2(cldev->memory, "[:]clist_end_page at cfile=%lu, bfile=%lu\n",

                  (unsigned long)cb.pos, (unsigned long)cldev->page_info.bfile_end_pos);

        else

            dmlprintf3(cldev->memory, "[:]clist_end_page at cfile=%lu%0lu, bfile=%lu\n",

                (unsigned long) (cb.pos >> 32), (unsigned long) (cb.pos & 0xFFFFFFFF),

                (unsigned long)cldev->page_info.bfile_end_pos);

    }

#endif

    if (cldev->page_uses_transparency && gs_debug[':']) {

        /* count how many bands were skipped */

        int skip_count = 0;

        int band;

        for (band=0; band < cldev->nbands - 1; band++) {

            if (cldev->states[band].color_usage.trans_bbox.p.y >

                cldev->states[band].color_usage.trans_bbox.q.y)

                skip_count++;

        }

        dprintf2("%d bands skipped out of %d\n", skip_count, cldev->nbands);

    }

    return ecode;

}

gx_color_usage_bits

gx_color_index2usage(gx_device *dev, gx_color_index color)

{

    gx_color_usage_bits bits = 0;

    uchar i;

    if (dev->color_info.polarity == GX_CINFO_POLARITY_ADDITIVE)

        color = color ^ ~0;   /* white is 0 */

    for (i = 0; i < dev->color_info.num_components; i++) {

        if (color & dev->color_info.comp_mask[i])

            bits |= (((gx_color_usage_bits)1) << i);

    }

    return bits;

}

/* Write the target device's current parameter list */

static int      /* ret 0 all ok, -ve error */

clist_put_current_params(gx_device_clist_writer *cldev)

{

    gx_device *target = cldev->target;

    gs_c_param_list param_list;

    int code;

    /*

     * If a put_params call fails, the device will be left in a closed

     * state, but higher-level code won't notice this fact.  We flag this by

     * setting permanent_error, which prevents writing to the command list.

     */

    if (cldev->permanent_error)

        return cldev->permanent_error;

    gs_c_param_list_write(&param_list, cldev->memory);

    code = (*dev_proc(target, get_params))

        (target, (gs_param_list *)&param_list);

    if (code >= 0) {

        gs_c_param_list_read(&param_list);

        code = cmd_put_params( cldev, (gs_param_list *)&param_list );

    }

    gs_c_param_list_release(&param_list);

    return code;

}

/* ---------------- Driver interface ---------------- */

/* ICC table operations.  See gxclist.h for details */

/* This checks the table for a hash code entry */

bool

clist_icc_searchtable(gx_device_clist_writer *cdev, int64_t hashcode)

{

    clist_icctable_t *icc_table = cdev->icc_table;

    clist_icctable_entry_t *curr_entry;

    if (icc_table == NULL)

        return(false);  /* No entry */

    curr_entry = icc_table->head;

    while(curr_entry != NULL) {

        if (curr_entry->serial_data.hashcode == hashcode){

            return(true);

        }

        curr_entry = curr_entry->next;

    }

     return(false);  /* No entry */

}

static void

clist_free_icc_table_contents(clist_icctable_t *icc_table)

{

    int number_entries;

    clist_icctable_entry_t *curr_entry, *next_entry;

    int k;

    number_entries = icc_table->tablesize;

    curr_entry = icc_table->head;

    for (k = 0; k < number_entries; k++) {

        next_entry = curr_entry->next;

        gsicc_adjust_profile_rc(curr_entry->icc_profile, -1, "clist_free_icc_table");

        gs_free_object(icc_table->memory, curr_entry, "clist_free_icc_table");

        curr_entry = next_entry;

    }

}

void

clist_icc_table_finalize(const gs_memory_t *memory, void * vptr)

{

    clist_icctable_t *icc_table = (clist_icctable_t *)vptr;

    clist_free_icc_table_contents(icc_table);

}

/* Free the table */

int

clist_free_icc_table(clist_icctable_t *icc_table, gs_memory_t *memory)

{

    if (icc_table == NULL)

        return(0);

    gs_free_object(icc_table->memory, icc_table, "clist_free_icc_table");

    return(0);

}

/* This serializes the ICC table and writes it out for maxband+1 */

int

clist_icc_writetable(gx_device_clist_writer *cldev)

{

    unsigned char *pbuf, *buf;

    clist_icctable_t *icc_table = cldev->icc_table;

    int number_entries = icc_table->tablesize;

    clist_icctable_entry_t *curr_entry;

    int size_data;

    int k;

    bool rend_is_valid;

    /* First we need to write out the ICC profiles themselves and update

       in the table where they will be stored and their size.  Set the

       rend cond valid flag prior to writing */

    curr_entry = icc_table->head;

    for ( k = 0; k < number_entries; k++ ){

        rend_is_valid = curr_entry->icc_profile->rend_is_valid;

        curr_entry->icc_profile->rend_is_valid = curr_entry->render_is_valid;

        curr_entry->serial_data.file_position = clist_icc_addprofile(cldev, curr_entry->icc_profile, &size_data);

        curr_entry->icc_profile->rend_is_valid = rend_is_valid;