1
1
openmpi/ompi/mca/common/sm/common_sm_mmap.h
Gleb Natapov 90c70e37b9 Clean up SM btl startup code. Remove no longer needed code leftovers from two
BTL times. Remove old and no longer correct comment.

This commit was SVN r17805.
2008-03-11 14:39:10 +00:00

137 строки
4.1 KiB
C

/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 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$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef _COMMON_SM_MMAP_H_
#define _COMMON_SM_MMAP_H_
#include "ompi_config.h"
#include "opal/class/opal_object.h"
#include "opal/class/opal_list.h"
#include "opal/sys/atomic.h"
#include "ompi/mca/mpool/mpool.h"
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
struct mca_mpool_base_module_t;
struct mca_common_sm_file_header_t {
/* lock to control atomic access */
opal_atomic_lock_t seg_lock;
/* is the segment ready for use */
volatile bool seg_inited;
/* Offset to next available memory location available for allocation */
size_t seg_offset;
/* total size of the segment */
size_t seg_size;
/* array of pointers to the base of the shared memory address - one per
* local process */
volatile char **base_shared_mem_segment;
};
typedef struct mca_common_sm_file_header_t mca_common_sm_file_header_t;
struct mca_common_sm_mmap_t {
/* double link list element */
opal_list_item_t map_item;
/* pointer to header imbeded in the shared memory file */
mca_common_sm_file_header_t* map_seg;
/* base address of the mmap'ed file */
unsigned char *map_addr;
/* base address of data segment */
unsigned char *data_addr;
size_t map_size;
char map_path[OMPI_PATH_MAX];
#if defined(__WINDOWS__)
HANDLE hMappedObject;
#endif /* defined(__WINDOWS__) */
};
typedef struct mca_common_sm_mmap_t mca_common_sm_mmap_t;
OBJ_CLASS_DECLARATION(mca_common_sm_mmap_t);
/**
* This routine is used to set up a shared memory file, backed
* by a specified file. It is assumed that the file does not
* exist before any of the current set of processes try and open
* it.
*
* @param size - size of the file, in bytes (IN)
*
* @param file_name name of file to be opened. (IN)
*
* @param size_ctl_structure size of the control structure at
* the head of the file. The control structure
* is assumed to have mca_common_sm_file_header_t
* as its first segment (IN)
*
* @param data_set_alignment alignment of the data segment. this
* follows the control structure. If this
* value if 0, then assume that there will
* be no data segment following the control
* structure. (IN)
*
* @returnvalue pointer to control structure at head of file.
*/
OMPI_DECLSPEC extern
mca_common_sm_mmap_t* mca_common_sm_mmap_init(
size_t size,
char *file_name,
size_t size_ctl_structure,
size_t data_seg_alignment);
OMPI_DECLSPEC extern
void* mca_common_sm_mmap_seg_alloc(
struct mca_mpool_base_module_t* mpool,
size_t* size,
mca_mpool_base_registration_t** registration);
/**
* This function will release all local ressources attached to the
* mmapped file. We assume that the operating system will destroy the
* file when the last process release it.
*
* @param sm_mmap - the control structure at head of file.
*
* @returnvalue 0 if everything was OK, otherwise a negative value.
*/
OMPI_DECLSPEC extern
int mca_common_sm_mmap_fini( mca_common_sm_mmap_t* sm_mmap );
/*
* Instance that is shared between components that use shared memory
*/
OMPI_DECLSPEC extern mca_common_sm_mmap_t *mca_common_sm_mmap;
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif