OpenMPI  0.1.1
shmem.h File Reference

shmem (shared memory backing facility) framework component interface definitions. More...

#include "opal_config.h"
#include "opal/mca/mca.h"
#include "opal/mca/base/base.h"
#include "opal/mca/shmem/shmem_types.h"

Go to the source code of this file.

Data Structures

struct  opal_shmem_base_component_2_0_0_t
 
struct  opal_shmem_base_module_2_0_0_t
 structure for shmem modules More...
 

Macros

#define OPAL_SHMEM_BASE_VERSION_2_0_0
 macro for use in components that are of type shmem see: opal/mca/mca.h for more information More...
 

Typedefs

typedef struct
opal_shmem_base_component_2_0_0_t 
opal_shmem_base_component_2_0_0_t
 
typedef struct
opal_shmem_base_component_2_0_0_t 
opal_shmem_base_component_t
 
typedef int(* opal_shmem_base_module_init_fn_t )(void)
 module initialization function. More...
 
typedef int(* opal_shmem_base_ds_copy_fn_t )(const opal_shmem_ds_t *from, opal_shmem_ds_t *to)
 copy shmem data structure information pointed to by from to the structure pointed to by to. More...
 
typedef int(* opal_shmem_base_module_segment_create_fn_t )(opal_shmem_ds_t *ds_buf, const char *file_name, size_t size)
 create a new shared memory segment and initialize members in structure pointed to by ds_buf. More...
 
typedef void *(* opal_shmem_base_module_segment_attach_fn_t )(opal_shmem_ds_t *ds_buf)
 attach to an existing shared memory segment initialized by segment_create. More...
 
typedef int(* opal_shmem_base_module_segment_detach_fn_t )(opal_shmem_ds_t *ds_buf)
 detach from an existing shared memory segment. More...
 
typedef int(* opal_shmem_base_module_unlink_fn_t )(opal_shmem_ds_t *ds_buf)
 unlink an existing shared memory segment. More...
 
typedef int(* opal_shmem_base_module_finalize_fn_t )(void)
 module finalize function. More...
 
typedef struct
opal_shmem_base_module_2_0_0_t 
opal_shmem_base_module_2_0_0_t
 convenience typedefs
 
typedef struct
opal_shmem_base_module_2_0_0_t 
opal_shmem_base_module_t
 

Variables

BEGIN_C_DECLS typedef int(* mca_shmem_base_component_runtime_query_fn_t )(mca_base_module_t **module, int *priority, const char *hint)
 

Detailed Description

shmem (shared memory backing facility) framework component interface definitions.

usage example: see ompi/mca/common/sm

The module has the following functions:

  • module_init
  • segment_create
  • ds_copy
  • segment_attach
  • segment_detach
  • unlink
  • module_finalize

Macro Definition Documentation

#define OPAL_SHMEM_BASE_VERSION_2_0_0
Value:
MCA_BASE_VERSION_2_0_0, \
"shmem", 2, 0, 0

macro for use in components that are of type shmem see: opal/mca/mca.h for more information

Typedef Documentation

typedef int(* opal_shmem_base_ds_copy_fn_t)(const opal_shmem_ds_t *from, opal_shmem_ds_t *to)

copy shmem data structure information pointed to by from to the structure pointed to by to.

Parameters
fromsource pointer (IN).
todestination pointer (OUT).
Returns
OPAL_SUCCESS on success.
typedef int(* opal_shmem_base_module_finalize_fn_t)(void)

module finalize function.

invoked by the base on the selected module when the shmem framework is being shut down.

typedef int(* opal_shmem_base_module_init_fn_t)(void)

module initialization function.

Returns
OPAL_SUCCESS on success.
typedef void*(* opal_shmem_base_module_segment_attach_fn_t)(opal_shmem_ds_t *ds_buf)

attach to an existing shared memory segment initialized by segment_create.

Parameters
ds_bufpointer to initialized opal_shmem_ds_t typedef'd structure (IN/OUT).
Returns
base address of shared memory segment on success. returns NULL otherwise.
typedef int(* opal_shmem_base_module_segment_create_fn_t)(opal_shmem_ds_t *ds_buf, const char *file_name, size_t size)

create a new shared memory segment and initialize members in structure pointed to by ds_buf.

Parameters
ds_bufpointer to opal_shmem_ds_t typedef'd structure defined in shmem_types.h (OUT).
file_namefile_name unique string identifier that must be a valid, writable path (IN).
sizesize of the shared memory segment.
Returns
OPAL_SUCCESS on success.
typedef int(* opal_shmem_base_module_segment_detach_fn_t)(opal_shmem_ds_t *ds_buf)

detach from an existing shared memory segment.

Parameters
ds_bufpointer to initialized opal_shmem_ds_t typedef'd structure (IN/OUT).
Returns
OPAL_SUCCESS on success.
typedef int(* opal_shmem_base_module_unlink_fn_t)(opal_shmem_ds_t *ds_buf)

unlink an existing shared memory segment.

Parameters
ds_bufpointer to initialized opal_shmem_ds_t typedef'd structure (IN/OUT).
Returns
OPAL_SUCCESS on success.