summaryrefslogtreecommitdiffstats
path: root/src/H5Fstdio.c
blob: cd47f3afe57caa455e2f49e10bfd2a17fb94d3f1 (plain)
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/*
 * Copyright (C) 1997 NCSA
 *                    All rights reserved.
 *
 * Programmer: Robb Matzke <matzke@llnl.gov>
 *             Wednesday, October 22, 1997
 *
 * Purpose:    This is the Posix stdio.h I/O subclass of H5Flow.
 */
#include <H5private.h>
#include <H5private.h>
#include <H5Eprivate.h>
#include <H5Fprivate.h>
#include <H5MMprivate.h>

#include <sys/types.h>
#include <sys/stat.h>


#define PABLO_MASK	H5F_sec2
static hbool_t interface_initialize_g = FALSE;

static H5F_low_t *H5F_stdio_open (const char *name, uintn flags,
				  H5F_search_t *key);
static herr_t H5F_stdio_close (H5F_low_t *lf);
static herr_t H5F_stdio_read (H5F_low_t *lf, haddr_t addr, size_t size,
			      uint8 *buf);
static herr_t H5F_stdio_write (H5F_low_t *lf, haddr_t addr, size_t size,
			      const uint8 *buf);
static herr_t H5F_stdio_flush (H5F_low_t *lf);
static size_t H5F_stdio_size (H5F_low_t *lf);


const H5F_low_class_t H5F_LOW_STDIO[1] = {{
   NULL,			/* use default access(2) func  		*/
   H5F_stdio_open, 		/* open method				*/
   H5F_stdio_close, 		/* close method				*/
   H5F_stdio_read,		/* read method				*/
   H5F_stdio_write, 		/* write method				*/
   H5F_stdio_flush, 		/* flush method				*/
   H5F_stdio_size, 		/* file size method			*/
}};



/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_open
 *
 * Purpose:	Opens a file with name NAME.  The FLAGS are a bit field with
 *		the possible values defined in H5F_low_open().
 *
 * Bugs:	H5F_ACC_EXCL has a race condition.
 *
 * Errors:
 *		IO        CANTOPENFILE  File doesn't exist and CREAT wasn't
 *		                        specified. 
 *		IO        CANTOPENFILE  Fopen failed. 
 *		IO        FILEEXISTS    File exists but CREAT and EXCL were
 *		                        specified. 
 *
 * Return:	Success:	Low-level file pointer
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static H5F_low_t *
H5F_stdio_open (const char *name, uintn flags, H5F_search_t *key)
{
   H5F_low_t	*lf=NULL;
   FILE		*f=NULL;
   struct stat	sb;

   FUNC_ENTER (H5F_stdio_open, NULL, NULL);

   if (access (name, F_OK)<0) {
      if ((flags & H5F_ACC_CREAT) && (flags & H5F_ACC_WRITE)) {
	 f = fopen (name, "wb+");
      } else {
	 /* File doesn't exist and CREAT wasn't specified */
	 HRETURN_ERROR (H5E_IO, H5E_CANTOPENFILE, NULL);
      }
      
   } else if ((flags & H5F_ACC_CREAT) && (flags & H5F_ACC_EXCL)) {
      /* File exists but CREAT and EXCL were specified */
      HRETURN_ERROR (H5E_IO, H5E_FILEEXISTS, NULL);
      
   } else if (flags & H5F_ACC_WRITE) {
      if (flags & H5F_ACC_TRUNC) f = fopen (name, "wb+");
      else f = fopen (name, "rb+");
      
   } else {
      f = fopen (name, "rb");
   }
   if (!f) HRETURN_ERROR (H5E_IO, H5E_CANTOPENFILE, NULL); /*fopen failed*/

   /* Build the return value */
   lf = H5MM_xcalloc (1, sizeof(H5F_low_t));
   lf->u.stdio.f = f;
   lf->u.stdio.op = H5F_OP_SEEK;
   lf->u.stdio.cur = 0;

   /* The unique key */
   if (key) {
      fstat (fileno (f), &sb);
      key->dev = sb.st_dev;
      key->ino = sb.st_ino;
   }

   FUNC_LEAVE (lf);
}


