netcdf-c/libdispatch/nclist.c
Dennis Heimbigner 59e04ae071 This PR adds EXPERIMENTAL support for accessing data in the
cloud using a variant of the Zarr protocol and storage
format. This enhancement is generically referred to as "NCZarr".

The data model supported by NCZarr is netcdf-4 minus the user-defined
types and the String type. In this sense it is similar to the CDF-5
data model.

More detailed information about enabling and using NCZarr is
described in the document NUG/nczarr.md and in a
[Unidata Developer's blog entry](https://www.unidata.ucar.edu/blogs/developer/en/entry/overview-of-zarr-support-in).

WARNING: this code has had limited testing, so do use this version
for production work. Also, performance improvements are ongoing.
Note especially the following platform matrix of successful tests:

Platform | Build System | S3 support
------------------------------------
Linux+gcc      | Automake     | yes
Linux+gcc      | CMake        | yes
Visual Studio  | CMake        | no

Additionally, and as a consequence of the addition of NCZarr,
major changes have been made to the Filter API. NOTE: NCZarr
does not yet support filters, but these changes are enablers for
that support in the future.  Note that it is possible
(probable?) that there will be some accidental reversions if the
changes here did not correctly mimic the existing filter testing.

In any case, previously filter ids and parameters were of type
unsigned int. In order to support the more general zarr filter
model, this was all converted to char*.  The old HDF5-specific,
unsigned int operations are still supported but they are
wrappers around the new, char* based nc_filterx_XXX functions.
This entailed at least the following changes:
1. Added the files libdispatch/dfilterx.c and include/ncfilter.h
2. Some filterx utilities have been moved to libdispatch/daux.c
3. A new entry, "filter_actions" was added to the NCDispatch table
   and the version bumped.
4. An overly complex set of structs was created to support funnelling
   all of the filterx operations thru a single dispatch
   "filter_actions" entry.
5. Move common code to from libhdf5 to libsrc4 so that it is accessible
   to nczarr.

Changes directly related to Zarr:
1. Modified CMakeList.txt and configure.ac to support both C and C++
   -- this is in support of S3 support via the awd-sdk libraries.
2. Define a size64_t type to support nczarr.
3. More reworking of libdispatch/dinfermodel.c to
   support zarr and to regularize the structure of the fragments
   section of a URL.

Changes not directly related to Zarr:
1. Make client-side filter registration be conditional, with default off.
2. Hack include/nc4internal.h to make some flags added by Ed be unique:
   e.g. NC_CREAT, NC_INDEF, etc.
3. cleanup include/nchttp.h and libdispatch/dhttp.c.
4. Misc. changes to support compiling under Visual Studio including:
   * Better testing under windows for dirent.h and opendir and closedir.
5. Misc. changes to the oc2 code to support various libcurl CURLOPT flags
   and to centralize error reporting.
6. By default, suppress the vlen tests that have unfixed memory leaks; add option to enable them.
7. Make part of the nc_test/test_byterange.sh test be contingent on remotetest.unidata.ucar.edu being accessible.

Changes Left TO-DO:
1. fix provenance code, it is too HDF5 specific.
2020-06-28 18:02:47 -06:00

287 lines
5.8 KiB
C

/* Copyright 2018, UCAR/Unidata and OPeNDAP, Inc.
See the COPYRIGHT file for more information. */
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "nclist.h"
#ifdef _WIN32
#define strcasecmp _stricmp
#endif
int nclistnull(void* e) {return e == NULL;}
#ifndef TRUE
#define TRUE 1
#endif
#ifndef FALSE
#define FALSE 0
#endif
#define DEFAULTALLOC 16
#define ALLOCINCR 16
NClist* nclistnew(void)
{
NClist* l;
/*
if(!ncinitialized) {
memset((void*)&ncDATANULL,0,sizeof(void*));
ncinitialized = 1;
}
*/
l = (NClist*)malloc(sizeof(NClist));
if(l) {
l->alloc=0;
l->length=0;
l->content=NULL;
}
return l;
}
int
nclistfree(NClist* l)
{
if(l) {
l->alloc = 0;
if(l->content != NULL) {free(l->content); l->content = NULL;}
free(l);
}
return TRUE;
}
/*
Free a list and its contents
*/
int
nclistfreeall(NClist* l)
{
size_t i,len;
void** content = NULL;
if(l == NULL) return TRUE;
len = l->length;
content = nclistextract(l);
for(i=0;i<len;i++) {
void* value = content[i];
if(value != NULL) free(value);
}
if(content != NULL) free(content);
return nclistfree(l);
}
int
nclistsetalloc(NClist* l, size_t sz)
{
void** newcontent = NULL;
if(l == NULL) return FALSE;
if(sz <= 0) {sz = (l->length?2*l->length:DEFAULTALLOC);}
if(l->alloc >= sz) {return TRUE;}
newcontent=(void**)calloc(sz,sizeof(void*));
if(newcontent != NULL && l->alloc > 0 && l->length > 0 && l->content != NULL) {
memcpy((void*)newcontent,(void*)l->content,sizeof(void*)*l->length);
}
if(l->content != NULL) free(l->content);
l->content=newcontent;
l->alloc=sz;
return TRUE;
}
int
nclistsetlength(NClist* l, size_t newlen)
{
if(l == NULL) return FALSE;
if(newlen > l->alloc && !nclistsetalloc(l,newlen)) return FALSE;
if(newlen > l->length) {
/* clear any extension */
memset(&l->content[l->length],0,(newlen - l->length)*sizeof(void*));
}
l->length = newlen;
return TRUE;
}
void*
nclistget(NClist* l, size_t index)
{
if(l == NULL || l->length == 0) return NULL;
if(index >= l->length) return NULL;
return l->content[index];
}
/* Insert at position i of l; will overwrite previous value;
guarantees alloc and length
*/
int
nclistset(NClist* l, size_t index, void* elem)
{
if(l == NULL) return FALSE;
if(!nclistsetalloc(l,index+1)) return FALSE;
if(index >= l->length) {
if(!nclistsetlength(l,index+1)) return FALSE;
}
l->content[index] = elem;
return TRUE;
}
/* Insert at position i of l; will push up elements i..|seq|. */
int
nclistinsert(NClist* l, size_t index, void* elem)
{
long i; /* do not make unsigned */
if(l == NULL) return FALSE;
if(index > l->length) return FALSE;
nclistsetalloc(l,0);
for(i=(long)l->length;i>index;i--) l->content[i] = l->content[i-1];
l->content[index] = elem;
l->length++;
return TRUE;
}
int
nclistpush(NClist* l, const void* elem)
{
if(l == NULL) return FALSE;
if(l->length >= l->alloc) nclistsetalloc(l,0);
l->content[l->length] = (void*)elem;
l->length++;
return TRUE;
}
void*
nclistpop(NClist* l)
{
if(l == NULL || l->length == 0) return NULL;
l->length--;
return l->content[l->length];
}
void*
nclisttop(NClist* l)
{
if(l == NULL || l->length == 0) return NULL;
return l->content[l->length - 1];
}
void*
nclistremove(NClist* l, size_t i)
{
size_t len;
void* elem;
if(l == NULL || (len=l->length) == 0) return NULL;
if(i >= len) return NULL;
elem = l->content[i];
for(i+=1;i<len;i++) l->content[i-1] = l->content[i];
l->length--;
return elem;
}
int
nclistcontains(NClist* l, void* elem)
{
size_t i;
for(i=0;i<nclistlength(l);i++) {
if(elem == nclistget(l,i)) return 1;
}
return 0;
}
/* Return 1/0 */
int
nclistmatch(NClist* l, const char* elem, int casesensitive)
{
size_t i;
for(i=0;i<nclistlength(l);i++) {
const char* candidate = (const char*)nclistget(l,i);
int match;
if(casesensitive)
match = strcmp(elem,candidate);
else
match = strcasecmp(elem,candidate);
if(match == 0) return 1;
}
return 0;
}
/* Remove element by value; only removes first encountered */
int
nclistelemremove(NClist* l, void* elem)
{
size_t len;
size_t i;
int found = 0;
if(l == NULL || (len=l->length) == 0) return 0;
for(i=0;i<nclistlength(l);i++) {
void* candidate = l->content[i];
if(elem == candidate) {
for(i+=1;i<len;i++) l->content[i-1] = l->content[i];
l->length--;
found = 1;
break;
}
}
return found;
}
/* Extends nclist to include a unique operator
which remove duplicate values; NULL values removed
return value is always 1.
*/
int
nclistunique(NClist* l)
{
size_t i,j,k,len;
void** content;
if(l == NULL || l->length == 0) return 1;
len = l->length;
content = l->content;
for(i=0;i<len;i++) {
for(j=i+1;j<len;j++) {
if(content[i] == content[j]) {
/* compress out jth element */
for(k=j+1;k<len;k++) content[k-1] = content[k];
len--;
}
}
}
l->length = len;
return 1;
}
/* Duplicate a list and if deep is true, assume the contents
are char** and duplicate those also */
NClist*
nclistclone(NClist* l, int deep)
{
NClist* clone = NULL;
if(l == NULL) goto done;
clone = nclistnew();
nclistsetalloc(clone,l->length+1); /* make room for final null */
if(!deep) {
nclistsetlength(clone,l->length);
memcpy((void*)clone->content,(void*)l->content,sizeof(void*)*l->length);
} else { /*deep*/
int i;
for(i=0;i<nclistlength(l);i++) {
char* dups = strdup(nclistget(l,i));
if(dups == NULL) {nclistfreeall(clone); clone = NULL; goto done;}
nclistpush(clone,dups);
}
}
clone->content[l->length] = (void*)0;
done:
return clone;
}
void*
nclistextract(NClist* l)
{
void* result = l->content;
l->alloc = 0;
l->length = 0;
l->content = NULL;
return result;
}