model-net.h 14.3 KB
Newer Older
1
/*
Philip Carns's avatar
Philip Carns committed
2
 * Copyright (C) 2013 University of Chicago.
3
 * See COPYRIGHT notice in top-level directory.
Philip Carns's avatar
Philip Carns committed
4
 *
5 6 7 8 9
 */

#ifndef MODELNET_H
#define MODELNET_H

Jonathan Jenkins's avatar
Jonathan Jenkins committed
10 11 12 13
#ifdef __cplusplus
extern "C" {
#endif

14 15 16 17 18
#include <ross.h>
#include <codes/lp-type-lookup.h>
#include <codes/configuration.h>
#include <codes/lp-io.h>
#include <codes/codes-mapping-context.h>
19
#include <stdint.h>
20

21 22
#define PULL_MSG_SIZE 128

23
#define MAX_NAME_LENGTH 256
24 25
#define CATEGORY_NAME_MAX 16
#define CATEGORY_MAX 12
26

27
// simple deprecation attribute hacking
28 29 30 31 32 33
#if !defined(DEPRECATED)
#  if defined(__GNUC__) || defined(__GNUG__) || defined(__clang__)
#    define DEPRECATED __attribute__((deprecated))
#  else
#    define DEPRECATED
#  endif
34 35
#endif

36 37 38 39 40
/* HACK: there is currently no scheduling fidelity across multiple
 * model_net_event calls. Hence, problems arise when some LP sends multiple
 * messages as part of an event and expects FCFS ordering. A proper fix which
 * involves model-net LP-level scheduling of requests is ideal, but not 
 * feasible for now (would basically have to redesign model-net), so expose
41 42
 * explicit start-sequence and stop-sequence markers as a workaround
 */
43
extern int mn_in_sequence;
44 45
extern tw_stime mn_msg_offset;
#define MN_START_SEQ() do {\
46
    mn_in_sequence = 1; \
47 48 49
    mn_msg_offset = 0.0; \
} while (0)
#define MN_END_SEQ() do {\
50
    mn_in_sequence = 0;\
51 52 53
} while (0)


54
typedef struct mn_stats mn_stats;
55

56 57 58 59 60
// use the X-macro to get types and names rolled up into one structure
// format: { enum vals, config name, internal lp name, lp method struct}
// last value is sentinel
#define NETWORK_DEF \
    X(SIMPLENET, "modelnet_simplenet", "simplenet", &simplenet_method)\
Jonathan Jenkins's avatar
Jonathan Jenkins committed
61
    X(SIMPLEP2P, "modelnet_simplep2p", "simplep2p", &simplep2p_method)\
62 63
    X(TORUS,     "modelnet_torus",     "torus",     &torus_method)\
    X(DRAGONFLY, "modelnet_dragonfly", "dragonfly", &dragonfly_method)\
64
    X(DRAGONFLY_ROUTER, "modelnet_dragonfly_router", "dragonfly_router", &dragonfly_router_method)\
65 66 67 68
    X(LOGGP,     "modelnet_loggp",     "loggp",     &loggp_method)\
    X(MAX_NETS,  NULL,                 NULL,        NULL)

#define X(a,b,c,d) a,
69 70
enum NETWORKS
{
71
    NETWORK_DEF
72
};
73 74
#undef X

75 76
// message parameter types
enum msg_param_type {
77
    // parameters for modelnet-scheduler (priorities and such)
78
    MN_MSG_PARAM_SCHED,
79 80 81
    // parameter allowing the explicit setting of a messages start time (useful
    // for routing scenarios in which a single message is implemented in terms
    // of multiple model-net events, such as for model_net_pull_*event's)
82
    MN_MSG_PARAM_START_TIME,
83 84 85
    MAX_MN_MSG_PARAM_TYPES
};

86 87 88 89 90
// MN_MSG_PARAM_MSG_START_TIME parameter types (only one for the time being)
enum msg_param_start_time {
    MN_MSG_PARAM_START_TIME_VAL
};

91 92 93 94 95
// return type for model_net_*event calls, to be passed into RC
// currently is just an int, but in the future may indicate whether lp-io was
// called etc.
typedef int model_net_event_return;

