/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * 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.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*-------------------------------------------------------------------------
 *
 * Created:     vfd_swmr_addrem_writer.c
 *              (copied and modified from swmr_addrem_writer.c)
 *
 * Purpose:     Adds and removes data to a randomly selected subset of the
 *              datasets in the VFD SWMR test file.
 *
 *              This program is intended to run concurrently with the
 *              vfd_swmr_reader program.  It is also run AFTER a sequential
 *              (not concurrent!) invoking of vfd_swmr_writer so the writer
 *              can dump a bunch of data into the datasets.  Otherwise,
 *              there wouldn't be much to shrink :)
 *
 *-------------------------------------------------------------------------
 */

/***********/
/* Headers */
/***********/

#include <err.h> /* errx(3) */
#include <stdlib.h> /* EXIT_FAILURE */

#include "h5test.h"
#include "vfd_swmr_common.h"

/****************/
/* Local Macros */
/****************/

/********************/
/* Local Prototypes */
/********************/

static hid_t open_skeleton(const char *filename, unsigned verbose);
static int addrem_records(hid_t fid, unsigned verbose, unsigned long nops,
    unsigned long flush_count);
static void usage(void);


/*-------------------------------------------------------------------------
 * Function:    open_skeleton
 *
 * Purpose:     Opens the SWMR HDF5 file and datasets.
 *
 * Parameters:  const char *filename
 *              The filename of the SWMR HDF5 file to open
 *
 *              unsigned verbose
 *              Whether or not to emit verbose console messages
 *
 * Return:      Success:    The file ID of the opened SWMR file
 *                          The dataset IDs are stored in a global array
 *
 *              Failure:    -1
 *
 *-------------------------------------------------------------------------
 */
static hid_t
open_skeleton(const char *filename, unsigned verbose)
{
    hid_t dapl = H5I_INVALID_HID;
    hid_t fid = -1;     /* File ID for new HDF5 file */
    hid_t fapl = -1;    /* File access property list */
    hid_t sid = -1;     /* Dataspace ID */
    hsize_t dim[2];     /* Dataspace dimension */
    unsigned u, v;      /* Local index variable */
    H5F_vfd_swmr_config_t *config = NULL;   /* Configuration for VFD SWMR */

    HDassert(filename);

    /* Create file access property list */
    if((fapl = h5_fileaccess()) < 0)
        goto error;

    if ((dapl = H5Pcreate(H5P_DATASET_ACCESS)) < 0)
        errx(EXIT_FAILURE, "%s.%d: H5Pcreate failed", __func__, __LINE__);

    if (H5Pset_chunk_cache(dapl, H5D_CHUNK_CACHE_NSLOTS_DEFAULT, 0,
                           H5D_CHUNK_CACHE_W0_DEFAULT) < 0)
        errx(EXIT_FAILURE, "H5Pset_chunk_cache failed");

    /* Set to use the latest library format */
    if(H5Pset_libver_bounds(fapl, H5F_LIBVER_LATEST, H5F_LIBVER_LATEST) < 0)
        goto error;

    /*
     * Set up to open the file with VFD SWMR configured.
     */

    /* Enable page buffering */
    if(H5Pset_page_buffer_size(fapl, 4096, 0, 0) < 0)
        goto error;

     /* Allocate memory for the configuration structure */
     if((config = calloc(1, sizeof(*config))) == NULL)
        goto error;

    config->version = H5F__CURR_VFD_SWMR_CONFIG_VERSION;
    config->tick_len = 4;
    config->max_lag = 5;
    config->writer = TRUE;
    config->md_pages_reserved = 128;
    esnprintf(config->md_file_path, sizeof(config->md_file_path),
        "./rw-shadow");

    /* Enable VFD SWMR configuration */
    if(H5Pset_vfd_swmr_config(fapl, config) < 0)
        goto error;

    /* Open the file */
    if((fid = H5Fopen(filename, H5F_ACC_RDWR, fapl)) < 0)
        goto error;

    /* Close file access property list */
    if(H5Pclose(fapl) < 0)
        goto error;

    if(config)
        HDfree(config);

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Opening datasets\n");

    /* Open the datasets */
    for(u = 0; u < NLEVELS; u++)
        for(v = 0; v < symbol_count[u]; v++) {
            hid_t dsid;

            if((dsid = H5Dopen2(fid, symbol_info[u][v].name, dapl)) < 0)
                goto error;

            symbol_info[u][v].dsid = dsid;

            if((sid = H5Dget_space(symbol_info[u][v].dsid)) < 0)
                goto error;
            if(2 != H5Sget_simple_extent_ndims(sid))
                goto error;
            if(H5Sget_simple_extent_dims(sid, dim, NULL) < 0)
                goto error;
            symbol_info[u][v].nrecords = dim[1];

            if(H5Sclose(sid) < 0)
                goto error;
        } /* end for */

    return fid;

error:
    if(config)
        HDfree(config);

    H5E_BEGIN_TRY {
        for(u = 0; u < NLEVELS; u++)
            for(v = 0; v < symbol_count[u]; v++)
                H5Dclose(symbol_info[u][v].dsid);
        H5Sclose(sid);
        H5Pclose(fapl);
        H5Fclose(fid);
        H5Pclose(dapl);
    } H5E_END_TRY;

    return -1;

} /* open_skeleton() */


