eccodes/src/grib_accessor_class.c

/*
 * Copyright 2005-2018 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
 * virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
 */

#include "grib_api_internal.h"
#include "grib_accessor_classes_hash.c"
/*     grib level     */


/* This file is generated by ./make_class.pl */
#include "grib_accessor_class.h"

#if GRIB_PTHREADS
static pthread_once_t once  = PTHREAD_ONCE_INIT;
static pthread_mutex_t mutex1 = PTHREAD_MUTEX_INITIALIZER;

static void init() {
    pthread_mutexattr_t attr;
    pthread_mutexattr_init(&attr);
    pthread_mutexattr_settype(&attr,PTHREAD_MUTEX_RECURSIVE);
    pthread_mutex_init(&mutex1,&attr);
    pthread_mutexattr_destroy(&attr);

}
#elif GRIB_OMP_THREADS
static int once = 0;
static omp_nest_lock_t mutex1;

static void init()
{
    GRIB_OMP_CRITICAL(lock_grib_accessor_class_c)
    {
        if (once == 0)
        {
            omp_init_nest_lock(&mutex1);
            once = 1;
        }
    }
}
#endif

struct table_entry
{
    char                  *type;
    grib_accessor_class   **cclass;
};

/* Note: A fast cut-down version of strcmp which does NOT return -1 */
/* 0 means input strings are equal and 1 means not equal */
static GRIB_INLINE int grib_inline_strcmp(const char* a,const char* b)
{
    if (*a != *b) return 1;
    while((*a!=0 && *b!=0) &&  *(a) == *(b) ) {a++;b++;}
    return (*a==0 && *b==0) ? 0 : 1;
}

static struct table_entry table[] =
{
/* This file is generated by ./make_class.pl */
#include "grib_accessor_factory.h"
};

#define NUMBER(x) (sizeof(x)/sizeof(x[0]))

grib_section* grib_create_root_section(const grib_context *context, grib_handle *h)
{
    char* fpath=0;
    grib_section*   s   = (grib_section*) grib_context_malloc_clear(context,sizeof(grib_section));

    GRIB_MUTEX_INIT_ONCE(&once,&init);
    GRIB_MUTEX_LOCK(&mutex1);
    if(h->context->grib_reader == NULL) {
        if ((fpath=grib_context_full_defs_path(h->context,"boot.def"))==NULL) {
            grib_context_log(h->context,GRIB_LOG_FATAL,
                    "Unable to find boot.def. Context path=%s\n"
                    "\nPossible causes:\n"
                    "- The software is not correctly installed\n"
                    "- The environment variable ECCODES_DEFINITION_PATH is defined but incorrect\n",
                    context->grib_definition_files_path);
        }
        grib_parse_file(h->context,fpath);
    }
    GRIB_MUTEX_UNLOCK(&mutex1);

    s->h = h;
    s->aclength = NULL;
    s->owner    = NULL;
    s->block    = (grib_block_of_accessors*)
                    grib_context_malloc_clear(context, sizeof(grib_block_of_accessors));
    grib_context_log(context, GRIB_LOG_DEBUG, "Creating root section");
    return s;
}

static GRIB_INLINE grib_accessor_class* get_class(grib_context* c,char* type)
{
    int i;
    int table_count = 0;
    grib_accessor_class** the_class=NULL;

    if ( (the_class=(grib_accessor_class**)grib_trie_get(c->classes,type))!=NULL)
        return *(the_class);

    table_count = NUMBER(table);
    for(i = 0; i < table_count ; i++) {
        if( grib_inline_strcmp(type,table[i].type) == 0 )
        {
            grib_trie_insert(c->classes,type,table[i].cclass);
            return *(table[i].cclass);
        }
    }
    grib_context_log(c, GRIB_LOG_ERROR, "ecCodes Version: %s\nDefinition files path: %s\n",
            ECCODES_VERSION_STR, c->grib_definition_files_path);
    grib_context_log(c,GRIB_LOG_FATAL,"unable to create class %s",type);
    return NULL;
}