96 97 98 99
// network identifiers (both the config lp names and the model-net internal
// names)
extern char * model_net_lp_config_names[];
extern char * model_net_method_names[];
100

101 102 103 104
// request structure that gets passed around (by the model-net implementation,
// not the user)
typedef struct model_net_request {
    tw_lpid  final_dest_lp;
105
    tw_lpid  dest_mn_lp; // destination modelnet lp
106
    tw_lpid  src_lp;
107 108
    // time the source event was called
    tw_stime msg_start_time;
109
    uint64_t msg_size;
110
    uint64_t pull_size;
111
    uint64_t packet_size;
112 113 114
    // unique message id set, *at the modelnet LP*, for each message the
    // modelnet LP processes
    uint64_t msg_id;
115 116 117 118 119 120 121
    int      net_id;
    int      is_pull;
    int      remote_event_size;
    int      self_event_size;
    char     category[CATEGORY_NAME_MAX];
} model_net_request;

122 123 124 125 126 127 128 129 130 131 132 133 134
/* data structure for tracking network statistics */
struct mn_stats
{
    char category[CATEGORY_NAME_MAX];
    long send_count;
    long send_bytes;
    tw_stime send_time;
    long recv_count;
    long recv_bytes;
    tw_stime recv_time;
    long max_event_size;
};

135 136 137
/* Registers all model-net LPs in ROSS. Should be called after 
 * configuration_load, but before codes_mapping_setup */
void model_net_register();
138

139 140 141 142 143 144 145 146
/* Configures all model-net LPs based on the CODES configuration, and returns
 * ids to address the different types by.
 *
 * id_count - the output number of networks
 *
 * return - the set of network IDs, indexed in the order given by the
 * modelnet_order configuration parameter */
int* model_net_configure(int *id_count);
147

148 149 150
/* Sets up a sampling loop for model net events. The sampling data provided by
 * each modelnet lp is model-defined. This is a PE-wide setting. Data is sent
 * to LP-IO with the category modelnet-samples */
151
void model_net_enable_sampling(tw_stime interval, tw_stime end);
152 153 154 155

/* Returns 1 if modelnet is performing sampling, 0 otherwise */
int model_net_sampling_enabled(void);

156 157 158 159 160
/* Initialize/configure the network(s) based on the CODES configuration.
 * returns an array of the network ids, indexed in the order given by the 
 * modelnet_order configuration parameter 
 * OUTPUT id_count - the output number of networks */
int* model_net_set_params(int *id_count);
161

162 163
/* utility function to get the modelnet ID post-setup */
int model_net_get_id(char *net_name);
164 165 166 167

/* This event does a collective operation call for model-net */
void model_net_event_collective(
    int net_id,
168
    char const * category,
169 170
    int message_size,
    int remote_event_size,
171
    void const * remote_event,
172 173 174 175 176 177 178 179
    tw_lp *sender);

/* reverse event of the collective operation call */
void model_net_event_collective_rc(
        int net_id,
        int message_size,
        tw_lp *sender);

