cdi_int.h 11.3 KB
Newer Older
1
2
#ifndef _CDI_INT_H
#define _CDI_INT_H
Uwe Schulzweida's avatar
Uwe Schulzweida committed
3
4
5
6
7

#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif

Uwe Schulzweida's avatar
Uwe Schulzweida committed
8
#include <assert.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
#include <stdio.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
10
#include <stdbool.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
#include <string.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
#include <errno.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
15
#include <math.h>
#include <sys/types.h>

16
17
18
/* dummy use of unused parameters to silence compiler warnings */
#define  UNUSED(x) (void)x

Uwe Schulzweida's avatar
Uwe Schulzweida committed
19
#ifndef strdupx
Uwe Schulzweida's avatar
Uwe Schulzweida committed
20
21
22
23
24
#ifndef strdup
char *strdup(const char *s);
#endif
#define strdupx  strdup
/*
Uwe Schulzweida's avatar
Uwe Schulzweida committed
25
26
27
28
29
30
31
#define strdupx(s)			          \
({					      	  \
   const char *__old = (s);			  \
   size_t __len = strlen(__old) + 1;		  \
   char *__new = (char *) malloc(__len);	  \
   (char *) memcpy(__new, __old, __len);	  \
})
Uwe Schulzweida's avatar
Uwe Schulzweida committed
32
*/
Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
34
#endif

35
36
#ifndef  M_PI
#define  M_PI        3.14159265358979323846  /* pi */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
37
38
39
40
41
42
43
44
45
#endif


#ifndef  _ERROR_H
#  include "error.h"
#endif
#ifndef _BASETIME_H
#  include "basetime.h"
#endif
46
47
48
#ifndef _TIMEBASE_H
#  include "timebase.h"
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#ifndef  _TAXIS_H
#  include "taxis.h"
#endif
#ifndef  _CDI_LIMITS_H
#  include "cdi_limits.h"
#endif
#ifndef  _SERVICE_H
#  include "service.h"
#endif
#ifndef  _EXTRA_H
#  include "extra.h"
#endif
#ifndef  _IEG_H
#  include "ieg.h"
#endif
64
65
66
#ifndef RESOURCE_HANDLE_H
#  include "resource_handle.h"
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
67

Thomas Jahns's avatar
Thomas Jahns committed
68

Deike Kleberg's avatar
Deike Kleberg committed
69
70
#define check_parg(arg)  if ( arg == 0 ) Warning("Argument '" #arg "' not allocated!")

Uwe Schulzweida's avatar
Uwe Schulzweida committed
71
#if defined (__xlC__) /* performance problems on IBM */
Uwe Schulzweida's avatar
cleanup    
Uwe Schulzweida committed
72
73
74
75
#ifndef DBL_IS_NAN
#  define DBL_IS_NAN(x)     ((x) != (x))
#endif
#else
76
#ifndef DBL_IS_NAN
77
#if  defined  (HAVE_DECL_ISNAN)
78
#  define DBL_IS_NAN(x)     (isnan(x))
79
#elif  defined  (FP_NAN)
80
#  define DBL_IS_NAN(x)     (fpclassify(x) == FP_NAN)
81
#else
82
#  define DBL_IS_NAN(x)     ((x) != (x))
83
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
84
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
85
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
86

87
88
#ifndef DBL_IS_EQUAL
/*#define DBL_IS_EQUAL(x,y) (!(x < y || y < x)) */
89
#  define DBL_IS_EQUAL(x,y) (DBL_IS_NAN(x)||DBL_IS_NAN(y)?(DBL_IS_NAN(x)&&DBL_IS_NAN(y)):!(x < y || y < x))
90
91
#endif

92
93
94
95
96
97
#ifndef IS_EQUAL
#  define IS_NOT_EQUAL(x,y) (x < y || y < x)
#  define IS_EQUAL(x,y)     (!IS_NOT_EQUAL(x,y))
#endif


Uwe Schulzweida's avatar
Uwe Schulzweida committed
98
99
100
101
102
103
#define  FALSE  0
#define  TRUE   1

#define  TYPE_REC  0
#define  TYPE_VAR  1

