/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright by The HDF Group. * * All rights reserved. * * * * This file is part of HDF5. The full HDF5 copyright notice, including * * terms governing use, modification, and redistribution, is contained in * * the COPYING file, which can be found at the root of the source code * * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. * * If you do not have access to either file, you may request a copy from * * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* * Purpose: * * * * * */ #include "H5FDdrvr_module.h" /* This source code file is part of the H5FD driver module */ #include "H5Fprivate.h" /* File access */ #include "H5private.h" /* Generic Functions */ #include "H5Eprivate.h" /* Error handling */ #include "H5Pprivate.h" /* Property lists */ #include "H5MMprivate.h" /* Memory management */ #include "H5Iprivate.h" /* IDs */ #include "hdf5.h" #if 0 /* from SEC2 stuff */ #include "H5FDprivate.h" /* File drivers */ #endif #if 0 /* from SEC2 stuff */ #include "H5FLprivate.h" /* Free Lists */ #include "H5FDsec2.h" /* Sec2 file driver */ #include "H5public.h" /* Generic Functions */ #include "H5FDpublic.h" /* Property lists */ #include "H5FDsplitter.h" /* Splitter file driver */ #endif /* The driver identification number, initialized at runtime */ static hid_t H5FD_SPLITTER_g = 0; #define H5F__CURR_SPLITTER_VFD_CONFIG_VERSION 1 /* * The information provided by application. */ #if 0 typedef struct H5F_splitter_vfd_config_t { int32 version; /* version of the H5F_splitter_vfd_config_t structure used */ hid_t rw_fapl_id; /* fapl for the R/W channel */ hid_t wo_fapl_id; /* fapl for the W/O channel */ char wo_path[H5FD_MAX_FILENAME_LEN + 1]; /* file name for the W/O channel */ char log_file_path[H5FD_MAX_FILENAME_LEN + 1]; /* file in which to record any errors reported by the W/O path */ hbool_t ignore_wo_errs; /* TRUE to ignore errors on the W/O channel */ } H5F_splitter_vfd_config_t; #endif /* * Driver-specific file access properties H5Pset_fapl_splitter stores info from H5F_splitter_vfd_config_t into H5FD_splitter_fapl_t fa H5Pset_driver(fapl_id, H5FD_MULTI, &fa) stores info in fa into a struct of fapl_id H5FD_open_splitter copies info from that struct into H5FD_splitter_t and returns *file */ typedef struct H5FD_splitter_fapl_t { hid_t rw_fapl_id; /* fapl for the R/W channel */ hid_t wo_fapl_id; /* fapl for the W/O channel */ char wo_path[H5FD_MAX_FILENAME_LEN + 1]; /* file name for the W/O channel */ char log_file_path[H5FD_MAX_FILENAME_LEN + 1]; /* file in which to record any errors reported by the W/O path */ hbool_t ignore_wo_errs; /* TRUE to ignore errors on the W/O channel */ } H5FD_splitter_fapl_t; /* * The information of this splitter. */ typedef struct H5FD_splitter_t { H5FD_t pub; /* public stuff, must be first */ unsigned version; /* version of the H5F_splitter_vfd_config_t structure used */ H5FD_splitter_fapl_t drvr_fapl; /* driver-specific file access properties */ int rw_fd; /* the R/W filesystem file descriptor */ int wo_fd; /* the W/O filesystem file descriptor */ haddr_t eoa; /* end of allocated region */ haddr_t eof; /* end of file; current file size */ } H5FD_splitter_t; /* H5FD_multi_fapl_t: Driver-specific file access properties H5FD_multi_t: description of a file belonging to this driver H5FD_splitter_fapl_t */ /* * These macros check for overflow of various quantities. These macros * assume that HDoff_t is signed and haddr_t and size_t are unsigned. * * ADDR_OVERFLOW: Checks whether a file address of type `haddr_t' * is too large to be represented by the second argument * of the file seek function. * * SIZE_OVERFLOW: Checks whether a buffer size of type `hsize_t' is too * large to be represented by the `size_t' type. * * REGION_OVERFLOW: Checks whether an address and size pair describe data * which can be addressed entirely by the second * argument of the file seek function. */ #define MAXADDR (((haddr_t)1<<(8*sizeof(HDoff_t)-1))-1) #define ADDR_OVERFLOW(A) (HADDR_UNDEF==(A) || ((A) & ~(haddr_t)MAXADDR)) #define SIZE_OVERFLOW(Z) ((Z) & ~(hsize_t)MAXADDR) #define REGION_OVERFLOW(A,Z) (ADDR_OVERFLOW(A) || SIZE_OVERFLOW(Z) || \ HADDR_UNDEF==(A)+(Z) || \ (HDoff_t)((A)+(Z))<(HDoff_t)(A)) /* Prototypes */ static herr_t H5FD_splitter_term(void); static H5FD_t *H5FD_splitter_open(const char *name, unsigned flags, hid_t fapl_id, haddr_t maxaddr); static herr_t H5FD_splitter_close(H5FD_t *_file); static herr_t H5FD_splitter_read(H5FD_t *_file, H5FD_mem_t type, hid_t fapl_id, haddr_t addr, size_t size, void *buf); static herr_t H5FD_splitter_write(H5FD_t *_file, H5FD_mem_t type, hid_t fapl_id, haddr_t addr, size_t size, const void *buf); static void *H5FD_splitter_fapl_get(H5FD_t *_file); static void *H5FD_splitter_fapl_copy(const void *_old_fa); static herr_t H5FD_splitter_flush(H5FD_t *_file, hid_t dxpl_id, hbool_t closing); static haddr_t H5FD_splitter_get_eoa(const H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type); static herr_t H5FD_splitter_set_eoa(H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type, haddr_t addr); static haddr_t H5FD_splitter_get_eof(const H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type); static const H5FD_class_t H5FD_splitter_g = { "splitter", /* name */ MAXADDR, /* maxaddr */ H5F_CLOSE_WEAK, /* fc_degree */ H5FD_splitter_term, /* terminate */ NULL, /* sb_size */ NULL, /* sb_encode */ NULL, /* sb_decode */ 0, /* fapl_size */ H5FD_splitter_fapl_get, /* fapl_get */ H5FD_splitter_fapl_copy, /* fapl_copy */ NULL, /* fapl_free */ 0, /* dxpl_size */ NULL, /* dxpl_copy */ NULL, /* dxpl_free */ H5FD_splitter_open, /* open */ H5FD_splitter_close, /* close */ NULL, /* cmp */ NULL, /* query */ NULL, /* get_type_map */ NULL, /* alloc */ NULL, /* free */ H5FD_splitter_get_eoa, /* get_eoa */ H5FD_splitter_set_eoa, /* set_eoa */ H5FD_splitter_get_eof, /* get_eof */ NULL, /* get_handle */ H5FD_splitter_read, /* read */ H5FD_splitter_write, /* write */ H5FD_splitter_flush, /* flush */ NULL, /* truncate */ NULL, /* lock */ NULL, /* unlock */ H5FD_FLMAP_DICHOTOMY /* fl_map */ }; /* Declare a free list to manage the H5FD_sec2_t struct */ H5FL_DEFINE_STATIC(H5FD_splitter_t); /*------------------------------------------------------------------------- * Function: H5FD_splitter_init * * Purpose: Initialize this driver by registering the driver with the * library. * * Return: Success: The driver ID for the splitter driver. * Failure: Negative * * August 27, 2018 * *------------------------------------------------------------------------- */ hid_t H5FD_splitter_init(void) { hid_t ret_value = H5I_INVALID_HID; /* Return value */ FUNC_ENTER_NOAPI(FAIL) if(H5I_VFL != H5I_get_type(H5FD_SPLITTER_g)) H5FD_SPLITTER_g = H5FD_register(&H5FD_splitter_g, sizeof(H5FD_class_t), FALSE); fprintf(stderr, "H5FD_SPLITTER_g = %d\n", H5FD_SPLITTER_g); /* Set return value */ ret_value = H5FD_SPLITTER_g; done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_init() */ /*------------------------------------------------------------------------- * Function: H5FD__init_package * * Purpose: Initializes any interface-specific data or routines. * * Return: Non-negative on success/Negative on failure * *------------------------------------------------------------------------- */ static herr_t H5FD__init_package(void) { herr_t ret_value = SUCCEED; FUNC_ENTER_STATIC if(H5FD_splitter_init() < 0) HGOTO_ERROR(H5E_VFL, H5E_CANTINIT, FAIL, "unable to initialize sec2 VFD") done: FUNC_LEAVE_NOAPI(ret_value) } /* H5FD__init_package() */ /*--------------------------------------------------------------------------- * Function: H5FD_splitter_term * * Purpose: Shut down the VFD * * Returns: SUCCEED (Can't fail) * * August 27, 2018 * *--------------------------------------------------------------------------- */ static herr_t H5FD_splitter_term(void) { FUNC_ENTER_NOAPI_NOINIT_NOERR /* Reset VFL ID */ H5FD_SPLITTER_g = 0; FUNC_LEAVE_NOAPI(SUCCEED) } /* end H5FD_splitter_term() */ /*------------------------------------------------------------------------- * Function: H5Pset_fapl_splitter * * Purpose: Sets the file access property list FAPL_ID to use the * splitter driver. There are no driver * specific properties. * * Return: SUCCEED/FAIL * * August 27, 2018 * *------------------------------------------------------------------------- */ herr_t H5Pset_fapl_splitter(hid_t fapl_id, H5F_splitter_vfd_config_t *vfd_config) { H5FD_splitter_fapl_t fapl; /* driver-specific file access properties */ H5P_genplist_t *plist; /* Property list pointer */ int pname_len = 0; herr_t ret_value; fprintf(stderr, "in H5Pset_fapl_splitter now\n"); /* Clear the error stack */ H5Eclear2(H5E_DEFAULT); FUNC_ENTER_API(FAIL) H5TRACE2("e", "i*x", fapl_id, vfd_config); /* Check arguments */ /* if(TRUE != H5P_isa_class(fapl_id, H5P_FILE_ACCESS)) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list") */ fprintf(stderr, "verifying fapl_id = %d, has type %d\n", fapl_id, H5I_get_type(fapl_id)); fprintf(stderr, "verifying H5FD_SPLITTER = %d, has type %d\n", H5FD_SPLITTER, H5I_get_type(H5FD_SPLITTER)); fprintf(stderr, "verifying H5FD_SEC2 = %d, has type %d\n", H5FD_SEC2, H5I_get_type(H5FD_SEC2)); fprintf(stderr, "verifying H5FD_FAMILY = %d, has type %d\n", H5FD_FAMILY, H5I_get_type(H5FD_FAMILY)); fprintf(stderr, "verifying H5FD_MULTI = %d, has type %d\n", H5FD_MULTI, H5I_get_type(H5FD_MULTI)); fprintf(stderr, "verifying H5FD_CORE = %d, has type %d\n", H5FD_CORE, H5I_get_type(H5FD_CORE)); fprintf(stderr, "verifying H5FD_LOG = %d, has type %d\n", H5FD_LOG, H5I_get_type(H5FD_LOG)); fprintf(stderr, "verifying H5FD_STDIO = %d, has type %d\n", H5FD_STDIO, H5I_get_type(H5FD_STDIO)); fprintf(stderr, "verifying H5FD_DIRECT = %d, has type %d\n", H5FD_DIRECT, H5I_get_type(H5FD_DIRECT)); if(NULL == (plist = H5P_object_verify(fapl_id, H5P_FILE_ACCESS))) { fprintf(stderr, "H5Pset_fapl_splitter: from H5P_object_verify, plist is NULL\n"); HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list") } if(H5P_DEFAULT == vfd_config->rw_fapl_id) fapl.rw_fapl_id = H5P_FILE_ACCESS_DEFAULT; else if(TRUE != H5P_isa_class(vfd_config->rw_fapl_id, H5P_FILE_ACCESS)) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access list") else fapl.rw_fapl_id = vfd_config->rw_fapl_id; if(H5P_DEFAULT == vfd_config->wo_fapl_id) fapl.wo_fapl_id = H5P_FILE_ACCESS_DEFAULT; else if(TRUE != H5P_isa_class(vfd_config->wo_fapl_id, H5P_FILE_ACCESS)) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access list") else fapl.wo_fapl_id = vfd_config->wo_fapl_id; /* Add driver-specific file access properties */ pname_len = HDstrlen(vfd_config->wo_path); HDstrncpy(fapl.wo_path, vfd_config->wo_path, pname_len); pname_len = HDstrlen(vfd_config->log_file_path); HDstrncpy(fapl.log_file_path, vfd_config->log_file_path, pname_len); fapl.ignore_wo_errs = TRUE; ret_value = H5P_set_driver(plist, H5FD_SPLITTER, &fapl); fprintf(stderr, "done ret_value = %d\n", ret_value); done: FUNC_LEAVE_API(ret_value) } /* end H5Pset_fapl_splitter() */ /*------------------------------------------------------------------------- * Function: H5Pget_fapl_splitter * * Purpose: Returns information about the splitter file access property * list through the structure splitter_config. * * Return: SUCCEED/FAIL * * August 27, 2018 * *------------------------------------------------------------------------- */ herr_t H5Pget_fapl_splitter(hid_t fapl_id, H5F_splitter_vfd_config_t *vfd_config) { H5FD_splitter_fapl_t *fapl; H5P_genplist_t *plist; /* Property list pointer */ int pname_len = 0; hid_t plist_id = 0; herr_t ret_value; FUNC_ENTER_API(FAIL) H5TRACE2("e", "i*x", fapl_id, vfd_config); /* Check arguments */ if(TRUE != H5P_isa_class(fapl_id, H5P_FILE_ACCESS)) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list") if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list") plist_id = H5P_peek_driver(plist); fprintf(stderr, "plist_id = %d\n", plist_id); if(H5FD_SPLITTER != H5P_peek_driver(plist)) HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "incorrect VFL driver") if(NULL == (fapl = (const H5FD_splitter_fapl_t *)H5P_peek_driver_info(plist))) HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "bad VFL driver info") vfd_config->rw_fapl_id = fapl->rw_fapl_id; vfd_config->wo_fapl_id = fapl->wo_fapl_id; pname_len = HDstrlen(fapl->wo_path); HDstrncpy(vfd_config->wo_path, fapl->wo_path, pname_len); pname_len = HDstrlen(fapl->log_file_path); HDstrncpy(vfd_config->log_file_path, fapl->log_file_path, pname_len); vfd_config->ignore_wo_errs = fapl->ignore_wo_errs; done: FUNC_LEAVE_API(ret_value) } /* end H5Pget_fapl_splitter() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_flush * * Purpose: * * * Return: Success: The driver ID for the splitter driver. * Failure: Negative * * August 27, 2018 * *------------------------------------------------------------------------- */ static herr_t H5FD_splitter_flush(H5FD_t *_file, hid_t H5_ATTR_UNUSED dxpl_id, hbool_t closing) { H5FD_splitter_t *file = (H5FD_splitter_t*)_file; unsigned u, nerrors = 0; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT if (H5FD_flush(file->drvr_fapl.rw_fapl_id, closing) < 0) nerrors++; if (H5FD_flush(file->drvr_fapl.wo_fapl_id, closing) < 0) nerrors++; if(nerrors) HGOTO_ERROR(H5E_IO, H5E_BADVALUE, FAIL, "unable to flush member files") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_flush() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_read * * Purpose: Reads SIZE bytes of data from FILE beginning at address ADDR * into buffer BUF according to data transfer properties in * DXPL_ID. * * buffer BUF. * Failure: FAIL, Contents of buffer BUF are undefined. * * August 27, 2018 *------------------------------------------------------------------------- */ static herr_t H5FD_splitter_read(H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type, hid_t H5_ATTR_UNUSED dxpl_id, haddr_t addr, size_t size, void *buf /*out*/) { H5FD_splitter_t *file = (H5FD_splitter_t *)_file; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(file && file->pub.cls); HDassert(buf); /* Check for overflow conditions */ if(!H5F_addr_defined(addr)) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "addr undefined, addr = %llu", (unsigned long long)addr) if(REGION_OVERFLOW(addr, size)) HGOTO_ERROR(H5E_ARGS, H5E_OVERFLOW, FAIL, "addr overflow, addr = %llu", (unsigned long long)addr) #if 0 /* Seek to the correct location */ if(addr != file->pos || OP_READ != file->op) { if(HDlseek(file->fd, (HDoff_t)addr, SEEK_SET) < 0) HSYS_GOTO_ERROR(H5E_IO, H5E_SEEKERROR, FAIL, "unable to seek to proper position") } /* end if */ /* Read data, being careful of interrupted system calls, partial results, * and the end of the file. */ while(size > 0) { h5_posix_io_t bytes_in = 0; /* # of bytes to read */ h5_posix_io_ret_t bytes_read = -1; /* # of bytes actually read */ /* Trying to read more bytes than the return type can handle is * undefined behavior in POSIX. */ if(size > H5_POSIX_MAX_IO_BYTES) bytes_in = H5_POSIX_MAX_IO_BYTES; else bytes_in = (h5_posix_io_t)size; do { bytes_read = HDread(file->fd, buf, bytes_in); } while(-1 == bytes_read && EINTR == errno); if(-1 == bytes_read) { /* error */ int myerrno = errno; time_t mytime = HDtime(NULL); HDoff_t myoffset = HDlseek(file->fd, (HDoff_t)0, SEEK_CUR); HGOTO_ERROR(H5E_IO, H5E_READERROR, FAIL, "file read failed: time = %s, filename = '%s', file descriptor = %d, errno = %d, error message = '%s', buf = %p, total read size = %llu, bytes this sub-read = %llu, bytes actually read = %llu, offset = %llu", HDctime(&mytime), file->filename, file->fd, myerrno, HDstrerror(myerrno), buf, (unsigned long long)size, (unsigned long long)bytes_in, (unsigned long long)bytes_read, (unsigned long long)myoffset); } /* end if */ if(0 == bytes_read) { /* end of file but not end of format address space */ HDmemset(buf, 0, size); break; } /* end if */ HDassert(bytes_read >= 0); HDassert((size_t)bytes_read <= size); size -= (size_t)bytes_read; addr += (haddr_t)bytes_read; buf = (char *)buf + bytes_read; } /* end while */ /* Update current position */ file->pos = addr; file->op = OP_READ; #endif done: if(ret_value < 0) { /* Reset last file I/O information */ #if 0 file->pos = HADDR_UNDEF; file->op = OP_UNKNOWN; #endif } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_read() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_write * * Purpose: Writes SIZE bytes of data to FILE beginning at address ADDR * from buffer BUF according to data transfer properties in * DXPL_ID. * * Return: SUCCEED/FAIL * * August 27, 2018 * *------------------------------------------------------------------------- */ static herr_t H5FD_splitter_write(H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type, hid_t H5_ATTR_UNUSED dxpl_id, haddr_t addr, size_t size, const void *buf) { H5FD_splitter_t *file = (H5FD_splitter_t *)_file; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(file && file->pub.cls); HDassert(buf); /* Check for overflow conditions */ if(!H5F_addr_defined(addr)) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "addr undefined, addr = %llu", (unsigned long long)addr) if(REGION_OVERFLOW(addr, size)) HGOTO_ERROR(H5E_ARGS, H5E_OVERFLOW, FAIL, "addr overflow, addr = %llu, size = %llu", (unsigned long long)addr, (unsigned long long)size) #if 0 /* Seek to the correct location */ if(addr != file->pos || OP_WRITE != file->op) { if(HDlseek(file->fd, (HDoff_t)addr, SEEK_SET) < 0) HSYS_GOTO_ERROR(H5E_IO, H5E_SEEKERROR, FAIL, "unable to seek to proper position") } /* end if */ /* Write the data, being careful of interrupted system calls and partial * results */ while(size > 0) { h5_posix_io_t bytes_in = 0; /* # of bytes to write */ h5_posix_io_ret_t bytes_wrote = -1; /* # of bytes written */ /* Trying to write more bytes than the return type can handle is * undefined behavior in POSIX. */ if(size > H5_POSIX_MAX_IO_BYTES) bytes_in = H5_POSIX_MAX_IO_BYTES; else bytes_in = (h5_posix_io_t)size; do { bytes_wrote = HDwrite(file->fd, buf, bytes_in); } while(-1 == bytes_wrote && EINTR == errno); if(-1 == bytes_wrote) { /* error */ int myerrno = errno; time_t mytime = HDtime(NULL); HDoff_t myoffset = HDlseek(file->fd, (HDoff_t)0, SEEK_CUR); HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "file write failed: time = %s, filename = '%s', file descriptor = %d, errno = %d, error message = '%s', buf = %p, total write size = %llu, bytes this sub-write = %llu, bytes actually written = %llu, offset = %llu", HDctime(&mytime), file->filename, file->fd, myerrno, HDstrerror(myerrno), buf, (unsigned long long)size, (unsigned long long)bytes_in, (unsigned long long)bytes_wrote, (unsigned long long)myoffset); } /* end if */ HDassert(bytes_wrote > 0); HDassert((size_t)bytes_wrote <= size); size -= (size_t)bytes_wrote; addr += (haddr_t)bytes_wrote; buf = (const char *)buf + bytes_wrote; } /* end while */ /* Update current position and eof */ file->pos = addr; file->op = OP_WRITE; if(file->pos > file->eof) file->eof = file->pos; #endif done: if(ret_value < 0) { /* Reset last file I/O information */ #if 0 file->pos = HADDR_UNDEF; file->op = OP_UNKNOWN; #endif } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_write() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_fapl_get * * Purpose: Returns a file access property list which indicates how the * specified file is being accessed. The return list could be * used to access another file the same way. * * Return: Success: Ptr to new file access property list with all * members copied from the file struct. * * Failure: NULL * * Programmer: Robb Matzke * Friday, August 13, 1999 * *------------------------------------------------------------------------- */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_fapl_get * * Purpose: Gets a file access property list which could be used to * create an identical file. * * Return: Success: Ptr to new file access property list. * * Failure: NULL * * Programmer: Robb Matzke * Friday, August 13, 1999 * * Modifications: * *------------------------------------------------------------------------- */ static void * H5FD_splitter_fapl_get(H5FD_t *_file) { H5FD_splitter_t *file = (H5FD_splitter_t*)_file; /* Clear the error stack */ H5Eclear2(H5E_DEFAULT); return H5FD_splitter_fapl_copy(&(file->drvr_fapl)); } /*------------------------------------------------------------------------- * Function: H5FD_splitter_fapl_copy * * Purpose: Copies the log-specific file access properties. * * Return: Success: Ptr to a new property list * Failure: NULL * * Programmer: Quincey Koziol * Thursday, April 20, 2000 * *------------------------------------------------------------------------- */ static void * H5FD_splitter_fapl_copy(const void *_old_fa) { const H5FD_splitter_fapl_t *old_fa = (const H5FD_splitter_fapl_t*)_old_fa; H5FD_splitter_fapl_t *new_fa = NULL; /* New FAPL info */ int path_len = 0; void *ret_value = NULL; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(old_fa); /* Allocate the new FAPL info */ if(NULL == (new_fa = (H5FD_splitter_fapl_t *)H5MM_malloc(sizeof(H5FD_splitter_fapl_t)))) HGOTO_ERROR(H5E_FILE, H5E_CANTALLOC, NULL, "unable to allocate log file FAPL") /* Copy the general information */ HDmemcpy(new_fa, old_fa, sizeof(H5FD_splitter_fapl_t)); /* new_fapl->rw_fapl_id = old_fa->rw_fapl_id; new_fapl->wo_fapl_id = old_fa->wo_fapl_id; */ /* Deep copy the file names */ path_len = HDstrlen(old_fa->wo_path); if(path_len > 0) HDstrncpy(new_fa->wo_path, old_fa->wo_path, path_len); path_len = HDstrlen(old_fa->log_file_path); if(path_len > 0) HDstrncpy(new_fa->log_file_path, old_fa->log_file_path, path_len); /* dynamic if(old_fa->wo_path != NULL) if(NULL == (new_fa->wo_path = H5MM_strdup(old_fa->wo_path))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "unable to allocate W/O file path") if(old_fa->log_file_path != NULL) if(NULL == (new_fa->log_file_path = H5MM_strdup(old_fa->log_file_path))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "unable to allocate W/O file path") */ /* Set return value */ ret_value = new_fa; done: if(NULL == ret_value) if(new_fa) { /* if(new_fa->log_file_path) new_fa->log_file_path = (char *)H5MM_xfree(new_fa->log_file_path); need wo_path too */ H5MM_free(new_fa); } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_fapl_copy() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_open * * Purpose: Create and/or opens a file as an HDF5 file. * * Return: Success: A pointer to a new file data structure. The * public fields will be initialized by the * caller, which is always H5FD_open(). * Failure: NULL * * August 27, 2018 * *------------------------------------------------------------------------- */ static H5FD_t * H5FD_splitter_open(const char *name, unsigned flags, hid_t splitter_fapl_id, haddr_t maxaddr) { H5FD_splitter_t *file = NULL; /* splitter VFD info */ H5FD_splitter_t *splitter_fa = NULL; /* splitter VFD info */ int fd = -1; /* File descriptor */ int o_flags; /* Flags for open() call */ #ifdef H5_HAVE_WIN32_API struct _BY_HANDLE_FILE_INFORMATION fileinfo; #endif H5FD_t *ret_value = NULL; /* Return value */ FUNC_ENTER_NOAPI_NOINIT /* Check arguments */ if(!name || !*name) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid file name") if(H5F_ACC_RDONLY & flags) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "read-only is not allowed") if(0 == maxaddr || HADDR_UNDEF == maxaddr) HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, NULL, "bogus maxaddr") if(ADDR_OVERFLOW(maxaddr)) HGOTO_ERROR(H5E_ARGS, H5E_OVERFLOW, NULL, "bogus maxaddr") if(H5P_FILE_ACCESS_DEFAULT==splitter_fapl_id || H5FD_SPLITTER!=H5Pget_driver(splitter_fapl_id)) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "driver is not splitter") /* Get the splitter fapl struct */ if(NULL == (splitter_fa = (H5FD_splitter_fapl_t *)H5Pget_driver_info(splitter_fapl_id))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "unable to get splitter fapl struct") /* file->splitter_fa.memb_map[mt] = splitter_fa->memb_map[mt]; file->splitter_fa.memb_addr[mt] = splitter_fa->memb_addr[mt]; */ /* Initialize file from file access properties */ if(NULL == (file = (H5FD_splitter_t *)H5MM_calloc(sizeof(H5FD_splitter_t)))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "unable to allocate file struct") /* Get driver info */ /* HDstrncpy(file->filename, name, sizeof(file->filename)); file->filename[sizeof(file->filename) - 1] = '\0'; */ /* Set return value */ ret_value = (H5FD_t*)file; done: if(NULL == ret_value) { if(fd >= 0) HDclose(fd); if(file) /* need to add H5_H5FD_splitter_t_reg_free_list somewhere */ fprintf(stderr, "file = H5FL_FREE(H5FD_splitter_t, file);\n"); } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_open() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_close * * Purpose: Closes both local and remote files. * * Return: Success: SUCCEED * Failure: FAIL, file not closed. * * August 27, 2018 * *------------------------------------------------------------------------- */ static herr_t H5FD_splitter_close(H5FD_t *_file) { H5FD_splitter_t *file = (H5FD_splitter_t *)_file; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT /* Sanity check */ HDassert(file); /* Close the local file if it's been opened */ if(file->rw_fd != 0 && HDclose(file->rw_fd) < 0) HGOTO_ERROR(H5E_IO, H5E_CANTCLOSEFILE, FAIL, "unable to close local file") /* Close the W/O file if it's been opened */ if(file->rw_fd != 0 && HDclose(file->wo_fd) < 0) HGOTO_ERROR(H5E_IO, H5E_CANTCLOSEFILE, FAIL, "unable to close remote file") /* Release the file info */ /* file = H5FL_FREE(H5FD_splitter_t, file); */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_splitter_close() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_get_eoa * * Purpose: Returns the end-of-address marker for the file. The EOA * marker is the first address past the last byte allocated in * the format address space. * * Return: Success: The end-of-address-marker * * Failure: HADDR_UNDEF * *------------------------------------------------------------------------- */ static haddr_t H5FD_splitter_get_eoa(const H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type) { const H5FD_splitter_t *file = (const H5FD_splitter_t*)_file; FUNC_ENTER_NOAPI_NOINIT_NOERR FUNC_LEAVE_NOAPI(file->eoa) } /*------------------------------------------------------------------------- * Function: H5FD_splitter_set_eoa * * Purpose: Set the end-of-address marker for the file. This function is * called shortly after an existing HDF5 file is opened in order * to tell the driver where the end of the HDF5 data is located. * * Return: SUCCEED (Can't fail) * * Programmer: Robb Matzke * Thursday, July 29, 1999 * *------------------------------------------------------------------------- */ static herr_t H5FD_splitter_set_eoa(H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type, haddr_t addr) { H5FD_splitter_t *file = (H5FD_splitter_t *)_file; FUNC_ENTER_NOAPI_NOINIT_NOERR file->eoa = addr; FUNC_LEAVE_NOAPI(SUCCEED) } /* end H5FD_splitter_set_eoa() */ /*------------------------------------------------------------------------- * Function: H5FD_splitter_get_eof * * Purpose: Returns the end-of-address marker for the file. The EOA * marker is the first address past the last byte allocated in * the format address space. * * Return: Success: The end-of-address-marker * * Failure: HADDR_UNDEF * *------------------------------------------------------------------------- */ static haddr_t H5FD_splitter_get_eof(const H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type) { const H5FD_splitter_t *file = (const H5FD_splitter_t*)_file; FUNC_ENTER_NOAPI_NOINIT_NOERR FUNC_LEAVE_NOAPI(file->eof) } #if 0 /* sec2 */ /* Prototypes */ static int H5FD_sec2_cmp(const H5FD_t *_f1, const H5FD_t *_f2); static herr_t H5FD_sec2_query(const H5FD_t *_f1, unsigned long *flags); static haddr_t H5FD_sec2_get_eoa(const H5FD_t *_file, H5FD_mem_t type); static herr_t H5FD_sec2_set_eoa(H5FD_t *_file, H5FD_mem_t type, haddr_t addr); static haddr_t H5FD_sec2_get_eof(const H5FD_t *_file, H5FD_mem_t type); static herr_t H5FD_sec2_get_handle(H5FD_t *_file, hid_t fapl, void** file_handle); static herr_t H5FD_sec2_truncate(H5FD_t *_file, hid_t dxpl_id, hbool_t closing); static herr_t H5FD_sec2_lock(H5FD_t *_file, hbool_t rw); static herr_t H5FD_sec2_unlock(H5FD_t *_file); /* Declare a free list to manage the H5FD_sec2_t struct */ H5FL_DEFINE_STATIC(H5FD_sec2_t); /*------------------------------------------------------------------------- * Function: H5FD_sec2_cmp * * Purpose: Compares two files belonging to this driver using an * arbitrary (but consistent) ordering. * * Return: Success: A value like strcmp() * Failure: never fails (arguments were checked by the * caller). * * Programmer: Robb Matzke * Thursday, July 29, 1999 * *------------------------------------------------------------------------- */ static int H5FD_sec2_cmp(const H5FD_t *_f1, const H5FD_t *_f2) { const H5FD_sec2_t *f1 = (const H5FD_sec2_t *)_f1; const H5FD_sec2_t *f2 = (const H5FD_sec2_t *)_f2; int ret_value = 0; FUNC_ENTER_NOAPI_NOINIT_NOERR #ifdef H5_HAVE_WIN32_API if(f1->dwVolumeSerialNumber < f2->dwVolumeSerialNumber) HGOTO_DONE(-1) if(f1->dwVolumeSerialNumber > f2->dwVolumeSerialNumber) HGOTO_DONE(1) if(f1->nFileIndexHigh < f2->nFileIndexHigh) HGOTO_DONE(-1) if(f1->nFileIndexHigh > f2->nFileIndexHigh) HGOTO_DONE(1) if(f1->nFileIndexLow < f2->nFileIndexLow) HGOTO_DONE(-1) if(f1->nFileIndexLow > f2->nFileIndexLow) HGOTO_DONE(1) #else /* H5_HAVE_WIN32_API */ #ifdef H5_DEV_T_IS_SCALAR if(f1->device < f2->device) HGOTO_DONE(-1) if(f1->device > f2->device) HGOTO_DONE(1) #else /* H5_DEV_T_IS_SCALAR */ /* If dev_t isn't a scalar value on this system, just use memcmp to * determine if the values are the same or not. The actual return value * shouldn't really matter... */ if(HDmemcmp(&(f1->device),&(f2->device),sizeof(dev_t)) < 0) HGOTO_DONE(-1) if(HDmemcmp(&(f1->device),&(f2->device),sizeof(dev_t)) > 0) HGOTO_DONE(1) #endif /* H5_DEV_T_IS_SCALAR */ if(f1->inode < f2->inode) HGOTO_DONE(-1) if(f1->inode > f2->inode) HGOTO_DONE(1) #endif /* H5_HAVE_WIN32_API */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_sec2_cmp() */ /*------------------------------------------------------------------------- * Function: H5FD_sec2_query * * Purpose: Set the flags that this VFL driver is capable of supporting. * (listed in H5FDpublic.h) * * Return: SUCCEED (Can't fail) * * Programmer: Quincey Koziol * Friday, August 25, 2000 * *------------------------------------------------------------------------- */ static herr_t H5FD_sec2_query(const H5FD_t *_file, unsigned long *flags /* out */) { const H5FD_sec2_t *file = (const H5FD_sec2_t *)_file; /* sec2 VFD info */ FUNC_ENTER_NOAPI_NOINIT_NOERR /* Set the VFL feature flags that this driver supports */ if(flags) { *flags = 0; *flags |= H5FD_FEAT_AGGREGATE_METADATA; /* OK to aggregate metadata allocations */ *flags |= H5FD_FEAT_ACCUMULATE_METADATA; /* OK to accumulate metadata for faster writes */ *flags |= H5FD_FEAT_DATA_SIEVE; /* OK to perform data sieving for faster raw data reads & writes */ *flags |= H5FD_FEAT_AGGREGATE_SMALLDATA; /* OK to aggregate "small" raw data allocations */ *flags |= H5FD_FEAT_POSIX_COMPAT_HANDLE; /* get_handle callback returns a POSIX file descriptor */ *flags |= H5FD_FEAT_SUPPORTS_SWMR_IO; /* VFD supports the single-writer/multiple-readers (SWMR) pattern */ *flags |= H5FD_FEAT_DEFAULT_VFD_COMPATIBLE; /* VFD creates a file which can be opened with the default VFD */ /* Check for flags that are set by h5repart */ if(file && file->fam_to_sec2) *flags |= H5FD_FEAT_IGNORE_DRVRINFO; /* Ignore the driver info when file is opened (which eliminates it) */ } /* end if */ FUNC_LEAVE_NOAPI(SUCCEED) } /* end H5FD_sec2_query() */ /*------------------------------------------------------------------------- * Function: H5FD_sec2_get_handle * * Purpose: Returns the file handle of sec2 file driver. * * Returns: SUCCEED/FAIL * * Programmer: Raymond Lu * Sept. 16, 2002 * *------------------------------------------------------------------------- */ static herr_t H5FD_sec2_get_handle(H5FD_t *_file, hid_t H5_ATTR_UNUSED fapl, void **file_handle) { H5FD_sec2_t *file = (H5FD_sec2_t *)_file; herr_t ret_value = SUCCEED; FUNC_ENTER_NOAPI_NOINIT if(!file_handle) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "file handle not valid") *file_handle = &(file->fd); done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_sec2_get_handle() */ /*------------------------------------------------------------------------- * Function: H5FD_sec2_truncate * * Purpose: Makes sure that the true file size is the same (or larger) * than the end-of-address. * * Return: SUCCEED/FAIL * * Programmer: Robb Matzke * Wednesday, August 4, 1999 * *------------------------------------------------------------------------- */ static herr_t H5FD_sec2_truncate(H5FD_t *_file, hid_t H5_ATTR_UNUSED dxpl_id, hbool_t H5_ATTR_UNUSED closing) { H5FD_sec2_t *file = (H5FD_sec2_t *)_file; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(file); /* Extend the file to make sure it's large enough */ if(!H5F_addr_eq(file->eoa, file->eof)) { #ifdef H5_HAVE_WIN32_API LARGE_INTEGER li; /* 64-bit (union) integer for SetFilePointer() call */ DWORD dwPtrLow; /* Low-order pointer bits from SetFilePointer() * Only used as an error code here. */ DWORD dwError; /* DWORD error code from GetLastError() */ BOOL bError; /* Boolean error flag */ /* Windows uses this odd QuadPart union for 32/64-bit portability */ li.QuadPart = (__int64)file->eoa; /* Extend the file to make sure it's large enough. * * Since INVALID_SET_FILE_POINTER can technically be a valid return value * from SetFilePointer(), we also need to check GetLastError(). */ dwPtrLow = SetFilePointer(file->hFile, li.LowPart, &li.HighPart, FILE_BEGIN); if(INVALID_SET_FILE_POINTER == dwPtrLow) { dwError = GetLastError(); if(dwError != NO_ERROR ) HGOTO_ERROR(H5E_FILE, H5E_FILEOPEN, FAIL, "unable to set file pointer") } bError = SetEndOfFile(file->hFile); if(0 == bError) HGOTO_ERROR(H5E_IO, H5E_SEEKERROR, FAIL, "unable to extend file properly") #else /* H5_HAVE_WIN32_API */ if(-1 == HDftruncate(file->fd, (HDoff_t)file->eoa)) HSYS_GOTO_ERROR(H5E_IO, H5E_SEEKERROR, FAIL, "unable to extend file properly") #endif /* H5_HAVE_WIN32_API */ /* Update the eof value */ file->eof = file->eoa; /* Reset last file I/O information */ file->pos = HADDR_UNDEF; file->op = OP_UNKNOWN; } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_sec2_truncate() */ /*------------------------------------------------------------------------- * Function: H5FD_sec2_lock * * Purpose: To place an advisory lock on a file. * The lock type to apply depends on the parameter "rw": * TRUE--opens for write: an exclusive lock * FALSE--opens for read: a shared lock * * Return: SUCCEED/FAIL * * Programmer: Vailin Choi; May 2013 * *------------------------------------------------------------------------- */ static herr_t H5FD_sec2_lock(H5FD_t *_file, hbool_t rw) { H5FD_sec2_t *file = (H5FD_sec2_t *)_file; /* VFD file struct */ int lock_flags; /* file locking flags */ herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(file); /* Set exclusive or shared lock based on rw status */ lock_flags = rw ? LOCK_EX : LOCK_SH; /* Place a non-blocking lock on the file */ if(HDflock(file->fd, lock_flags | LOCK_NB) < 0) { if(ENOSYS == errno) HSYS_GOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL, "file locking disabled on this file system (use HDF5_USE_FILE_LOCKING environment variable to override)") else HSYS_GOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL, "unable to lock file") } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_sec2_lock() */ /*------------------------------------------------------------------------- * Function: H5FD_sec2_unlock * * Purpose: To remove the existing lock on the file * * Return: SUCCEED/FAIL * * Programmer: Vailin Choi; May 2013 * *------------------------------------------------------------------------- */ static herr_t H5FD_sec2_unlock(H5FD_t *_file) { H5FD_sec2_t *file = (H5FD_sec2_t *)_file; /* VFD file struct */ herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT HDassert(file); if(HDflock(file->fd, LOCK_UN) < 0) { if(ENOSYS == errno) HSYS_GOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL, "file locking disabled on this file system (use HDF5_USE_FILE_LOCKING environment variable to override)") else HSYS_GOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL, "unable to unlock file") } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5FD_sec2_unlock() */ #endif /* sec2 */ #if 0 splitter() { hid_t fid = -1; /* file ID */ hid_t fapl_id = -1; /* file access property list ID */ hid_t fapl_id_out = -1; /* from H5Fget_access_plist */ hid_t driver_id = -1; /* ID for this VFD */ unsigned long driver_flags = 0; /* VFD feature flags */ char filename[1024]; /* filename */ char filename[1024]; /* filename */ void *os_file_handle = NULL; /* OS file handle */ hsize_t file_size; /* file size */ /* Set property list and file name for SPLITTER driver */ if((fapl_id = H5Pcreate(H5P_FILE_ACCESS)) < 0) TEST_ERROR; if(H5Pset_fapl_splitter(fapl_id) < 0) TEST_ERROR; h5_fixname(FILENAME, fapl_id, filename, sizeof(filename)); /* Check that the VFD feature flags are correct */ if ((driver_id = H5Pget_driver(fapl_id)) < 0) TEST_ERROR if (H5FDdriver_query(driver_id, &driver_flags) < 0) TEST_ERROR } #endif