1
1
Mark Allen 482d84b6e5 fixes for Dave's get/set info code
The expected sequence of events for processing info during object creation
is that if there's an incoming info arg, it is opal_info_dup()ed into the obj
at obj->s_info first. Then interested components register callbacks for
keys they want to know about using opal_infosubscribe_infosubscribe().

Inside info_subscribe_subscribe() the specified callback() is called with
whatever matching k/v is in the object's info, or with the default. The
return string from the callback goes into the new k/v stored in info, and
the input k/v is saved as __IN_<key>/<val>. It's saved the same way
whether the input came from info or whether it was a default. A null return
from the callback indicates an ignored key/val, and no k/v is stored for
it, but an __IN_<key>/<val> is still kept so we still have access to the
original.

At MPI_*_set_info() time, opal_infosubscribe_change_info() is used. That
function calls the registered callbacks for each item in the provided info.
If the callback returns non-null, the info is updated with that k/v, or if
the callback returns null, that key is deleted from info. An __IN_<key>/<val>
is saved either way, and overwrites any previously saved value.

When MPI_*_get_info() is called, opal_info_dup_mpistandard() is used, which
allows relatively easy changes in interpretation of the standard, by looking
at both the <key>/<val> and __IN_<key>/<val> in info. Right now it does
  1. includes system extras, eg k/v defaults not expliclty set by the user
  2. omits ignored keys
  3. shows input values, not callback modifications, eg not the internal values

Currently the callbacks are doing things like
    return some_condition ? "true" : "false"
that is, returning static strings that are not to be freed. If the return
strings start becoming more dynamic in the future I don't see how unallocated
strings could support that, so I'd propose a change for the future that
the callback()s registered with info_subscribe_subscribe() do a strdup on
their return, and we change the callers of callback() to free the strings
it returns (there are only two callers).

Rough outline of the smaller changes spread over the less central files:
  comm.c
    initialize comm->super.s_info to NULL
    copy into comm->super.s_info in comm creation calls that provide info
    OBJ_RELEASE comm->super.s_info at free time
  comm_init.c
    initialize comm->super.s_info to NULL
  file.c
    copy into file->super.s_info if file creation provides info
    OBJ_RELEASE file->super.s_info at free time
  win.c
    copy into win->super.s_info if win creation provides info
    OBJ_RELEASE win->super.s_info at free time

  comm_get_info.c
  file_get_info.c
  win_get_info.c
    change_info() if there's no info attached (shouldn't happen if callbacks
      are registered)
    copy the info for the user

The other category of change is generally addressing compiler warnings where
ompi_info_t and opal_info_t were being used a little too interchangably. An
ompi_info_t* contains an opal_info_t*, at &(ompi_info->super)

Also this commit updates the copyrights.

Signed-off-by: Mark Allen <markalle@us.ibm.com>
2017-05-17 01:12:49 -04:00

154 строки
6.1 KiB
C

