OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs
osc.h File Reference

One-sided Communication interface. More...

`#include "opal_config.h"`
`#include "opal/mca/mca.h"`

Go to the source code of this file.

## Data Structures
struct | ompi_osc_base_component_2_0_0_t
| OSC component interface. More...
struct | ompi_osc_base_module_1_0_0_t
| OSC module instance. More...

## Macros
#define | OMPI_OSC_BASE_VERSION_2_0_0
| Macro for use in components that are of type osc. More...

## Typedefs
typedef int(* | ompi_osc_base_component_init_fn_t )(bool enable_progress_threads, bool enable_mpi_threads)
| OSC component initialization. More...
typedef int(* | ompi_osc_base_component_finalize_fn_t )(void)
| OSC component finalization. More...
typedef int(* | ompi_osc_base_component_query_fn_t )(struct ompi_win_t *win, struct ompi_info_t *info, struct ompi_communicator_t *comm)
| OSC component query. More...
typedef int(* | ompi_osc_base_component_select_fn_t )(struct ompi_win_t *win, struct ompi_info_t *info, struct ompi_communicator_t *comm)
| OSC component select. More...
typedef struct ompi_osc_base_component_2_0_0_t | ompi_osc_base_component_2_0_0_t
typedef ompi_osc_base_component_2_0_0_t | ompi_osc_base_component_t
typedef int(* | ompi_osc_base_module_free_fn_t )(struct ompi_win_t *win)
| Free resources associated with win. More...
typedef int(* | ompi_osc_base_module_put_fn_t )(void *origin_addr, int origin_count, struct ompi_datatype_t *origin_dt, int target, OPAL_PTRDIFF_TYPE target_disp, int target_count, struct ompi_datatype_t *target_dt, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_get_fn_t )(void *origin_addr, int origin_count, struct ompi_datatype_t *origin_dt, int target, OPAL_PTRDIFF_TYPE target_disp, int target_count, struct ompi_datatype_t *target_dt, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_accumulate_fn_t )(void *origin_addr, int origin_count, struct ompi_datatype_t *origin_dt, int target, OPAL_PTRDIFF_TYPE target_disp, int target_count, struct ompi_datatype_t *target_dt, struct ompi_op_t *op, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_fence_fn_t )(int assert, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_start_fn_t )(struct ompi_group_t *group, int assert, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_complete_fn_t )(struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_post_fn_t )(struct ompi_group_t *group, int assert, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_wait_fn_t )(struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_test_fn_t )(struct ompi_win_t *win, int *flag)
typedef int(* | ompi_osc_base_module_lock_fn_t )(int lock_type, int target, int assert, struct ompi_win_t *win)
typedef int(* | ompi_osc_base_module_unlock_fn_t )(int target, struct ompi_win_t *win)
typedef struct ompi_osc_base_module_1_0_0_t | ompi_osc_base_module_1_0_0_t
typedef ompi_osc_base_module_1_0_0_t | ompi_osc_base_module_t

## Detailed Description

One-sided Communication interface.

Interface for implementing the one-sided communication chapter of the MPI-2 standard. Similar in scope to the PML for point-to-point communication from MPI-1.

## Macro Definition Documentation

#define OMPI_OSC_BASE_VERSION_2_0_0

Value:
MCA_BASE_VERSION_2_0_0, \
"osc", 2, 0, 0

Macro for use in components that are of type osc.

## Typedef Documentation

typedef int(* ompi_osc_base_component_finalize_fn_t)(void)

OSC component finalization.

Finalize the given one-sided component. This function should clean up any component-level data allocated during component_init(). It should also clean up any data created during the lifetime of the component, including any modules that are outstanding.

Return values

  OMPI_SUCCESS | Component successfully finalized
  OMPI_ERROR | An unspecified error occurred

typedef int(* ompi_osc_base_component_init_fn_t)(bool enable_progress_threads, bool enable_mpi_threads)

OSC component initialization.

Initialize the given one-sided component. This function should initialize any component-level data.

Note
  The component framework is not lazily opened, so attempts should be made to minimize the amount of memory allocated during this function.

Parameters

  [in] | enable_progress_threads | True if the component needs to support progress threads
  [in] | enable_mpi_threads | True if the component needs to support MPI_THREAD_MULTIPLE

Return values

  OMPI_SUCCESS | Component successfully initialized
  OMPI_ERROR | An unspecified error occurred

typedef int(* ompi_osc_base_component_query_fn_t)(struct ompi_win_t *win, struct ompi_info_t *info, struct ompi_communicator_t *comm)

OSC component query.

Query whether, given the info and comm, the component can be used for one-sided support. The ability to use the component for the window does not mean that the component will be selected. The win argument should not be modified during this call and no memory should be allocated that is associated with this window.

Returns
  The selection priority of the component

Parameters

  [in] | win | The window handle, already filled in by MPI_WIN_CREATE()
  [in] | info | An info structure with hints from the user regarding the usage of the component
  [in] | comm | The communicator specified by the user for the basis of the group membership for the Window.

Return values

  -1 | The component can not be used for this window
  >= | 0 The priority of the component for this window

typedef int(* ompi_osc_base_component_select_fn_t)(struct ompi_win_t *win, struct ompi_info_t *info, struct ompi_communicator_t *comm)

OSC component select.

This component has been selected to provide one-sided services for the given window. The win->w_osc_module field can be updated and memory can be associated with this window. The module should be ready for use immediately upon return of this function, and the module is responsible for providing any required collective synchronization before the end of the call.

Note
  The comm is the communicator specified from the user, so normal internal usage rules apply. In other words, if you need communication for the life of the window, you should call comm_dup() during this function.

Parameters

  | in/out] | win The window handle, already filled in by MPI_WIN_CREATE()
  [in] | info | An info structure with hints from the user regarding the usage of the component
  [in] | comm | The communicator specified by the user for the basis of the group membership for the Window.

Return values

  OMPI_SUCCESS | Component successfully selected
  OMPI_ERROR | An unspecified error occurred

typedef int(* ompi_osc_base_module_free_fn_t)(struct ompi_win_t *win)

Free resources associated with win.

Free all resources associated with `win`. The component must provide the barrier semantics required by MPI-2 6.2.1. The caller will guarantee that no new calls into the module are made after the start of this call. It is possible that the window is locked by remote processes. win->w_flags will have OMPI_WIN_FREED set before this function is called.

Parameters

  [in] | win | Window to free

Return values

  OMPI_SUCCESS | Component successfully selected
  OMPI_ERROR | An unspecified error occurred