/* -*- Mode: C; c-basic-offset:4 ; -*- */
/**
  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
  *                         Corporation.  All rights reserved.
  * Copyright (c) 2004-2007 The University of Tennessee and The University
  *                         of Tennessee Research Foundation.  All rights
  *                         reserved.
  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, 
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2009      IBM Corporation.  All rights reserved.
  * $COPYRIGHT$
  * 
  * Additional copyrights may follow
  * 
  * $HEADER$
  */
/**
  * @file
  * Description of the Registration Cache framework
  */
#ifndef MCA_RCACHE_H
#define MCA_RCACHE_H
#include "opal/mca/mca.h"
#include "opal/mca/mpool/mpool.h"
#include "opal/threads/mutex.h"


/**
 * component initialize
 */
typedef struct mca_rcache_base_module_t* (*mca_rcache_base_component_init_fn_t)(void);
                                                               

typedef int (*mca_rcache_base_module_find_fn_t) (
        struct mca_rcache_base_module_t* rcache, void* addr, size_t size,
        mca_mpool_base_registration_t **reg);

typedef int (*mca_rcache_base_module_find_all_fn_t)(
        struct mca_rcache_base_module_t* rcache, void* addr, size_t size,
        mca_mpool_base_registration_t **regs, int reg_cnt);

typedef int (*mca_rcache_base_module_insert_fn_t)(
        struct mca_rcache_base_module_t* rcache,
        mca_mpool_base_registration_t* registration, size_t limit);

typedef int (*mca_rcache_base_module_delete_fn_t)(
        struct mca_rcache_base_module_t* rcache,
        mca_mpool_base_registration_t* registration);

/* Do not call the clean function with the rcache lock held */
typedef int (*mca_rcache_base_module_clean_fn_t)(
        struct mca_rcache_base_module_t* rcache);

typedef void (*mca_rcache_base_module_dump_range_fn_t)(
        struct mca_rcache_base_module_t* rcache, unsigned char* addr, size_t size, char *msg);

/**
  * finalize
  */
typedef void (*mca_rcache_base_module_finalize_fn_t)(
        struct mca_rcache_base_module_t*);

/** 
 * rcache component descriptor. Contains component version information and 
 * open/close/init functions 
 */ 

struct mca_rcache_base_component_2_0_0_t{ 
    mca_base_component_t rcache_version;      /**< version */ 
    mca_base_component_data_t rcache_data; /**<metadata */ 
    mca_rcache_base_component_init_fn_t rcache_init; /**<init function */ 
}; 

typedef struct mca_rcache_base_component_2_0_0_t mca_rcache_base_component_2_0_0_t; 

typedef struct mca_rcache_base_component_2_0_0_t mca_rcache_base_component_t; 


/**
 * rcache module descriptor
 */ 
struct mca_rcache_base_module_t {
    mca_rcache_base_component_t *rcache_component; /**< component struct */
    mca_rcache_base_module_find_fn_t rcache_find;
    mca_rcache_base_module_find_all_fn_t rcache_find_all;
    mca_rcache_base_module_insert_fn_t rcache_insert;
    mca_rcache_base_module_delete_fn_t rcache_delete;
    mca_rcache_base_module_clean_fn_t rcache_clean;
    mca_rcache_base_module_finalize_fn_t rcache_finalize;
    mca_rcache_base_module_dump_range_fn_t rcache_dump_range;
    opal_mutex_t lock;
};
typedef struct mca_rcache_base_module_t mca_rcache_base_module_t;

/**
 * Macro for use in components that are of type rcache
 */
#define MCA_RCACHE_BASE_VERSION_2_0_0 \
  MCA_BASE_VERSION_2_0_0, \
  "rcache", 2, 0, 0

#endif /* MCA_RCACHE_H */