/* Copyright (C) 2001-2025 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.

*/

/*  GS ICC link cache.  Initial stubbing of functions.  */

#include "std.h"

#include "stdpre.h"

#include "gstypes.h"

#include "gsmemory.h"

#include "gsstruct.h"

#include "scommon.h"

#include "gx.h"

#include "gpsync.h" /* for MAX_THREADS */

#include "gxgstate.h"

#include "smd5.h"

#include "gscms.h"

#include "gsicc_cms.h"

#include "gsicc_manage.h"

#include "gsicc_cache.h"

#include "gserrors.h"

#include "gsmalloc.h" /* Needed for named color structure allocation */

#include "string_.h"  /* Needed for named color structure allocation */

#include "gxsync.h"

#include "gzstate.h"

#include "stdint_.h"

#include "assert_.h"

        /*

         *  Note that the the external memory used to maintain

         *  links in the CMS is generally not visible to GS.

         *  For most CMS's the  links are 33x33x33x33x4 bytes at worst

         *  for a CMYK to CMYK MLUT which is about 4.5Mb per link.

         *  If the link were matrix based it would be much much smaller.

         *  We will likely want to do at least have an estimate of the

         *  memory used based upon how the CMS is configured.

         *  This will be done later.  For now, just limit the number

         *  of links.

         */

#define ICC_CACHE_MAXLINKS (MAX_THREADS*2)  /* allow up to two active links per thread */

#define ICC_CACHE_NOT_VALID_COUNT 20  /* This should not really occur. If it does we need to take a closer look */

/* Static prototypes */

static gsicc_link_t * gsicc_alloc_link(gs_memory_t *memory, gsicc_hashlink_t hashcode);

static int gsicc_get_cspace_hash(gsicc_manager_t *icc_manager, gx_device *dev,

                                 cmm_profile_t *profile, int64_t *hash);

static int gsicc_compute_linkhash(gsicc_manager_t *icc_manager, gx_device *dev,

                                  cmm_profile_t *input_profile,

                                  cmm_profile_t *output_profile,

                                  gsicc_rendering_param_t *rendering_params,

                                  gsicc_hashlink_t *hash);

static void gsicc_remove_link(gsicc_link_t *link);

static void gsicc_get_buff_hash(unsigned char *data, int64_t *hash, unsigned int num_bytes);

static void rc_gsicc_link_cache_free(gs_memory_t * mem, void *ptr_in, client_name_t cname);

/* Structure pointer information */

struct_proc_finalize(icc_link_finalize);

gs_private_st_ptrs3_final(st_icc_link, gsicc_link_t, "gsiccmanage_link",

                    icc_link_enum_ptrs, icc_link_reloc_ptrs, icc_link_finalize,

                    icc_link_cache, next, lock);

struct_proc_finalize(icc_linkcache_finalize);

gs_private_st_ptrs3_final(st_icc_linkcache, gsicc_link_cache_t, "gsiccmanage_linkcache",

                    icc_linkcache_enum_ptrs, icc_linkcache_reloc_ptrs, icc_linkcache_finalize,

                    head, lock, full_wait);

/* These are used to construct a hash for the ICC link based upon the

   render parameters */

#define BP_SHIFT 0

#define REND_SHIFT 8

#define PRESERVE_SHIFT 16

/**

 * gsicc_cache_new: Allocate a new ICC cache manager

 * Return value: Pointer to allocated manager, or NULL on failure.

 **/

gsicc_link_cache_t *

gsicc_cache_new(gs_memory_t *memory)

{

    gsicc_link_cache_t *result;

    /* We want this to be maintained in stable_memory.  It should be be effected by the

       save and restores */

    memory = memory->stable_memory;

    result = gs_alloc_struct(memory, gsicc_link_cache_t, &st_icc_linkcache,

                             "gsicc_cache_new");

    if ( result == NULL )

        return(NULL);

    result->head = NULL;

    result->num_links = 0;

    result->cache_full = false;

    result->memory = memory;

    result->full_wait = NULL; /* Required so finaliser can work when result freed. */

    rc_init_free(result, memory, 1, rc_gsicc_link_cache_free);

    result->lock = gx_monitor_label(gx_monitor_alloc(memory),

                                    "gsicc_cache_new");

    if (result->lock == NULL) {

        rc_decrement(result, "gsicc_cache_new");

        return(NULL);

    }

    result->full_wait = gx_semaphore_label(gx_semaphore_alloc(memory),

                                           "gsicc_cache_new");

    if (result->full_wait == NULL) {

        /* Don't free result->lock, as the finaliser for result does that! */

        rc_decrement(result, "gsicc_cache_new");

        return(NULL);

    }

    if_debug2m(gs_debug_flag_icc, memory,

               "[icc] Allocating link cache = "PRI_INTPTR" memory = "PRI_INTPTR"\n",

         (intptr_t)result, (intptr_t)result->memory);

    return(result);

}

