OpenMPI 0.1.1

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

- File List
- Globals

Data Structures | Macros | Typedefs
shmem_types.h File Reference

shmem (shared memory backing facility) framework types, convenience macros, etc. More...

`#include "opal_config.h"`

Go to the source code of this file.

## Data Structures
struct | opal_shmem_seg_hdr_t
struct | opal_shmem_ds_t

## Macros
#define | OPAL_SHMEM_DS_FLAGS_VALID 0x01
| ds_buf: pointer to opal_shmem_ds_t typedef'd struct More...
#define | OPAL_SHMEM_DS_FLAGS_INTERNAL_MASK 0x0F
| 0x1* - reserved for internal flags. More...
#define | OPAL_SHMEM_DS_ID_INVALID -1
| invalid id value
#define | OPAL_SHMEM_DS_RESET_FLAGS(ds_buf)
| macro that sets all bits in flags to 0 More...
#define | OPAL_SHMEM_DS_SET_VALID(ds_buf)
| sets valid bit in flags to 1 More...
#define | OPAL_SHMEM_DS_INVALIDATE(ds_buf)
| sets valid bit in flags to 0 More...
#define | OPAL_SHMEM_DS_IS_VALID(ds_buf) ( (ds_buf)->flags & OPAL_SHMEM_DS_FLAGS_VALID )
| evaluates to 1 if the valid bit in flags is set to 1. More...

## Typedefs
typedef uint8_t | opal_shmem_ds_flag_t
typedef struct opal_shmem_seg_hdr_t | opal_shmem_seg_hdr_t
typedef struct opal_shmem_ds_t | opal_shmem_ds_t

## Detailed Description

shmem (shared memory backing facility) framework types, convenience macros, etc.

## Macro Definition Documentation

#define OPAL_SHMEM_DS_FLAGS_INTERNAL_MASK 0x0F

0x1* - reserved for internal flags.

that is, flags that will NOT be propagated via ds_copy during inter-process information sharing. masks out internal flags

#define OPAL_SHMEM_DS_FLAGS_VALID 0x01

ds_buf: pointer to opal_shmem_ds_t typedef'd struct

flag indicating the state (valid/invalid) of the shmem data structure 0x0* - reserved for non-internal flags

#define OPAL_SHMEM_DS_INVALIDATE | ( |  | ds_buf | ) |

Value:
do { \
(ds_buf)->flags &= ~OPAL_SHMEM_DS_FLAGS_VALID; \
} while (0)
OPAL_SHMEM_DS_FLAGS_VALID
#define OPAL_SHMEM_DS_FLAGS_VALID
ds_buf: pointer to opal_shmem_ds_t typedef'd struct
Definition: shmem_types.h:47

sets valid bit in flags to 0

#define OPAL_SHMEM_DS_IS_VALID | ( |  | ds_buf | ) | ( (ds_buf)->flags & OPAL_SHMEM_DS_FLAGS_VALID )

evaluates to 1 if the valid bit in flags is set to 1.

evaluates to 0 otherwise.

#define OPAL_SHMEM_DS_RESET_FLAGS | ( |  | ds_buf | ) |

Value:
do { \
(ds_buf)->flags = 0x00; \
} while (0)

macro that sets all bits in flags to 0

#define OPAL_SHMEM_DS_SET_VALID | ( |  | ds_buf | ) |

Value:
do { \
(ds_buf)->flags |= OPAL_SHMEM_DS_FLAGS_VALID; \
} while (0)
OPAL_SHMEM_DS_FLAGS_VALID
#define OPAL_SHMEM_DS_FLAGS_VALID
ds_buf: pointer to opal_shmem_ds_t typedef'd struct
Definition: shmem_types.h:47

sets valid bit in flags to 1