mercury_types.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013 Argonne National Laboratory, Department of Energy,
 *                    UChicago Argonne, LLC and The HDF Group.
 * All rights reserved.
 *
 * The full copyright notice, including terms governing use, modification,
 * and redistribution, is contained in the COPYING file that can be
 * found at the root of the source code distribution tree.
 */

#ifndef MERCURY_TYPES_H
#define MERCURY_TYPES_H

#include "na.h"
#include "mercury_config.h"

typedef hg_uint32_t hg_id_t; /* Operation ID of the operation */
typedef hg_bool_t hg_status_t; /* Status of the operation */
typedef hg_int32_t hg_error_t; /* Error code */
typedef void * hg_request_t; /* Abstract request */
typedef void * hg_proc_t; /* Abstract serialization processor */
typedef void * hg_handle_t; /* Abstract RPC handle */
typedef void * hg_bulk_t; /* Abstract bulk data handle */
typedef void * hg_bulk_request_t;/* Bulk request object */

typedef enum {
 HG_BULK_PUSH,
 HG_BULK_PULL
} hg_bulk_op_t;

#define HG_BULK_READWRITE NA_MEM_READWRITE
#define HG_BULK_READ_ONLY NA_MEM_READ_ONLY
#define HG_BULK_WRITE_ONLY NA_MEM_READWRITE

#define HG_STATUS_IGNORE ((hg_status_t *)1)

#define HG_MAX_IDLE_TIME NA_MAX_IDLE_TIME

#define HG_REQUEST_NULL ((hg_request_t)0)
#define HG_PROC_NULL ((hg_proc_t)0)
#define HG_HANDLE_NULL ((hg_handle_t)0)
#define HG_BULK_NULL ((hg_bulk_t)0)
#define HG_BULK_REQUEST_NULL ((hg_bulk_request_t)0)

typedef enum {
 HG_ENCODE,
 HG_DECODE,
 HG_FREE
} hg_proc_op_t;

typedef enum {
 HG_CRC16,
 HG_CRC64,
 HG_NOHASH
} hg_proc_hash_t;

/* Error return codes:
 * Functions return 0 for success or -HG_XXX_ERROR for failure */
typedef enum hg_return {
 HG_FAIL = -1, /* default (TODO keep until switch to new error format) */
 HG_SUCCESS = 0,
 HG_NA_ERROR, /* error in NA layer */
 HG_TIMEOUT, /* reached timeout */
 HG_INVALID_PARAM, /* invalid parameter */
 HG_SIZE_ERROR, /* size error */
 HG_NOMEM_ERROR, /* no memory error */
 HG_PROTOCOL_ERROR, /* protocol does not match */
 HG_NO_MATCH, /* no function match */
 HG_CHECKSUM_ERROR /* checksum error */
} hg_return_t;

/* Proc callback for serializing/deserializing parameters */
typedef hg_return_t (*hg_proc_cb_t)(hg_proc_t proc, void *in_struct);

/* Callback for executing RPC */
typedef hg_return_t (*hg_rpc_cb_t)(hg_handle_t handle);

/* Context used for request emulation */
struct hg_context {
 na_class_t *na_class;
 na_context_t *na_context;
};

#endif /* MERCURY_TYPES_H */