/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_close
 *
 * Purpose:	Closes a file.
 *
 * Errors:
 *		IO        CLOSEERROR    Close failed. 
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5F_stdio_close (H5F_low_t *lf)
{
   FUNC_ENTER (H5F_stdio_close, NULL, FAIL);

   if (fclose (lf->u.stdio.f)<0) {
      HRETURN_ERROR (H5E_IO, H5E_CLOSEERROR, FAIL); /*close failed*/
   }
   lf->u.stdio.f = NULL;

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_read
 *
 * Purpose:	Reads SIZE bytes beginning at address ADDR in file LF and
 *		places them in buffer BUF.  Reading past the end of the
 *		file returns zeros instead of failing.
 *
 * Errors:
 *		IO        READERROR     Fread failed. 
 *		IO        SEEKERROR     Fseek failed. 
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5F_stdio_read (H5F_low_t *lf, haddr_t addr, size_t size, uint8 *buf)
{
   size_t	n;
   
   FUNC_ENTER (H5F_stdio_read, NULL, FAIL);

   /*
    * Seek to the correct file position.
    */
   if (!H5F_OPT_SEEK ||
       lf->u.stdio.op==H5F_OP_UNKNOWN ||
       lf->u.stdio.cur!=addr) {
      if (fseek (lf->u.stdio.f, addr, SEEK_SET)<0) {
	 HRETURN_ERROR (H5E_IO, H5E_SEEKERROR, FAIL); /*fseek failed*/
      }
      lf->u.stdio.cur = addr;
   }

   /*
    * Read the data.  Since we're reading single-byte values, a partial read
    * will advance the file position by N.  If N is negative or an error
    * occurs then the file position is undefined.
    */
   n = fread (buf, 1, size, lf->u.stdio.f);
   if (n<=0 && ferror (lf->u.stdio.f)) {
      lf->u.stdio.op = H5F_OP_UNKNOWN;
      HRETURN_ERROR (H5E_IO, H5E_READERROR, FAIL); /*fread failed*/
   } else if (n<size) {
      HDmemset (buf+n, 0, size-n);
   }

   /*
    * Update the file position data.
    */
   lf->u.stdio.op = H5F_OP_READ;
   lf->u.stdio.cur = addr + n;
   FUNC_LEAVE (SUCCEED);
}



/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_write
 *
 * Purpose:	Writes SIZE bytes from the beginning of BUF into file LF at
 *		file address ADDR.
 *
 * Errors:
 *		IO        SEEKERROR     Fseek failed. 
 *		IO        WRITEERROR    Fwrite failed. 
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5F_stdio_write (H5F_low_t *lf, haddr_t addr, size_t size, const uint8 *buf)
{
   FUNC_ENTER (H5F_stdio_write, NULL, FAIL);

   /*
    * Seek to the correct file position.
    */
   if (!H5F_OPT_SEEK ||
       lf->u.stdio.op==H5F_OP_UNKNOWN ||
       lf->u.stdio.cur!=addr) {
      if (fseek (lf->u.stdio.f, addr, SEEK_SET)<0) {
	 HRETURN_ERROR (H5E_IO, H5E_SEEKERROR, FAIL); /*fseek failed*/
      }
      lf->u.stdio.cur = addr;
   }

   /*
    * Write the buffer.  On successful return, the file position will be
    * advanced by the number of bytes read.  Otherwise nobody knows where it
    * is.
    */
   if (size != fwrite (buf, 1, size, lf->u.stdio.f)) {
      lf->u.stdio.op = H5F_OP_UNKNOWN;
      HRETURN_ERROR (H5E_IO, H5E_WRITEERROR, FAIL); /*fwrite failed*/
   }

   /*
    * Update seek optimizing data.
    */
   lf->u.stdio.op = H5F_OP_WRITE;
   lf->u.stdio.cur = addr + size;
   FUNC_LEAVE (SUCCEED);
}



/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_flush
 *
 * Purpose:	Makes sure that all data is on disk.
 *
 * Errors:
 *		IO        WRITEERROR    Fflush failed. 
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5F_stdio_flush (H5F_low_t *lf)
{
   FUNC_ENTER (H5F_stdio_flush, NULL, FAIL);

   /*
    * What happens to the file position?  Is it guaranteed to be the same
    * after the fflush() as it was before?
    */
   lf->u.stdio.op = H5F_OP_UNKNOWN;

   /*
    * Flush
    */
   if (fflush (lf->u.stdio.f)<0) {
      HRETURN_ERROR (H5E_IO, H5E_WRITEERROR, FAIL); /*fflush failed*/
   }
   
   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5F_stdio_size
 *
 * Purpose:	Returns the current size of the file in bytes.
 *
 * Bugs:	There is no way to determine if this function failed.
 *
 * Errors:
 *		IO        SEEKERROR     Fseek failed. 
 *
 * Return:	Success:	Size of file in bytes
 *
 *		Failure:	0
 *
 * Programmer:	Robb Matzke
 *              Wednesday, October 22, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static size_t
H5F_stdio_size (H5F_low_t *lf)
{
   off_t	size;
   
   FUNC_ENTER (H5F_stdio_size, NULL, 0);

   /* Seek to the end and get the file offset */
   if (fseek (lf->u.stdio.f, 0, SEEK_END)<0) {
      HRETURN_ERROR (H5E_IO, H5E_SEEKERROR, 0); /*fseek failed*/
   }
   size = ftell (lf->u.stdio.f);

   /* Update seek opt data */
   lf->u.stdio.op = H5F_OP_SEEK;
   lf->u.stdio.cur = size;

   FUNC_LEAVE (size);
}