netcdf-c/libdispatch/dreadonly.c
Dennis Heimbigner bf2746b8ea Provide byte-range reading of remote datasets
re: issue https://github.com/Unidata/netcdf-c/issues/1251

Assume that you have the URL to a remote dataset
which is a normal netcdf-3 or netcdf-4 file.

This PR allows the netcdf-c to read that dataset's
contents as a netcdf file using HTTP byte ranges
if the remote server supports byte-range access.

Originally, this PR was set up to access Amazon S3 objects,
but it can also access other remote datasets such as those
provided by a Thredds server via the HTTPServer access protocol.
It may also work for other kinds of servers.

Note that this is not intended as a true production
capability because, as is known, this kind of access to
can be quite slow. In addition, the byte-range IO drivers
do not currently do any sort of optimization or caching.

An additional goal here is to gain some experience with
the Amazon S3 REST protocol.

This architecture and its use documented in
the file docs/byterange.dox.

There are currently two test cases:

1. nc_test/tst_s3raw.c - this does a simple open, check format, close cycle
   for a remote netcdf-3 file and a remote netcdf-4 file.
2. nc_test/test_s3raw.sh - this uses ncdump to investigate some remote
   datasets.

This PR also incorporates significantly changed model inference code
(see the superceded PR https://github.com/Unidata/netcdf-c/pull/1259).

1. It centralizes the code that infers the dispatcher.
2. It adds support for byte-range URLs

Other changes:

1. NC_HDF5_finalize was not being properly called by nc_finalize().
2. Fix minor bug in ncgen3.l
3. fix memory leak in nc4info.c
4. add code to walk the .daprc triples and to replace protocol=
   fragment tag with a more general mode= tag.

Final Note:
Th inference code is still way too complicated. We need to move
to the validfile() model used by netcdf Java, where each
dispatcher is asked if it can process the file. This decentralizes
the inference code. This will be done after all the major new
dispatchers (PIO, Zarr, etc) have been implemented.
2019-01-01 18:27:36 -07:00

261 lines
5.0 KiB
C

/* Copyright 2018, UCAR/Unidata See netcdf/COPYRIGHT file for copying
* and redistribution conditions.*/
/**
* @file
* @internal This file contains functions that return NC_EPERM, for
* read-only dispatch layers.
*
* @author Ed Hartnett
*/
#include "ncdispatch.h"
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param name Ignored.
* @param newname Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_rename_att(int ncid, int varid, const char *name, const char *newname)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param name Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_del_att(int ncid, int varid, const char *name)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param name Ignored.
* @param file_type Ignored.
* @param len Ignored.
* @param data Ignored.
* @param memtype Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_put_att(int ncid, int varid, const char *name, nc_type file_type,
size_t len, const void *data, nc_type mem_type)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param name Ignored.
* @param len Ignored.
* @param idp Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_def_dim(int ncid, const char *name, size_t len, int *idp)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param dimid Ignored.
* @param name Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_rename_dim(int ncid, int dimid, const char *name)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param name Ignored.
* @param xtype Ignored.
* @param ndims Ignored.
* @param dimidsp Ignored.
* @param varidp Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_def_var(int ncid, const char *name, nc_type xtype,
int ndims, const int *dimidsp, int *varidp)
{
return NC_EPERM;
}
/**
* @internal Not allowed for classic model access.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param no_fill Ignored.
* @param fill_value Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_def_var_fill(int ncid, int varid, int no_fill, const void *fill_value)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid File ID.
* @param varid Variable ID
* @param name New name of the variable.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_rename_var(int ncid, int varid, const char *name)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid File ID.
* @param varid Variable ID.
* @param startp Array of start indices.
* @param countp Array of counts.
* @param op pointer that gets the data.
* @param memtype The type of these data in memory.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_put_vara(int ncid, int varid, const size_t *startp,
const size_t *countp, const void *op, int memtype)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid File and group ID.
* @param fillmode File mode.
* @param old_modep Pointer that gets old mode. Ignored if NULL.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_set_fill(int ncid, int fillmode, int *old_modep)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_redef(int ncid)
{
return NC_EPERM;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
* @param h_minfree Ignored.
* @param v_align Ignored.
* @param v_minfree Ignored.
* @param r_align Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO__enddef(int ncid, size_t h_minfree, size_t v_align,
size_t v_minfree, size_t r_align)
{
return NC_NOERR;
}
/**
* @internal Not allowed for read-only access.
*
* @param ncid Ignored.
*
* @return ::NC_EPERM Not allowed.
* @author Ed Hartnett
*/
int
NC_RO_sync(int ncid)
{
return NC_NOERR;
}
/**
* @internal Not allowed for read-only access.
*
* @param path Ignored.
* @param cmode Ignored.
* @param initialsz Ignored.
* @param basepe Ignored.
* @param chunksizehintp Ignored.
* @param use_parallel Ignored.
* @param parameters Ignored.
* @param dispatch Ignored.
* @param nc_file Ignored.
*
* @return ::NC_EPERM Cannot create files.
* @author Ed Hartnett
*/
int
NC_RO_create(const char* path, int cmode, size_t initialsz, int basepe,
size_t *chunksizehintp, void *parameters,
NC_Dispatch *dispatch, NC *nc_file)
{
return NC_EPERM;
}