104
105
106
#define  MEMTYPE_DOUBLE  1
#define  MEMTYPE_FLOAT   2

Uwe Schulzweida's avatar
Uwe Schulzweida committed
107
108
typedef struct
{
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  void     *buffer;             /* gribapi, cgribex */
  size_t    buffersize;         /* gribapi, cgribex */
  off_t     position;           /* ieg */
  int       param;              /* srv */
  int       level;              /* ext, srv */
  int       date;               /* ext, srv */
  int       time;               /* srv */
  int       gridID;             /* ieg, ext */
  int       varID;              /* ieg */
  int       levelID;            /* ieg  */
  int       prec;               /* ext, srv */
  int       sec0[2];            /* cgribex */
  int       sec1[1024];         /* cgribex */
  int       sec2[4096];         /* cgribex */
  int       sec3[2];            /* cgribex */
  int       sec4[512];          /* cgribex */
  void     *exsep;              /* ieg, ext, srv */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
126
127
128
}
Record;

129
130
131
132
/* data structure specifying tile-related meta-data. structure
 * contains "-1" if this is no tile-variable. */
typedef struct {
  int
133
134
    tileindex,
    totalno_of_tileattr_pairs,
135
136
137
138
139
140
    tileClassification,
    numberOfTiles,
    numberOfAttributes,
    attribute;
} var_tile_t;

Uwe Schulzweida's avatar
Uwe Schulzweida committed
141
142
143
144
145