180 181 182
/* allocate and transmit a new event that will pass through model_net to 
 * arrive at its destination:
 *
183 184
 * - net_id: the type of network to send this message through. The set of
 *   net_id's is given by model_net_configure.
185 186 187 188 189 190 191 192 193 194 195 196
 * - category: category name to associate with this communication
 *   - OPTIONAL: callers can set this to NULL if they don't want to use it,
 *     and model_net methods can ignore it if they don't support it
 * - final_dest_lp: the LP that the message should be delivered to.
 *   - NOTE: this is _not_ the LP of an underlying network method (for
 *     example, it is not a torus or dragonfly LP), but rather the LP of an
 *     MPI process or storage server that you are transmitting to.
 * - message_size: this is the size of the message (in bytes) that modelnet
 *     will simulate transmitting to the final_dest_lp.  It can be any size
 *     (i.e. it is not constrained by transport packet size).
 * - remote_event_size: this is the size of the ROSS event structure that
 *     will be delivered to the final_dest_lp.
197 198 199
 * - remote_event: pointer to data to be used as the remote event message. When
 *   the message payload (of size message_size) has been fully delivered to the
 *   destination (given by final_dest_lp), this event will be issued.
200 201 202 203 204 205 206
 * - self_event_size: this is the size of the ROSS event structure that will
 *     be delivered to the calling LP once local completion has occurred for
 *     the network transmission.
 *     - NOTE: "local completion" in this sense means that model_net has
 *       transmitted the data off of the local node, but it does not mean that
 *       the data has been (or even will be) delivered.  Once this event is
 *       delivered the caller is free to re-use its buffer.
207 208 209 210
 * - self_event: pointer to data to be used as the self event message. When the
 *   message payload (of size message_size) has been fully sent from the
 *   sender's point of view (e.g. the corresponding NIC has sent out all
 *   packets for this message), the event will be issued to the sender.
211 212
 * - sender: pointer to the tw_lp structure of the API caller.  This is
 *     identical to the sender argument to tw_event_new().
213
 *
214 215 216 217
 * The modelnet LP used for communication is determined by the default CODES
 * map context (see codes-base, codes/codes-mapping-context.h), using net_id
 * to differentiate different model types. Note that the map context is used
 * when calculating *both* sender and receiver modelnet LPs
218 219
 */
// first argument becomes the network ID
220
model_net_event_return model_net_event(
221
    int net_id,
222
    char const * category, 
223
    tw_lpid final_dest_lp, 
224
    uint64_t message_size, 
225
    tw_stime offset,
226
    int remote_event_size,
227
    void const * remote_event,
228
    int self_event_size,
229
    void const * self_event,
230
    tw_lp *sender);
231 232 233 234 235
/*
 * See model_net_event for a general description.
 *
 * Unlike model_net_event, this function uses the annotation to differentiate
 * multiple modelnet LPs with the same type but different annotation. The caller
236 237
 * annotation is not consulted here. The corresponding CODES map context is
 * CODES_MCTX_GROUP_MODULO with the supplied annotation arguments.
238
 */
239
model_net_event_return model_net_event_annotated(
240
        int net_id,
241 242
        char const * annotation,
        char const * category, 
243 244 245 246
        tw_lpid final_dest_lp, 
        uint64_t message_size, 
        tw_stime offset,
        int remote_event_size,
247
        void const * remote_event,
248
        int self_event_size,
249
        void const * self_event,
250
        tw_lp *sender);
251 252 253 254 255 256
/*
 * See model_net_event for a general description.
 *
 * This variant uses CODES map contexts to calculate the sender and receiver
 * modelnet LPs
 */
257
model_net_event_return model_net_event_mctx(
258 259 260 261 262 263 264 265 266 267 268 269 270
        int net_id,
        struct codes_mctx const * send_map_ctx,
        struct codes_mctx const * recv_map_ctx,
        char const * category, 
        tw_lpid final_dest_lp, 
        uint64_t message_size, 
        tw_stime offset,
        int remote_event_size,
        void const * remote_event,
        int self_event_size,
        void const * self_event,
        tw_lp *sender);

271

272 273
/* model_net_find_local_device()
 *
274 275 276
 * returns the LP id of the network card attached to the calling LP using the
 * default CODES mapping context if ignore_annotations is true, and
 * CODES_MCTX_GROUP_MODULO with the supplied annotation parameters otherwise
277
 */
278 279 280 281
tw_lpid model_net_find_local_device(
        int          net_id,
        const char * annotation,
        int          ignore_annotations,
282
        tw_lpid      sender_gid);
283

284 285 286 287 288 289
/* same as ^, except use the supplied mapping context */
tw_lpid model_net_find_local_device_mctx(
        int net_id,
        struct codes_mctx const * map_ctx,
        tw_lpid sender_gid);

290 291
int model_net_get_msg_sz(int net_id);

292 293 294 295 296 297 298 299 300 301
/* model_net_event_rc()
 *
 * This function does reverse computation for the model_net_event_new()
 * function.
 * - sender: pointer to the tw_lp structure of the API caller.  This is
 *   identical to the sender argument to tw_event_new().
 */
/* NOTE: we may end up needing additoinal arguments here to track state for
 * reverse computation; add as needed 
 */