static void

rc_gsicc_link_cache_free(gs_memory_t * mem, void *ptr_in, client_name_t cname)

{

    /* Ending the entire cache.  The ref counts on all the links should be 0 */

    gsicc_link_cache_t *link_cache = (gsicc_link_cache_t * ) ptr_in;

    /* mem is unused, but we are passed it anyway by the ref counting mechanisms. */

    assert(link_cache != NULL && mem == link_cache->memory);

    if (link_cache == NULL)

        return;

    if_debug2m(gs_debug_flag_icc, link_cache->memory,

               "[icc] Removing link cache = "PRI_INTPTR" memory = "PRI_INTPTR"\n",

               (intptr_t)link_cache, (intptr_t)link_cache->memory);

    /* NB: freeing the link_cache will call icc_linkcache_finalize */

    gs_free_object(link_cache->memory, link_cache, "rc_gsicc_link_cache_free");

}

/* release the monitor of the link_cache when it is freed */

void

icc_linkcache_finalize(const gs_memory_t *mem, void *ptr)

{

    gsicc_link_cache_t *link_cache = (gsicc_link_cache_t * ) ptr;

    /* mem is unused, but we are passed it anyway by the ref counting mechanisms. */

    assert(link_cache != NULL && mem == link_cache->memory);

    if (link_cache == NULL)

        return;

    while (link_cache->head != NULL) {

        if (link_cache->head->ref_count != 0) {

            if_debug2m(gs_debug_flag_icc, link_cache->memory, "link at "PRI_INTPTR" being removed, but has ref_count = %d\n",

                      (intptr_t)link_cache->head, link_cache->head->ref_count);

            link_cache->head->ref_count = 0;  /* force removal */

        }

        gsicc_remove_link(link_cache->head);

    }

#ifdef DEBUG

    if (link_cache->num_links != 0) {

        emprintf1(link_cache->memory, "num_links is %d, should be 0.\n", link_cache->num_links);

    }

#endif

    if (link_cache->rc.ref_count == 0) {

        gx_monitor_free(link_cache->lock);

        link_cache->lock = NULL;

        gx_semaphore_free(link_cache->full_wait);

        link_cache->full_wait = 0;

    }

}

/* This is a special allocation for a link that is used by devices for

   doing color management on post rendered data.  It is not tied into the

   profile cache like gsicc_alloc_link. Also it goes ahead and creates

   the link, i.e. link creation is not delayed. */

gsicc_link_t *

gsicc_alloc_link_dev(gs_memory_t *memory, cmm_profile_t *src_profile,

    cmm_profile_t *des_profile, gsicc_rendering_param_t *rendering_params)

{

    gsicc_link_t *result;

    int cms_flags = 0;

    memory = memory->non_gc_memory;

    result = (gsicc_link_t*)gs_alloc_byte_array(memory, 1,

        sizeof(gsicc_link_t), "gsicc_alloc_link_dev");

    if (result == NULL)

        return NULL;

    result->lock = gx_monitor_label(gx_monitor_alloc(memory),

        "gsicc_link_new");

    if (result->lock == NULL) {

        gs_free_object(memory, result, "gsicc_alloc_link(lock)");

        return NULL;

    }

    gx_monitor_enter(result->lock);

    /* set up placeholder values */

    result->is_monitored = false;

    result->orig_procs.map_buffer = NULL;

    result->orig_procs.map_color = NULL;

    result->orig_procs.free_link = NULL;

    result->next = NULL;

    result->link_handle = NULL;

    result->icc_link_cache = NULL;

    result->procs.map_buffer = gscms_transform_color_buffer;

    result->procs.map_color = gscms_transform_color;

    result->procs.free_link = gscms_release_link;

    result->hashcode.link_hashcode = 0;

    result->hashcode.des_hash = 0;

    result->hashcode.src_hash = 0;

    result->hashcode.rend_hash = 0;

    result->ref_count = 1;

    result->includes_softproof = 0;

    result->includes_devlink = 0;

    result->is_identity = false;

    result->valid = true;

    result->memory = memory;

    if_debug1m('^', result->memory, "[^]icclink "PRI_INTPTR" init = 1\n",

               (intptr_t)result);

    if (src_profile->profile_handle == NULL) {

        src_profile->profile_handle = gsicc_get_profile_handle_buffer(

            src_profile->buffer, src_profile->buffer_size, memory);

    }

    if (des_profile->profile_handle == NULL) {

        des_profile->profile_handle = gsicc_get_profile_handle_buffer(

            des_profile->buffer, des_profile->buffer_size, memory);

    }

    /* Check for problems.. */

    if (src_profile->profile_handle == 0 || des_profile->profile_handle == 0) {

        gs_free_object(memory, result, "gsicc_alloc_link_dev");

        return NULL;

    }

    /* [0] is chunky, littleendian, noalpha, 16-in, 16-out */

    result->link_handle = gscms_get_link(src_profile->profile_handle,

        des_profile->profile_handle, rendering_params, cms_flags,

        memory);

    /* Check for problems.. */

    if (result->link_handle == NULL) {

        gs_free_object(memory, result, "gsicc_alloc_link_dev");

        return NULL;

    }

    /* Check for identity transform */

    if (gsicc_get_hash(src_profile) == gsicc_get_hash(des_profile))

        result->is_identity = true;

    /* Set the rest */

    result->data_cs = src_profile->data_cs;

    result->num_input = src_profile->num_comps;

    result->num_output = des_profile->num_comps;

    return result;

}

