/*
Copyright (c) 1994 - 2010, Lawrence Livermore National Security, LLC.
LLNL-CODE-425250.
All rights reserved.

This file is part of Silo. For details, see silo.llnl.gov.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

   * Redistributions of source code must retain the above copyright
     notice, this list of conditions and the disclaimer below.
   * Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the disclaimer (as noted
     below) in the documentation and/or other materials provided with
     the distribution.
   * Neither the name of the LLNS/LLNL nor the names of its
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.

THIS SOFTWARE  IS PROVIDED BY  THE COPYRIGHT HOLDERS  AND CONTRIBUTORS
"AS  IS" AND  ANY EXPRESS  OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT
LIMITED TO, THE IMPLIED  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A  PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN  NO  EVENT SHALL  LAWRENCE
LIVERMORE  NATIONAL SECURITY, LLC,  THE U.S.  DEPARTMENT OF  ENERGY OR
CONTRIBUTORS BE LIABLE FOR  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR  CONSEQUENTIAL DAMAGES  (INCLUDING, BUT NOT  LIMITED TO,
PROCUREMENT OF  SUBSTITUTE GOODS  OR SERVICES; LOSS  OF USE,  DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER  IN CONTRACT, STRICT LIABILITY,  OR TORT (INCLUDING
NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT  OF THE USE  OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This work was produced at Lawrence Livermore National Laboratory under
Contract  No.   DE-AC52-07NA27344 with  the  DOE.  Neither the  United
States Government  nor Lawrence  Livermore National Security,  LLC nor
any of  their employees,  makes any warranty,  express or  implied, or
assumes   any   liability   or   responsibility  for   the   accuracy,
completeness, or usefulness of any information, apparatus, product, or
process  disclosed, or  represents  that its  use  would not  infringe
privately-owned   rights.  Any  reference   herein  to   any  specific
commercial products,  process, or  services by trade  name, trademark,
manufacturer or otherwise does not necessarily constitute or imply its
endorsement,  recommendation,   or  favoring  by   the  United  States
Government or Lawrence Livermore National Security, LLC. The views and
opinions  of authors  expressed  herein do  not  necessarily state  or
reflect those  of the United  States Government or  Lawrence Livermore
National  Security, LLC,  and shall  not  be used  for advertising  or
product endorsement purposes.
*/
typedef enum _ioflags_t
{
    IO_WRITE    = 0x00000001,
    IO_READ     = 0x00000002,
    IO_APPEND   = 0x00000004,
    IO_TRUNCATE = 0x00000008
} ioflags_t;

/* if you define members such that a value of 0 serves
   as a suitable default, then you don't have to worry
   about an special initialization. */
typedef struct _options_t
{
    const char *io_interface;
    int request_size_in_bytes;
    int num_requests;
    int initial_file_size;
    int seek_noise;
    int size_noise;
    int test_read;
    ioflags_t flags;
    int print_details;
    int alignment;
    int rand_file_name;
    int no_mpi;
    int mpi_rank;
    int mpi_size;
} options_t;

typedef enum _ioop_t
{
    OP_WRITE,
    OP_READ,
    OP_OPEN,
    OP_CLOSE,
    OP_SEEK,
    OP_ERROR,
    OP_OUTPUT_TIMINGS,
    OP_OUTPUT_SUMMARY
} ioop_t;

typedef int (*OpenFunc)(ioflags_t flags);
typedef int (*WriteFunc)(void *buf, size_t nbytes);
typedef int (*ReadFunc)(void *buf, size_t nbytes);
typedef int (*CloseFunc)(void);
typedef int (*SeekFunc)(size_t offset);
typedef double (*TimeFunc)(void);

typedef struct _iointerface_t
{
    TimeFunc Time; /* A default is provided but can be overridden by plugin */
    OpenFunc Open;
    WriteFunc Write;
    ReadFunc Read;
    CloseFunc Close;
    SeekFunc Seek;
    void *dlhandle;
} iointerface_t;

typedef iointerface_t* (*CreateInterfaceFunc)(int argi, int argc, char *argv[], const char *filename, const options_t *opts);
