roccom_c.h

Go to the documentation of this file.

/* *******************************************************************
 * Rocstar Simulation Suite                                          *
 * Copyright@2015, Illinois Rocstar LLC. All rights reserved.        *
 *                                                                   *
 * Illinois Rocstar LLC                                              *
 * Champaign, IL                                                     *
 * www.illinoisrocstar.com                                           *
 * sales@illinoisrocstar.com                                         *
 *                                                                   *
 * License: See LICENSE file in top level of distribution package or *
 * http://opensource.org/licenses/NCSA                               *
 *********************************************************************/
/* *******************************************************************
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,   *
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   *
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          *
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE CONTRIBUTORS OR           *
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   *
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE    *
 * USE OR OTHER DEALINGS WITH THE SOFTWARE.                          *
 *********************************************************************/
/* $Id: roccom_c.h,v 1.26 2008/12/06 08:43:25 mtcampbe Exp $ */

/* Author: Xiangmin Jiao
 * Dates:  Jan. 10, 2001
 */

#ifndef __ROCCOM_C_H__
#define __ROCCOM_C_H__

#include "roccom_basic.h"
#include "commpi.h"
#include <string.h>

/* C API of Roccom. */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define LOAD_MODULE_WRAPPER( mixed, lower, UPPER)                       \
                                                                        \
  void mixed ## _load_module( const char * mod) {                       \
    extern void COM_F_FUNC2( lower ## _load_module, UPPER ## _LOAD_MODULE) \
      ( const char *mod, long int len);                                 \
                                                                        \
    long int len = strlen(mod);                                         \
    COM_F_FUNC2( lower ## _load_module, UPPER ## _LOAD_MODULE)          \
      ( mod, len);                                                      \
  }                                                                     \
                                                                        \
  void mixed ## _unload_module( const char * mod) {                     \
    extern void COM_F_FUNC2( lower ## _unload_module, UPPER ## _UNLOAD_MODULE) \
      ( const char *mod, long int len);                                 \
                                                                        \
    long int len = strlen(mod);                                         \
    COM_F_FUNC2( lower ## _unload_module, UPPER ## _UNLOAD_MODULE)      \
      ( mod, len);                                                      \
  }

  void COM_init( int *argc, char ***argv);
  void COM_finalize();
  int  COM_initialized();
  void COM_abort( int ierr);

  void COM_set_default_communicator( MPI_Comm comm);
  MPI_Comm COM_get_default_communicator();
  void COM_load_module( const char *libname, const char *winname);
  void COM_unload_module( const char *libname, const char *winname);

  /* Creation and deletion of a window. str specifies a window's name.
   * The length of a string can be omitted for C/C++ code. For Fortran,
   * the lengths are passed automatically by the compilers.
   * (Same for all other routines.) */
  void COM_new_window( const char *w_str, MPI_Comm c);
  void COM_delete_window( const char *str);

  /* Deregistering a pane from Roccom
   *    w_str is a window's name.
   *    pane_id is the id of a pane which was created before. */
  void COM_delete_pane( const char *w_str,
                        const int pane_id);

  /* This marks the end of the initialization of a window, 
   *    w_str is a window's name. */
  void COM_window_init_done( const char *w_str, int pane_changed);

  void COM_new_attribute( const char *wa_str,
                          const char loc,
                          const int  type,
                          int  ncomp,
                          const char *unit);

  void COM_delete_attribute( const char *wa_str);

#ifndef C_ONLY

  void COM_set_size( const char *wa_str, int pane_id, int size, int ng);

  void COM_set_array( const char *wa_str, int pane_id, 
                      void *addr, int strd, int cap);

  void COM_set_bounds( const char *wa_str, int pane_id, 
                       const void *lbound, const void *ubound);

  void COM_allocate_array( const char *wa_str, int pane_id, 
                           void **addr, int strd, int cap);

  void COM_resize_array( const char *wa_str, int pane_id, 
                         void **addr, int strd, int cap);

  void COM_append_array( const char *wa_str, int pane_id,
                         const void *val, int v_strd, int v_size);

  void COM_use_attribute( const char *wname, const char *attr, 
                          int with_ghost, const char *ptnname, int val);

  void COM_clone_attribute( const char *wname, const char *attr, 
                            int with_ghost, const char *ptnname, int val);

  void COM_copy_attribute( const char *wname, const char *attr, 
                           int with_ghost, const char *ptnname, int val);

  void COM_copy_attribute_handles( int trg_hdl, int src_hdl, 
                                  int with_ghost, int ptn_hdl, int val) ;

  void COM_deallocate_array( const char *wa_str, const int pid);

  void COM_get_size(const char *wa_str, int pane_id, int *size, int *ng);

  void COM_get_attribute(const char *wa_str, char *loc,
                         int *type, int *ncomp, char *unit, int n);
#endif

  void COM_get_array( const char *wa_str, int pane_id, 
                      void **addr, int *strd, int *cap);

  void COM_copy_array( const char *wa_str, int pane_id,
                       void *val, int v_strd, int v_size, int offset);

  void COM_get_bounds( const char *wa_str, int pane_id, 
                       void *lbound, void *ubound);

  int COM_check_bounds( const char *wa_str, int pane_id);

  void COM_get_attribute( const char *wa_str, char *loc,
                          int *type, int *ncomp, char *unit, int n);
  void COM_get_communicator( const char *wname, MPI_Comm *comm);

  void COM_get_panes( const char *wname, int *npanes, 
                      int **pane_ids, int rank);

  void COM_get_attributes( const char *wname, int *na, char **names);

  void COM_get_connectivities( const char *wname, int pane_id,
                               int *nc, char **names);

  void COM_get_parent( const char *waname, int pane_id, char **parent);

  void COM_free_buffer( char **buf);

  int COM_get_window_handle( const char *wname);
  int COM_get_attribute_handle( const char *waname);
  int COM_get_attribute_handle_const( const char *waname);
  int COM_get_function_handle( const char *wfname);

  int COM_get_status( const char *waname, const int pane_id);
  
  /* Associate a function pointer with a name. 
   *   The function can take up to seven arguments of void* type
   *   and return no value. */
  void COM_set_function( const char *wf_str,
                         Func_ptr   func,
                         const char *intents,
                         const COM_Type *types);

  void COM_set_member_function( const char *wf_str,
                                Func_ptr   func,
                                const char *wa_str,
                                const char *intents,
                                const COM_Type *types);

  /* Invoke a function by a name registered to Roccom. */
  void COM_call_function( const int wf, int argc, ...);

  /* Non-blocking invocation of a function by a name registered to Roccom. */
  void COM_icall_function( const int wf, int argc, ...);

  void COM_wait( const int id);
  int  COM_test( const int id);

  void COM_set_verbose( int i);
  void COM_set_debug( bool debug);
  void COM_set_profiling( int i);
  void COM_set_profiling_barrier( int hdl, MPI_Comm comm);
  void COM_print_profile( const char *fname, const char *header);
  /*\}*/

  int  COM_get_sizeof( const COM_Type type, int c);
  int  COM_compatible_types( COM_Type type1, COM_Type type2);

  int  COM_get_error_code();
  /*\}*/
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __ROCCOM_C_H__ */