/*-------------------------------------------------------------------------
 * Function:    addrem_records
 *
 * Purpose:     Adds/removes a specified number of records to random datasets
 *              to the SWMR test file.
 *
 * Parameters:  hid_t fid
 *              The file ID of the SWMR HDF5 file
 *
 *              unsigned verbose
 *              Whether or not to emit verbose console messages
 *
 *              unsigned long nops
 *              # of records to read/write in the datasets
 *
 *              unsigned long flush_count
 *              # of records to write before flushing the file to disk
 *
 * Return:      Success:    0
 *              Failure:    -1
 *
 *-------------------------------------------------------------------------
 */
static int
addrem_records(hid_t fid, unsigned verbose, unsigned long nops, unsigned long flush_count)
{
    hid_t tid = -1;                     /* Datatype ID for records */
    hid_t mem_sid = -1;                 /* Memory dataspace ID */
    hid_t file_sid = -1;                /* Dataset's space ID */
    hsize_t start[2] = {0, 0}, count[2] = {1, 1}; /* Hyperslab selection values */
    hsize_t dim[2] = {1, 0};            /* Dataspace dimensions */
    symbol_t buf[MAX_SIZE_CHANGE];      /* Write buffer */
    unsigned long op_to_flush;          /* # of operations before flush */
    unsigned long u, v;                 /* Local index variables */

    HDassert(fid > 0);

    /* Reset the buffer */
    HDmemset(&buf, 0, sizeof(buf));

    /* Create a dataspace for the record to add */
    if((mem_sid = H5Screate_simple(2, count, NULL)) < 0)
        goto error;

    /* Create datatype for appending records */
    if((tid = create_symbol_datatype()) < 0)
        goto error;

    /* Add and remove records to random datasets, according to frequency
     * distribution */
    op_to_flush = flush_count;
    for(u=0; u<nops; u++) {
        symbol_info_t *symbol;  /* Symbol to write record to */

        /* Get a random dataset, according to the symbol distribution */
        symbol = choose_dataset(NULL, NULL);

        /* Decide whether to shrink or expand, and by how much */
        count[1] = (hsize_t)HDrandom() % (MAX_SIZE_CHANGE * 2) + 1;

        if(count[1] > MAX_SIZE_CHANGE) {
            /* Add records */
            count[1] -= MAX_SIZE_CHANGE;

            /* Set the buffer's IDs (equal to its position) */
            for(v=0; v<count[1]; v++)
                buf[v].rec_id = (uint64_t)symbol->nrecords + (uint64_t)v;

            /* Set the memory space to the correct size */
            if(H5Sset_extent_simple(mem_sid, 2, count, NULL) < 0)
                goto error;

            /* Get the coordinates to write */
            start[1] = symbol->nrecords;

             /* Extend the dataset's dataspace to hold the new record */
            symbol->nrecords+= count[1];
            dim[1] = symbol->nrecords;
            if(H5Dset_extent(symbol->dsid, dim) < 0)
                goto error;

            /* Get the dataset's dataspace */
            if((file_sid = H5Dget_space(symbol->dsid)) < 0)
                goto error;

            /* Choose the last record in the dataset */
            if(H5Sselect_hyperslab(file_sid, H5S_SELECT_SET, start, NULL, count, NULL) < 0)
                goto error;

            /* Write record to the dataset */
            if(H5Dwrite(symbol->dsid, tid, mem_sid, file_sid, H5P_DEFAULT, &buf) < 0)
                goto error;

            if(H5Dflush(symbol->dsid) < 0)
                goto error;

            /* Close the dataset's dataspace */
            if(H5Sclose(file_sid) < 0)
                goto error;
        } /* end if */
        else {
            /* Shrink the dataset's dataspace */
            if(count[1] > symbol->nrecords)
                symbol->nrecords = 0;
            else
                symbol->nrecords -= count[1];
            dim[1] = symbol->nrecords;
            if(H5Dset_extent(symbol->dsid, dim) < 0)
                goto error;
        } /* end else */

        /* Check for flushing file */
        if(flush_count > 0) {
            /* Decrement count of records to write before flushing */
            op_to_flush--;

            /* Check for counter being reached */
            if(0 == op_to_flush) {
#ifdef TEMP_OUT
                /* Flush contents of file */
                if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
                    return -1;
#endif /* TEMP_OUT */

                /* Reset flush counter */
                op_to_flush = flush_count;
            } /* end if */
        } /* end if */
    } /* end for */

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Closing datasets\n");

    /* Close the datasets */
    for(u = 0; u < NLEVELS; u++)
        for(v = 0; v < symbol_count[u]; v++)
            if(H5Dclose(symbol_info[u][v].dsid) < 0)
                return -1;

    return 0;

error:
     H5E_BEGIN_TRY {
        H5Sclose(mem_sid);
        H5Sclose(file_sid);
        H5Tclose(tid);

        for(u = 0; u < NLEVELS; u++)
            for(v = 0; v < symbol_count[u]; v++)
                H5Dclose(symbol_info[u][v].dsid);

    } H5E_END_TRY;

    return -1;

} /* addrem_records() */

