include/x10rt_net.h File Reference

Core Networking Layer. More...

#include <cstdlib>
#include <x10rt_types.h>
Include dependency graph for x10rt_net.h:

Go to the source code of this file.

Functions

x10rt_error x10rt_net_preinit (char *connInfoBuffer, int connInfoBufferSize)
 Partially initialize the X10RT API logical layer.
x10rt_error x10rt_net_init (int *argc, char ***argv, x10rt_msg_type *counter)
 Initialize the X10RT API logical layer.
const char * x10rt_net_error_msg (void)
 Get a detailed user-readable error about the fatal error that has rendered X10RT inoperable.
void x10rt_net_register_msg_receiver (x10rt_msg_type msg_type, x10rt_handler *cb)
 Register handlers for a plain message.
void x10rt_net_register_get_receiver (x10rt_msg_type msg_type, x10rt_finder *cb1, x10rt_notifier *cb2)
 Register handlers for a get message.
void x10rt_net_register_put_receiver (x10rt_msg_type msg_type, x10rt_finder *cb1, x10rt_notifier *cb2)
 Register handlers for a put message.
void x10rt_net_internal_barrier (void)
 A single-threaded SPMD host barrier.
x10rt_place x10rt_net_nhosts (void)
x10rt_place x10rt_net_ndead (void)
bool x10rt_net_is_place_dead (x10rt_place p)
x10rt_error x10rt_net_get_dead (x10rt_place *dead_places, x10rt_place len)
x10rt_place x10rt_net_here (void)
void x10rt_net_send_msg (x10rt_msg_params *p)
void x10rt_net_send_get (x10rt_msg_params *p, void *buf, x10rt_copy_sz len)
void x10rt_net_send_put (x10rt_msg_params *p, void *buf, x10rt_copy_sz len)
x10rt_error x10rt_net_probe (void)
 Handle any oustanding message from the network by calling the registered callbacks.
x10rt_error x10rt_net_blocking_probe (void)
 Handle any oustanding message from the network by calling the registered callbacks, blocking if nothing is available.
void x10rt_net_remote_op (x10rt_place place, x10rt_remote_ptr remote_addr, x10rt_op_type type, unsigned long long value)
void x10rt_net_remote_ops (x10rt_remote_op_params *ops, size_t num_ops)
void x10rt_net_register_mem (void *ptr, size_t len)
void x10rt_net_finalize (void)
 Shut down the network layer.
int x10rt_net_supports (x10rt_opt o)
 Return whether the x10rt_net implementation supports a particular feature.
void x10rt_net_team_new (x10rt_place placec, x10rt_place *placev, x10rt_completion_handler2 *ch, void *arg)
void x10rt_net_team_del (x10rt_team team, x10rt_place role, x10rt_completion_handler *ch, void *arg)
x10rt_place x10rt_net_team_sz (x10rt_team team)
void x10rt_net_team_split (x10rt_team parent, x10rt_place parent_role, x10rt_place color, x10rt_place new_role, x10rt_completion_handler2 *ch, void *arg)
void x10rt_net_barrier (x10rt_team team, x10rt_place role, x10rt_completion_handler *ch, void *arg)
void x10rt_net_bcast (x10rt_team team, x10rt_place role, x10rt_place root, const void *sbuf, void *dbuf, size_t el, size_t count, x10rt_completion_handler *ch, void *arg)
void x10rt_net_scatter (x10rt_team team, x10rt_place role, x10rt_place root, const void *sbuf, void *dbuf, size_t el, size_t count, x10rt_completion_handler *ch, void *arg)
void x10rt_net_alltoall (x10rt_team team, x10rt_place role, const void *sbuf, void *dbuf, size_t el, size_t count, x10rt_completion_handler *ch, void *arg)
void x10rt_net_reduce (x10rt_team team, x10rt_place role, x10rt_place root, const void *sbuf, void *dbuf, x10rt_red_op_type op, x10rt_red_type dtype, size_t count, x10rt_completion_handler *ch, void *arg)
void x10rt_net_allreduce (x10rt_team team, x10rt_place role, const void *sbuf, void *dbuf, x10rt_red_op_type op, x10rt_red_type dtype, size_t count, x10rt_completion_handler *ch, void *arg)

Variables