grib_accessor* grib_accessor_factory(grib_section* p, grib_action* creator,
        const long len, grib_arguments* params)
{
    grib_accessor_class* c=NULL;
    grib_accessor* a=NULL;
    size_t size=0;

    /* Using the TRIE:
     *   c = get_class(p->h->context,creator->op);
     */
    /* Use the hash table from gperf */
    c=*((grib_accessor_classes_hash(creator->op,strlen(creator->op)))->cclass);

    a = (grib_accessor*) grib_context_malloc_clear(p->h->context,c->size);

    a->name                = creator->name;
    a->name_space          = creator->name_space;

    a->all_names[0]        = creator->name;
    a->all_name_spaces[0]  = creator->name_space;

    a->creator             = creator;
    a->context             = p->h->context;
    a->h                   = NULL;
    a->next                = NULL;
    a->previous            = NULL;
    a->parent              = p;
    a->length              = 0 ;
    a->offset              = 0;
    a->flags               = creator->flags;
    a->set					= creator->set;

    if(p->block->last)	{
        a->offset           = grib_get_next_position_offset(p->block->last);
#if 0
        printf("offset: p->block->last %s %s %ld %ld\n",
                p->block->last->cclass->name,
                p->block->last->name,(long)p->block->last->offset,(long)p->block->last->length);
#endif
    } else {
        if(p->owner)	{
            a->offset         = p->owner->offset;
        } else
            a->offset          = 0;
    }

    a->cclass               = c;

    grib_init_accessor(a, len,  params);
    size = grib_get_next_position_offset(a);

    if(size > p->h->buffer->ulength) {
        if(!p->h->buffer->growable) {
            if(!p->h->partial)
                grib_context_log(p->h->context, GRIB_LOG_ERROR,
                        "Creating (%s)%s of %s at offset %d-%d over message boundary (%d)",
                        p->owner?p->owner->name : "" ,a->name ,
                                creator->op, a->offset,
                                a->offset + a->length,
                                p->h->buffer->ulength);

            grib_accessor_delete(p->h->context,a);
            return NULL;
        } else {
            grib_context_log(p->h->context,GRIB_LOG_DEBUG,
                    "CREATE: name=%s class=%s offset=%ld length=%ld action=",
                    a->name,a->cclass->name,a->offset,a->length);

            grib_grow_buffer(p->h->context,p->h->buffer,size);
            p->h->buffer->ulength = size;
        }
    }

    if(p->owner)
        grib_context_log(p->h->context, GRIB_LOG_DEBUG,
                "Creating (%s)%s of %s at offset %d [len=%d]",
                p->owner->name ,a->name ,creator->op, a->offset,len,p->block);
    else
        grib_context_log(p->h->context, GRIB_LOG_DEBUG,
                "Creating root %s of %s at offset %d [len=%d]",
                a->name ,creator->op, a->offset,len,p->block);

    return a;
}

static void link_same_attributes(grib_accessor* a,grib_accessor* b)
{
    int i=0;
    int idx=0;
    grib_accessor* bAttribute=NULL;
    if (a==NULL || b==NULL) return;
    while (i<MAX_ACCESSOR_ATTRIBUTES && a->attributes[i]) {
        bAttribute=_grib_accessor_get_attribute(b,a->attributes[i]->name,&idx);
        if (bAttribute) a->attributes[i]->same=bAttribute;
        i++;
    }
}

void grib_push_accessor(grib_accessor* a, grib_block_of_accessors* l)
{
    int id;
    grib_handle* hand = grib_handle_of_accessor(a);
    if (!l->first)
        l->first = l->last = a;
    else{
        l->last->next = a;
        a->previous = l->last;
    }
    l->last = a;

    if (hand->use_trie) {
        if (*(a->all_names[0]) != '_') {
            id=grib_hash_keys_get_id(a->context->keys,a->all_names[0]);

            DebugAssert(id >=0 && id < ACCESSORS_ARRAY_SIZE);

            a->same=hand->accessors[id];
            link_same_attributes(a,a->same);
            hand->accessors[id]=a;

            if(a->same == a) {
                fprintf(stderr,"---> %s\n",a->name);
                Assert(a->same != a);
            }
        }
    }
}

void grib_section_post_init(grib_section* s)
{
    grib_accessor* a = s ? s->block->first : NULL;

    while(a )  {
        grib_accessor_class* c=a->cclass;
        if(c->post_init) c->post_init(a);
        if (a->sub_section)
            grib_section_post_init(a->sub_section);
        a = a->next;
    }
}

