/*
 * Copyright (c) 2010      Cisco Systems, Inc.  All rights reserved. 
 * Copyright (c) 2012-2013 Los Alamos National Security, Inc.  All rights reserved. 
 * Copyright (c) 2013-2014 Intel, Inc. All rights reserved.
 * $COPYRIGHT$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 */
/** @file:
 */

#ifndef MCA_DSTORE_BASE_H
#define MCA_DSTORE_BASE_H

#include "opal_config.h"
#include "opal/types.h"

#include "opal/mca/mca.h"
#include "opal/mca/base/mca_base_framework.h"
#include "opal/mca/event/event.h"
#include "opal/class/opal_hash_table.h"
#include "opal/class/opal_list.h"
#include "opal/class/opal_pointer_array.h"
#include "opal/dss/dss.h"

#include "opal/mca/dstore/dstore.h"

BEGIN_C_DECLS

OPAL_DECLSPEC extern mca_base_framework_t opal_dstore_base_framework;

/**
 * Select a dstore module
 */
OPAL_DECLSPEC int opal_dstore_base_select(void);

typedef struct {
    opal_dstore_base_component_t *active;  // active component
    opal_pointer_array_t handles;          // array of open datastore handles
} opal_dstore_base_t;

OPAL_DECLSPEC extern opal_dstore_base_t opal_dstore_base;

typedef struct {
    opal_object_t super;
    char *name;
    opal_dstore_base_module_t *module;
} opal_dstore_handle_t;
OBJ_CLASS_DECLARATION(opal_dstore_handle_t);

/**
 * Data for a particular opal process
 * The name association is maintained in the
 * proc_data hash table.
 */
typedef struct {
    /** Structure can be put on lists (including in hash tables) */
    opal_list_item_t super;
    bool loaded;
    /* List of opal_value_t structures containing all data
       received from this process, sorted by key. */
    opal_list_t data;
} opal_dstore_proc_data_t;
OBJ_CLASS_DECLARATION(opal_dstore_proc_data_t);

OPAL_DECLSPEC int opal_dstore_base_open(const char *name);
OPAL_DECLSPEC int opal_dstore_base_close(int dstorehandle);
OPAL_DECLSPEC int opal_dstore_base_store(int dstorehandle,
                                         const opal_identifier_t *id,
                                         opal_value_t *kv);
OPAL_DECLSPEC void opal_dstore_base_commit(int dstorehandle,
                                           const opal_identifier_t *id);
OPAL_DECLSPEC int opal_dstore_base_fetch(int dstorehandle,
                                         const opal_identifier_t *id,
                                         const char *key,
                                         opal_list_t *kvs);
OPAL_DECLSPEC int opal_dstore_base_remove_data(int dstorehandle,
                                               const opal_identifier_t *id,
                                               const char *key);

/* support */
OPAL_DECLSPEC opal_dstore_proc_data_t* opal_dstore_base_lookup_proc(opal_hash_table_t *jtable,
                                                                    opal_identifier_t id);


OPAL_DECLSPEC opal_value_t* opal_dstore_base_lookup_keyval(opal_dstore_proc_data_t *proc_data,
                                                           const char *key);


END_C_DECLS

#endif