/* And the related release of the link */

void

gsicc_free_link_dev(gsicc_link_t *link)

{

    if (link == NULL)

        return;

    link->procs.free_link(link);

    gs_free_object(link->memory, link, "gsicc_free_link_dev");

}

static gsicc_link_t *

gsicc_alloc_link(gs_memory_t *memory, gsicc_hashlink_t hashcode)

{

    gsicc_link_t *result;

    /* The link has to be added in stable memory. We want them

       to be maintained across the gsave and grestore process */

    memory = memory->stable_memory;

    result = gs_alloc_struct(memory, gsicc_link_t, &st_icc_link,

                             "gsicc_alloc_link");

    if (result == NULL)

        return NULL;

    /* set up placeholder values */

    result->is_monitored = false;

    result->orig_procs.map_buffer = NULL;

    result->orig_procs.map_color = NULL;

    result->orig_procs.free_link = NULL;

    result->next = NULL;

    result->link_handle = NULL;

    result->procs.map_buffer = gscms_transform_color_buffer;

    result->procs.map_color = gscms_transform_color;

    result->procs.free_link = gscms_release_link;

    result->hashcode.link_hashcode = hashcode.link_hashcode;

    result->hashcode.des_hash = 0;

    result->hashcode.src_hash = 0;

    result->hashcode.rend_hash = 0;

    result->ref_count = 1;    /* prevent it from being freed */

    result->includes_softproof = 0;

    result->includes_devlink = 0;

    result->is_identity = false;

    result->valid = false;   /* not yet complete */

    result->memory = memory;

    result->lock = gx_monitor_label(gx_monitor_alloc(memory),

                                    "gsicc_link_new");

    if (result->lock == NULL) {

        gs_free_object(memory, result, "gsicc_alloc_link(lock)");

        return NULL;

    }

    gx_monitor_enter(result->lock);     /* this link is owned by this thread until built and made "valid" */

    if_debug1m('^', result->memory, "[^]icclink "PRI_INTPTR" init = 1\n",

               (intptr_t)result);

    return result;

}

static void

gsicc_set_link_data(gsicc_link_t *icc_link, void *link_handle,

                    gsicc_hashlink_t hashcode, gx_monitor_t *lock,

                    bool includes_softproof, bool includes_devlink,

                    bool pageneutralcolor, gsicc_colorbuffer_t data_cs)

{

    gx_monitor_enter(lock);   /* lock the cache while changing data */

    icc_link->link_handle = link_handle;

    gscms_get_link_dim(link_handle, &(icc_link->num_input), &(icc_link->num_output),

        icc_link->memory);

    icc_link->hashcode.link_hashcode = hashcode.link_hashcode;

    icc_link->hashcode.des_hash = hashcode.des_hash;

    icc_link->hashcode.src_hash = hashcode.src_hash;

    icc_link->hashcode.rend_hash = hashcode.rend_hash;

    icc_link->includes_softproof = includes_softproof;

    icc_link->includes_devlink = includes_devlink;

    if ( (hashcode.src_hash == hashcode.des_hash) &&

          !includes_softproof && !includes_devlink) {

        icc_link->is_identity = true;

    } else {

        icc_link->is_identity = false;

    }

    /* Set up for monitoring */

    icc_link->data_cs = data_cs;

    if (pageneutralcolor)

        gsicc_mcm_set_link(icc_link);

    /* release the lock of the link so it can now be used */

    icc_link->valid = true;

    gx_monitor_leave(icc_link->lock);

    gx_monitor_leave(lock); /* done with updating, let everyone run */

}

static void

gsicc_link_free_contents(gsicc_link_t *icc_link)

{

    icc_link->procs.free_link(icc_link);

    gx_monitor_free(icc_link->lock);

    icc_link->lock = NULL;

}

void

gsicc_link_free(gsicc_link_t *icc_link)

{

    if (icc_link == NULL)

        return;

    gsicc_link_free_contents(icc_link);

    gs_free_object(icc_link->memory, icc_link, "gsicc_link_free");

}

void

icc_link_finalize(const gs_memory_t *mem, void *ptr)

