include/simgrid/host.h

   1 /* Copyright (c) 2013-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SIMGRID_HOST_H_
   8 #define SIMGRID_HOST_H_
   9
  10 #include <xbt/dict.h>
  11 #include <xbt/dynar.h>
  12
  13 #include <simgrid/forward.h>
  14 #include <surf/surf.h>
  15
  16 SG_BEGIN_DECL()
  17
  18 XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name);
  19 XBT_PUBLIC(sg_host_t) sg_host_by_name_or_create(const char *name);
  20 static XBT_INLINE char *sg_host_get_name(sg_host_t host){
  21         return host->key;
  22 }
  23 XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar(void);
  24
  25 #ifdef __cplusplus
  26 #define DEFINE_EXTERNAL_CLASS(klass) class klass;
  27 class Cpu;
  28 #else
  29 #define DEFINE_EXTERNAL_CLASS(klass) typedef struct klass klass;
  30 #endif
  31 // ========== User Data ==============
  32 XBT_PUBLIC(void*) sg_host_user(sg_host_t host);
  33 XBT_PUBLIC(void) sg_host_user_set(sg_host_t host, void* userdata);
  34 XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host);
  35
  36 // ========== MSG Layer ==============
  37 typedef struct s_msg_host_priv *msg_host_priv_t;
  38 msg_host_priv_t sg_host_msg(sg_host_t host);
  39 XBT_PUBLIC(void) sg_host_msg_set(sg_host_t host, msg_host_priv_t priv);
  40 XBT_PUBLIC(void) sg_host_msg_destroy(sg_host_t host);
  41
  42 // ========== SD Layer ==============
  43 typedef struct SD_workstation *SD_workstation_priv_t;
  44 SD_workstation_priv_t sg_host_sd(sg_host_t host);
  45 XBT_PUBLIC(void) sg_host_sd_set(sg_host_t host, SD_workstation_priv_t priv);
  46 XBT_PUBLIC(void) sg_host_sd_destroy(sg_host_t host);
  47
  48 // ========== Simix layer =============
  49 typedef struct s_smx_host_priv *smx_host_priv_t;
  50 XBT_PUBLIC(smx_host_priv_t) sg_host_simix(sg_host_t host);
  51 XBT_PUBLIC(void) sg_host_simix_set(sg_host_t host, smx_host_priv_t priv);
  52 XBT_PUBLIC(void) sg_host_simix_destroy(sg_host_t host);
  53
  54 // ========== SURF CPU ============
  55 XBT_PUBLIC(surf_cpu_t) sg_host_surfcpu(sg_host_t host);
  56 XBT_PUBLIC(void) sg_host_surfcpu_set(sg_host_t host, surf_cpu_t cpu);
  57 XBT_PUBLIC(void) sg_host_surfcpu_register(sg_host_t host, surf_cpu_t cpu);
  58 XBT_PUBLIC(void) sg_host_surfcpu_destroy(sg_host_t host);
  59
  60 // ========== RoutingEdge ============
  61 XBT_PUBLIC(routing_edge_t) sg_host_edge(sg_host_t host);
  62 XBT_PUBLIC(void) sg_host_edge_set(sg_host_t host, routing_edge_t edge);
  63 XBT_PUBLIC(void) sg_host_edge_destroy(sg_host_t host, int do_callback);
  64
  65
  66 // Module initializer. Won't survive the conversion to C++. Hopefully.
  67 XBT_PUBLIC(void) sg_host_init(void);
  68
  69 // =========== user-level functions ===============
  70 XBT_PUBLIC(double) sg_host_get_speed(sg_host_t host);
  71 XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host);
  72 XBT_PUBLIC(int) sg_host_get_core(sg_host_t host);
  73 XBT_PUBLIC(int) sg_host_get_state(sg_host_t host);
  74
  75 XBT_PUBLIC(int) sg_host_get_nb_pstates(sg_host_t host);
  76 XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host);
  77 XBT_PUBLIC(double) sg_host_get_consumed_energy(sg_host_t host);
  78
  79
  80 SG_END_DECL()
  81
  82 #endif /* SIMGRID_HOST_H_ */