Blame src/mpi/attr/win_set_attr.c

Packit Service c5cf8c
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
Packit Service c5cf8c
/*
Packit Service c5cf8c
 *
Packit Service c5cf8c
 *  (C) 2001 by Argonne National Laboratory.
Packit Service c5cf8c
 *      See COPYRIGHT in top-level directory.
Packit Service c5cf8c
 */
Packit Service c5cf8c
Packit Service c5cf8c
#include "mpiimpl.h"
Packit Service c5cf8c
#include "attr.h"
Packit Service c5cf8c
Packit Service c5cf8c
/* -- Begin Profiling Symbol Block for routine MPI_Win_set_attr */
Packit Service c5cf8c
#if defined(HAVE_PRAGMA_WEAK)
Packit Service c5cf8c
#pragma weak MPI_Win_set_attr = PMPI_Win_set_attr
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_HP_SEC_DEF)
Packit Service c5cf8c
#pragma _HP_SECONDARY_DEF PMPI_Win_set_attr  MPI_Win_set_attr
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_CRI_DUP)
Packit Service c5cf8c
#pragma _CRI duplicate MPI_Win_set_attr as PMPI_Win_set_attr
Packit Service c5cf8c
#elif defined(HAVE_WEAK_ATTRIBUTE)
Packit Service c5cf8c
int MPI_Win_set_attr(MPI_Win win, int win_keyval, void *attribute_val)
Packit Service c5cf8c
    __attribute__ ((weak, alias("PMPI_Win_set_attr")));
Packit Service c5cf8c
#endif
Packit Service c5cf8c
/* -- End Profiling Symbol Block */
Packit Service c5cf8c
Packit Service c5cf8c
/* Define MPICH_MPI_FROM_PMPI if weak symbols are not supported to build
Packit Service c5cf8c
   the MPI routines */