/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* 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 (c) 2008-2015 University of Houston. All rights reserved.
* Copyright (c) 2015 Los Alamos National Security, LLC. All rights
* reserved.
* Copyright (c) 2015 Research Organization for Information Science
* and Technology (RIST). All rights reserved.
* Copyright (c) 2016-2017 IBM Corporation. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef OMPI_MCA_FS_H
#define OMPI_MCA_FS_H
#include "ompi_config.h"
#include "mpi.h"
#include "ompi/mca/mca.h"
#include "opal/mca/base/base.h"
#include "ompi/info/info.h"
BEGIN_C_DECLS
struct mca_io_ompio_file_t;
/*
* Macro for use in components that are of type coll
*/
#define MCA_FS_BASE_VERSION_2_0_0 \
OMPI_MCA_BASE_VERSION_2_1_0("fs", 2, 0, 0)
/*
* This framework provides the abstraction for file management operations
* of the MPI I/O chapter in MPI-2. The operations defined by this
* framework are mostly collective in nature.
*
* These are the component function prototypes. These function pointers
* go into the component structure. These functions (query() and finalize()
* are called during fs_base_select(). Each component is query() ied
* and subsequently, all the unselected components are finalize() 'ed
* so that any *stuff* they did during query() can be undone. By
* similar logic, finalize() is also called on the component which
* was selected when the communicator is being destroyed.
*
* So, to sum it up, every component carries 4 functions:
* 1. open() - called during MPI_INIT
* 2. close() - called during MPI_FINALIZE
* 3. query() - called to select a particular component
* 4. finalize() - called when actions taken during query have
* to be undone
*/
/*
* **************** component struct *******************************
* *********** These functions go in the component struct **********
* **************** component struct *******************************
*/
typedef int (*mca_fs_base_component_init_query_1_0_0_fn_t)
(bool enable_progress_threads,
bool enable_mpi_threads);
typedef struct mca_fs_base_module_1_0_0_t *
(*mca_fs_base_component_file_query_1_0_0_fn_t) (struct mca_io_ompio_file_t *file,
int *priority);
typedef int (*mca_fs_base_component_file_unquery_1_0_0_fn_t)
(struct mca_io_ompio_file_t *file);
/*
* ****************** component struct ******************************
* Structure for fs v2.0.0 components.This is chained to MCA v2.0.0
* ****************** component struct ******************************
*/
struct mca_fs_base_component_2_0_0_t {
mca_base_component_t fsm_version;
mca_base_component_data_t fsm_data;
mca_fs_base_component_init_query_1_0_0_fn_t fsm_init_query;
mca_fs_base_component_file_query_1_0_0_fn_t fsm_file_query;
mca_fs_base_component_file_unquery_1_0_0_fn_t fsm_file_unquery;
};
typedef struct mca_fs_base_component_2_0_0_t mca_fs_base_component_2_0_0_t;
typedef struct mca_fs_base_component_2_0_0_t mca_fs_base_component_t;
/*
* ***********************************************************************
* ************************ Interface function definitions **************
* These are the typedefs for the function pointers to various fs
* backend functions which will be used by the various fs components
* ***********************************************************************
*/
typedef int (*mca_fs_base_module_init_1_0_0_fn_t)
(struct mca_io_ompio_file_t *file);
typedef int (*mca_fs_base_module_finalize_1_0_0_fn_t)
(struct mca_io_ompio_file_t *file);
typedef int (*mca_fs_base_module_file_open_fn_t)(
struct ompi_communicator_t *comm, const char *filename, int amode,
struct opal_info_t *info, struct mca_io_ompio_file_t *fh);
typedef int (*mca_fs_base_module_file_close_fn_t)(struct mca_io_ompio_file_t *fh);
typedef int (*mca_fs_base_module_file_delete_fn_t)(
char *filename, struct opal_info_t *info);
typedef int (*mca_fs_base_module_file_set_size_fn_t)
(struct mca_io_ompio_file_t *fh, OMPI_MPI_OFFSET_TYPE size);
typedef int (*mca_fs_base_module_file_get_size_fn_t)
(struct mca_io_ompio_file_t *fh, OMPI_MPI_OFFSET_TYPE *size);
typedef int (*mca_fs_base_module_file_sync_fn_t)
(struct mca_io_ompio_file_t *fh);
/*
* ***********************************************************************
* *************************** module structure *************************
* ***********************************************************************
*/
struct mca_fs_base_module_1_0_0_t {
/*
* Per-file initialization function. This is called only
* on the module which is selected. The finalize corresponding to
* this function is present on the component struct above
*/
mca_fs_base_module_init_1_0_0_fn_t fs_module_init;
mca_fs_base_module_finalize_1_0_0_fn_t fs_module_finalize;
/* FS function pointers */
mca_fs_base_module_file_open_fn_t fs_file_open;
mca_fs_base_module_file_close_fn_t fs_file_close;
mca_fs_base_module_file_delete_fn_t fs_file_delete;
mca_fs_base_module_file_set_size_fn_t fs_file_set_size;
mca_fs_base_module_file_get_size_fn_t fs_file_get_size;
mca_fs_base_module_file_sync_fn_t fs_file_sync;
};
typedef struct mca_fs_base_module_1_0_0_t mca_fs_base_module_1_0_0_t;
typedef mca_fs_base_module_1_0_0_t mca_fs_base_module_t;
END_C_DECLS
#endif /* OMPI_MCA_FS_H */