From 0a2f1350bf1944709dba8751e85896cc0998bc38 Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Sun, 29 Dec 2019 21:24:48 +0100 Subject: [PATCH] [sonar] Constify pointer and reference parameters in src/simdag/. --- include/simgrid/simdag.h | 35 ++++++++++++++++++----------------- src/simdag/sd_daxloader.cpp | 9 ++++++--- src/simdag/sd_task.cpp | 34 +++++++++++++++++----------------- src/simdag/simdag_private.hpp | 2 +- 4 files changed, 42 insertions(+), 38 deletions(-) diff --git a/include/simgrid/simdag.h b/include/simgrid/simdag.h index 849930536b..ed718015b1 100644 --- a/include/simgrid/simdag.h +++ b/include/simgrid/simdag.h @@ -35,6 +35,7 @@ typedef sg_link_t SD_link_t; */ typedef struct s_SD_task_t* SD_task_t; +typedef const struct s_SD_task_t* const_SD_task_t; /** @brief Task states @ingroup SD_task_api */ @@ -73,34 +74,34 @@ typedef enum { * @{ */ XBT_PUBLIC SD_task_t SD_task_create(const char* name, void* data, double amount); -XBT_PUBLIC void* SD_task_get_data(SD_task_t task); +XBT_PUBLIC void* SD_task_get_data(const_SD_task_t task); XBT_PUBLIC void SD_task_set_data(SD_task_t task, void* data); -XBT_PUBLIC e_SD_task_state_t SD_task_get_state(SD_task_t task); -XBT_PUBLIC const char* SD_task_get_name(SD_task_t task); +XBT_PUBLIC e_SD_task_state_t SD_task_get_state(const_SD_task_t task); +XBT_PUBLIC const char* SD_task_get_name(const_SD_task_t task); XBT_PUBLIC void SD_task_set_name(SD_task_t task, const char* name); XBT_PUBLIC void SD_task_set_rate(SD_task_t task, double rate); XBT_PUBLIC void SD_task_watch(SD_task_t task, e_SD_task_state_t state); XBT_PUBLIC void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state); -XBT_PUBLIC double SD_task_get_amount(SD_task_t task); +XBT_PUBLIC double SD_task_get_amount(const_SD_task_t task); XBT_PUBLIC void SD_task_set_amount(SD_task_t task, double amount); -XBT_PUBLIC double SD_task_get_alpha(SD_task_t task); -XBT_PUBLIC double SD_task_get_remaining_amount(SD_task_t task); -XBT_PUBLIC double SD_task_get_execution_time(SD_task_t task, int host_count, const sg_host_t* host_list, +XBT_PUBLIC double SD_task_get_alpha(const_SD_task_t task); +XBT_PUBLIC double SD_task_get_remaining_amount(const_SD_task_t task); +XBT_PUBLIC double SD_task_get_execution_time(const_SD_task_t task, int host_count, const sg_host_t* host_list, const double* flops_amount, const double* bytes_amount); -XBT_PUBLIC e_SD_task_kind_t SD_task_get_kind(SD_task_t task); +XBT_PUBLIC e_SD_task_kind_t SD_task_get_kind(const_SD_task_t task); XBT_PUBLIC void SD_task_schedule(SD_task_t task, int host_count, const sg_host_t* host_list, const double* flops_amount, const double* bytes_amount, double rate); XBT_PUBLIC void SD_task_unschedule(SD_task_t task); -XBT_PUBLIC double SD_task_get_start_time(SD_task_t task); -XBT_PUBLIC double SD_task_get_finish_time(SD_task_t task); -XBT_PUBLIC xbt_dynar_t SD_task_get_parents(SD_task_t task); -XBT_PUBLIC xbt_dynar_t SD_task_get_children(SD_task_t task); -XBT_PUBLIC int SD_task_get_workstation_count(SD_task_t task); -XBT_PUBLIC sg_host_t* SD_task_get_workstation_list(SD_task_t task); +XBT_PUBLIC double SD_task_get_start_time(const_SD_task_t task); +XBT_PUBLIC double SD_task_get_finish_time(const_SD_task_t task); +XBT_PUBLIC xbt_dynar_t SD_task_get_parents(const_SD_task_t task); +XBT_PUBLIC xbt_dynar_t SD_task_get_children(const_SD_task_t task); +XBT_PUBLIC int SD_task_get_workstation_count(const_SD_task_t task); +XBT_PUBLIC sg_host_t* SD_task_get_workstation_list(const_SD_task_t task); XBT_PUBLIC void SD_task_destroy(SD_task_t task); -XBT_PUBLIC void SD_task_dump(SD_task_t task); -XBT_PUBLIC void SD_task_dotty(SD_task_t task, void* out_FILE); +XBT_PUBLIC void SD_task_dump(const_SD_task_t task); +XBT_PUBLIC void SD_task_dotty(const_SD_task_t task, void* out_FILE); XBT_PUBLIC SD_task_t SD_task_create_comp_seq(const char* name, void* data, double amount); XBT_PUBLIC SD_task_t SD_task_create_comp_par_amdahl(const char* name, void* data, double amount, double alpha); @@ -131,7 +132,7 @@ XBT_PUBLIC void SD_task_schedulel(SD_task_t task, int count, ...); */ XBT_PUBLIC void SD_task_dependency_add(SD_task_t src, SD_task_t dst); XBT_PUBLIC void SD_task_dependency_remove(SD_task_t src, SD_task_t dst); -XBT_PUBLIC int SD_task_dependency_exists(SD_task_t src, SD_task_t dst); +XBT_PUBLIC int SD_task_dependency_exists(const_SD_task_t src, SD_task_t dst); /** @} */ /************************** Global *******************************************/ diff --git a/src/simdag/sd_daxloader.cpp b/src/simdag/sd_daxloader.cpp index 5872efa65c..3331c7bc13 100644 --- a/src/simdag/sd_daxloader.cpp +++ b/src/simdag/sd_daxloader.cpp @@ -30,20 +30,23 @@ void uniq_transfer_task_name(SD_task_t task) SD_task_set_name(task, new_name.c_str()); } -static bool children_are_marked(SD_task_t task){ +static bool children_are_marked(const_SD_task_t task) +{ return std::none_of(task->successors->begin(), task->successors->end(), [](const SD_task_t& elm) { return not elm->marked; }) && std::none_of(task->outputs->begin(), task->outputs->end(), [](const SD_task_t& elm) { return not elm->marked; }); } -static bool parents_are_marked(SD_task_t task){ +static bool parents_are_marked(const_SD_task_t task) +{ return std::none_of(task->predecessors->begin(), task->predecessors->end(), [](const SD_task_t& elm) { return not elm->marked; }) && std::none_of(task->inputs->begin(), task->inputs->end(), [](const SD_task_t& elm) { return not elm->marked; }); } -bool acyclic_graph_detail(xbt_dynar_t dag){ +bool acyclic_graph_detail(const_xbt_dynar_t dag) +{ unsigned int count; bool all_marked = true; SD_task_t task = nullptr; diff --git a/src/simdag/sd_task.cpp b/src/simdag/sd_task.cpp index 6dcdeafde6..3b7fc8d44d 100644 --- a/src/simdag/sd_task.cpp +++ b/src/simdag/sd_task.cpp @@ -204,7 +204,7 @@ void SD_task_destroy(SD_task_t task) * @return the user data associated with this task (can be @c nullptr) * @see SD_task_set_data() */ -void *SD_task_get_data(SD_task_t task) +void* SD_task_get_data(const_SD_task_t task) { return task->data; } @@ -254,7 +254,7 @@ void SD_task_set_rate(SD_task_t task, double rate) * #SD_NOT_SCHEDULED, #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING, #SD_DONE or #SD_FAILED * @see e_SD_task_state_t */ -e_SD_task_state_t SD_task_get_state(SD_task_t task) +e_SD_task_state_t SD_task_get_state(const_SD_task_t task) { return task->state; } @@ -316,7 +316,7 @@ void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) * @param task a task * @return the name of this task (can be @c nullptr) */ -const char *SD_task_get_name(SD_task_t task) +const char* SD_task_get_name(const_SD_task_t task) { return task->name; } @@ -334,7 +334,7 @@ void SD_task_set_name(SD_task_t task, const char *name) * @return a newly allocated dynar comprising the parents of this task */ -xbt_dynar_t SD_task_get_parents(SD_task_t task) +xbt_dynar_t SD_task_get_parents(const_SD_task_t task) { xbt_dynar_t parents = xbt_dynar_new(sizeof(SD_task_t), nullptr); @@ -351,7 +351,7 @@ xbt_dynar_t SD_task_get_parents(SD_task_t task) * @param task a task * @return a newly allocated dynar comprising the parents of this task */ -xbt_dynar_t SD_task_get_children(SD_task_t task) +xbt_dynar_t SD_task_get_children(const_SD_task_t task) { xbt_dynar_t children = xbt_dynar_new(sizeof(SD_task_t), nullptr); @@ -369,7 +369,7 @@ xbt_dynar_t SD_task_get_children(SD_task_t task) * Only call this on already scheduled tasks! * @param task a task */ -int SD_task_get_workstation_count(SD_task_t task) +int SD_task_get_workstation_count(const_SD_task_t task) { return task->allocation->size(); } @@ -380,7 +380,7 @@ int SD_task_get_workstation_count(SD_task_t task) * Only call this on already scheduled tasks! * @param task a task */ -sg_host_t *SD_task_get_workstation_list(SD_task_t task) +sg_host_t* SD_task_get_workstation_list(const_SD_task_t task) { return task->allocation->data(); } @@ -392,7 +392,7 @@ sg_host_t *SD_task_get_workstation_list(SD_task_t task) * @return the total amount of work (computation or data transfer) for this task * @see SD_task_get_remaining_amount() */ -double SD_task_get_amount(SD_task_t task) +double SD_task_get_amount(const_SD_task_t task) { return task->amount; } @@ -420,7 +420,7 @@ void SD_task_set_amount(SD_task_t task, double amount) * @param task a parallel task assuming Amdahl's law as speedup model * @return the alpha parameter (serial part of a task in percent) for this task */ -double SD_task_get_alpha(SD_task_t task) +double SD_task_get_alpha(const_SD_task_t task) { xbt_assert(SD_task_get_kind(task) == SD_TASK_COMP_PAR_AMDAHL, "Alpha parameter is not defined for this kind of task"); return task->alpha; @@ -433,7 +433,7 @@ double SD_task_get_alpha(SD_task_t task) * @return the remaining amount of work (computation or data transfer) of this task * @see SD_task_get_amount() */ -double SD_task_get_remaining_amount(SD_task_t task) +double SD_task_get_remaining_amount(const_SD_task_t task) { if (task->surf_action) return task->surf_action->get_remains(); @@ -441,13 +441,13 @@ double SD_task_get_remaining_amount(SD_task_t task) return (task->state == SD_DONE) ? 0 : task->amount; } -e_SD_task_kind_t SD_task_get_kind(SD_task_t task) +e_SD_task_kind_t SD_task_get_kind(const_SD_task_t task) { return task->kind; } /** @brief Displays debugging information about a task */ -void SD_task_dump(SD_task_t task) +void SD_task_dump(const_SD_task_t task) { XBT_INFO("Displaying task %s", SD_task_get_name(task)); if (task->state == SD_RUNNABLE) @@ -499,7 +499,7 @@ void SD_task_dump(SD_task_t task) } /** @brief Dumps the task in dotty formalism into the FILE* passed as second argument */ -void SD_task_dotty(SD_task_t task, void *out) +void SD_task_dotty(const_SD_task_t task, void* out) { FILE *fout = static_cast(out); fprintf(fout, " T%p [label=\"%.20s\"", task, task->name); @@ -583,7 +583,7 @@ void SD_task_dependency_add(SD_task_t src, SD_task_t dst) * If src is nullptr, checks whether dst has any pre-dependency. * If dst is nullptr, checks whether src has any post-dependency. */ -int SD_task_dependency_exists(SD_task_t src, SD_task_t dst) +int SD_task_dependency_exists(const_SD_task_t src, SD_task_t dst) { xbt_assert(src != nullptr || dst != nullptr, "Invalid parameter: both src and dst are nullptr"); @@ -676,7 +676,7 @@ void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) * @param bytes_amount communication amount between each pair of hosts (i.e., a matrix of host_count*host_count doubles) * @see SD_schedule() */ -double SD_task_get_execution_time(SD_task_t /*task*/, int host_count, const sg_host_t* host_list, +double SD_task_get_execution_time(const_SD_task_t /*task*/, int host_count, const sg_host_t* host_list, const double* flops_amount, const double* bytes_amount) { xbt_assert(host_count > 0, "Invalid parameter"); @@ -820,7 +820,7 @@ void SD_task_run(SD_task_t task) * @param task: a task * @return the start time of this task */ -double SD_task_get_start_time(SD_task_t task) +double SD_task_get_start_time(const_SD_task_t task) { if (task->surf_action) return task->surf_action->get_start_time(); @@ -838,7 +838,7 @@ double SD_task_get_start_time(SD_task_t task) * @param task: a task * @return the start time of this task */ -double SD_task_get_finish_time(SD_task_t task) +double SD_task_get_finish_time(const_SD_task_t task) { if (task->surf_action) /* should never happen as actions are destroyed right after their completion */ return task->surf_action->get_finish_time(); diff --git a/src/simdag/simdag_private.hpp b/src/simdag/simdag_private.hpp index e452c3ba3d..d089197d61 100644 --- a/src/simdag/simdag_private.hpp +++ b/src/simdag/simdag_private.hpp @@ -63,7 +63,7 @@ struct s_SD_task_t { /* SimDag private functions */ XBT_PRIVATE void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state); XBT_PRIVATE void SD_task_run(SD_task_t task); -XBT_PRIVATE bool acyclic_graph_detail(xbt_dynar_t dag); +XBT_PRIVATE bool acyclic_graph_detail(const_xbt_dynar_t dag); XBT_PRIVATE void uniq_transfer_task_name(SD_task_t task); XBT_PRIVATE const char *__get_state_name(e_SD_task_state_t state); #endif -- 2.20.1