static void
usage(void)
{
    printf("\n");
    printf("Usage error!\n");
    printf("\n");
    printf("Usage: vfd_swmr_addrem_writer [-q] [-f <# of operations between flushing\n");
    printf("    file contents>] [-r <random seed>] <# of operations>\n");
    printf("\n");
    printf("<# of operations between flushing file contents> should be 0 (for\n");
    printf("no flushing) or between 1 and (<# of operations> - 1).\n");
    printf("\n");
    printf("<# of operations> must be specified.\n");
    printf("\n");
    printf("Defaults to verbose (no '-q' given), flushing every 1000 operations\n");
    printf("('-f 1000'), and will generate a random seed (no -r given).\n");
    printf("\n");
    HDexit(1);
} /* usage() */

int main(int argc, const char *argv[])
{
    sigset_t oldset;
    hid_t fid;                  /* File ID for file opened */
    long nops = 0;              /* # of times to grow or shrink the dataset */
    long flush_count = 1000;    /* # of records to write between flushing file */
    unsigned verbose = 1;       /* Whether to emit some informational messages */
    unsigned use_seed = 0;      /* Set to 1 if a seed was set on the command line */
    unsigned random_seed = 0;   /* Random # seed */
    unsigned u;                 /* Local index variable */
    int temp;

    block_signals(&oldset);

    /* Parse command line options */
    if(argc < 2)
        usage();
    if(argc > 1) {
        u = 1;
        while(u < (unsigned)argc) {
            if(argv[u][0] == '-') {
                switch(argv[u][1]) {
                    /* # of records to write between flushing file */
                    case 'f':
                        flush_count = HDatol(argv[u + 1]);
                        if(flush_count < 0)
                            usage();
                        u += 2;
                        break;

                    /* Be quiet */
                    case 'q':
                        verbose = 0;
                        u++;
                        break;
                    
                    /* Random # seed */
                    case 'r':
                        use_seed = 1;
                        temp = HDatoi(argv[u + 1]);
                        if(temp < 0)
                            usage();
                        else
                            random_seed = (unsigned)temp;
                        u += 2;
                        break;

                    default:
                        usage();
                        break;
                } /* end switch */
            } /* end if */
            else {
                /* Get the number of records to append */
                nops = HDatol(argv[u]);
                if(nops <= 0)
                    usage();

                u++;
            } /* end else */
        } /* end while */
    } /* end if */
    if(nops <= 0)
        usage();
    if(flush_count >= nops)
        usage();

    /* Emit informational message */
    if(verbose) {
        HDfprintf(stderr, "WRITER: Parameters:\n");
        HDfprintf(stderr, "\t# of operations between flushes = %ld\n", flush_count);
        HDfprintf(stderr, "\t# of operations = %ld\n", nops);
    } /* end if */

    /* Set the random seed */
    if(0 == use_seed) {
        struct timeval t;
        HDgettimeofday(&t, NULL);
        random_seed = (unsigned)(t.tv_usec);
    } /* end if */
    HDsrandom(random_seed);
    /* ALWAYS emit the random seed for possible debugging */
    HDfprintf(stderr, "WRITER: Using writer random seed: %u\n", random_seed);

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Generating symbol names\n");

    /* Generate dataset names */
    if(generate_symbols() < 0)
        return -1;

    /* Emit informational message */
    if(verbose) {
        HDfprintf(stderr, "WRITER: Opening skeleton file: %s\n",
            COMMON_FILENAME);
    }

    /* Open file skeleton */
    if((fid = open_skeleton(COMMON_FILENAME, verbose)) < 0) {
        HDfprintf(stderr, "WRITER: Error opening skeleton file!\n");
        HDexit(1);
    } /* end if */

    /* Send a message to indicate "H5Fopen" is complete--releasing the file lock */
    h5_send_message(WRITER_MESSAGE, NULL, NULL);

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Adding and removing records\n");

    /* Grow and shrink datasets */
    if(addrem_records(fid, verbose, (unsigned long)nops, (unsigned long)flush_count) < 0) {
        HDfprintf(stderr, "WRITER: Error adding and removing records from datasets!\n");
        HDexit(1);
    } /* end if */

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Releasing symbols\n");

    /* Clean up the symbols */
    if(shutdown_symbols() < 0) {
        HDfprintf(stderr, "WRITER: Error releasing symbols!\n");
        HDexit(1);
    } /* end if */

    await_signal(fid);

    restore_signals(&oldset);

    /* Emit informational message */
    if(verbose)
        HDfprintf(stderr, "WRITER: Closing objects\n");

    /* Close objects opened */
    if(H5Fclose(fid) < 0) {
        HDfprintf(stderr, "WRITER: Error closing file!\n");
        HDexit(1);
    } /* end if */

    return 0;
} /* main() */