Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
33f4ce0425046fce3f0a2c5d38572bf7d6eb7ecb
[simgrid.git] / include / msg / msg.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef MSG_H
9 #define MSG_H
10
11 #include "xbt/misc.h"
12 #include "xbt/sysdep.h"
13
14 BEGIN_DECL()
15 #include "msg/datatypes.h"
16
17 /************************** Global ******************************************/
18 void MSG_config(const char *name, ...);
19 void MSG_global_init(int *argc, char **argv);
20 void MSG_global_init_args(int *argc, char **argv);
21 MSG_error_t MSG_set_channel_number(int number);
22 int MSG_get_channel_number(void);
23 MSG_error_t MSG_main(void);
24 MSG_error_t MSG_clean(void);
25 void MSG_function_register(const char *name, m_process_code_t code);
26 m_process_code_t MSG_get_registered_function(const char *name);
27 void MSG_launch_application(const char *file);
28 void MSG_paje_output(const char *filename);
29
30 double MSG_get_clock(void);
31
32 /************************** Host handling ***********************************/
33 MSG_error_t MSG_host_set_data(m_host_t host, void *data);
34 void *MSG_host_get_data(m_host_t host);
35 const char *MSG_host_get_name(m_host_t host);
36 m_host_t MSG_host_self(void);
37 int MSG_get_host_msgload(m_host_t host);
38 /* int MSG_get_msgload(void); This function lacks specification; discard it */
39 double MSG_get_host_speed(m_host_t h);
40
41 void MSG_create_environment(const char *file);
42
43 m_host_t MSG_get_host_by_name(const char *name);
44 int MSG_get_host_number(void);
45 m_host_t *MSG_get_host_table(void);
46
47 /************************** Process handling *********************************/
48 m_process_t MSG_process_create(const char *name,
49                                m_process_code_t code, void *data,
50                                m_host_t host);
51 m_process_t MSG_process_create_with_arguments(const char *name,
52                                               m_process_code_t code, void *data,
53                                               m_host_t host, int argc, char **argv);
54 void MSG_process_kill(m_process_t process);
55 int MSG_process_killall(int reset_PIDs);
56
57 MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host);
58
59 void *MSG_process_get_data(m_process_t process);
60 MSG_error_t MSG_process_set_data(m_process_t process, void *data);
61 m_host_t MSG_process_get_host(m_process_t process);
62 m_process_t MSG_process_from_PID(int PID);
63 int MSG_process_get_PID(m_process_t process);
64 int MSG_process_get_PPID(m_process_t process);
65 const char *MSG_process_get_name(m_process_t process);
66 int MSG_process_self_PID(void);
67 int MSG_process_self_PPID(void);
68 m_process_t MSG_process_self(void);
69
70 MSG_error_t MSG_process_suspend(m_process_t process);
71 MSG_error_t MSG_process_resume(m_process_t process);
72 int MSG_process_is_suspended(m_process_t process);
73
74 /************************** Task handling ************************************/
75
76 m_task_t MSG_task_create(const char *name, double compute_duration,
77                          double message_size, void *data);
78 m_task_t MSG_parallel_task_create(const char *name, 
79                                   int host_nb,
80                                   const m_host_t *host_list,
81                                   double *computation_amount,
82                                   double *communication_amount,
83                                   void *data);
84 void *MSG_task_get_data(m_task_t task);
85 m_process_t MSG_task_get_sender(m_task_t task);
86 m_host_t MSG_task_get_source(m_task_t task);
87 const char *MSG_task_get_name(m_task_t task);
88 MSG_error_t MSG_task_cancel(m_task_t task);
89 MSG_error_t MSG_task_destroy(m_task_t task);
90
91 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel);
92 MSG_error_t MSG_task_get_with_time_out(m_task_t * task, m_channel_t channel,
93                                        double max_duration);
94 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, 
95                          m_channel_t channel);
96 MSG_error_t MSG_task_put_bounded(m_task_t task,
97                                  m_host_t dest, m_channel_t channel,
98                                  double max_rate);
99 MSG_error_t MSG_task_execute(m_task_t task);
100 MSG_error_t MSG_parallel_task_execute(m_task_t task);
101 void MSG_task_set_priority(m_task_t task, double priority);
102
103 int MSG_task_Iprobe(m_channel_t channel);
104 int MSG_task_probe_from(m_channel_t channel);
105 MSG_error_t MSG_channel_select_from(m_channel_t channel, double max_duration,
106                                     int *PID);
107 MSG_error_t MSG_process_sleep(double nb_sec);
108 MSG_error_t MSG_get_errno(void);
109
110 double MSG_task_get_compute_duration(m_task_t task);
111 double MSG_task_get_remaining_computation(m_task_t task);
112 double MSG_task_get_data_size(m_task_t task);
113
114 END_DECL()
115 #endif