gpi2-docs/GASPI_8h_source.html

/*

Copyright (c) Fraunhofer ITWM - Carsten Lojewski <lojewski@itwm.fhg.de>, 2013


This file is part of GPI-2.


GPI-2 is free software; you can redistribute it

and/or modify it under the terms of the GNU General Public License

version 3 as published by the Free Software Foundation.


GPI-2 is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.


You should have received a copy of the GNU General Public License

along with GPI-2. If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef GPI2_H

#define GPI2_H


#ifdef __cplusplus

extern "C"

{

#endif


#define GASPI_MAJOR_VERSION (1)

#define GASPI_MINOR_VERSION (0)

#define GASPI_REVISION (0)


#define GASPI_BLOCK       (0xffffffff)

#define GASPI_TEST        (0x0)

#define GASPI_MAX_NODES   (65536)

#define GASPI_SN_PORT     (10840)

#define GASPI_MAX_GROUPS  (32)

#define GASPI_MAX_MSEGS   (32)

#define GASPI_GROUP_ALL   (0)

#define GASPI_MAX_QP      (16)

#define GASPI_COLL_QP     (GASPI_MAX_QP)

#define GASPI_PASSIVE_QP  (GASPI_MAX_QP+1)

#define GASPI_MAX_TSIZE_C ((1ul<<31ul)-1ul)

#define GASPI_MAX_TSIZE_P ((1ul<<16ul)-1ul)

#define GASPI_MAX_QSIZE   (4096)

#define GASPI_MAX_NOTIFICATION  (65536)


  typedef char gaspi_char;

  typedef unsigned char gaspi_uchar;

  typedef short gaspi_short;

  typedef unsigned short gaspi_ushort;

  typedef int gaspi_int;

  typedef unsigned int gaspi_uint;

  typedef long gaspi_long;

  typedef unsigned long gaspi_ulong;

  typedef float gaspi_float;

  typedef double gaspi_double;


  typedef unsigned int gaspi_timeout_t;

  typedef unsigned short gaspi_rank_t;

  typedef unsigned char gaspi_group_t;

  typedef unsigned int gaspi_number_t;

  typedef void *gaspi_pointer_t;

  typedef void *gaspi_state_t;

  typedef unsigned char *gaspi_state_vector_t;

  typedef unsigned char gaspi_queue_id_t;

  typedef unsigned long gaspi_size_t;

  typedef unsigned long gaspi_alloc_t;

  typedef unsigned char gaspi_segment_id_t;

  typedef unsigned long gaspi_offset_t;

  typedef unsigned long gaspi_atomic_value_t;

  typedef unsigned long gaspi_time_t;

  typedef unsigned short gaspi_notification_id_t;

  typedef unsigned int gaspi_notification_t;

  typedef unsigned int gaspi_statistic_counter_t;

  typedef char * gaspi_string_t;


  typedef enum

  {

    GASPI_ERROR = -1,

    GASPI_SUCCESS = 0,

    GASPI_TIMEOUT = 1

  } gaspi_return_t;


  typedef enum

  {

    GASPI_IB = 0,

    GASPI_ETHERNET = 1,

    GASPI_GEMINI = 2,

    GASPI_ARIES = 3

  } gaspi_network_t;


  typedef enum

  {

    GASPI_OP_MIN = 0,

    GASPI_OP_MAX = 1,

    GASPI_OP_SUM = 2

  } gaspi_operation_t;


  typedef enum

  {

    GASPI_TYPE_INT = 0,

    GASPI_TYPE_UINT = 1,

    GASPI_TYPE_FLOAT = 2,

    GASPI_TYPE_DOUBLE = 3,

    GASPI_TYPE_LONG = 4,

    GASPI_TYPE_ULONG = 5

  } gaspi_datatype_t;


  typedef enum

  {

    GASPI_STATE_HEALTHY = 0,

    GASPI_STATE_CORRUPT = 1

  } gaspi_qp_state_t;


  enum gaspi_alloc_policy_flags

  {

    GASPI_MEM_UNINITIALIZED = 0,

    GASPI_MEM_INITIALIZED = 1

  };


  typedef struct gaspi_config

  {

    gaspi_uint logger;

    gaspi_uint net_info;

    gaspi_uint netdev_id;

    gaspi_uint mtu;

    gaspi_uint port_check;

    gaspi_uint user_net;

    gaspi_network_t net_typ;

    gaspi_uint queue_depth;

    gaspi_uint qp_count;

    gaspi_number_t group_max;

    gaspi_number_t segment_max;

    gaspi_size_t transfer_size_max;

    gaspi_number_t notification_num;

    gaspi_number_t passive_queue_size_max;

    gaspi_number_t passive_transfer_size_max;

    gaspi_size_t allreduce_buf_size;

    gaspi_number_t allreduce_elem_max;

    gaspi_number_t build_infrastructure;


  } gaspi_config_t;


  typedef enum

    {

      GASPI_STATISTIC_ARGUMENT_NONE

    } gaspi_statistic_argument_t;


  typedef gaspi_return_t (*gaspi_reduce_operation_t) (gaspi_pointer_t const

                                                      operand_one,

                                                      gaspi_pointer_t const

                                                      operand_two,

                                                      gaspi_pointer_t const

                                                      result,

                                                      gaspi_state_t const

                                                      state,

                                                      const gaspi_number_t

                                                      num,

                                                      const gaspi_size_t

                                                      element_size,

                                                      const gaspi_timeout_t

                                                      timeout_ms);


  gaspi_return_t gaspi_config_get (gaspi_config_t * const config);


  gaspi_return_t gaspi_config_set (const gaspi_config_t new_config);


  gaspi_return_t gaspi_version (float *version);


  gaspi_return_t gaspi_proc_init (const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_proc_term (const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_proc_rank (gaspi_rank_t * const rank);


  gaspi_return_t gaspi_proc_num (gaspi_rank_t * const proc_num);


  gaspi_return_t gaspi_proc_kill (const gaspi_rank_t rank,

                                  const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_connect (const gaspi_rank_t rank,

                                const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_disconnect (const gaspi_rank_t rank,

                                   const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_group_create (gaspi_group_t * const group);


  gaspi_return_t gaspi_group_delete (const gaspi_group_t group);


  gaspi_return_t gaspi_group_add (const gaspi_group_t group,

                                  const gaspi_rank_t rank);


  gaspi_return_t gaspi_group_commit (const gaspi_group_t group,

                                     const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_group_num (gaspi_number_t * const group_num);


  gaspi_return_t gaspi_group_size (const gaspi_group_t group,

                                   gaspi_number_t * const group_size);


  gaspi_return_t gaspi_group_ranks (const gaspi_group_t group,

                                    gaspi_rank_t * const group_ranks);


  gaspi_return_t gaspi_group_max (gaspi_number_t * const group_max);


  gaspi_return_t gaspi_segment_alloc (const gaspi_segment_id_t segment_id,

                                      const gaspi_size_t size,

                                      const gaspi_alloc_t alloc_policy);

  gaspi_return_t gaspi_segment_delete (const gaspi_segment_id_t segment_id);


  gaspi_return_t gaspi_segment_register (const gaspi_segment_id_t segment_id,

                                         const gaspi_rank_t rank,

                                         const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_segment_create (const gaspi_segment_id_t segment_id,

                                       const gaspi_size_t size,

                                       const gaspi_group_t group,

                                       const gaspi_timeout_t timeout_ms,

                                       const gaspi_alloc_t alloc_policy);


  gaspi_return_t gaspi_segment_num (gaspi_number_t * const segment_num);


  gaspi_return_t gaspi_segment_list (const gaspi_number_t num,

                                     gaspi_segment_id_t *

                                     const segment_id_list);


  gaspi_return_t gaspi_segment_ptr (const gaspi_segment_id_t segment_id,

                                    gaspi_pointer_t * ptr);


  gaspi_return_t gaspi_segment_size (const gaspi_segment_id_t segment_id,

                                     const gaspi_rank_t rank,

                                     gaspi_size_t * const size);


  gaspi_return_t gaspi_segment_max (gaspi_number_t * const segment_max);


  gaspi_return_t gaspi_write (const gaspi_segment_id_t segment_id_local,

                              const gaspi_offset_t offset_local,

                              const gaspi_rank_t rank,

                              const gaspi_segment_id_t segment_id_remote,

                              const gaspi_offset_t offset_remote,

                              const gaspi_size_t size,

                              const gaspi_queue_id_t queue,

                              const gaspi_timeout_t timeout_ms);

  gaspi_return_t gaspi_read (const gaspi_segment_id_t segment_id_local,

                             const gaspi_offset_t offset_local,

                             const gaspi_rank_t rank,

                             const gaspi_segment_id_t segment_id_remote,

                             const gaspi_offset_t offset_remote,

                             const gaspi_size_t size,

                             const gaspi_queue_id_t queue,

                             const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_write_list (const gaspi_number_t num,

                                   gaspi_segment_id_t *

                                   const segment_id_local,

                                   gaspi_offset_t * const offset_local,

                                   const gaspi_rank_t rank,

                                   gaspi_segment_id_t *

                                   const segment_id_remote,

                                   gaspi_offset_t * const offset_remote,

                                   gaspi_size_t * const size,

                                   const gaspi_queue_id_t queue,

                                   const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_read_list (const gaspi_number_t num,

                                  gaspi_segment_id_t * const segment_id_local,

                                  gaspi_offset_t * const offset_local,

                                  const gaspi_rank_t rank,

                                  gaspi_segment_id_t *

                                  const segment_id_remote,

                                  gaspi_offset_t * const offset_remote,

                                  gaspi_size_t * const size,

                                  const gaspi_queue_id_t queue,

                                  const gaspi_timeout_t timeout_ms);

  gaspi_return_t gaspi_wait (const gaspi_queue_id_t queue,

                             const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_barrier (const gaspi_group_t group,

                                const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_allreduce (gaspi_pointer_t const buffer_send,

                                  gaspi_pointer_t const buffer_receive,

                                  const gaspi_number_t num,

                                  const gaspi_operation_t operation,

                                  const gaspi_datatype_t datatyp,

                                  const gaspi_group_t group,

                                  const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_allreduce_user (gaspi_pointer_t const buffer_send,

                                       gaspi_pointer_t const buffer_receive,

                                       const gaspi_number_t num,

                                       const gaspi_size_t element_size,

                                       gaspi_reduce_operation_t const

                                       reduce_operation,

                                       gaspi_state_t const reduce_state,

                                       const gaspi_group_t group,

                                       const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_atomic_fetch_add (const gaspi_segment_id_t segment_id,

                                         const gaspi_offset_t offset,

                                         const gaspi_rank_t rank,

                                         const gaspi_atomic_value_t val_add,

                                         gaspi_atomic_value_t * const val_old,

                                         const gaspi_timeout_t timeout_ms);

  gaspi_return_t gaspi_atomic_compare_swap (const gaspi_segment_id_t

                                            segment_id,

                                            const gaspi_offset_t offset,

                                            const gaspi_rank_t rank,

                                            const gaspi_atomic_value_t

                                            comparator,

                                            const gaspi_atomic_value_t

                                            val_new,

                                            gaspi_atomic_value_t *

                                            const val_old,

                                            const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_passive_send (const gaspi_segment_id_t

                                     segment_id_local,

                                     const gaspi_offset_t offset_local,

                                     const gaspi_rank_t rank,

                                     const gaspi_size_t size,

                                     const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_passive_receive (const gaspi_segment_id_t

                                        segment_id_local,

                                        const gaspi_offset_t offset_local,

                                        gaspi_rank_t * const rem_rank,

                                        const gaspi_size_t size,

                                        const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_notify (const gaspi_segment_id_t segment_id_remote,

                               const gaspi_rank_t rank,

                               const gaspi_notification_id_t notification_id,

                               const gaspi_notification_t notification_value,

                               const gaspi_queue_id_t queue,

                               const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_notify_waitsome (const gaspi_segment_id_t

                                        segment_id_local,

                                        const gaspi_notification_id_t

                                        notification_begin,

                                        const gaspi_number_t num,

                                        gaspi_notification_id_t *

                                        const first_id,

                                        const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_notify_reset (const gaspi_segment_id_t

                                     segment_id_local,

                                     const gaspi_notification_id_t

                                     notification_id,

                                     gaspi_notification_t *

                                     const old_notification_val);


  gaspi_return_t gaspi_write_notify (const gaspi_segment_id_t

                                     segment_id_local,

                                     const gaspi_offset_t offset_local,

                                     const gaspi_rank_t rank,

                                     const gaspi_segment_id_t

                                     segment_id_remote,

                                     const gaspi_offset_t offset_remote,

                                     const gaspi_size_t size,

                                     const gaspi_notification_id_t

                                     notification_id,

                                     const gaspi_notification_t

                                     notification_value,

                                     const gaspi_queue_id_t queue,

                                     const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_write_list_notify (const gaspi_number_t num,

                                          gaspi_segment_id_t *

                                          const segment_id_local,

                                          gaspi_offset_t * const offset_local,

                                          const gaspi_rank_t rank,

                                          gaspi_segment_id_t *

                                          const segment_id_remote,

                                          gaspi_offset_t *

                                          const offset_remote,

                                          gaspi_size_t * const size,

                                          const gaspi_segment_id_t

                                          segment_id_notification,

                                          const gaspi_notification_id_t

                                          notification_id,

                                          const gaspi_notification_t

                                          notification_value,

                                          const gaspi_queue_id_t queue,

                                          const gaspi_timeout_t timeout_ms);


  gaspi_return_t gaspi_queue_size (const gaspi_queue_id_t queue,

                                   gaspi_number_t * const queue_size);


  gaspi_return_t gaspi_queue_num (gaspi_number_t * const queue_num);


  gaspi_return_t gaspi_queue_size_max (gaspi_number_t * const queue_size_max);


  gaspi_return_t gaspi_transfer_size_min (gaspi_size_t *

                                          const transfer_size_min);


  gaspi_return_t gaspi_transfer_size_max (gaspi_size_t *

                                          const transfer_size_max);


  gaspi_return_t gaspi_notification_num (gaspi_number_t * const notification_num);


  gaspi_return_t gaspi_passive_transfer_size_max (gaspi_size_t *

                                                  const

                                                  passive_transfer_size_max);


  gaspi_return_t gaspi_allreduce_buf_size (gaspi_size_t * const buf_size);


  gaspi_return_t gaspi_allreduce_elem_max (gaspi_number_t * const elem_max);


  gaspi_return_t gaspi_rw_list_elem_max (gaspi_number_t * const elem_max);


  gaspi_return_t gaspi_network_type (gaspi_network_t * const network_type);


  gaspi_return_t gaspi_time_ticks (gaspi_time_t * const ticks);


  gaspi_return_t gaspi_cpu_frequency (gaspi_float * const cpu_mhz);


  gaspi_return_t gaspi_machine_type (char const machine_type[16]);


  gaspi_return_t gaspi_state_vec_get (gaspi_state_vector_t state_vector);


  void gaspi_printf (const char *fmt, ...);


  void gaspi_print_affinity_mask ();


  gaspi_return_t gaspi_set_socket_affinity (const gaspi_uchar socket);


  gaspi_return_t gaspi_statistic_verbosity_level(gaspi_number_t _verbosity_level);


  gaspi_return_t gaspi_statistic_counter_max(gaspi_statistic_counter_t* counter_max);


  gaspi_return_t

  gaspi_statistic_counter_info(gaspi_statistic_counter_t counter

                               , gaspi_statistic_argument_t* counter_argument

                               , gaspi_string_t* counter_name

                               , gaspi_string_t* counter_description

                               , gaspi_number_t* verbosity_level

                               );


  gaspi_return_t

  gaspi_statistic_counter_get ( gaspi_statistic_counter_t counter

                                , gaspi_number_t argument

                                , gaspi_number_t *value

                                );


  gaspi_return_t gaspi_statistic_counter_reset (gaspi_statistic_counter_t counter);


#ifdef __cplusplus

}

#endif


#endif