1
1
openmpi/opal/memoryhooks/memory.h

163 строки
6.2 KiB
C
Исходник Обычный вид История

/*
* Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2006 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
2015-06-24 06:59:57 +03:00
* 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$
2015-06-24 06:59:57 +03:00
*
* Additional copyrights may follow
2015-06-24 06:59:57 +03:00
*
* $HEADER$
*/
/**
* @file@
*
* Hooks for receiving callbacks when memory is allocated or deallocated
*
* Hooks for receiving callbacks when memory is allocated or
* deallocated from the current process. Intended to be used with
* RDMA communication devices that require "pinning" of virtual
* memory. The hooks allow for a "lazy unpinning" approach, which
* provides better latency when application buffer reuse is high.
* Most operating systems do not respond well to memory being freed
* from a process while still pinned, so some type of callback to
* unpin is necessary before the memory is returned to the OS.
*
* \note For linking reasons, this is not a component framework (some of
* these require tight coupling into libopal and the wrapper compilers
* and that entire stack).
*/
#ifndef OPAL_MEMORY_MEMORY_H
#define OPAL_MEMORY_MEMORY_H
#include "opal_config.h"
#include "memory_internal.h"
- Replace combinations of #if defined (c_plusplus) defined (__cplusplus) followed by extern "C" { and the closing counterpart by BEGIN_C_DECLS and END_C_DECLS. Notable exceptions are: - opal/include/opal_config_bottom.h: This is our generated code, that itself defines BEGIN_C_DECL and END_C_DECL - ompi/mpi/cxx/mpicxx.h: Here we do not include opal_config_bottom.h: - Belongs to external code: opal/mca/backtrace/darwin/MoreBacktrace/MoreDebugging/MoreBacktrace.c opal/mca/backtrace/darwin/MoreBacktrace/MoreDebugging/MoreBacktrace.h - opal/include/opal/prefetch.h: Has C++ specific macros that are protected: - Had #if ... } #endif _and_ END_C_DECLS (aka end up with 2x END_C_DECLS) ompi/mca/btl/openib/btl_openib.h - opal/event/event.h has #ifdef __cplusplus as BEGIN_C_DECLS... - opal/win32/ompi_process.h: had extern "C"\n {... opal/win32/ompi_process.h: dito - ompi/mca/btl/pcie/btl_pcie_lex.l: needed to add *_C_DECLS ompi/mpi/f90/test/align_c.c: dito - ompi/debuggers/msgq_interface.h: used #ifdef __cplusplus - ompi/mpi/f90/xml/common-C.xsl: Amend Tested on linux using --with-openib and --with-mx The following do not contain either opal_config.h, orte_config.h or ompi_config.h (but possibly other header files, that include one of the above): ompi/mca/bml/r2/bml_r2_ft.h ompi/mca/btl/gm/btl_gm_endpoint.h ompi/mca/btl/gm/btl_gm_proc.h ompi/mca/btl/mx/btl_mx_endpoint.h ompi/mca/btl/ofud/btl_ofud_endpoint.h ompi/mca/btl/ofud/btl_ofud_frag.h ompi/mca/btl/ofud/btl_ofud_proc.h ompi/mca/btl/openib/btl_openib_mca.h ompi/mca/btl/portals/btl_portals_endpoint.h ompi/mca/btl/portals/btl_portals_frag.h ompi/mca/btl/sctp/btl_sctp_endpoint.h ompi/mca/btl/sctp/btl_sctp_proc.h ompi/mca/btl/tcp/btl_tcp_endpoint.h ompi/mca/btl/tcp/btl_tcp_ft.h ompi/mca/btl/tcp/btl_tcp_proc.h ompi/mca/btl/template/btl_template_endpoint.h ompi/mca/btl/template/btl_template_proc.h ompi/mca/btl/udapl/btl_udapl_eager_rdma.h ompi/mca/btl/udapl/btl_udapl_endpoint.h ompi/mca/btl/udapl/btl_udapl_mca.h ompi/mca/btl/udapl/btl_udapl_proc.h ompi/mca/mtl/mx/mtl_mx_endpoint.h ompi/mca/mtl/mx/mtl_mx.h ompi/mca/mtl/psm/mtl_psm_endpoint.h ompi/mca/mtl/psm/mtl_psm.h ompi/mca/pml/cm/pml_cm_component.h ompi/mca/pml/csum/pml_csum_comm.h ompi/mca/pml/dr/pml_dr_comm.h ompi/mca/pml/dr/pml_dr_component.h ompi/mca/pml/dr/pml_dr_endpoint.h ompi/mca/pml/dr/pml_dr_recvfrag.h ompi/mca/pml/example/pml_example.h ompi/mca/pml/ob1/pml_ob1_comm.h ompi/mca/pml/ob1/pml_ob1_component.h ompi/mca/pml/ob1/pml_ob1_endpoint.h ompi/mca/pml/ob1/pml_ob1_rdmafrag.h ompi/mca/pml/ob1/pml_ob1_recvfrag.h ompi/mca/pml/v/pml_v_output.h opal/include/opal/prefetch.h opal/mca/timer/aix/timer_aix.h opal/util/qsort.h test/support/components.h This commit was SVN r21855. The following SVN revision numbers were found above: r2 --> open-mpi/ompi@58fdc188553052bc2e893ba28fb28fddbe78435a
2009-08-20 15:42:18 +04:00
BEGIN_C_DECLS
/**
* Initialize the memory hooks subsystem
*
* Initialize the memory hooks subsystem. This is generally called
* during opal_init() and should be called before any other function
2015-06-24 06:59:57 +03:00
* in the interface is called.
*
* \note Note that some back-end functionality is activated pre-main,
* so not calling this function does not prevent the memory hooks from
* becoming active.
*
* @retval OPAL_SUCCESS Initialization completed successfully
*/
OPAL_DECLSPEC int opal_mem_hooks_init(void);
/**
* Finalize the memory hooks subsystem
*
* Finalize the memory hooks subsystem. This is generally called
* during opal_finalize() and no other memory hooks functions should
* be called after this function is called. opal_mem_hooks_finalize()
* will automatically deregister any callbacks that have not already
* been deregistered. In a multi-threaded application, it is possible
* that one thread will have a memory hook callback while the other
* thread is in opal_mem_hooks_finalize(), however, no threads will
* receive a callback once the calling thread has exited
* opal_mem_hooks_finalize().
*
* @retval OPAL_SUCCESS Shutdown completed successfully
*/
OPAL_DECLSPEC int opal_mem_hooks_finalize(void);
/**
* Query level of support provided by memory hooks
*
* Query memory hooks subsystem about the level of support provided by
* the current system configuration. The return value is \c 0 if no
* support is provided or a bit-wise OR of the available return values
* if support is provided.
*
* @retval OPAL_MEMORY_FREE_SUPPORT Memory hooks subsytem can trigger
2015-06-24 06:59:57 +03:00
* callback events when memory is going
* to be released by the process, either
* by the user calling an allocator
* function or munmap. Implies
* OPAL_MEMORY_MUNMAP_SUPPORT.
* @retval OPAL_MEMORY_MUNMAP_SUPPORT Subsystem can trigger callback events
* by the user calling munmap directly.
2015-06-24 06:59:57 +03:00
* @retval OPAL_MEMORY_CHUNK_SUPPORT Memory hooks subsystem will only
* trigger callback events when the
* process is giving memory back to the
* operating system, not at ever call
* to realloc/free/etc.
*
* \note This function must be called after opal_mem_hooks_init().
*/
OPAL_DECLSPEC int opal_mem_hooks_support_level(void);
/**
* Memory status change callback
*
* Typedef for callbacks triggered when memory has been allocated or
* is about to be freed. The callback will be triggered according to
* the note in opal_mem_hooks_register_alloc() or
* opal_mem_hooks_register_release().
*
2015-06-24 06:59:57 +03:00
* @param buf Pointer to the start of the allocation
* @param lentgh Length of the allocation
* @param cbdata Data passed to memory hooks when callback
* was registered
* @param from_alloc True if the callback is caused by a call to the
* general allocation routines (malloc, calloc, free,
* etc.) or directly from the user (mmap, munmap, etc.)
*/
2015-06-24 06:59:57 +03:00
typedef void (opal_mem_hooks_callback_fn_t)(void *buf, size_t length,
void *cbdata, bool from_alloc);
/**
* Register callback for when memory is to be released
*
* Register a \c opal_mem_hooks_callback_fn_t function pointer to be called
* whenever the current process is about to release memory.
*
* @param func Function pointer to call when memory is to be released
* @param cbdata A pointer-length field to be passed to func when it is
* invoked.
*
* @retval OPAL_SUCCESS The registration completed successfully.
* @retval OPAL_EXISTS The function is already registered and will not
* be registered again.
2015-06-24 06:59:57 +03:00
* @retval OPAL_ERR_NOT_SUPPORTED There are no hooks available for
* receiving callbacks when memory is to be released
*/
2015-06-24 06:59:57 +03:00
OPAL_DECLSPEC int opal_mem_hooks_register_release(opal_mem_hooks_callback_fn_t *func,
void *cbdata);
/**
* Unregister previously registered release callback
*
* Unregister previously registered release callback.
*
* @param func Function pointer to registered callback to remove
*
* @retval OPAL_SUCCESS The function was successfully deregistered
* @retval OPAL_ERR_NOT_FOUND The function was not previously registered
*/
OPAL_DECLSPEC int opal_mem_hooks_unregister_release(opal_mem_hooks_callback_fn_t *func);
- Replace combinations of #if defined (c_plusplus) defined (__cplusplus) followed by extern "C" { and the closing counterpart by BEGIN_C_DECLS and END_C_DECLS. Notable exceptions are: - opal/include/opal_config_bottom.h: This is our generated code, that itself defines BEGIN_C_DECL and END_C_DECL - ompi/mpi/cxx/mpicxx.h: Here we do not include opal_config_bottom.h: - Belongs to external code: opal/mca/backtrace/darwin/MoreBacktrace/MoreDebugging/MoreBacktrace.c opal/mca/backtrace/darwin/MoreBacktrace/MoreDebugging/MoreBacktrace.h - opal/include/opal/prefetch.h: Has C++ specific macros that are protected: - Had #if ... } #endif _and_ END_C_DECLS (aka end up with 2x END_C_DECLS) ompi/mca/btl/openib/btl_openib.h - opal/event/event.h has #ifdef __cplusplus as BEGIN_C_DECLS... - opal/win32/ompi_process.h: had extern "C"\n {... opal/win32/ompi_process.h: dito - ompi/mca/btl/pcie/btl_pcie_lex.l: needed to add *_C_DECLS ompi/mpi/f90/test/align_c.c: dito - ompi/debuggers/msgq_interface.h: used #ifdef __cplusplus - ompi/mpi/f90/xml/common-C.xsl: Amend Tested on linux using --with-openib and --with-mx The following do not contain either opal_config.h, orte_config.h or ompi_config.h (but possibly other header files, that include one of the above): ompi/mca/bml/r2/bml_r2_ft.h ompi/mca/btl/gm/btl_gm_endpoint.h ompi/mca/btl/gm/btl_gm_proc.h ompi/mca/btl/mx/btl_mx_endpoint.h ompi/mca/btl/ofud/btl_ofud_endpoint.h ompi/mca/btl/ofud/btl_ofud_frag.h ompi/mca/btl/ofud/btl_ofud_proc.h ompi/mca/btl/openib/btl_openib_mca.h ompi/mca/btl/portals/btl_portals_endpoint.h ompi/mca/btl/portals/btl_portals_frag.h ompi/mca/btl/sctp/btl_sctp_endpoint.h ompi/mca/btl/sctp/btl_sctp_proc.h ompi/mca/btl/tcp/btl_tcp_endpoint.h ompi/mca/btl/tcp/btl_tcp_ft.h ompi/mca/btl/tcp/btl_tcp_proc.h ompi/mca/btl/template/btl_template_endpoint.h ompi/mca/btl/template/btl_template_proc.h ompi/mca/btl/udapl/btl_udapl_eager_rdma.h ompi/mca/btl/udapl/btl_udapl_endpoint.h ompi/mca/btl/udapl/btl_udapl_mca.h ompi/mca/btl/udapl/btl_udapl_proc.h ompi/mca/mtl/mx/mtl_mx_endpoint.h ompi/mca/mtl/mx/mtl_mx.h ompi/mca/mtl/psm/mtl_psm_endpoint.h ompi/mca/mtl/psm/mtl_psm.h ompi/mca/pml/cm/pml_cm_component.h ompi/mca/pml/csum/pml_csum_comm.h ompi/mca/pml/dr/pml_dr_comm.h ompi/mca/pml/dr/pml_dr_component.h ompi/mca/pml/dr/pml_dr_endpoint.h ompi/mca/pml/dr/pml_dr_recvfrag.h ompi/mca/pml/example/pml_example.h ompi/mca/pml/ob1/pml_ob1_comm.h ompi/mca/pml/ob1/pml_ob1_component.h ompi/mca/pml/ob1/pml_ob1_endpoint.h ompi/mca/pml/ob1/pml_ob1_rdmafrag.h ompi/mca/pml/ob1/pml_ob1_recvfrag.h ompi/mca/pml/v/pml_v_output.h opal/include/opal/prefetch.h opal/mca/timer/aix/timer_aix.h opal/util/qsort.h test/support/components.h This commit was SVN r21855. The following SVN revision numbers were found above: r2 --> open-mpi/ompi@58fdc188553052bc2e893ba28fb28fddbe78435a
2009-08-20 15:42:18 +04:00
END_C_DECLS
#endif /* OPAL_MEMORY_MEMORY_H */