{

    gsicc_link_t *icc_link = (gsicc_link_t * ) ptr;

    gsicc_link_free_contents(icc_link);

}

static void

gsicc_mash_hash(gsicc_hashlink_t *hash)

{

    hash->link_hashcode =

        (hash->des_hash >> 1) ^ (hash->rend_hash) ^ (hash->src_hash);

}

static void

gsicc_set_hash(cmm_profile_t *profile)

{

    if (!profile->hash_is_valid) {

        int64_t hash;

        gsicc_get_icc_buff_hash(profile->buffer, &hash, profile->buffer_size);

        profile->hashcode = hash;

        profile->hash_is_valid = true;

    }

    return;

}

int64_t

gsicc_get_hash(cmm_profile_t *profile)

{

    if (!profile->hash_is_valid) {

        int64_t hash;

        gsicc_get_icc_buff_hash(profile->buffer, &hash, profile->buffer_size);

        profile->hashcode = hash;

        profile->hash_is_valid = true;

    }

    return profile->hashcode;

}

bool

gsicc_profiles_equal(cmm_profile_t *profile1, cmm_profile_t *profile2) {

    if (profile1 == NULL || profile2 == NULL)

        return false;

    if (!(profile1->hash_is_valid)) {

        gsicc_set_hash(profile1);

    }

    if (!(profile1->hash_is_valid)) {

        gsicc_set_hash(profile2);

    }

    return profile1->hashcode == profile2->hashcode;

}

void

gsicc_get_icc_buff_hash(unsigned char *buffer, int64_t *hash, unsigned int buff_size)

{

    gsicc_get_buff_hash(buffer, hash, buff_size);

}

static void

gsicc_get_buff_hash(unsigned char *data, int64_t *hash, unsigned int num_bytes)

{

    gs_md5_state_t md5;

    byte digest[16];

    int k;

    uint64_t word1,word2,shift;

   /* We could probably do something faster than this. But use this for now. */

    gs_md5_init(&md5);

    gs_md5_append(&md5, data, num_bytes);

    gs_md5_finish(&md5, digest);

    /* For now, xor this into 64 bit word */

    word1 = 0;

    word2 = 0;

    shift = 0;

    /* need to do it this way because of

       potential word boundary issues */

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

       word1 += ((uint64_t) digest[k]) << shift;

       word2 += ((uint64_t) digest[k+8]) << shift;

       shift += 8;

    }

    *hash = word1 ^ word2;

}

/* Compute a hash code for the current transformation case.

    This just computes a 64bit xor of upper and lower portions of

    md5 for the input, output

    and rendering params structure.  We may change this later */

static int

gsicc_compute_linkhash(gsicc_manager_t *icc_manager, gx_device *dev,

                       cmm_profile_t *input_profile,

                       cmm_profile_t *output_profile,

                       gsicc_rendering_param_t *rendering_params,

                       gsicc_hashlink_t *hash)

{

    int code;

    /* first get the hash codes for the color spaces */

    code = gsicc_get_cspace_hash(icc_manager, dev, input_profile,

                                 &(hash->src_hash));

    if (code < 0)

        return code;

    code = gsicc_get_cspace_hash(icc_manager, dev, output_profile,

                                 &(hash->des_hash));

    if (code < 0)

        return code;

    /* now for the rendering paramaters, just use the word itself.  At this

       point in time, we only include the black point setting, the intent

       and if we are preserving black.  We don't differentiate at this time

       with object type since the current CMM does not create different

       links based upon this type setting.  Other parameters such as cmm

       and override ICC are used prior to a link creation and so should also

       not factor into the link hash calculation */

    hash->rend_hash = ((rendering_params->black_point_comp) << BP_SHIFT) +

                      ((rendering_params->rendering_intent) << REND_SHIFT) +

                      ((rendering_params->preserve_black) << PRESERVE_SHIFT);

    /* for now, mash all of these into a link hash */

    gsicc_mash_hash(hash);

    return 0;

}

static int

gsicc_get_cspace_hash(gsicc_manager_t *icc_manager, gx_device *dev,

                      cmm_profile_t *cmm_icc_profile_data, int64_t *hash)

{

    cmm_dev_profile_t *dev_profile;

    cmm_profile_t *icc_profile;

    gsicc_rendering_param_t render_cond;

    int code;

    if (cmm_icc_profile_data == NULL)

    {

        if (dev == NULL)

            return -1;

        code = dev_proc(dev, get_profile)(dev, &dev_profile);

        if (code < 0)

            return code;

        gsicc_extract_profile(dev->graphics_type_tag, dev_profile,

            &(icc_profile), &render_cond);

        *hash = icc_profile->hashcode;

        return 0;

    }

    if (cmm_icc_profile_data->hash_is_valid ) {

        *hash = cmm_icc_profile_data->hashcode;

    } else {

        /* We need to compute for this color space */

        gsicc_get_icc_buff_hash(cmm_icc_profile_data->buffer, hash,

                                cmm_icc_profile_data->buffer_size);

        cmm_icc_profile_data->hashcode = *hash;

        cmm_icc_profile_data->hash_is_valid = true;

    }

    return 0;

}