Packit Service c5cf8c
#ifndef MPICH_MPI_FROM_PMPI
Packit Service c5cf8c
#undef MPI_Win_set_attr
Packit Service c5cf8c
#define MPI_Win_set_attr PMPI_Win_set_attr
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPII_Win_set_attr
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
int MPII_Win_set_attr(MPI_Win win, int win_keyval, void *attribute_val, MPIR_Attr_type attrType)
Packit Service c5cf8c
{
Packit Service c5cf8c
    int mpi_errno = MPI_SUCCESS;
Packit Service c5cf8c
    MPIR_Win *win_ptr = NULL;
Packit Service c5cf8c
    MPII_Keyval *keyval_ptr = NULL;
Packit Service c5cf8c
    MPIR_Attribute *p, **old_p;
Packit Service c5cf8c
    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPIR_WIN_SET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_ERRTEST_INITIALIZED_ORDIE();
Packit Service c5cf8c
Packit Service c5cf8c
    /* The thread lock prevents a valid attr delete on the same window
Packit Service c5cf8c
     * but in a different thread from causing problems */
Packit Service c5cf8c
    MPID_THREAD_CS_ENTER(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);
Packit Service c5cf8c
    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPIR_WIN_SET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    /* Validate parameters, especially handles needing to be converted */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        MPID_BEGIN_ERROR_CHECKS;
Packit Service c5cf8c
        {
Packit Service c5cf8c
            MPIR_ERRTEST_WIN(win, mpi_errno);
Packit Service c5cf8c
            MPIR_ERRTEST_KEYVAL(win_keyval, MPIR_WIN, "window", mpi_errno);
Packit Service c5cf8c
            MPIR_ERRTEST_KEYVAL_PERM(win_keyval, mpi_errno);
Packit Service c5cf8c
        }
Packit Service c5cf8c
        MPID_END_ERROR_CHECKS;
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif
Packit Service c5cf8c
Packit Service c5cf8c
    /* Convert MPI object handles to object pointers */
Packit Service c5cf8c
    MPIR_Win_get_ptr(win, win_ptr);
Packit Service c5cf8c
    MPII_Keyval_get_ptr(win_keyval, keyval_ptr);
Packit Service c5cf8c
Packit Service c5cf8c
    /* Validate parameters and objects (post conversion) */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        MPID_BEGIN_ERROR_CHECKS;
Packit Service c5cf8c
        {
Packit Service c5cf8c
            /* Validate win_ptr */
Packit Service c5cf8c
            MPIR_Win_valid_ptr(win_ptr, mpi_errno);
Packit Service c5cf8c
            /* If win_ptr is not valid, it will be reset to null */
Packit Service c5cf8c
            /* Validate keyval */
Packit Service c5cf8c
            MPII_Keyval_valid_ptr(keyval_ptr, mpi_errno);
Packit Service c5cf8c
            if (mpi_errno)
Packit Service c5cf8c
                goto fn_fail;
Packit Service c5cf8c
        }
Packit Service c5cf8c
        MPID_END_ERROR_CHECKS;
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif /* HAVE_ERROR_CHECKING */
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... body of routine ...  */
Packit Service c5cf8c
Packit Service c5cf8c
    /* Look for attribute.  They are ordered by keyval handle.  This uses
Packit Service c5cf8c
     * a simple linear list algorithm because few applications use more than a
Packit Service c5cf8c
     * handful of attributes */
Packit Service c5cf8c
Packit Service c5cf8c
    old_p = &win_ptr->attributes;
Packit Service c5cf8c
    p = win_ptr->attributes;
Packit Service c5cf8c
    while (p) {
Packit Service c5cf8c
        if (p->keyval->handle == keyval_ptr->handle) {
Packit Service c5cf8c
            /* If found, call the delete function before replacing the
Packit Service c5cf8c
             * attribute */
Packit Service c5cf8c
            mpi_errno = MPIR_Call_attr_delete(win, p);
Packit Service c5cf8c
            /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
            if (mpi_errno) {
Packit Service c5cf8c
                /* FIXME : communicator of window? */
Packit Service c5cf8c
                goto fn_fail;
Packit Service c5cf8c
            }
Packit Service c5cf8c
            /* --END ERROR HANDLING-- */
Packit Service c5cf8c
            p->value = (MPII_Attr_val_t) (intptr_t) attribute_val;
Packit Service c5cf8c
            p->attrType = attrType;
Packit Service c5cf8c
            /* Does not change the reference count on the keyval */
Packit Service c5cf8c
            break;
Packit Service c5cf8c
        } else if (p->keyval->handle > keyval_ptr->handle) {
Packit Service c5cf8c
            MPIR_Attribute *new_p = MPID_Attr_alloc();
Packit Service c5cf8c
            MPIR_ERR_CHKANDJUMP1(!new_p, mpi_errno, MPI_ERR_OTHER,
Packit Service c5cf8c
                                 "**nomem", "**nomem %s", "MPIR_Attribute");
Packit Service c5cf8c
            new_p->keyval = keyval_ptr;
Packit Service c5cf8c
            new_p->attrType = attrType;
Packit Service c5cf8c
            new_p->pre_sentinal = 0;
Packit Service c5cf8c
            new_p->value = (MPII_Attr_val_t) (intptr_t) attribute_val;
Packit Service c5cf8c
            new_p->post_sentinal = 0;
Packit Service c5cf8c
            new_p->next = p->next;
Packit Service c5cf8c
            MPII_Keyval_add_ref(keyval_ptr);
Packit Service c5cf8c
            p->next = new_p;
Packit Service c5cf8c
            break;
Packit Service c5cf8c
        }
Packit Service c5cf8c
        old_p = &p->next;
Packit Service c5cf8c
        p = p->next;
Packit Service c5cf8c
    }
Packit Service c5cf8c
    if (!p) {
Packit Service c5cf8c
        MPIR_Attribute *new_p = MPID_Attr_alloc();
Packit Service c5cf8c
        MPIR_ERR_CHKANDJUMP1(!new_p, mpi_errno, MPI_ERR_OTHER,
Packit Service c5cf8c
                             "**nomem", "**nomem %s", "MPIR_Attribute");
Packit Service c5cf8c
        /* Did not find in list.  Add at end */
Packit Service c5cf8c
        new_p->attrType = attrType;
Packit Service c5cf8c
        new_p->keyval = keyval_ptr;
Packit Service c5cf8c
        new_p->pre_sentinal = 0;
Packit Service c5cf8c
        new_p->value = (MPII_Attr_val_t) (intptr_t) attribute_val;
Packit Service c5cf8c
        new_p->post_sentinal = 0;
Packit Service c5cf8c
        new_p->next = 0;
Packit Service c5cf8c
        MPII_Keyval_add_ref(keyval_ptr);
Packit Service c5cf8c
        *old_p = new_p;
Packit Service c5cf8c
    }
Packit Service c5cf8c
Packit Service c5cf8c
    /* Here is where we could add a hook for the device to detect attribute
Packit Service c5cf8c
     * value changes, using something like
Packit Service c5cf8c
     * MPID_Win_attr_hook(win_ptr, keyval, attribute_val);
Packit Service c5cf8c
     */
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... end of body of routine ... */
Packit Service c5cf8c
Packit Service c5cf8c
  fn_exit:
Packit Service c5cf8c
    MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPIR_WIN_SET_ATTR);
Packit Service c5cf8c
    MPID_THREAD_CS_EXIT(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);
Packit Service c5cf8c
    return mpi_errno;
Packit Service c5cf8c
Packit Service c5cf8c
  fn_fail:
Packit Service c5cf8c
    /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        mpi_errno =
Packit Service c5cf8c
            MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER,
Packit Service c5cf8c
                                 "**mpi_win_set_attr", "**mpi_win_set_attr %W %d %p", win,
Packit Service c5cf8c
                                 win_keyval, attribute_val);
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    mpi_errno = MPIR_Err_return_win(win_ptr, FCNAME, mpi_errno);
Packit Service c5cf8c
    goto fn_exit;
Packit Service c5cf8c
    /* --END ERROR HANDLING-- */
Packit Service c5cf8c
}
Packit Service c5cf8c
#endif
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPI_Win_set_attr
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
Packit Service c5cf8c
/*@
Packit Service c5cf8c
   MPI_Win_set_attr - Stores attribute value associated with a key
Packit Service c5cf8c
Packit Service c5cf8c
Input Parameters:
Packit Service c5cf8c
+ win - MPI window object to which attribute will be attached (handle)
Packit Service c5cf8c
. win_keyval - key value, as returned by  'MPI_Win_create_keyval' (integer)
Packit Service c5cf8c
- attribute_val - attribute value
Packit Service c5cf8c
Packit Service c5cf8c
Notes:
Packit Service c5cf8c
Packit Service c5cf8c
The type of the attribute value depends on whether C or Fortran is being used.
Packit Service c5cf8c
In C, an attribute value is a pointer ('void *'); in Fortran, it is an
Packit Service c5cf8c
address-sized integer.
Packit Service c5cf8c
Packit Service c5cf8c
If an attribute is already present, the delete function (specified when the
Packit Service c5cf8c
corresponding keyval was created) will be called.
Packit Service c5cf8c
Packit Service c5cf8c
.N ThreadSafe
Packit Service c5cf8c
Packit Service c5cf8c
.N Fortran
Packit Service c5cf8c
Packit Service c5cf8c
.N Errors
Packit Service c5cf8c
.N MPI_SUCCESS
Packit Service c5cf8c
.N MPI_ERR_WIN
Packit Service c5cf8c
.N MPI_ERR_KEYVAL
Packit Service c5cf8c
@*/
Packit Service c5cf8c
int MPI_Win_set_attr(MPI_Win win, int win_keyval, void *attribute_val)
Packit Service c5cf8c
{
Packit Service c5cf8c
    int mpi_errno = MPI_SUCCESS;
Packit Service c5cf8c
    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPI_WIN_SET_ATTR);
Packit Service c5cf8c
    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPI_WIN_SET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_ERRTEST_INITIALIZED_ORDIE();
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... body of routine ...  */
Packit Service c5cf8c
    mpi_errno = MPII_Win_set_attr(win, win_keyval, attribute_val, MPIR_ATTR_PTR);
Packit Service c5cf8c
    if (mpi_errno)
Packit Service c5cf8c
        goto fn_fail;
Packit Service c5cf8c
    /* ... end of body of routine ... */
Packit Service c5cf8c
Packit Service c5cf8c
  fn_exit:
Packit Service c5cf8c
    MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPI_WIN_SET_ATTR);
Packit Service c5cf8c
    return mpi_errno;
Packit Service c5cf8c
Packit Service c5cf8c
  fn_fail:
Packit Service c5cf8c
    /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        mpi_errno =
Packit Service c5cf8c
            MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER,
Packit Service c5cf8c
                                 "**mpi_win_set_attr", "**mpi_win_set_attr %W %d %p", win,
Packit Service c5cf8c
                                 win_keyval, attribute_val);
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    goto fn_exit;
Packit Service c5cf8c
    /* --END ERROR HANDLING-- */
Packit Service c5cf8c
}