typedef struct
{
  off_t     position;
  size_t    size;
146
  int       zip;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
147
  int       param;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
148
149
150
  int       ilevel;
  int       ilevel2;
  int       ltype;
151
  int       tsteptype;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
152
153
154
  short     used;
  short     varID;
  short     levelID;
155
  char      varname[32]; /* needed for grib decoding with GRIB_API */
156
  var_tile_t tiles;      /* tile-related meta-data, currently for GRIB-API only. */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
157
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
158
record_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
159
160
161


typedef struct {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
162
  record_t *records;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
163
164
165
166
167
168
169
170
171
  int       recordSize;  /* number of allocated records           */
  int      *recIDs;      /* IDs of non constant records           */
  int       nrecs;       /* number of used records                */
                         /* tsID=0 nallrecs                       */
                         /* tsID>0 number of non constant records */
  int       nallrecs;    /* number of all records                 */
  int       curRecID;    /* current record ID                     */
  long      next;
  off_t     position;    /* timestep file position                */
172
  taxis_t   taxis;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
173
}
174
tsteps_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
175
176
177
178


typedef struct {
  int       nlevs;
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
  int      *recordID;     /* record IDs: [nlevs] */
  int      *lindex;       /* level index */
  int       subtypeIndex; /* corresponding tile in subtype_t structure (subtype->self) */
} sleveltable_t;


typedef struct {
  int            ncvarid;
  int            subtypeSize;
  sleveltable_t *recordTable; /* record IDs for each subtype */
  int            defmiss;     /* TRUE if missval is defined in file */

  int            isUsed;
  int            gridID;
  int            zaxisID;
  int            tsteptype;   /* TSTEP_* */
  int            subtypeID;   /* subtype ID, e.g. for tile-related meta-data (currently for GRIB-API only). */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
196
}
197
svarinfo_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
198
199
200
201
202
203
204
205
206
207
208
209


typedef struct {
  int       ilev;
  int       mlev;
  int       ilevID;
  int       mlevID;
}
VCT;


typedef struct {
210
211
212
213
214
215
216
217
218
219
  int         self;
  int         accesstype;   /* TYPE_REC or TYPE_VAR */
  int         accessmode;
  int         filetype;
  int         byteorder;
  int         fileID;
  int         filemode;
  off_t       numvals;
  char       *filename;
  Record     *record;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
220
  int         nrecs;        /* number of records                  */
221
222
223
224
225
226
227
228
229
  int         nvars;        /* number of variables                */
  svarinfo_t *vars;
  int         varsAllocated;
  int         curTsID;      /* current timestep ID */
  int         rtsteps;      /* number of tsteps accessed       */
  long        ntsteps;      /* number of tsteps : only set if all records accessed */
  tsteps_t   *tsteps;
  int         tstepsTableSize;
  int         tstepsNextID;
230
  basetime_t  basetime;
231
232
  int         ncmode;
  int         vlistID;
233
234
235
  int         xdimID[MAX_GRIDS_PS];	//Warning: synchronous array to vlist_to_pointer(vlistID)->gridIDs
  int         ydimID[MAX_GRIDS_PS];	//Warning: synchronous array to vlist_to_pointer(vlistID)->gridIDs
  int         zaxisID[MAX_ZAXES_PS];	//Warning: synchronous array to vlist_to_pointer(vlistID)->zaxisIDs
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
  int         ncxvarID[MAX_GRIDS_PS];
  int         ncyvarID[MAX_GRIDS_PS];
  int         ncavarID[MAX_GRIDS_PS];
  int         historyID;
  int         globalatts;
  int         localatts;
  VCT         vct;
  int         unreduced;
  int         sortname;
  int         have_missval;
  int         comptype;      // compression type
  int         complevel;     // compression level
#if defined (GRIBCONTAINER2D)
  void      **gribContainers;
#else
  void       *gribContainers;
#endif
  int         vlistIDorig;
254
  /* only used by MPI-parallelized version of library */
255
  int       ownerRank;    // MPI rank of owner process
256
257

  void *gh; // grib handle
Uwe Schulzweida's avatar
Uwe Schulzweida committed
258
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
259
stream_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
260
261


262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/* Length of optional keyword/value pair list */
#define MAX_OPT_GRIB_ENTRIES 500


/* Data type specification for optional key/value pairs (GRIB) */
typedef enum {
  t_double = 0,
  t_int    = 1
} key_val_pair_datatype;

/* Data structure holding optional key/value pairs for GRIB */
typedef struct
{
  char*                  keyword;        /* keyword string */
  int                    update;
  key_val_pair_datatype  data_type;      /* data type of this key/value pair */
  double                 dbl_val;        /* double value (data_type == t_double) */
  int                    int_val;        /* integer value (data_type == t_int) */
  int                    subtype_index;  /* tile index for this key-value pair */
} opt_key_val_pair_t;




Uwe Schulzweida's avatar
Uwe Schulzweida committed
286
extern int CDI_Debug;      /* If set to 1, debuggig (default 0)            */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
287
extern int CDI_Recopt;
288
extern int cdiGribApiDebug;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
289
290
291
292
293
extern double cdiDefaultMissval;
extern int cdiDefaultInstID;
extern int cdiDefaultModelID;
extern int cdiDefaultTableID;
extern int cdiDefaultLeveltype;
294
//extern int cdiNcMissingValue;
295
extern int cdiNcChunksizehint;
296
extern int cdiChunkType;
297
extern int cdiSplitLtype105;
298
299
300
301
302
extern int cdiDataUnreduced;
extern int cdiSortName;
extern int cdiHaveMissval;
extern int STREAM_Debug;

Uwe Schulzweida's avatar
Uwe Schulzweida committed
303

Uwe Schulzweida's avatar
Uwe Schulzweida committed
304
305
extern char *cdiPartabPath;
extern int   cdiPartabIntern;
306
307
308
309
310
311
312
extern const resOps streamOps;

static inline stream_t *
stream_to_pointer(int idx)
{
  return reshGetVal(idx, &streamOps);
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
313

314
315
316
317
318
319
static inline void
stream_check_ptr(const char *caller, stream_t *streamptr)
{
  if ( streamptr == NULL )
    Errorc("stream undefined!");
}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
320

Uwe Schulzweida's avatar
Uwe Schulzweida committed
321
322
int     streamInqFileID(int streamID);

323
324
void    gridDefHasDims(int gridID, int hasdims);
int     gridInqHasDims(int gridID);
325
const char *gridNamePtr(int gridtype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
326
char   *zaxisNamePtr(int leveltype);
327
int     zaxisInqLevelID(int zaxisID, double level);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
328

329
void    streamCheckID(const char *caller, int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
330
331
332
333
334

void    streamDefineTaxis(int streamID);

int     streamsNewEntry(int filetype);
void    streamsInitEntry(int streamID);
335
void    cdiStreamSetupVlist(stream_t *streamptr, int vlistID, int vlistIDorig);
336
int     stream_new_var(stream_t *streamptr, int gridID, int zaxisID, int tilesetID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
337

338
int     tstepsNewEntry(stream_t *streamptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
339

340
const char *strfiletype(int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
341

342
void    cdi_generate_vars(stream_t *streamptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
343

344
void    vlist_check_contents(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
345

346
void    cdi_create_records(stream_t *streamptr, int tsID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
347

348
int     recordNewEntry(stream_t *streamptr, int tsID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
349

350
void    cdiCreateTimesteps(stream_t *streamptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
351

Uwe Schulzweida's avatar
Uwe Schulzweida committed
352
void    recordInitEntry(record_t *record);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
353
354
355
356
357
358
359
360

void    cdiCheckZaxis(int zaxisID);

void    cdiPrintDatatypes(void);

void    cdiDefAccesstype(int streamID, int type);
int     cdiInqAccesstype(int streamID);

Deike Kleberg's avatar
Deike Kleberg committed
361
362
int     getByteswap(int byteorder);

363
void cdiStreamGetIndexList(unsigned numIDs, int IDs[numIDs]);
Deike Kleberg's avatar
Deike Kleberg committed
364

Uwe Schulzweida's avatar
Uwe Schulzweida committed
365

366
367
void  cdiInitialize(void);

368
369
void uuid2str(const unsigned char *uuid, char *uuidstr);
int str2uuid(const char *uuidstr, unsigned char *uuid);
Thomas Jahns's avatar
Thomas Jahns committed
370

371
int cdiUUIDIsNull(const unsigned char *uuid);
Thomas Jahns's avatar
Thomas Jahns committed
372

373
374
char* cdiEscapeSpaces(const char* string);
char* cdiUnescapeSpaces(const char* string, const char** outStringEnd);
375

376
377
378
379
380
381
#define CDI_UNIT_PA   1
#define CDI_UNIT_HPA  2
#define CDI_UNIT_MM   3
#define CDI_UNIT_CM   4
#define CDI_UNIT_DM   5
#define CDI_UNIT_M    6
382

383
384
385
386
387
388
389
struct streamAssoc
{
  int streamID, vlistID, vlistIDorig;
};

struct streamAssoc
streamUnpack(char * unpackBuffer, int unpackBufferSize,
390
             int * unpackBufferPos, int originNamespace, void *context);
391

392
393
int
cdiStreamOpenDefaultDelegate(const char *filename, const char *filemode,
394
395
                             int filetype, stream_t *streamptr,
                             int recordBufIsToBeCreated);
396
397
398
399
400
401
402
403
404
405

void
cdiStreamDefVlist_(int streamID, int vlistID);
void
cdiStreamWriteVar_(int streamID, int varID, int memtype, const void *data,
                   int nmiss);
void
cdiStreamwriteVarChunk_(int streamID, int varID, int memtype,
                        const int rect[][2], const void *data, int nmiss);
void
406
407
cdiStreamCloseDefaultDelegate(stream_t *streamptr,
                              int recordBufIsToBeDeleted);
408

Thomas Jahns's avatar
Thomas Jahns committed
409
410
int cdiStreamDefTimestep_(stream_t *streamptr, int tsID);

Thomas Jahns's avatar
Thomas Jahns committed
411
412
void cdiStreamSync_(stream_t *streamptr);

413
414
char *cdiUnitNamePtr(int cdi_unit);

415
416
417
418
419
void zaxisGetIndexList(int nzaxis, int *zaxisIndexList);

void zaxisDefLtype2(int zaxisID, int ltype2);
int  zaxisInqLtype2(int zaxisID);

420
421
422
void streamFCopyRecord(stream_t *streamptr2, stream_t *streamptr1,
                       const char *container_name);

423
#endif  /* _CDI_INT_H */
424
425
426
427
428
429
430
431
432
/*
 * Local Variables:
 * c-file-style: "Java"
 * c-basic-offset: 2
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */