File: s3io.c

package info (click to toggle)
paraview 5.13.2%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 544,220 kB
  • sloc: cpp: 3,374,605; ansic: 1,332,409; python: 150,381; xml: 122,166; sql: 65,887; sh: 7,317; javascript: 5,262; yacc: 4,417; java: 3,977; perl: 2,363; lex: 1,929; f90: 1,397; makefile: 170; objc: 153; tcl: 59; pascal: 50; fortran: 29
file content (325 lines) | stat: -rw-r--r-- 8,698 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*********************************************************************
*    COPYRIGHT 2018, UCAR/UNIDATA
*    SEE NETCDF/COPYRIGHT FILE FOR COPYING AND REDISTRIBUTION CONDITIONS.
* ********************************************************************/

#if HAVE_CONFIG_H
#include "config.h"
#endif

#undef DEBUG

#include <assert.h>
#include <stdlib.h>
#ifdef DEBUG
#include <stdio.h>
#endif
#include <errno.h>
#include <string.h>
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif
#ifdef _MSC_VER /* MICROSOFT COMPILERS */
#include <io.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#include "netcdf.h"
#include "nc3internal.h"
#include "nclist.h"
#include "ncbytes.h"
#include "ncrc.h"
#include "nclog.h"
#include "ncio.h"
#include "fbits.h"
#include "rnd.h"
#include "ncs3sdk.h"
#include "ncuri.h"

#define DEFAULTPAGESIZE 16384

/* PRIVATE DATA */

enum IO {NOIO=0, CURLIO=1, S3IO=2};

typedef struct NCS3IO {
    long long size; /* of the object */
    NCS3INFO s3;
    void* s3client;
    char* errmsg;
    void* buffer;
} NCS3IO;

/* Forward */
static int s3io_rel(ncio *const nciop, off_t offset, int rflags);
static int s3io_get(ncio *const nciop, off_t offset, size_t extent, int rflags, void **const vpp);
static int s3io_move(ncio *const nciop, off_t to, off_t from, size_t nbytes, int rflags);
static int s3io_sync(ncio *const nciop);
static int s3io_filesize(ncio* nciop, off_t* filesizep);
static int s3io_pad_length(ncio* nciop, off_t length);
static int s3io_close(ncio* nciop, int);

#define reporterr(s3io) {if((s3io) && (s3io)->errmsg) {nclog(NCLOGERR,(s3io)->errmsg);} nullfree((s3io)->errmsg); (s3io)->errmsg = NULL;}

static long pagesize = 0;

/* Create a new ncio struct to hold info about the file. */
static int
s3io_new(const char* path, int ioflags, ncio** nciopp, NCS3IO** hpp)
{
    int status = NC_NOERR;
    ncio* nciop = NULL;
    NCS3IO* s3io = NULL;

    if(pagesize == 0)
        pagesize = DEFAULTPAGESIZE;
    errno = 0;

    nciop = (ncio* )calloc(1,sizeof(ncio));
    if(nciop == NULL) {status = NC_ENOMEM; goto fail;}
    
    nciop->ioflags = ioflags;

    *((char**)&nciop->path) = strdup(path);
    if(nciop->path == NULL) {status = NC_ENOMEM; goto fail;}

    *((ncio_relfunc**)&nciop->rel) = s3io_rel;
    *((ncio_getfunc**)&nciop->get) = s3io_get;
    *((ncio_movefunc**)&nciop->move) = s3io_move;
    *((ncio_syncfunc**)&nciop->sync) = s3io_sync;
    *((ncio_filesizefunc**)&nciop->filesize) = s3io_filesize;
    *((ncio_pad_lengthfunc**)&nciop->pad_length) = s3io_pad_length;
    *((ncio_closefunc**)&nciop->close) = s3io_close;

    s3io = (NCS3IO*)calloc(1,sizeof(NCS3IO));
    if(s3io == NULL) {status = NC_ENOMEM; goto fail;}
    *((void* *)&nciop->pvt) = s3io;

    if(nciopp) *nciopp = nciop;
    if(hpp) *hpp = s3io;

done:
    return status;

fail:
    nullfree(s3io);
    if(nciop != NULL) {
        if(nciop->path != NULL) free((char*)nciop->path);
    }
    goto done;
}

/* Create a file, and the ncio struct to go with it. This function is
   only called from nc__create_mp.

   path - path of file to create.
   ioflags - flags from nc_create
   initialsz - From the netcdf man page: "The argument
   Iinitialsize sets the initial size of the file at creation time."
   igeto - 
   igetsz - 
   sizehintp - the size of a page of data for buffered reads and writes.
   nciopp - pointer to a pointer that will get location of newly
   created and inited ncio struct.
   mempp - pointer to pointer to the initial memory read.
*/
int
s3io_create(const char* path, int ioflags,
    size_t initialsz,
    off_t igeto, size_t igetsz, size_t* sizehintp,
    void* parameters,
    ncio* *nciopp, void** const mempp)
{
    return NC_EPERM;
}

/* This function opens the data file. It is only called from nc.c,
   from nc__open_mp and nc_delete_mp.

   path - path of data file.
   ioflags - flags passed into nc_open.
   igeto - looks like this function can do an initial page get, and
   igeto is going to be the offset for that. But it appears to be
   unused 
   igetsz - the size in bytes of initial page get (a.k.a. extent). Not
   ever used in the library.
   sizehintp - the size of a page of data for buffered reads and writes.
   nciopp - pointer to pointer that will get address of newly created
   and inited ncio struct.
   mempp - pointer to pointer to the initial memory read.
*/
int
s3io_open(const char* path,
    int ioflags,
    /* ignored */ off_t igeto, size_t igetsz, size_t* sizehintp,
    /* ignored */ void* parameters,
    ncio* *nciopp,
    /* ignored */ void** const mempp)
{
    ncio* nciop;
    int status;
    NCS3IO* s3io = NULL;
    size_t sizehint;
    NCURI* url = NULL;

    if(path == NULL ||* path == 0)
        return EINVAL;

    /* Create private data */
    if((status = s3io_new(path, ioflags, &nciop, &s3io))) goto done;

    /* parse path */
    ncuriparse(path,&url);
    if(url == NULL)
        {status = NC_EURL; goto done;}

    /* Convert to canonical path-style */
    if((status = NC_s3urlprocess(url,&s3io->s3))) goto done;
    /* Verify root path */
    if(s3io->s3.rootkey == NULL)
        {status = NC_EURL; goto done;}
    s3io->s3client = NC_s3sdkcreateclient(&s3io->s3);
    /* Get the size */
    switch (status = NC_s3sdkinfo(s3io->s3client,s3io->s3.bucket,s3io->s3.rootkey,(long long unsigned*)&s3io->size,&s3io->errmsg)) {
    case NC_NOERR: break;
    case NC_EEMPTY:
        s3io->size = 0;
	goto done;
    default:
        goto done;
    }

    sizehint = pagesize;

    /* sizehint must be multiple of 8 */
    sizehint = (sizehint / 8) * 8;
    if(sizehint < 8) sizehint = 8;

    *sizehintp = sizehint;
    *nciopp = nciop;
done:
    ncurifree(url);
    if(status) {
	reporterr(s3io);
        s3io_close(nciop,0);
    }
    return status;
}

/* 
 *  Get file size in bytes.
 */
static int
s3io_filesize(ncio* nciop, off_t* filesizep)
{
    NCS3IO* s3io;
    if(nciop == NULL || nciop->pvt == NULL) return NC_EINVAL;
    s3io = (NCS3IO*)nciop->pvt;
    if(filesizep != NULL) *filesizep = s3io->size;
    return NC_NOERR;
}

/*
 *  Sync any changes to disk, then truncate or extend file so its size
 *  is length.  This is only intended to be called before close, if the
 *  file is open for writing and the actual size does not match the
 *  calculated size, perhaps as the result of having been previously
 *  written in NOFILL mode.
 */
static int
s3io_pad_length(ncio* nciop, off_t length)
{
    return NC_NOERR; /* do nothing */
}

/* Write out any dirty buffers to disk and
   ensure that next read will get data from disk.
   Sync any changes, then close the open file associated with the ncio
   struct, and free its memory.
   nciop - pointer to ncio to close.
   doUnlink - if true, unlink file
*/

static int 
s3io_close(ncio* nciop, int deleteit)
{
    int status = NC_NOERR;
    NCS3IO* s3io;
    if(nciop == NULL || nciop->pvt == NULL) return NC_NOERR;

    s3io = (NCS3IO*)nciop->pvt;
    assert(s3io != NULL);

    if(s3io->s3client && s3io->s3.bucket && s3io->s3.rootkey) {
        NC_s3sdkclose(s3io->s3client, &s3io->s3, deleteit, &s3io->errmsg);
    }
    s3io->s3client = NULL;
    NC_s3clear(&s3io->s3);
    nullfree(s3io->errmsg);
    nullfree(s3io->buffer);
    nullfree(s3io);

    if(nciop->path != NULL) free((char*)nciop->path);
    free(nciop);
    return status;
}

/*
 * Request that the region (offset, extent)
 * be made available through *vpp.
 */
static int
s3io_get(ncio* const nciop, off_t offset, size_t extent, int rflags, void** const vpp)
{
    int status = NC_NOERR;
    NCS3IO* s3io;

    if(nciop == NULL || nciop->pvt == NULL) {status = NC_EINVAL; goto done;}
    s3io = (NCS3IO*)nciop->pvt;

    assert(s3io->buffer == NULL);
    if((s3io->buffer = (unsigned char*)malloc(extent))==NULL)
        {status = NC_ENOMEM; goto done;}
    status = NC_s3sdkread(s3io->s3client, s3io->s3.bucket, s3io->s3.rootkey, offset, extent, s3io->buffer, &s3io->errmsg);
    if(status) {reporterr(s3io); goto done;}

    if(vpp) *vpp = s3io->buffer;
done:
    return status;
}

/*
 * Like memmove(), safely move possibly overlapping data.
 */
static int
s3io_move(ncio* const nciop, off_t to, off_t from, size_t nbytes, int ignored)
{
    return NC_EPERM;
}

static int
s3io_rel(ncio* const nciop, off_t offset, int rflags)
{
    int status = NC_NOERR;
    NCS3IO* s3io;

    if(nciop == NULL || nciop->pvt == NULL) {status = NC_EINVAL; goto done;}
    s3io = (NCS3IO*)nciop->pvt;
    nullfree(s3io->buffer);
    s3io->buffer = NULL;
done:
    return status;
}

/*
 * Write out any dirty buffers to disk and
 * ensure that next read will get data from disk.
 */
static int
s3io_sync(ncio* const nciop)
{
    return NC_NOERR; /* do nothing */
}