302
DEPRECATED
303 304 305
void model_net_event_rc(
    int net_id,
    tw_lp *sender,
306
    uint64_t message_size);
307

308 309 310 311 312 313
/* This function replaces model_net_event_rc, and will replace the name later
 * on. The num_rng_calls argument is the return value of model_net_*event*
 * calls */
void model_net_event_rc2(
        tw_lp *sender,
        model_net_event_return const * ret);
314 315 316 317 318 319 320 321 322 323 324 325 326

/* Issue a 'pull' from the memory of the destination LP, without
 * requiring the destination LP to do event processing. This is meant as a
 * simulation-based abstraction of RDMA. A control packet will be sent to the
 * destination LP, the payload will be sent back to the requesting LP, and the
 * requesting LP will be issued it's given completion event.
 *
 * Parameters are largely the same as model_net_event, with the following
 * exceptions:
 * - final_dest_lp is the lp to pull data from
 * - self_event_size, self_event are applied at the requester upon receipt of 
 *   the payload from the dest
 */
327
model_net_event_return model_net_pull_event(
328
        int net_id,
329
        char const *category,
330 331 332 333
        tw_lpid final_dest_lp,
        uint64_t message_size,
        tw_stime offset,
        int self_event_size,
334
        void const *self_event,
335
        tw_lp *sender);
336
model_net_event_return model_net_pull_event_annotated(
337
        int net_id,
338 339
        char const * annotation,
        char const *category,
340 341 342 343
        tw_lpid final_dest_lp,
        uint64_t message_size,
        tw_stime offset,
        int self_event_size,
344
        void const *self_event,
345
        tw_lp *sender);
346
model_net_event_return model_net_pull_event_mctx(
347
        int net_id,
348 349
        struct codes_mctx const * send_map_ctx,
        struct codes_mctx const * recv_map_ctx,
350 351 352 353 354 355 356
        char const *category,
        tw_lpid final_dest_lp,
        uint64_t message_size,
        tw_stime offset,
        int self_event_size,
        void const *self_event,
        tw_lp *sender);
357

358
DEPRECATED
359 360 361 362
void model_net_pull_event_rc(
        int net_id,
        tw_lp *sender);

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
/*
 * Set message-specific parameters
 * type     - overall type (see msg_param_type)
 * sub_type - type of parameter specific to type. This is intended to be
 *            an enum for each of msg_param_type's values
 * params   - the parameter payload
 *
 * This function works by setting up a temporary parameter context within the
 * model-net implementation (currently implemented as a set of translation-unit
 * globals). Upon a subsequent model_net_*event* call, the context is consumed
 * and reset to an unused state.
 * 
 * NOTE: this call MUST be placed in the same calling context as the subsequent
 * model_net_*event* call. Otherwise, the parameters are not guaranteed to work
 * on the intended event, and may possibly be consumed by another, unrelated
 * event.
 */
void model_net_set_msg_param(
        enum msg_param_type type,
        int sub_type,
        const void * params);

385 386 387
/* returns pointer to LP information for simplenet module */
const tw_lptype* model_net_get_lp_type(int net_id);

388
DEPRECATED
389
uint64_t model_net_get_packet_size(int net_id);
390

391 392 393
/* used for reporting overall network statistics for e.g. average latency ,
 * maximum latency, total number of packets finished during the entire
 * simulation etc. */
394
void model_net_report_stats(int net_id);
395

396
/* writing model-net statistics on a per LP basis */
397 398
void model_net_write_stats(tw_lpid lpid, mn_stats* stat);

399
/* printing model-net statistics on a per LP basis */
400 401 402
void model_net_print_stats(tw_lpid lpid, mn_stats mn_stats_array[]);

/* find model-net statistics */
403
mn_stats* model_net_find_stats(char const * category, mn_stats mn_stats_array[]);
Jonathan Jenkins's avatar
Jonathan Jenkins committed
404 405 406 407 408

#ifdef __cplusplus
}
#endif

409 410 411 412 413 414 415 416 417 418
#endif /* MODELNET_H */

/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 * End:
 *
 * vim: ft=c ts=8 sts=4 sw=4 expandtab
 */