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

201 строка
7.5 KiB
C

/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2013 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 Cisco Systems, Inc. All rights reserved.
* Copyright (c) 2009 Oak Ridge National Labs. All rights reserved.
* Copyright (c) 2012-2013 Los Alamos National Security, Inc. All rights reserved.
* Copyright (c) 2012-2013 Inria. All rights reserved.
* Copyright (c) 2014-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 MCA_TOPO_BASE_H
#define MCA_TOPO_BASE_H
#include "ompi_config.h"
#include "opal/class/opal_list.h"
#include "ompi/mca/mca.h"
#include "ompi/mca/topo/topo.h"
#include "ompi/proc/proc.h"
#include "ompi/communicator/communicator.h"
#include "ompi/info/info.h"
/*
* All stuff goes in here
*/
BEGIN_C_DECLS
/* Lazily initialize the framework (if it wasn't already) */
OMPI_DECLSPEC int mca_topo_base_lazy_init(void);
/*
* MCA Framework
*/
OMPI_DECLSPEC extern mca_base_framework_t ompi_topo_base_framework;
/* Select a topo module for a particular type of topology */
OMPI_DECLSPEC int
mca_topo_base_comm_select(const ompi_communicator_t* comm,
mca_topo_base_module_t* preferred_module,
mca_topo_base_module_t** selected_module,
uint32_t type);
/* Find all components that want to be considered in this job */
OMPI_DECLSPEC int
mca_topo_base_find_available(bool enable_progress_threads,
bool enable_mpi_threads);
/*
* All the glue functions which we will provide to the users by
* default. The component authors need to only write back-end
* functions for cart_create(), graph_create(), graph_map(), and
* cart_map() for their topology components. But they can implement
* these glue functions if they want.
*
* These glue functions
*/
OMPI_DECLSPEC int
mca_topo_base_cart_create(mca_topo_base_module_t *topo_module,
ompi_communicator_t* old_comm,
int ndims,
const int *dims,
const int *periods,
bool reorder,
ompi_communicator_t** comm_topo);
OMPI_DECLSPEC int
mca_topo_base_cart_coords(ompi_communicator_t *comm,
int rank,
int maxdims,
int *coords);
OMPI_DECLSPEC int
mca_topo_base_cartdim_get(ompi_communicator_t *comm,
int *ndims);
OMPI_DECLSPEC int
mca_topo_base_cart_get(ompi_communicator_t *comm,
int maxdims,
int *dims,
int *periods,
int *coords);
OMPI_DECLSPEC int
mca_topo_base_cart_map(ompi_communicator_t * comm,
int ndims,
const int *dims, const int *periods, int *newrank);
OMPI_DECLSPEC int
mca_topo_base_cart_rank(ompi_communicator_t *comm,
const int *coords,
int *rank);
OMPI_DECLSPEC int
mca_topo_base_cart_shift(ompi_communicator_t *comm,
int direction,
int disp,
int *rank_source,
int *rank_dest);
OMPI_DECLSPEC int
mca_topo_base_cart_sub(ompi_communicator_t *comm,
const int *remain_dims,
ompi_communicator_t **new_comm);
OMPI_DECLSPEC int
mca_topo_base_graphdims_get(ompi_communicator_t *comm,
int *nodes,
int *nedges);
OMPI_DECLSPEC int
mca_topo_base_graph_create(mca_topo_base_module_t *topo_module,
ompi_communicator_t* old_comm,
int nnodes,
const int *index,
const int *edges,
bool reorder,
ompi_communicator_t** new_comm);
OMPI_DECLSPEC int
mca_topo_base_graph_get(ompi_communicator_t *comm,
int maxindex,
int maxedges,
int *index,
int *edges);
OMPI_DECLSPEC int
mca_topo_base_graph_map(ompi_communicator_t * comm,
int nnodes,
const int *index, const int *edges, int *newrank);
OMPI_DECLSPEC int
mca_topo_base_graph_neighbors(ompi_communicator_t *comm,
int rank,
int maxneighbors,
int *neighbors);
OMPI_DECLSPEC int
mca_topo_base_graph_neighbors_count(ompi_communicator_t *comm,
int rank,
int *nneighbors);
/**
* Efficiently distribute the information about the distributed graph as
* submitted through the distributed graph interface.
*/
OMPI_DECLSPEC int
mca_topo_base_dist_graph_distribute(mca_topo_base_module_t* module,
ompi_communicator_t *comm,
int n, const int nodes[],
const int degrees[], const int targets[],
const int weights[],
mca_topo_base_comm_dist_graph_2_2_0_t** ptopo);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_create(mca_topo_base_module_t* module,
ompi_communicator_t *old_comm,
int n, const int nodes[],
const int degrees[], const int targets[], const int weights[],
opal_info_t *info, int reorder,
ompi_communicator_t **new_comm);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_create_adjacent(mca_topo_base_module_t* module,
ompi_communicator_t *old_comm,
int indegree, const int sources[],
const int sourceweights[], int outdegree,
const int destinations[], const int destweights[],
opal_info_t *info, int reorder,
ompi_communicator_t **comm_dist_graph);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_neighbors(ompi_communicator_t *comm,
int maxindegree,
int sources[], int sourceweights[],
int maxoutdegree, int destinations[],
int destweights[]);
OMPI_DECLSPEC int
mca_topo_base_dist_graph_neighbors_count(ompi_communicator_t *comm,
int *inneighbors, int *outneighbors, int *weighted);
END_C_DECLS
#endif /* MCA_BASE_TOPO_H */