include/simgrid/engine.h

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