src/include/surf/surf.hpp

   1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SURF_SURF_H
   7 #define SURF_SURF_H
   8
   9 #include "simgrid/forward.h"
  10
  11 /** @ingroup SURF_models
  12  *  @brief The CPU model object for the physical machine layer
  13  */
  14 XBT_PUBLIC_DATA simgrid::kernel::resource::CpuModel* surf_cpu_model_pm;
  15
  16 /** @ingroup SURF_models
  17  *  @brief The CPU model object for the virtual machine layer
  18  */
  19 XBT_PUBLIC_DATA simgrid::kernel::resource::CpuModel* surf_cpu_model_vm;
  20
  21 /** @ingroup SURF_models
  22  *  @brief The host model
  23  *
  24  *  Note that when you create an API on top of SURF, the host model should be the only one you use
  25  *  because depending on the platform model, the network model and the CPU model may not exist.
  26  */
  27 XBT_PUBLIC_DATA simgrid::surf::HostModel* surf_host_model;
  28
  29
  30 /*** SURF Globals **************************/
  31
  32 /** @ingroup SURF_simulation
  33  *  @brief Initialize SURF
  34  *  @param argc argument number
  35  *  @param argv arguments
  36  *
  37  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
  38  *  calling  e.g. surf_host_model_init_CM02()
  39  *
  40  *  @see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
  41  */
  42 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
  43
  44 /** @ingroup SURF_simulation
  45  *  @brief Finish simulation initialization
  46  *
  47  *  This function must be called before the first call to surf_solve()
  48  */
  49 XBT_PUBLIC void surf_presolve();
  50
  51 /** @ingroup SURF_simulation
  52  *  @brief Performs a part of the simulation
  53  *  @param max_date Maximum date to update the simulation to, or -1
  54  *  @return the elapsed time, or -1.0 if no event could be executed
  55  *
  56  *  This function execute all possible events, update the action states  and returns the time elapsed.
  57  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
  58  *  when you call surf_solve.
  59  *  Note that the returned elapsed time can be zero.
  60  */
  61 XBT_PUBLIC double surf_solve(double max_date);
  62
  63 /** @ingroup SURF_simulation
  64  *  @brief Return the current time
  65  *
  66  *  Return the current time in millisecond.
  67  */
  68 XBT_PUBLIC double surf_get_clock();
  69
  70 /** @ingroup SURF_simulation
  71  *  @brief Exit SURF
  72  *
  73  *  Clean everything.
  74  *
  75  *  @see surf_init()
  76  */
  77 XBT_PUBLIC void surf_exit();
  78
  79 /* surf parse file related (public because called from a test suite) */
  80 XBT_PUBLIC void parse_platform_file(const std::string& file);
  81
  82 #endif