X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f1137465cab98cdaa8b0364e533fc82d9b7b0cdc..abf7c33aff8279f498000149d39448946c3297b3:/src/surf/cpu_interface.hpp diff --git a/src/surf/cpu_interface.hpp b/src/surf/cpu_interface.hpp index 852d71c3a4..c4bc20c5bf 100644 --- a/src/surf/cpu_interface.hpp +++ b/src/surf/cpu_interface.hpp @@ -1,3 +1,9 @@ +/* Copyright (c) 2004-2014. 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. */ + #include "surf_interface.hpp" #include "maxmin_private.hpp" @@ -22,47 +28,181 @@ typedef CpuPlugin *CpuPluginPtr; /************* * Callbacks * *************/ -CpuPtr getActionCpu(CpuActionPtr action); +XBT_PUBLIC(CpuPtr) getActionCpu(CpuActionPtr action); + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Cpu creation * + * @details Callback functions have the following signature: `void(CpuPtr)` + */ +XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuCreatedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Cpu destruction * + * @details Callback functions have the following signature: `void(CpuPtr)` + */ +XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuDestructedCallbacks; -extern surf_callback(void, CpuPtr) createCpuCallbacks; -extern surf_callback(void, CpuPtr) deleteCpuCallbacks; -extern surf_callback(void, CpuActionPtr) updateCpuActionCallbacks; +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Cpu State changed * + * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)` + */ +XBT_PUBLIC_DATA( surf_callback(void, CpuPtr, e_surf_resource_state_t, e_surf_resource_state_t)) cpuStateChangedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after CpuAction State changed * + * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)` + */ +XBT_PUBLIC_DATA( surf_callback(void, CpuActionPtr, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks; + +XBT_PUBLIC(void) cpu_parse_init(sg_platf_host_cbarg_t host); + +XBT_PUBLIC(void) cpu_add_traces(); /********* * Model * *********/ -class CpuModel : public Model { + + /** @ingroup SURF_cpu_interface + * @brief SURF cpu model interface class + * @details A model is an object which handle the interactions between its Resources and its Actions + */ +XBT_PUBLIC_CLASS CpuModel : public Model { public: + /** + * @brief CpuModel constructor + * + * @param name The name of the model + */ CpuModel(const char *name) : Model(name) {}; - CpuPtr createResource(string name); + + /** + * @brief Create a Cpu + * + * @param name The name of the Cpu + * @param power_peak The power peak of this Cpu + * @param pstate [TODO] + * @param power_scale The power scale of this Cpu + * @param power_trace [TODO] + * @param core The number of core of this Cpu + * @param state_initial [TODO] + * @param state_trace [TODO] + * @param cpu_properties Dictionary of properties associated to this Cpu + */ + virtual CpuPtr createCpu(const char *name, xbt_dynar_t power_peak, + int pstate, double power_scale, + tmgr_trace_t power_trace, int core, + e_surf_resource_state_t state_initial, + tmgr_trace_t state_trace, + xbt_dict_t cpu_properties)=0; + void updateActionsStateLazy(double now, double delta); void updateActionsStateFull(double now, double delta); - - virtual void addTraces() =0; }; /************ * Resource * ************/ -class Cpu : public Resource { + +/** @ingroup SURF_cpu_interface +* @brief SURF cpu resource interface class +* @details A Cpu represent a cpu associated to a workstation +*/ +XBT_PUBLIC_CLASS Cpu : public Resource { public: - Cpu(){surf_callback_emit(createCpuCallbacks, this);}; + /** + * @brief Cpu constructor + */ + Cpu(); + + /** + * @brief Cpu constructor + * + * @param model The CpuModel associated to this Cpu + * @param name The name of the Cpu + * @param props Dictionary of properties associated to this Cpu + * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component + * @param core The number of core of this Cpu + * @param powerPeak The power peak of this Cpu + * @param powerScale The power scale of this Cpu + */ Cpu(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, int core, double powerPeak, double powerScale); + + /** + * @brief Cpu constructor + * + * @param model The CpuModel associated to this Cpu + * @param name The name of the Cpu + * @param props Dictionary of properties associated to this Cpu + * @param core The number of core of this Cpu + * @param powerPeak The power peak of this Cpu in [TODO] + * @param powerScale The power scale of this Cpu in [TODO] + */ Cpu(ModelPtr model, const char *name, xbt_dict_t props, int core, double powerPeak, double powerScale); + + /** + * @brief Cpu destructor + */ ~Cpu(); + + /** + * @brief Execute some quantity of computation + * + * @param size The value of the processing amount (in flop) needed to process + * @return The CpuAction corresponding to the processing + */ virtual CpuActionPtr execute(double size)=0; + + /** + * @brief Make a process sleep for duration (in seconds) + * + * @param duration The number of seconds to sleep + * @return The CpuAction corresponding to the sleeping + */ virtual CpuActionPtr sleep(double duration)=0; + + /** + * @brief Get the number of cores of the current Cpu + * + * @return The number of cores of the current Cpu + */ virtual int getCore(); + + /** + * @brief Get the speed of the current Cpu + * @details [TODO] load * m_powerPeak + * + * @param load [TODO] + * + * @return The speed of the current Cpu + */ virtual double getSpeed(double load); + + /** + * @brief Get the available speed of the current Cpu + * @details [TODO] + * + * @return The available speed of the current Cpu + */ virtual double getAvailableSpeed(); - virtual double getCurrentPowerPeak()=0; + /** + * @brief Get the current Cpu power peak + * + * @return The current Cpu power peak + */ + virtual double getCurrentPowerPeak(); + + virtual double getPowerPeakAt(int pstate_index)=0; + virtual int getNbPstates()=0; + virtual void setPowerPeakAt(int pstate_index)=0; + void setState(e_surf_resource_state_t state); + void addTraces(void); int m_core; double m_powerPeak; /*< CPU power peak */ @@ -76,19 +216,48 @@ public: /********** * Action * **********/ -class CpuAction : public Action { + + /** @ingroup SURF_cpu_interface + * @brief SURF Cpu action interface class + * @details A CpuAction represent the execution of code on a Cpu + */ +XBT_PUBLIC_CLASS CpuAction : public Action { friend CpuPtr getActionCpu(CpuActionPtr action); public: - CpuAction(){}; + /** + * @brief CpuAction constructor + * + * @param model The CpuModel associated to this CpuAction + * @param cost [TODO] + * @param failed [TODO] + */ CpuAction(ModelPtr model, double cost, bool failed) - : Action(model, cost, failed) {} //FIXME:REMOVE + : Action(model, cost, failed) {} //FIXME:REMOVE + + /** + * @brief CpuAction constructor + * + * @param model The CpuModel associated to this CpuAction + * @param cost [TODO] + * @param failed [TODO] + * @param var The lmm variable associated to this CpuAction if it is part of a LMM component + */ CpuAction(ModelPtr model, double cost, bool failed, lmm_variable_t var) - : Action(model, cost, failed, var) {} + : Action(model, cost, failed, var) {} + + /** + * @brief Set the affinity of the current CpuAction + * @details [TODO] + * + * @param cpu [TODO] + * @param mask [TODO] + */ virtual void setAffinity(CpuPtr cpu, unsigned long mask); - virtual void setBound(double bound); + + void setState(e_surf_action_state_t state); void updateRemainingLazy(double now); - double m_bound; + }; #endif /* SURF_CPU_INTERFACE_HPP_ */