X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d74bb413a4b25a580d7cfc96065b638292a2e679..c40d9806f658ba76d747939d667f87883b8aab1a:/include/msg/msg.h diff --git a/include/msg/msg.h b/include/msg/msg.h index f75907f210..0e4838df1f 100644 --- a/include/msg/msg.h +++ b/include/msg/msg.h @@ -1,6 +1,4 @@ -/* $Id$ */ - -/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */ +/* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -11,27 +9,60 @@ #include "xbt.h" #include "msg/datatypes.h" +#include "xbt/automaton.h" + +#include "simgrid/simix.h" + SG_BEGIN_DECL() +/** @brief Return code of most MSG functions + @ingroup msg_simulation + @{ */ +/* Keep these code as binary values: java bindings manipulate | of these values */ +typedef enum { + MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */ + MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */ + MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task + transfer. Either the network is down or the remote host has been + shutdown. */ + MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are + running has just been rebooted. Free your datastructures and + return now !*/ + MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/ +} MSG_error_t; +/** @} */ + /************************** Global ******************************************/ XBT_PUBLIC(void) MSG_config(const char *name, ...); XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv); XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv); -XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number); -XBT_PUBLIC(int) MSG_get_channel_number(void); XBT_PUBLIC(MSG_error_t) MSG_main(void); +XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void); +XBT_PUBLIC(MSG_error_t) MSG_main_liveness(xbt_automaton_t a); XBT_PUBLIC(MSG_error_t) MSG_clean(void); XBT_PUBLIC(void) MSG_function_register(const char *name, xbt_main_func_t code); XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code); XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name); XBT_PUBLIC(void) MSG_launch_application(const char *file); +/*Bypass the parser */ +XBT_PUBLIC(void) MSG_set_function(const char *host_id, + const char *function_name, + xbt_dynar_t arguments); XBT_PUBLIC(double) MSG_get_clock(void); XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void); +/************************** File handling ***********************************/ +XBT_PUBLIC(size_t) MSG_file_read(void* ptr, size_t size, size_t nmemb, msg_file_t stream); +XBT_PUBLIC(size_t) MSG_file_write(const void* ptr, size_t size, size_t nmemb, msg_file_t stream); +XBT_PUBLIC(msg_file_t) MSG_file_open(const char* mount, const char* path, const char* mode); +XBT_PUBLIC(int) MSG_file_close(msg_file_t fp); +XBT_PUBLIC(int) MSG_file_stat(msg_file_t fd, s_msg_stat_t *buf); + + /************************** Host handling ***********************************/ XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data); XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host); @@ -41,31 +72,38 @@ XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host); /* int MSG_get_msgload(void); This function lacks specification; discard it */ XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h); XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h); +XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host); /*property handlers*/ XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host); XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host, const char *name); +XBT_PUBLIC(void) MSG_host_set_property_value(m_host_t host, + const char *name, char *value, + void_f_pvoid_t free_ctn); + XBT_PUBLIC(void) MSG_create_environment(const char *file); +XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file); XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name); -XBT_PUBLIC(int) MSG_get_host_number(void); -XBT_PUBLIC(m_host_t *) MSG_get_host_table(void); +XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void); /************************** Process handling *********************************/ XBT_PUBLIC(m_process_t) MSG_process_create(const char *name, - xbt_main_func_t code, void *data, - m_host_t host); + xbt_main_func_t code, + void *data, m_host_t host); XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, m_host_t host, int argc, char **argv); -XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name, +XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char + *name, xbt_main_func_t - code, void *data, + code, + void *data, m_host_t host, int argc, char **argv, @@ -74,10 +112,12 @@ XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char *name, XBT_PUBLIC(void) MSG_process_kill(m_process_t process); XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs); -XBT_PUBLIC(MSG_error_t) MSG_process_change_host(m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host); XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process); -XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, void *data); +XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, + void *data); +XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup); XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process); XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID); XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process); @@ -86,10 +126,13 @@ XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process); XBT_PUBLIC(int) MSG_process_self_PID(void); XBT_PUBLIC(int) MSG_process_self_PPID(void); XBT_PUBLIC(m_process_t) MSG_process_self(void); +XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void); +XBT_PUBLIC(MSG_error_t) MSG_process_set_kill_time(m_process_t process, double kill_time); /*property handlers*/ XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process); -XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t process, +XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t + process, const char *name); XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process); @@ -97,118 +140,208 @@ XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process); XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process); /************************** Task handling ************************************/ - XBT_PUBLIC(m_task_t) MSG_task_create(const char *name, double compute_duration, double message_size, void *data); -XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, int host_nb, +XBT_PUBLIC(m_gpu_task_t) MSG_gpu_task_create(const char *name, + double compute_duration, + double dispatch_latency, + double collect_latency); +XBT_PUBLIC(m_task_t) MSG_parallel_task_create(const char *name, + int host_nb, const m_host_t * host_list, double *computation_amount, double *communication_amount, void *data); XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task); -XBT_PUBLIC(void) MSG_task_set_data(m_task_t task,void*data); +XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data); +XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) ( + m_task_t task, m_process_t src, m_process_t dst)); XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task); XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task); XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name); XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task); XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task); -XBT_PUBLIC(void) MSG_task_ref(m_task_t t); - -XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel); -XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, - m_channel_t channel, - double max_duration); -XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel, - m_host_t host); - MSG_error_t MSG_task_receive_from_host(m_task_t * task, - const char *alias, m_host_t host); -XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel, - double max_duration, m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_task_receive_from_host(m_task_t * task, const char *alias, + m_host_t host); -XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, - m_channel_t channel); -XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task, - m_host_t dest, - m_channel_t channel, - double max_rate); -XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, - m_host_t dest, - m_channel_t channel, - double max_duration); XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task); XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task); XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority); -XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel); -XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel); -XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host); -XBT_PUBLIC(MSG_error_t) MSG_channel_select_from(m_channel_t channel, - double max_duration, - int *PID); XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec); -XBT_PUBLIC(MSG_error_t) MSG_get_errno(void); XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task, + double compute_duration); XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task); XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task); +XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task); XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task); XBT_PUBLIC(MSG_error_t) - MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout, + MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout, m_host_t host); XBT_PUBLIC(MSG_error_t) - MSG_task_receive_with_timeout(m_task_t * task, const char *alias, + MSG_task_receive_with_timeout(m_task_t * task, const char *alias, double timeout); XBT_PUBLIC(MSG_error_t) - MSG_task_receive(m_task_t * task, const char *alias); + MSG_task_receive(m_task_t * task, const char *alias); +#define MSG_task_recv(t,a) MSG_task_receive(t,a) + +XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias); +XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, + const char *alias, + int (*match_fun)(void*,void*, smx_action_t), + void *match_data); + +XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup); +XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias); +XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm); +XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms); +XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm); +XBT_PUBLIC(MSG_error_t) MSG_comm_wait(msg_comm_t comm, double timeout); +XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, + double timeout); +XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms); +XBT_PUBLIC(m_task_t) MSG_comm_get_task(msg_comm_t comm); +XBT_PUBLIC(MSG_error_t) MSG_comm_get_status(msg_comm_t comm); XBT_PUBLIC(int) MSG_task_listen(const char *alias); -XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, m_host_t host); - -XBT_PUBLIC(MSG_error_t) - MSG_alias_select_from(const char *alias, double timeout, int *PID); +XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, + m_host_t host); XBT_PUBLIC(MSG_error_t) - MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout); + MSG_task_send_with_timeout(m_task_t task, const char *alias, + double timeout); XBT_PUBLIC(MSG_error_t) - MSG_task_send(m_task_t task, const char *alias); + MSG_task_send(m_task_t task, const char *alias); XBT_PUBLIC(MSG_error_t) - MSG_task_send_bounded(m_task_t task, const char *alias, double rate); + MSG_task_send_bounded(m_task_t task, const char *alias, double rate); XBT_PUBLIC(int) MSG_task_listen_from(const char *alias); +XBT_PUBLIC(void) MSG_task_set_category (m_task_t task, const char *category); +XBT_PUBLIC(const char *) MSG_task_get_category (m_task_t task); + /************************** Task handling ************************************/ XBT_PUBLIC(MSG_error_t) - MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task, + MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task, m_host_t host, double timeout); XBT_PUBLIC(MSG_error_t) - MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, + MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, double timeout); /************************** Action handling **********************************/ - typedef void (*msg_action_fun) (xbt_dynar_t args); -XBT_PUBLIC(void) MSG_action_register(const char *action_name, - msg_action_fun function); -XBT_PUBLIC(void) MSG_action_unregister(const char *action_name); - MSG_error_t MSG_action_trace_run(char *path); - +MSG_error_t MSG_action_trace_run(char *path); #ifdef MSG_USE_DEPRECATED +/* these are the functions which are deprecated. Do not use them, they may get removed in future releases */ +XBT_PUBLIC(int) MSG_get_host_number(void); +XBT_PUBLIC(m_host_t *) MSG_get_host_table(void); + +#define MSG_TIMEOUT_FAILURE MSG_TIMEOUT +#define MSG_TASK_CANCELLED MSG_TASK_CANCELED #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \ MSG_mailbox_put_with_timeout(mailbox, task, timeout) +#define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h); +XBT_PUBLIC(MSG_error_t) MSG_get_errno(void); + +XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel); +XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, + m_channel_t channel, + double max_duration); +XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, + int channel, m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel, + double max_duration, + m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, + m_channel_t channel); +XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task, + m_host_t dest, + m_channel_t channel, + double max_rate); +XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, + m_host_t dest, + m_channel_t channel, + double max_duration); +XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel); +XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel); +XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host); + +XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number); +XBT_PUBLIC(int) MSG_get_channel_number(void); #endif #include "instr/instr.h" +/** @brief Opaque type describing a Virtual Machine. + * @ingroup msg_VMs + * + * All this is highly experimental and the interface will probably change in the future. + * Please don't depend on this yet (although testing is welcomed if you feel so). + * Usual lack of guaranty of any kind applies here, and is even increased. + * + */ +typedef struct msg_vm *msg_vm_t; +/* This function should not be called directly, but rather from MSG_vm_start_from_template that does not exist yet*/ +XBT_PUBLIC(msg_vm_t) MSG_vm_start(m_host_t location, int coreAmount); + +XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t); +XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t); + +XBT_PUBLIC(void) MSG_vm_bind(msg_vm_t vm, m_process_t process); +XBT_PUBLIC(void) MSG_vm_unbind(msg_vm_t vm, m_process_t process); // simple wrapper over process_kill + +XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, m_host_t destination); + +XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm); + // \forall p in VM, MSG_process_suspend(p) // Freeze the processes + +XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm); // Simulate the fact of reading the processes from disk and resuming them + // \forall p in VM, MSG_process_resume(p) // unfreeze them + +XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); // killall + +XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm); + +XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void); + +/* +void* MSG_process_get_property(msg_process_t, char* key) +void MSG_process_set_property(msg_process_t, char* key, void* data) +void MSG_vm_set_property(msg_vm_t, char* key, void* data) + +void MSG_vm_setMemoryUsed(msg_vm_t vm, double size); +void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad); + // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur; + // <100 si c'est pas CPU intensive) + // Contraintes à poser: + // HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task) + // VM_coreAmount >= Load de toutes les tasks +*/ + + /* +xbt_dynar_t MSG_vm_get_list_from_host(msg_host_t) +xbt_dynar_t MSG_vm_get_list_from_hosts(msg_dynar_t) ++ des fonctions de filtrage sur les dynar +*/ + + +/* ****************************************************************************************** */ +/* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */ +XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process); + SG_END_DECL() #endif