/********************************************************************* * Copyright 1993, UCAR/Unidata * See netcdf/COPYRIGHT file for copying and redistribution conditions. * $Header: /upc/share/CVS/netcdf-3/libncdap3/cdf3.c,v 1.33 2009/12/03 03:42:37 dmh Exp $ *********************************************************************/ #include "ncdap3.h" #include "daputil.h" #include "dapdump.h" #ifdef DAPDEBUG extern char* ocfqn(OCddsnode); #endif CDFnode* v4node = NULL; /* Forward*/ static NCerror sequencecheck3r(CDFnode* node, NClist* vars, CDFnode* topseq); static NCerror restruct3r(CDFnode*, CDFnode*, NClist*); static NCerror repairgrids(NClist*); static NCerror structwrap3(CDFnode*, CDFnode*, int, CDFnode*, int); static int findin(CDFnode* parent, CDFnode* child); static CDFnode* makenewstruct3(CDFnode* node, CDFnode* template); static NCerror mapnodes3r(CDFnode*, CDFnode*, int depth); static NCerror mapfcn(CDFnode* dstnode, CDFnode* srcnode); static NCerror definedimsetplus3(NCDAPCOMMON* nccomm, CDFnode* node); static NCerror definedimsetall3(NCDAPCOMMON* nccomm, CDFnode* node); static NCerror definedimsetall3(NCDAPCOMMON* nccomm, CDFnode* node); static NCerror definedimsettrans3(NCDAPCOMMON* nccomm, CDFnode* node); /* Accumulate useful node sets */ NCerror computecdfnodesets3(NCDAPCOMMON* nccomm, CDFtree* tree) { unsigned int i; NClist* varnodes; NClist* allnodes; allnodes = tree->nodes; varnodes = nclistnew(); if(tree->seqnodes == NULL) tree->seqnodes = nclistnew(); if(tree->gridnodes == NULL) tree->gridnodes = nclistnew(); nclistclear(tree->seqnodes); nclistclear(tree->gridnodes); computevarnodes3(nccomm,allnodes,varnodes); nclistfree(tree->varnodes); tree->varnodes = varnodes; varnodes = NULL; /* Now compute other sets of interest */ for(i=0;inctype) { case NC_Sequence: nclistpush(tree->seqnodes,(void*)node); break; case NC_Grid: nclistpush(tree->gridnodes,(void*)node); break; default: break; } } return NC_NOERR; } NCerror computevarnodes3(NCDAPCOMMON* nccomm, NClist* allnodes, NClist* varnodes) { unsigned int i,len; NClist* allvarnodes = nclistnew(); for(i=0;iocname)) { char* newname = dap_repairname(node->ocname); nullfree(node->ocname); node->ocname = newname; } #endif if(node->nctype == NC_Atomic) nclistpush(allvarnodes,(void*)node); } /* Further process the variable nodes to get the final set */ /* Use toplevel vars first */ len = nclistlength(allvarnodes); for(i=0;icontrols,NCF_NCDAP)) nclistpush(varnodes,(void*)node); nclistset(allvarnodes,i,(void*)NULL); } } /*... then all others */ for(i=0;icdf.ddsroot->tree->gridnodes; for(i=0;itree->nodes);i++) { CDFnode* node = (CDFnode*)nclistget(root->tree->nodes,i); node->elided = 0; if(node->nctype == NC_Grid || node->nctype == NC_Dataset) node->elided = 1; } /* ensure all variables have an initial full name defined */ for(i=0;incfullname); var->ncfullname = makecdfpathstring3(var,nccomm->cdf.separator); #ifdef DEBUG2 fprintf(stderr,"var names: %s %s %s\n", var->ocname,var->ncbasename,var->ncfullname); #endif } /* unify all variables with same fullname and dimensions basevar fields says: "for duplicate grid variables"; when does this happen? */ if(FLAGSET(nccomm->controls,NCF_NC3)) { for(i=0;iarray.basevar != NULL) continue; /* already processed */ if(strcmp(var->ncfullname,testnode->ncfullname) != 0) match = 0; else if(nclistlength(testnode->array.dimsetall) != nclistlength(var->array.dimsetall)) match = 0; else for(d=0;darray.dimsetall);d++) { CDFnode* vdim = (CDFnode*)nclistget(var->array.dimsetall,d); CDFnode* tdim = (CDFnode*)nclistget(testnode->array.dimsetall,d); if(vdim->dim.declsize != tdim->dim.declsize) { match = 0; break; } } if(match) { testnode->array.basevar = var; fprintf(stderr,"basevar invoked: %s\n",var->ncfullname); } } } } /* Finally, verify unique names */ for(i=0;iarray.basevar != NULL) continue; for(j=0;jarray.basevar != NULL) continue; if(strcmp(var1->ncfullname,var2->ncfullname)==0) { PANIC1("duplicate var names: %s",var1->ncfullname); } } } return NC_NOERR; } /* locate and connect usable sequences and vars. A sequence is usable iff: 1. it has a path from one of its subnodes to a leaf and that path does not contain a sequence. 2. No parent container has dimensions. */ NCerror sequencecheck3(NCDAPCOMMON* nccomm) { (void)sequencecheck3r(nccomm->cdf.ddsroot, nccomm->cdf.ddsroot->tree->varnodes,NULL); return NC_NOERR; } static NCerror sequencecheck3r(CDFnode* node, NClist* vars, CDFnode* topseq) { unsigned int i; NCerror err = NC_NOERR; int ok = 0; if(topseq == NULL && nclistlength(node->array.dimset0) > 0) { err = NC_EINVAL; /* This container has dimensions, so no sequence within it can be usable */ } else if(node->nctype == NC_Sequence) { /* Recursively walk the path for each subnode of this sequence node looking for a path without any sequence */ for(i=0;isubnodes);i++) { CDFnode* sub = (CDFnode*)nclistget(node->subnodes,i); err = sequencecheck3r(sub,vars,node); if(err == NC_NOERR) ok = 1; /* there is at least 1 usable var below */ } if(topseq == NULL && ok == 1) { /* this sequence is usable because it has scalar container (by construction) and has a path to a leaf without an intermediate sequence. */ err = NC_NOERR; node->usesequence = 1; } else { /* this sequence is unusable because it has no path to a leaf without an intermediate sequence. */ node->usesequence = 0; err = NC_EINVAL; } } else if(nclistcontains(vars,(void*)node)) { /* If we reach a leaf, then topseq is usable, so save it */ node->array.sequence = topseq; } else { /* Some kind of non-sequence container node with no dimensions */ /* recursively compute usability */ for(i=0;isubnodes);i++) { CDFnode* sub = (CDFnode*)nclistget(node->subnodes,i); err = sequencecheck3r(sub,vars,topseq); if(err == NC_NOERR) ok = 1; } err = (ok?NC_NOERR:NC_EINVAL); } return err; } /* Originally, if one did a constraint on a Grid such that only one array or map in the grid was returned, that element was returned as a top level variable. This is incorrect because it loses the Grid scope information. Eventually, this behavior was changed so that such partial grids are converted to structures where the structure name is the grid name. This preserves the proper scoping. However, it is still the case that some servers do the old behavior. The rules that most old-style servers appear to adhere to are these. 1. Asking for just a grid array or a single grid map returns just the array not wrapped in a structure. 2. Asking for a subset of the fields (array plus map) of a grid returns those fields wrapped in a structure. 3. However, there is an odd situation: asking for a grid array plus any subset of maps that includes the last map in the grid returns a malformed grid. This is clearly a bug. For case 1, we insert a structure node so that case 1 is consistent with case 2. Case 3 should cause an error with a malformed grid. [Note: for some reason, this code has been difficult to get right; I have rewritten 6 times and it probably is still not right.] [2/25/2013 Sigh! Previous fixes have introducted another bug, so now we fix the fix.] Input is (1) the root of the dds that needs to be re-gridded (2) the full datadds tree that defines where the grids are. (3) the projections that were used to produce (1) from (2). */ NCerror restruct3(CDFnode* ddsroot, CDFnode* template, NClist* projections) { NCerror ncstat = NC_NOERR; NClist* repairs = nclistnew(); /* The current restruct assumes that the ddsroot tree has missing grids compared to the template. It is also assumed that order of the nodes in the ddsroot is the same as in the template. */ if(ddsroot->tree->restructed) return NC_NOERR; #ifdef DEBUG fprintf(stderr,"restruct: ddsroot=%s\n",dumptree(ddsroot)); fprintf(stderr,"restruct: template=%s\n",dumptree(template)); #endif /* Match roots */ if(!simplenodematch34(ddsroot,template)) ncstat = NC_EDATADDS; else if(!restruct3r(ddsroot,template,repairs)) ncstat = NC_EDATADDS; else if(nclistlength(repairs) > 0) { /* Do the repairs */ ncstat = repairgrids(repairs); } return THROW(ncstat); } /* Locate nodes in the tree rooted at node that correspond to a single grid field in the template when the template is a grid. Wrap that grid field in a synthesized structure. The key thing to look for is the case where we have an atomic variable that appear where we expected a grid. */ static int restruct3r(CDFnode* parentnode, CDFnode* templateparent, NClist* repairlist) { int index, i, j, match; #ifdef DEBUG fprintf(stderr,"restruct: matched: %s -> %s\n", ocfqn(parentnode->ocnode),ocfqn(templateparent->ocnode)); #endif /* walk each node child and locate its match in the template's children; recurse on matches, non-matches may be nodes needing wrapping. */ for(index=0;indexsubnodes);index++) { CDFnode* subnode = (CDFnode*)nclistget(parentnode->subnodes,index); CDFnode* matchnode = NULL; /* Look for a matching template node with same ocname */ for(i=0;isubnodes);i++) { CDFnode* subtemp = (CDFnode*)nclistget(templateparent->subnodes,i); if(strcmp(subnode->ocname,subtemp->ocname) == 0) { matchnode = subtemp; break; } } #ifdef DEBUG fprintf(stderr,"restruct: candidate: %s -> %s\n", ocfqn(subnode->ocnode),ocfqn(matchnode->ocnode)); #endif if(simplenodematch34(subnode,matchnode)) { /* this subnode of the node matches the corresponding node of the template, so it is ok => recurse looking for nested mis-matches */ if(!restruct3r(subnode,matchnode,repairlist)) return 0; } else { /* If we do not have a direct match, then we need to look at all the grids to see if this node matches a field in one of the grids */ for(match=0,i=0;!match && isubnodes);i++) { CDFnode* subtemp = (CDFnode*)nclistget(templateparent->subnodes,i); if(subtemp->nctype == NC_Grid) { /* look inside */ for(j=0;jsubnodes);j++) { CDFnode* gridfield = (CDFnode*)nclistget(subtemp->subnodes,j); if(simplenodematch34(subnode,gridfield)) { /* We need to do this repair */ nclistpush(repairlist,(void*)subnode); nclistpush(repairlist,(void*)gridfield); match = 1; break; } } } } if(!match) return 0; /* we failed */ } } return 1; /* we matched everything at this level */ } /* Wrap the node wrt the template grid or template struct */ static NCerror repairgrids(NClist* repairlist) { NCerror ncstat = NC_NOERR; int i; assert(nclistlength(repairlist) % 2 == 0); for(i=0;icontainer,node); int tindex = findin(template->container,template); ncstat = structwrap3(node,node->container,index, template->container,tindex); #ifdef DEBUG fprintf(stderr,"repairgrids: %s -> %s\n", ocfqn(node->ocnode),ocfqn(template->ocnode)); #endif } return ncstat; } static NCerror structwrap3(CDFnode* node, CDFnode* parent, int parentindex, CDFnode* templategrid, int gridindex) { CDFnode* newstruct; ASSERT((templategrid->nctype == NC_Grid)); newstruct = makenewstruct3(node,templategrid); if(newstruct == NULL) {return THROW(NC_ENOMEM);} /* replace the node with the new structure in the parent's list of children*/ nclistset(parent->subnodes,parentindex,(void*)newstruct); /* Update the list of all nodes in the tree */ nclistpush(node->root->tree->nodes,(void*)newstruct); return NC_NOERR; } static int findin(CDFnode* parent, CDFnode* child) { int i; NClist* subnodes = parent->subnodes; for(i=0;inctype = NC_Structure; newstruct->nc_virtual = 1; newstruct->ocname = nulldup(templatenode->ocname); newstruct->ocnode = templatenode->ocnode; newstruct->ncbasename = nulldup(templatenode->ncbasename); newstruct->subnodes = nclistnew(); newstruct->container = node->container; newstruct->template = templatenode; node->container = newstruct; nclistpush(newstruct->subnodes,(void*)node); return newstruct; } /** Make the constrained dds nodes (root) point to the corresponding unconstrained dds nodes (fullroot). */ NCerror mapnodes3(CDFnode* root, CDFnode* fullroot) { NCerror ncstat = NC_NOERR; ASSERT(root != NULL && fullroot != NULL); if(!simplenodematch34(root,fullroot)) {THROWCHK(ncstat=NC_EINVAL); goto done;} /* clear out old associations*/ unmap3(root); ncstat = mapnodes3r(root,fullroot,0); done: return ncstat; } static NCerror mapnodes3r(CDFnode* connode, CDFnode* fullnode, int depth) { unsigned int i,j; NCerror ncstat = NC_NOERR; ASSERT((simplenodematch34(connode,fullnode))); #ifdef DEBUG { char* path1 = makecdfpathstring3(fullnode,"."); char* path2 = makecdfpathstring3(connode,"."); fprintf(stderr,"mapnode: %s->%s\n",path1,path2); nullfree(path1); nullfree(path2); } #endif /* Map node */ mapfcn(connode,fullnode); #if 0 { int i; for(i=0;isubnodes);i++) { CDFnode* n = (CDFnode*)nclistget(fullnode->subnodes,i); fprintf(stderr,"fullnode.subnode[%d]: (%d) %s\n",i,n->nctype,n->ocname); } for(i=0;isubnodes);i++) { CDFnode* n = (CDFnode*)nclistget(connode->subnodes,i); fprintf(stderr,"connode.subnode[%d]: (%d) %s\n",i,n->nctype,n->ocname); } } #endif /* Try to match connode subnodes against fullnode subnodes */ ASSERT(nclistlength(connode->subnodes) <= nclistlength(fullnode->subnodes)); for(i=0;isubnodes);i++) { CDFnode* consubnode = (CDFnode*)nclistget(connode->subnodes,i); /* Search full subnodes for a matching subnode from con */ for(j=0;jsubnodes);j++) { CDFnode* fullsubnode = (CDFnode*)nclistget(fullnode->subnodes,j); if(simplenodematch34(fullsubnode,consubnode)) { ncstat = mapnodes3r(consubnode,fullsubnode,depth+1); if(ncstat) goto done; } } } done: return THROW(ncstat); } /* The specific actions of a map are defined by this function. */ static NCerror mapfcn(CDFnode* dstnode, CDFnode* srcnode) { /* Mark node as having been mapped */ dstnode->basenode = srcnode; return NC_NOERR; } void unmap3(CDFnode* root) { unsigned int i; CDFtree* tree = root->tree; for(i=0;inodes);i++) { CDFnode* node = (CDFnode*)nclistget(tree->nodes,i); node->basenode = NULL; } } /* Move dimension data from basenodes to nodes */ NCerror dimimprint3(NCDAPCOMMON* nccomm) { NCerror ncstat = NC_NOERR; NClist* allnodes; int i,j; CDFnode* basenode; allnodes = nccomm->cdf.ddsroot->tree->nodes; for(i=0;ibasenode; if(basenode == NULL) continue; noderank = nclistlength(node->array.dimset0); baserank = nclistlength(basenode->array.dimset0); if(noderank == 0) continue; ASSERT(noderank == baserank); #ifdef DEBUG fprintf(stderr,"dimimprint %s/%d -> %s/%d\n", makecdfpathstring3(basenode,"."), noderank, makecdfpathstring3(node,"."), baserank); #endif for(j=0;jarray.dimset0,j); CDFnode* basedim = (CDFnode*)nclistget(basenode->array.dimset0,j); dim->dim.declsize0 = basedim->dim.declsize; #ifdef DEBUG fprintf(stderr,"dimimprint: %d: %lu -> %lu\n",i,basedim->dim.declsize,dim->dim.declsize0); #endif } } return ncstat; } static CDFnode* clonedim(NCDAPCOMMON* nccomm, CDFnode* dim, CDFnode* var) { CDFnode* clone; clone = makecdfnode34(nccomm,dim->ocname,OC_Dimension, NULL,dim->container); /* Record its existence */ nclistpush(dim->container->root->tree->nodes,(void*)clone); clone->dim = dim->dim; /* copy most everything */ clone->dim.dimflags |= CDFDIMCLONE; clone->dim.array = var; return clone; } static NClist* clonedimset3(NCDAPCOMMON* nccomm, NClist* dimset, CDFnode* var) { NClist* result = nclistnew(); int i; for(i=0;iarray.dimsetplus == NULL); if(node->array.dimset0 == NULL) dimset = nclistnew(); else { /* copy the dimset0 into dimset */ dimset = nclistclone(node->array.dimset0); } /* Insert the sequence or string dims */ if(node->array.stringdim != NULL) { clone = node->array.stringdim; nclistpush(dimset,(void*)clone); } if(node->array.seqdim != NULL) { clone = node->array.seqdim; nclistpush(dimset,(void*)clone); } node->array.dimsetplus = dimset; return ncstat; } /* Define the dimsetall list for a node */ static NCerror definedimsetall3(NCDAPCOMMON* nccomm/*notused*/, CDFnode* node) { int i; int ncstat = NC_NOERR; NClist* dimsetall; /* Because of upward recursion (see below) the dimsetall may already be defined */ if(node->array.dimsetall != NULL) return ncstat; if(node->container != NULL) { if(node->container->array.dimsetall == NULL) { #ifdef DEBUG1 fprintf(stderr,"dimsetall: recurse to container%s\n",node->container->ocname); #endif ncstat = definedimsetall3(nccomm,node->container); if(ncstat != NC_NOERR) return ncstat; } /* We need to clone the parent dimensions because we will be assigning indices vis-a-vis this variable */ dimsetall = clonedimset3(nccomm,node->container->array.dimsetall,node); } else dimsetall = nclistnew(); // concat parentall and dimset; for(i=0;iarray.dimsetplus);i++) { CDFnode* clone = (CDFnode*)nclistget(node->array.dimsetplus,i); nclistpush(dimsetall,(void*)clone); } node->array.dimsetall = dimsetall; #ifdef DEBUG1 fprintf(stderr,"dimsetall: |%s|=%d\n",node->ocname,(int)nclistlength(dimsetall)); #endif return ncstat; } /* Define the dimsettrans list for a node */ static NCerror definedimsettrans3(NCDAPCOMMON* nccomm/*notused*/, CDFnode* node) { int i; int ncstat = NC_NOERR; NClist* dimsettrans; /* Because of upward recursion (see below) the dimsettrans may already be defined */ if(node->array.dimsettrans != NULL) return ncstat; if(node->container != NULL) { if(node->container->array.dimsettrans == NULL) { #ifdef DEBUG1 fprintf(stderr,"dimsettrans: recurse to container%s\n",node->container->ocname); #endif ncstat = definedimsettrans3(nccomm,node->container); if(ncstat != NC_NOERR) return ncstat; } /* We need to clone the parent dimensions because we will be assigning indices vis-a-vis this variable */ dimsettrans = clonedimset3(nccomm,node->container->array.dimsettrans,node); } else dimsettrans = nclistnew(); // concat parent dimset0 and dimset; for(i=0;iarray.dimset0);i++) { CDFnode* clone = (CDFnode*)nclistget(node->array.dimset0,i); nclistpush(dimsettrans,(void*)clone); } node->array.dimsettrans = dimsettrans; #ifdef DEBUG1 fprintf(stderr,"dimsettrans: |%s|=%d\n",node->ocname,(int)nclistlength(dimsettrans)); #endif return ncstat; } /* Define the dimsetplus, dimsettrans, and dimsetall lists for all nodes with dimensions */ NCerror definedimsets3(NCDAPCOMMON* nccomm, CDFtree* tree) { int i; int ncstat = NC_NOERR; NClist* allnodes = tree->nodes; for(i=0;inctype == NC_Dimension) continue; //ignore ASSERT((rankednode->array.dimsettrans == NULL)); ncstat = definedimsettrans3(nccomm,rankednode); if(ncstat != NC_NOERR) return ncstat; } for(i=0;inctype == NC_Dimension) continue; //ignore ASSERT((rankednode->array.dimsetplus == NULL)); ncstat = definedimsetplus3(nccomm,rankednode); if(ncstat != NC_NOERR) return ncstat; } for(i=0;inctype == NC_Dimension) continue; //ignore ASSERT((rankednode->array.dimsetplus != NULL)); ncstat = definedimsetall3(nccomm,rankednode); if(ncstat != NC_NOERR) return ncstat; } return NC_NOERR; }