gsicc_link_t*

gsicc_findcachelink(gsicc_hashlink_t hash, gsicc_link_cache_t *icc_link_cache,

                    bool includes_proof, bool includes_devlink)

{

    gsicc_link_t *curr, *prev;

    int64_t hashcode = hash.link_hashcode;

    int cache_loop = 0;

    /* Look through the cache for the hashcode */

    gx_monitor_enter(icc_link_cache->lock);

    /* List scanning is fast, so we scan the entire list, this includes   */

    /* links that are currently unused, but still in the cache (zero_ref) */

    curr = icc_link_cache->head;

    prev = NULL;

    while (curr != NULL ) {

        if (curr->hashcode.link_hashcode == hashcode &&

            includes_proof == curr->includes_softproof &&

            includes_devlink == curr->includes_devlink) {

            /* move this one to the front of the list hoping we will use it

               again soon */

            if (prev != NULL) {

                /* if prev == NULL, curr is already the head */

                prev->next = curr->next;

                curr->next = icc_link_cache->head;

                icc_link_cache->head = curr;

            }

            /* bump the ref_count since we will be using this one */

            curr->ref_count++;

            if_debug3m('^', curr->memory, "[^]%s "PRI_INTPTR" ++ => %d\n",

                       "icclink", (intptr_t)curr, curr->ref_count);

            while (curr->valid == false) {

                gx_monitor_leave(icc_link_cache->lock); /* exit to let other threads run briefly */

                if (cache_loop > ICC_CACHE_NOT_VALID_COUNT) {

                    /* Clearly something is wrong.  Return NULL.

                       File a bug report. */

                    emprintf(curr->memory, "Reached maximum invalid counts \n");

                    return NULL;

                }

                cache_loop++;

                gx_monitor_enter(curr->lock);     /* wait until we can acquire the lock */

                gx_monitor_leave(curr->lock);     /* it _should be valid now */

                /* If it is still not valid, but we were able to lock, it means that the thread */

                /* that was building it failed to be able to complete building it.  Try this only

                   a limited number of times before we bail. */

                if (curr->valid == false) {

                if_debug1m(gs_debug_flag_icc, curr->memory, "link "PRI_INTPTR" lock released, but still not valid.\n", (intptr_t)curr); /* Breakpoint here */

                }

                gx_monitor_enter(icc_link_cache->lock); /* re-enter to loop and check */

            }

            gx_monitor_leave(icc_link_cache->lock);

            return curr; /* success */

        }

        prev = curr;

        curr = curr->next;

    }

    gx_monitor_leave(icc_link_cache->lock);

    return NULL;

}

/* Remove link from cache.  Notify CMS and free */

static void

gsicc_remove_link(gsicc_link_t *link)

{

    gsicc_link_t *curr, *prev;

    gsicc_link_cache_t *icc_link_cache = link->icc_link_cache;

    if_debug2m(gs_debug_flag_icc, link->memory,

               "[icc] Removing link = "PRI_INTPTR" memory = "PRI_INTPTR"\n",

               (intptr_t)link, (intptr_t)link->memory);

    /* NOTE: link->ref_count must be 0: assert ? */

    gx_monitor_enter(icc_link_cache->lock);

    if (link->ref_count != 0) {

      if_debug2m(gs_debug_flag_icc, link->memory, "link at "PRI_INTPTR" being removed, but has ref_count = %d\n", (intptr_t)link, link->ref_count);

    }

    curr = icc_link_cache->head;

    prev = NULL;

    while (curr != NULL ) {

        /* don't get rid of it if another thread has decided to use it */

        if (curr == link && link->ref_count == 0) {

            /* remove this one from the list */

            if (prev == NULL)

                icc_link_cache->head = curr->next;

            else

                prev->next = curr->next;

            break;

        }

        prev = curr;

        curr = curr->next;

    }

    /* if curr != link we didn't find it or another thread may have decided to */

    /* use it (ref_count > 0). Skip freeing it if so.                          */

    if (curr == link && link->ref_count == 0) {

        icc_link_cache->num_links--;  /* no longer in the cache */

        if (icc_link_cache->cache_full) {

            icc_link_cache->cache_full = false;

            gx_semaphore_signal(icc_link_cache->full_wait);  /* let a waiting thread run */

        }

        gx_monitor_leave(icc_link_cache->lock);

        gsicc_link_free(link);  /* outside link cache now. */

    } else {

        /* even if we didn't find the link to remove, unlock the cache */

        gx_monitor_leave(icc_link_cache->lock);

    }

}

static void

