1 /* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef INCLUDE_SIMGRID_ENGINE_H_
7 #define INCLUDE_SIMGRID_ENGINE_H_
9 #include <simgrid/forward.h>
12 SG_BEGIN_DECL /* C interface */
14 /** Initialize the SimGrid engine, taking the command line parameters of your main function. */
16 simgrid_init(int* argc, char** argv);
18 /** Creates a new platform, including hosts, links, and the routing table.
21 * See also: :ref:`platform`.
24 XBT_PUBLIC void simgrid_load_platform(const char* filename);
25 /** Load a deployment file and launch the actors that it contains
28 * See also: :ref:`deploy`.
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
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/cpp/replay-comms and similar).
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_ATTRIB_DEPRECATED_v330("Please use sg_actor_count()") XBT_PUBLIC int simgrid_get_actor_count();
47 /** @brief Allow other libraries to react to the --help flag, too
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.
54 XBT_PUBLIC void sg_config_continue_after_help();
58 #endif /* INCLUDE_SIMGRID_ENGINE_H_ */