src/simix/simcalls.in

   1 # Copyright (c) 2014-2022. 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 # The simcalls are given as C-like signatures (one per line):
   7 #
   8 # int foo(int x, int y);
   9 # int foo(int x, int y) [[block]];
  10 # int foo(int x, int y) [[nohandler]];
  11 # int foo(int x, int y) [[block, nohandler]];
  12 #
  13 # The `block` attribute is used for calls which do not return in the same
  14 # scheduling round. The answer requires some interaction with SURF,
  15 # even if this can still occur at the same timestamp under some
  16 # circumstances (eg if the surf_action cannot start because of resources
  17 # that are down) examples: things that last some time (communicate, execute,
  18 # mutex_lock).
  19 #
  20 # The `nohandler` is used to disable handlers.
  21 # I wish we could completely remove the handlers as their only use is
  22 # to adapt the interface between the exported symbol that is visible
  23 # by the user applications and the internal symbol that is implemented
  24 # by the kernel.
  25 # The only remaining use of that mechanism is to add the caller
  26 # identity as a parameter of internal call, but that could be
  27 # automated too (eg by having a special parameter type called "self")
  28
  29 # Please note that in addition to completing this file with your new simcall,
  30 # you should complete the libsmx.c file by adding the corresponding function
  31 # (a.k.a. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
  32 # If you want to remove an handler, it is important to remove although
  33 # the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code
  34 # is not sufficient, the python script does not check whether the code is commented or not).
  35 # Last but not the least, you should declare the new simix call in
  36 # ./include/simgrid/simix.h (otherwise you will get a warning at compile time)
  37
  38 void       run_kernel(std::function<void()> const* code) [[nohandler]];
  39 void       run_blocking(std::function<void()> const* code) [[block,nohandler]];