gsicc_get_srcprofile(gsicc_colorbuffer_t data_cs,

    gs_graphics_type_tag_t graphics_type_tag,

    cmm_srcgtag_profile_t *srcgtag_profile, cmm_profile_t **profile,

    gsicc_rendering_param_t *render_cond)

{

    (*profile) = NULL;

    (*render_cond).rendering_intent = gsPERCEPTUAL;

    (*render_cond).cmm = gsCMM_DEFAULT;

    switch (graphics_type_tag & ~GS_DEVICE_ENCODES_TAGS) {

    case GS_UNKNOWN_TAG:

    case GS_UNTOUCHED_TAG:

    default:

        break;

    case GS_VECTOR_TAG:

        if (data_cs == gsRGB) {

            (*profile) = srcgtag_profile->rgb_profiles[gsSRC_GRAPPRO];

            *render_cond = srcgtag_profile->rgb_rend_cond[gsSRC_GRAPPRO];

        }

        else if (data_cs == gsCMYK) {

            (*profile) = srcgtag_profile->cmyk_profiles[gsSRC_GRAPPRO];

            *render_cond = srcgtag_profile->cmyk_rend_cond[gsSRC_GRAPPRO];

        }

        else if (data_cs == gsGRAY) {

            (*profile) = srcgtag_profile->gray_profiles[gsSRC_GRAPPRO];

            *render_cond = srcgtag_profile->gray_rend_cond[gsSRC_GRAPPRO];

        }

        break;

    case GS_IMAGE_TAG:

        if (data_cs == gsRGB) {

            (*profile) = srcgtag_profile->rgb_profiles[gsSRC_IMAGPRO];

            *render_cond = srcgtag_profile->rgb_rend_cond[gsSRC_IMAGPRO];

        }

        else if (data_cs == gsCMYK) {

            (*profile) = srcgtag_profile->cmyk_profiles[gsSRC_IMAGPRO];

            *render_cond = srcgtag_profile->cmyk_rend_cond[gsSRC_IMAGPRO];

        }

        else if (data_cs == gsGRAY) {

            (*profile) = srcgtag_profile->gray_profiles[gsSRC_IMAGPRO];

            *render_cond = srcgtag_profile->gray_rend_cond[gsSRC_IMAGPRO];

        }

        break;

    case GS_TEXT_TAG:

        if (data_cs == gsRGB) {

            (*profile) = srcgtag_profile->rgb_profiles[gsSRC_TEXTPRO];

            *render_cond = srcgtag_profile->rgb_rend_cond[gsSRC_TEXTPRO];

        }

        else if (data_cs == gsCMYK) {

            (*profile) = srcgtag_profile->cmyk_profiles[gsSRC_TEXTPRO];

            *render_cond = srcgtag_profile->cmyk_rend_cond[gsSRC_TEXTPRO];

        }

        else if (data_cs == gsGRAY) {

            (*profile) = srcgtag_profile->gray_profiles[gsSRC_TEXTPRO];

            *render_cond = srcgtag_profile->gray_rend_cond[gsSRC_TEXTPRO];

        }

        break;

    }

}

gsicc_link_t*

gsicc_get_link(const gs_gstate *pgs, gx_device *dev,

               const gs_color_space *pcs_in,

               gs_color_space *output_colorspace,

               gsicc_rendering_param_t *rendering_params, gs_memory_t *memory)