x10rt_stats x10rt_lgl_stats
 Counters exposed to the backend for direct (i.e.

Detailed Description

Core Networking Layer.

This layer is used to implement X10 inter-host communication functionality on top of a network library.

See also:
Library Structure

Function Documentation

x10rt_error x10rt_net_preinit ( char *  connInfoBuffer,
int  connInfoBufferSize 
)

Partially initialize the X10RT API logical layer.

See also:
x10rt_lgl_preinit
Parameters:
connInfoBuffer As in x10rt_lgl_preinit.
connInfoBufferSize As in x10rt_lgl_preinit.
x10rt_error x10rt_net_init ( int *  argc,
char ***  argv,
x10rt_msg_type counter 
)

Initialize the X10RT API logical layer.

See also:
x10rt_lgl_init
Parameters:
argc As in x10rt_lgl_init.
argv As in x10rt_lgl_init.
counter As in x10rt_lgl_init.
const char* x10rt_net_error_msg ( void   ) 

Get a detailed user-readable error about the fatal error that has rendered X10RT inoperable.

Returns:
Text describing the error, or NULL if no error has occured.
void x10rt_net_register_msg_receiver ( x10rt_msg_type  msg_type,
x10rt_handler cb 
)

Register handlers for a plain message.

See also:
x10rt_lgl_register_msg_receiver
Parameters:
msg_type s in x10rt_lgl_register_msg_receiver
cb As in x10rt_lgl_register_msg_receiver
void x10rt_net_register_get_receiver ( x10rt_msg_type  msg_type,
x10rt_finder cb1,
x10rt_notifier cb2 
)

Register handlers for a get message.

See also:
x10rt_lgl_register_get_receiver
Parameters:
msg_type As in x10rt_lgl_register_get_receiver
cb1 As in x10rt_lgl_register_get_receiver
cb2 As in x10rt_lgl_register_get_receiver
void x10rt_net_register_put_receiver ( x10rt_msg_type  msg_type,
x10rt_finder cb1,
x10rt_notifier cb2 
)

Register handlers for a put message.

See also:
x10rt_lgl_register_put_receiver
Parameters:
msg_type As in x10rt_lgl_register_put_receiver
cb1 As in x10rt_lgl_register_put_receiver
cb2 As in x10rt_lgl_register_put_receiver
void x10rt_net_internal_barrier ( void   ) 

A single-threaded SPMD host barrier.

Deprecated:
x10rt_place x10rt_net_nhosts ( void   ) 
See also:
x10rt_lgl_nhosts
x10rt_place x10rt_net_ndead ( void   ) 
See also:
x10rt_ndead
bool x10rt_net_is_place_dead ( x10rt_place  p  ) 
x10rt_error x10rt_net_get_dead ( x10rt_place dead_places,
x10rt_place  len 
)
See also:
x10rt_get_dead
x10rt_place x10rt_net_here ( void   ) 
See also:
x10rt_lgl_here
void x10rt_net_send_msg ( x10rt_msg_params p  ) 
See also:
x10rt_lgl_send_msg
Parameters:
p As in x10rt_lgl_send_msg.
void x10rt_net_send_get ( x10rt_msg_params p,
void *  buf,
x10rt_copy_sz  len 
)
See also:
x10rt_lgl_send_msg
Parameters:
p As in x10rt_lgl_send_msg.
buf As in x10rt_lgl_send_msg.
len As in x10rt_lgl_send_msg.
void x10rt_net_send_put ( x10rt_msg_params p,
void *  buf,
x10rt_copy_sz  len 
)
See also:
x10rt_lgl_send_msg
Parameters:
p As in x10rt_lgl_send_msg.
buf As in x10rt_lgl_send_msg.
len As in x10rt_lgl_send_msg.
x10rt_error x10rt_net_probe ( void   ) 

Handle any oustanding message from the network by calling the registered callbacks.

See also:
x10rt_lgl_probe
x10rt_error x10rt_net_blocking_probe ( void   ) 

Handle any oustanding message from the network by calling the registered callbacks, blocking if nothing is available.

See also:
x10rt_lgl_probe
void x10rt_net_remote_op ( x10rt_place  place,
x10rt_remote_ptr  remote_addr,
x10rt_op_type  type,
unsigned long long  value 
)
See also:
x10rt_lgl_remote_op
Parameters:
place As in x10rt_lgl_remote_op
remote_addr As in x10rt_lgl_remote_op
type As in x10rt_lgl_remote_op
value As in x10rt_lgl_remote_op
void x10rt_net_remote_ops ( x10rt_remote_op_params ops,
size_t  num_ops 
)
See also:
x10rt_lgl_remote_ops
Parameters:
ops As in x10rt_lgl_remote_ops
num_ops As in x10rt_lgl_remote_ops
void x10rt_net_register_mem ( void *  ptr,
size_t  len 
)
See also:
x10rt_lgl_register_mem
Parameters:
ptr As in x10rt_lgl_register_mem
len As in x10rt_lgl_register_mem
void x10rt_net_finalize ( void   ) 

Shut down the network layer.

See also:
x10rt_lgl_finalize
void x10rt_net_team_new ( x10rt_place  placec,
x10rt_place placev,
x10rt_completion_handler2 ch,
void *  arg 
)
See also:
x10rt_lgl_team_new
Parameters:
placec As in x10rt_lgl_team_new
placev As in x10rt_lgl_team_new
ch As in x10rt_lgl_team_new
arg As in x10rt_lgl_team_new
void x10rt_net_team_del ( x10rt_team  team,
x10rt_place  role,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_team_del
Parameters:
team As in x10rt_lgl_team_del
role As in x10rt_lgl_team_del
ch As in x10rt_lgl_team_del
arg As in x10rt_lgl_team_del
x10rt_place x10rt_net_team_sz ( x10rt_team  team  ) 
See also:
x10rt_lgl_team_sz
Parameters:
team As in x10rt_lgl_team_sz
Returns:
As in x10rt_lgl_team_sz
void x10rt_net_team_split ( x10rt_team  parent,
x10rt_place  parent_role,
x10rt_place  color,
x10rt_place  new_role,
x10rt_completion_handler2 ch,
void *  arg 
)
See also:
x10rt_lgl_team_split
Parameters:
parent As in x10rt_lgl_team_split
parent_role As in x10rt_lgl_team_split
color As in x10rt_lgl_team_split
new_role As in x10rt_lgl_team_split
ch As in x10rt_lgl_team_split
arg As in x10rt_lgl_team_split
void x10rt_net_barrier ( x10rt_team  team,
x10rt_place  role,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_barrier
Parameters:
team As in x10rt_lgl_barrier
role As in x10rt_lgl_barrier
ch As in x10rt_lgl_barrier
arg As in x10rt_lgl_barrier
void x10rt_net_bcast ( x10rt_team  team,
x10rt_place  role,
x10rt_place  root,
const void *  sbuf,
void *  dbuf,
size_t  el,
size_t  count,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_bcast
Parameters:
team As in x10rt_lgl_bcast
role As in x10rt_lgl_bcast
root As in x10rt_lgl_bcast
sbuf As in x10rt_lgl_bcast
dbuf As in x10rt_lgl_bcast
el As in x10rt_lgl_bcast
count As in x10rt_lgl_bcast
ch As in x10rt_lgl_bcast
arg As in x10rt_lgl_bcast
void x10rt_net_scatter ( x10rt_team  team,
x10rt_place  role,
x10rt_place  root,
const void *  sbuf,
void *  dbuf,
size_t  el,
size_t  count,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_scatter
Parameters:
team As in x10rt_lgl_scatter
role As in x10rt_lgl_scatter
root As in x10rt_lgl_scatter
sbuf As in x10rt_lgl_scatter
dbuf As in x10rt_lgl_scatter
el As in x10rt_lgl_scatter
count As in x10rt_lgl_scatter
ch As in x10rt_lgl_scatter
arg As in x10rt_lgl_scatter
void x10rt_net_alltoall ( x10rt_team  team,
x10rt_place  role,
const void *  sbuf,
void *  dbuf,
size_t  el,
size_t  count,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_alltoall
Parameters:
team As in x10rt_lgl_alltoall
role As in x10rt_lgl_alltoall
sbuf As in x10rt_lgl_alltoall
dbuf As in x10rt_lgl_alltoall
el As in x10rt_lgl_alltoall
count As in x10rt_lgl_alltoall
ch As in x10rt_lgl_alltoall
arg As in x10rt_lgl_alltoall
void x10rt_net_reduce ( x10rt_team  team,
x10rt_place  role,
x10rt_place  root,
const void *  sbuf,
void *  dbuf,
x10rt_red_op_type  op,
x10rt_red_type  dtype,
size_t  count,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_reduce
Parameters:
team As in x10rt_lgl_reduce
role As in x10rt_lgl_reduce
root As in x10rt_lgl_reduce
sbuf As in x10rt_lgl_reduce
dbuf As in x10rt_lgl_reduce
el As in x10rt_lgl_reduce
count As in x10rt_lgl_reduce
ch As in x10rt_lgl_reduce
arg As in x10rt_lgl_reduce
void x10rt_net_allreduce ( x10rt_team  team,
x10rt_place  role,
const void *  sbuf,
void *  dbuf,
x10rt_red_op_type  op,
x10rt_red_type  dtype,
size_t  count,
x10rt_completion_handler ch,
void *  arg 
)
See also:
x10rt_lgl_allreduce
Parameters:
team As in x10rt_lgl_allreduce
role As in x10rt_lgl_allreduce
sbuf As in x10rt_lgl_allreduce
dbuf As in x10rt_lgl_allreduce
op As in x10rt_lgl_allreduce
dtype As in x10rt_lgl_allreduce
count As in x10rt_lgl_allreduce
ch As in x10rt_lgl_allreduce
arg As in x10rt_lgl_allreduce

Variable Documentation

Counters exposed to the backend for direct (i.e.

fast) manipulation.


Generated on 29 Aug 2013 for X10RT by  doxygen 1.6.1