int grib_section_adjust_sizes(grib_section* s,int update,int depth)
{
    int err = 0;
    grib_accessor* a = s ? s->block->first : NULL;
    size_t length = update ? 0 : (s?s->padding:0);
    size_t offset = (s && s->owner) ? s->owner->offset:0;
    int force_update = update > 1;

    while(a)  {
        register long l;
        /* grib_section_adjust_sizes(grib_get_sub_section(a),update,depth+1); */
        err = grib_section_adjust_sizes(a->sub_section,update,depth+1);
        if (err) return err;
        grib_context_log(a->context,GRIB_LOG_DEBUG,"grib_section_adjust_sizes: %s %ld [len=%ld] (depth=%d)",a->name,(long)a->offset,(long)a->length,depth);

        l = a->length;

        if(offset != a->offset)    {
            grib_context_log(a->context,GRIB_LOG_ERROR,
                    "Offset mismatch %s A->offset %ld offset %ld\n",a->name,(long)a->offset, (long)offset);
            a->offset = offset;
            return GRIB_DECODING_ERROR;
        }
        length += l;
        offset += l;
        a = a->next;
    }

    if(s)
    {
        if(s->aclength)
        {
            size_t  len = 1;
            long plen = 0;
            int lret=grib_unpack_long(s->aclength, &plen, &len);
            Assert( lret == GRIB_SUCCESS);
            /* This happens when there is some padding */
            if((plen != length) || force_update)
            {
                if(update)
                {
                    plen = length;
                    lret=grib_pack_long(s->aclength, &plen, &len);
                    Assert(lret == GRIB_SUCCESS);
                    s->padding = 0;
                }
                else {
                    if(!s->h->partial) {
                        if(length >= plen)
                        {
                            grib_context_log(s->h->context,GRIB_LOG_ERROR,"Invalid size %ld found for %s, assuming %ld",
                                    (long)plen,s->owner->name,(long)length);
                            plen = length;
                        }
                        s->padding = plen - length;
                    }
                    length = plen;
                }
            }
        }

        if(s->owner) {
            grib_context_log(s->owner->context,GRIB_LOG_DEBUG,"grib_section_adjust_sizes: updating owner (%s->length old=%ld new=%ld)",s->owner->name,(long)s->owner->length,(long)length);
            s->owner->length = length;
        }
        s->length = length;
    }
    return err;
}

int grib_get_block_length(grib_section* s, size_t *l)
{
    *l = s->length;
    return GRIB_SUCCESS;
#if 0

    /* TODO: Because grib_pack_long takes a SIGNED value, we may have problems */

    if(s->aclength)
    {
        size_t  len = 1;
        long plen = 0;

        int ret = grib_unpack_long(s->aclength, &plen, &len);
        if(ret == GRIB_SUCCESS && plen != 0)
        {
            *l = plen;
            return GRIB_SUCCESS;
        }
    }

    /* empty block */
    if(s->block->first == NULL)
    {
        *l = 0;
        return GRIB_SUCCESS;
    }
    /* no accessor for block length */
    if(s->owner)
        *l = grib_get_next_position_offset(s->block->last) - s->owner->offset;
    else
        *l = grib_get_next_position_offset(s->block->last);


    if(s->aclength)
    {
        size_t  len = 1;
        long plen = *l;

        int ret = grib_pack_long(s->aclength, &plen, &len);
        if(ret != GRIB_SUCCESS)
            ;
        if(s->h->context->debug)
            printf("SECTION updating length %ld %s\n",plen,s->owner->name);
    }

    /*
     if(s->aclength)
     Assert(*l == plen);*/

    return GRIB_SUCCESS;
#endif
}

grib_accessor* find_paddings(grib_section* s)
{
    grib_accessor* a = s ? s->block->first : NULL;

    while(a)
    {
        /* grib_accessor* p = find_paddings(grib_get_sub_section(a)); */
        grib_accessor* p = find_paddings(a->sub_section);
        if(p) return p;

        if(grib_preferred_size(a,0) != a->length)
            return a;

        a = a->next;
    }

    return NULL;
}

void grib_update_paddings(grib_section* s)
{
    grib_accessor* last = NULL;
    grib_accessor* changed;

    /* while((changed = find_paddings(s)) != NULL) */
    while((changed = find_paddings(s->h->root)) != NULL)
    {
        Assert(changed != last);
        grib_resize(changed,grib_preferred_size(changed,0));
        last = changed;
    }
}