{

    cmm_profile_t *gs_input_profile;

    cmm_profile_t *gs_srcgtag_profile = NULL;

    cmm_profile_t *gs_output_profile;

    gsicc_rendering_param_t render_cond;

    cmm_dev_profile_t *dev_profile;

    int code;

    bool devicegraytok;

    gs_color_space *input_colorspace = (gs_color_space*) pcs_in;

    if (dev == NULL) {

        /* This only occurs for the other (non-ps/pdf) interpreters */

        dev = pgs->device;

    }

    if (input_colorspace->cmm_icc_profile_data == NULL) {

        if (input_colorspace->icc_equivalent != NULL) {

            gs_input_profile = input_colorspace->icc_equivalent->cmm_icc_profile_data;

        } else {

            /* Use default type */

            gs_input_profile = gsicc_get_gscs_profile(input_colorspace,

                                                      pgs->icc_manager);

        }

    } else {

        gs_input_profile = input_colorspace->cmm_icc_profile_data;

    }

    code = dev_proc(dev, get_profile)(dev,  &dev_profile);

    if (code < 0)

        return NULL;

    /* If present, use an graphic object defined source profile */

    if (pgs->icc_manager != NULL &&

        pgs->icc_manager->srcgtag_profile != NULL) {

            /* This is to do with 'object' based colour management which allows the user to

             * selectively disable (or override) colour management based on the colour space

             * and object type. The problem is that the profile data_cs is not what we'd expect

             * for CIEBased input, so we need to check an additional member. See Bug #706789.

             */

            if ((gs_input_profile->data_cs == gsRGB

                || gs_input_profile->data_cs == gsCMYK

                || gs_input_profile->data_cs == gsGRAY) && gs_input_profile->default_match < CIE_A) {

                gsicc_get_srcprofile(gs_input_profile->data_cs,

                                      dev->graphics_type_tag,

                                      pgs->icc_manager->srcgtag_profile,

                                      &(gs_srcgtag_profile), &render_cond);

                if (gs_srcgtag_profile != NULL) {

                    /* In this case, the user is letting the source profiles

                       drive the color management.  Let that set the

                       rendering intent and blackpoint compensation also as they

                       must know what they are doing.  However, before we do

                       this we need to check if they want to overide

                       embedded source profiles.   See if our profile is a

                       default one that came from DefaultRGB or DefaultCMYK

                       for example */

                    int csi;

                    csi = gsicc_get_default_type(gs_input_profile);

                    if (render_cond.override_icc ||

                        csi == gs_color_space_index_DeviceRGB ||

                        csi == gs_color_space_index_DeviceCMYK ||

                        csi == gs_color_space_index_DeviceGray) {

                        gs_input_profile = gs_srcgtag_profile;

                        (*rendering_params) = render_cond;

                    }

                    /* We also need to worry about the case when the source

                       profile is actually a device link profile.  In this case

                       we can go ahead now and the our link transform as we

                       don't need to worry about a destination profile.

                       However, it is possible that someone could do another

                       device link profile associated with the device. */

                    if (gs_input_profile->isdevlink) {

                        /* OK. Go ahead and use this one.  Note output profile

                           is not NULL so that we can compute a hash with out

                           special conditional logic */

                        rendering_params->rendering_intent =

                            render_cond.rendering_intent & gsRI_MASK;

                        rendering_params->black_point_comp =

                            render_cond.black_point_comp & gsBP_MASK;

                            return gsicc_get_link_profile(pgs, dev, gs_input_profile,

                                             dev_profile->device_profile[GS_DEFAULT_DEVICE_PROFILE],

                                             rendering_params, memory, false);

                    }

                } else {

                    /* In this case we may be wanting for a "unmanaged color"

                       result. This is done by specifying "None" on the

                       particular line for that source object.  Check if this

                       is what is desired.  If it is, then return the link now.

                       Also need to worry about the replace case */

                    if (render_cond.cmm == gsCMM_NONE) {

                        gsicc_link_t *link;

                        link = gsicc_nocm_get_link(pgs, dev, gs_input_profile->num_comps);

                        /* Set the identity case if we are in that situation */

                        if (link != NULL) {

                            if (gs_input_profile->num_comps ==

                                dev_profile->device_profile[GS_DEFAULT_DEVICE_PROFILE]->num_comps) {

                                link->is_identity = true;

                            }

                            return link;

                        }

                    } else if (render_cond.cmm == gsCMM_REPLACE) {

                        return gsicc_rcm_get_link(pgs, dev,

                                                  gs_input_profile->data_cs);

                        /* Note that there is never an identity case  */

                    }

                }

            }

    }

    if (output_colorspace != NULL) {

        gs_output_profile = output_colorspace->cmm_icc_profile_data;

        devicegraytok = false;

    } else {

        /* Check for unmanaged color case */

        if (gsicc_use_fast_color(gs_input_profile) > 0 && dev_profile->usefastcolor) {

            /* Return a "link" from the source space to the device color space */

            gsicc_link_t *link = gsicc_nocm_get_link(pgs, dev,

                                                     gs_input_profile->num_comps);

            if (link != NULL) {

                if (gs_input_profile->num_comps ==

                    dev_profile->device_profile[GS_DEFAULT_DEVICE_PROFILE]->num_comps) {

                    link->is_identity = true;

                }

                return link;

            }

        }

        /* Use the device profile. Only use the rendering intent if it has

           an override setting.  Also, only use the blackpoint if overide_bp

           is set. Note that this can conflict with intents set from the source

           objects so the user needs to understand what options to set. */

        gsicc_extract_profile(dev->graphics_type_tag, dev_profile,

                               &(gs_output_profile), &render_cond);

        /* Check if the incoming rendering intent was source based

           (this can occur for high level images in the clist) in

           that case we need to use the source ri and not the device one */

        if (!(rendering_params->rendering_intent & gsRI_OVERRIDE)) {

            /* No it was not.  Check if our device profile RI was specified */

            if (render_cond.rendering_intent != gsRINOTSPECIFIED) {

                rendering_params->rendering_intent = render_cond.rendering_intent;

            }

        }

        /* Similar for the black point compensation */

        if (!(rendering_params->black_point_comp & gsBP_OVERRIDE)) {

            if (render_cond.black_point_comp != gsBPNOTSPECIFIED) {

                rendering_params->black_point_comp = render_cond.black_point_comp;

            }

        }

        /* And the Black preservation */

        if (!(rendering_params->preserve_black & gsKP_OVERRIDE)) {

            if (render_cond.preserve_black != gsBKPRESNOTSPECIFIED) {

                rendering_params->preserve_black = render_cond.preserve_black;

            }

        }

        devicegraytok = dev_profile->devicegraytok;

    }

    /* If we are going from DeviceGray to DeviceCMYK and devicegraytok

       is true then use the ps_gray and ps_cmyk profiles instead of these

       profiles */

    rendering_params->rendering_intent = rendering_params->rendering_intent & gsRI_MASK;

    rendering_params->black_point_comp = rendering_params->black_point_comp & gsBP_MASK;

    rendering_params->preserve_black = rendering_params->preserve_black & gsKP_MASK;

    return gsicc_get_link_profile(pgs, dev, gs_input_profile, gs_output_profile,

                    rendering_params, memory, devicegraytok);

}

