include/simgrid/engine.h

   1 /* Copyright (c) 2018-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 INCLUDE_SIMGRID_ENGINE_H_
   7 #define INCLUDE_SIMGRID_ENGINE_H_
   8
   9 #include <simgrid/forward.h>
  10
  11 SG_BEGIN_DECL /* C interface */
  12 /** Initialize the SimGrid engine, taking the command line parameters of your main function. */
  13 XBT_PUBLIC void simgrid_init(int* argc, char** argv);
  14
  15 /** Creates a new platform, including hosts, links, and the routing table.
  16  *
  17  * \rst
  18  * See also: :ref:`platform`.
  19  * \endrst
  20  */
  21 XBT_PUBLIC void simgrid_load_platform(const char* filename);
  22 /** Load a deployment file and launch the actors that it contains
  23  *
  24  * \rst
  25  * See also: :ref:`deploy`.
  26  * \endrst
  27  */
  28 XBT_PUBLIC void simgrid_load_deployment(const char* filename);
  29 /** Run the simulation after initialization */
  30 XBT_PUBLIC void simgrid_run();
  31 /** Registers the main function of an actor that will be launched from the deployment file */
  32 XBT_PUBLIC void simgrid_register_function(const char* name, int (*code)(int, char**));
  33 /** Registers a function as the default main function of actors
  34  *
  35  * It will be used as fallback when the function requested from the deployment file was not registered.
  36  * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
  37  */
  38 XBT_PUBLIC void simgrid_register_default(int (*code)(int, char**));
  39 /** Retrieve the simulation time (in seconds) */
  40 XBT_PUBLIC double simgrid_get_clock();
  41 /** Retrieve the number of actors in the simulation */
  42 XBT_PUBLIC int simgrid_get_actor_count();
  43
  44 /** @brief Allow other libraries to react to the --help flag, too
  45  *
  46  * When finding --help on the command line, simgrid usually stops right after displaying its help message.
  47  * If you are writing a library using simgrid, you may want to display your own help message before everything stops.
  48  * If so, just call this function before having simgrid parsing the command line, and you will be given the control
  49  * even if the user is asking for help.
  50  */
  51 XBT_PUBLIC void sg_config_continue_after_help();
  52
  53 SG_END_DECL
  54
  55 #endif /* INCLUDE_SIMGRID_ENGINE_H_ */