1 /* Copyright (c) 2007-2009 Da 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 SIMDAG_DATATYPES_H
7 #define SIMDAG_DATATYPES_H
9 /** @brief Workstation datatype
10 @ingroup SD_datatypes_management
12 A workstation is a place where a task can be executed.
13 A workstation is represented as a <em>physical
14 resource with computing capabilities</em> and has a <em>name</em>.
16 @see SD_workstation_management */
17 typedef struct SD_workstation *SD_workstation_t;
19 /** @brief Workstation access mode
20 @ingroup SD_datatypes_management
22 By default, a workstation resource is shared, i.e. several tasks
23 can be executed at the same time on a workstation. The CPU power of
24 the workstation is shared between the running tasks on the workstation.
25 In sequential mode, only one task can use the workstation, and the other
28 @see SD_workstation_get_access_mode(), SD_workstation_set_access_mode() */
30 SD_WORKSTATION_SHARED_ACCESS, /**< @brief Several tasks can be executed at the same time */
31 SD_WORKSTATION_SEQUENTIAL_ACCESS /**< @brief Only one task can be executed, the others wait in a FIFO. */
32 } e_SD_workstation_access_mode_t;
37 } e_SD_link_sharing_policy_t;
39 /** @brief Link datatype
40 @ingroup SD_datatypes_management
42 A link is a network node represented as a <em>name</em>, a <em>current
43 bandwidth</em> and a <em>current latency</em>. A route is a list of
44 links between two workstations.
46 @see SD_link_management */
47 typedef struct SD_link *SD_link_t;
49 /** @brief Task datatype
50 @ingroup SD_datatypes_management
52 A task is some <em>computing amount</em> that can be executed
53 in parallel on several workstations. A task may depend on other
54 tasks, this means that the task cannot start until the other tasks are done.
55 Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
56 the task is scheduled, running, done, etc.
58 @see SD_task_management */
59 typedef struct SD_task *SD_task_t;
61 /** @brief Task states
62 @ingroup SD_datatypes_management
64 @see SD_task_management */
66 SD_NOT_SCHEDULED = 0, /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
67 SD_SCHEDULED = 0x0001, /**< @brief A task becomes SD_SCHEDULED when you call function
68 SD_task_schedule. SD_simulate will execute it when it becomes SD_READY. */
69 SD_READY = 0x0002, /**< @brief A scheduled task becomes ready is SD_simulate as soon as its dependencies are satisfied. */
70 SD_IN_FIFO = 0x0004, /**< @brief A ready task can have to wait in a workstation fifo if the workstation is sequential */
71 SD_RUNNING = 0x0008, /**< @brief An SD_READY or SD_IN_FIFO becomes SD_RUNNING when it is launched. */
72 SD_DONE = 0x0010, /**< @brief The task is successfuly finished. */
73 SD_FAILED = 0x0020 /**< @brief A problem occured during the execution of the task. */
77 @ingroup SD_datatypes_management
79 @see SD_task_management */
81 SD_TASK_NOT_TYPED = 0, /**< @no specified type */
82 SD_TASK_COMM_E2E = 1, /**< @brief end to end communication */
83 SD_TASK_COMP_SEQ = 2, /**< @brief sequential computation */