/* This operation of adding in a new link entry is actually shared amongst

   different functions that can each add an entry.  For example, entrys may

   come from the CMM or they may come from the non color managed approach

   (i.e. gsicc_nocm_get_link)

   Returns true if link was found with that has, false if alloc fails.

*/

bool

gsicc_alloc_link_entry(gsicc_link_cache_t *icc_link_cache,

                       gsicc_link_t **ret_link, gsicc_hashlink_t hash,

                       bool include_softproof, bool include_devlink)

{

    gs_memory_t *cache_mem = icc_link_cache->memory;

    gsicc_link_t *link;

    int retries = 0;

    assert(cache_mem == cache_mem->stable_memory);

    *ret_link = NULL;

    /* First see if we can add a link */

    /* TODO: this should be based on memory usage, not just num_links */

    gx_monitor_enter(icc_link_cache->lock);

    while (icc_link_cache->num_links >= ICC_CACHE_MAXLINKS) {

        /* Look through the cache for first zero ref count to re-use that entry.

           When ref counts go to zero, the icc_link will have been moved to

           the end of the list, so the first we find is the 'oldest'.

           If we get to the last entry we release the lock, set the cache_full

           flag and wait on full_wait for some other thread to let this thread

           run again after releasing a cache slot. Release the cache lock to

           let other threads run and finish with (release) a cache entry.

        */

        link = icc_link_cache->head;

        while (link != NULL ) {

            if (link->ref_count == 0) {

                /* we will use this one */

                if_debug3m('^', cache_mem, "[^]%s "PRI_INTPTR" ++ => %d\n",

                           "icclink", (intptr_t)link, link->ref_count);

                break;

            }

            link = link->next;

        }

        if (link == NULL) {

            icc_link_cache->cache_full = true;

            /* unlock while waiting for a link to come available */

            gx_monitor_leave(icc_link_cache->lock);

            gx_semaphore_wait(icc_link_cache->full_wait);

            /* repeat the findcachelink to see if some other thread has */

            /* already started building the link we need    */

            *ret_link = gsicc_findcachelink(hash, icc_link_cache,

                                            include_softproof, include_devlink);

            /* Got a hit, return link. ref_count for the link was already bumped */

            if (*ret_link != NULL)

                return true;

            gx_monitor_enter(icc_link_cache->lock);     /* restore the lock */

            /* we will re-test the num_links above while locked to insure */

            /* that some other thread didn't grab the slot and max us out */

            if (retries++ > 10)

                return false;

        } else {

            /* Remove the zero ref_count link profile we found.   */

            /* Even if we remove this link, we may still be maxed out so*/

            /* the outermost 'while' will check to make sure some other */

            /* thread did not grab the one we remove.     */

            gsicc_remove_link(link);

        }

    }

    /* insert an empty link that we will reserve so we can unlock while */

    /* building the link contents. If successful, the entry will set  */

    /* the hash for the link, Set valid=false, and lock the profile     */

    (*ret_link) = gsicc_alloc_link(cache_mem, hash);

    /* NB: the link returned will be have the lock owned by this thread */

    /* the lock will be released when the link becomes valid.           */

    if (*ret_link) {

        (*ret_link)->icc_link_cache = icc_link_cache;

        (*ret_link)->next = icc_link_cache->head;

        icc_link_cache->head = *ret_link;

        icc_link_cache->num_links++;

    }

    /* unlock before returning */

    gx_monitor_leave(icc_link_cache->lock);

    return false; /* we didn't find it, but return a link to be filled */

}

/* This is the main function called to obtain a linked transform from the ICC

   cache If the cache has the link ready, it will return it.  If not, it will

   request one from the CMS and then return it.  We may need to do some cache

   locking during this process to avoid multi-threaded issues (e.g. someone

   deleting while someone is updating a reference count).  Note that if the

   source profile is a device link profile we have no output profile but