Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
separate the energy plugin from surf in the doc + improvements
[simgrid.git] / src / surf / storage_n11.cpp
1 /* Copyright (c) 2013-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "storage_n11.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "src/kernel/routing/NetPoint.hpp"
9 #include <math.h> /*ceil*/
10
11 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_storage);
12
13 /*************
14  * CallBacks *
15  *************/
16 extern std::map<std::string, storage_type_t> storage_types;
17
18 static void check_disk_attachment()
19 {
20   for (auto s : *simgrid::surf::StorageImpl::storagesMap()) {
21     simgrid::kernel::routing::NetPoint* host_elm = sg_netpoint_by_name_or_null(s.second->attach_.c_str());
22     if (not host_elm)
23       surf_parse_error("Unable to attach storage %s: host %s does not exist.", s.second->cname(),
24                        s.second->attach_.c_str());
25     else
26       s.second->piface_.attached_to_ = sg_host_by_name(s.second->attach_.c_str());
27   }
28 }
29
30 void storage_register_callbacks()
31 {
32   simgrid::s4u::onPlatformCreated.connect(check_disk_attachment);
33   instr_routing_define_callbacks();
34 }
35
36 /*********
37  * Model *
38  *********/
39
40 void surf_storage_model_init_default()
41 {
42   surf_storage_model = new simgrid::surf::StorageN11Model();
43   all_existing_models->push_back(surf_storage_model);
44 }
45
46 namespace simgrid {
47 namespace surf {
48
49 StorageImpl* StorageN11Model::createStorage(const char* id, const char* type_id, const char* content_name,
50                                             const char* attach)
51 {
52   storage_type_t storage_type = storage_types.at(type_id);
53
54   double Bread =
55       surf_parse_get_bandwidth(storage_type->model_properties->at("Bread").c_str(), "property Bread, storage", type_id);
56   double Bwrite = surf_parse_get_bandwidth(storage_type->model_properties->at("Bwrite").c_str(),
57                                            "property Bwrite, storage", type_id);
58
59   StorageImpl* storage = new StorageN11(this, id, maxminSystem_, Bread, Bwrite, type_id, (char*)content_name,
60                                         storage_type->size, (char*)attach);
61   storageCreatedCallbacks(storage);
62
63   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s'\n\t\tBread '%f'\n", id, type_id, Bread);
64
65   p_storageList.push_back(storage);
66
67   return storage;
68 }
69
70 double StorageN11Model::nextOccuringEvent(double now)
71 {
72   double min_completion = StorageModel::nextOccuringEventFull(now);
73
74   for(auto storage: p_storageList) {
75     double rate = 0;
76     // Foreach write action on that disk
77     for (auto write_action: storage->writeActions_) {
78       rate += lmm_variable_getvalue(write_action->getVariable());
79     }
80     if(rate > 0)
81       min_completion = MIN(min_completion, (storage->size_-storage->usedSize_)/rate);
82   }
83
84   return min_completion;
85 }
86
87 void StorageN11Model::updateActionsState(double /*now*/, double delta)
88 {
89
90   ActionList *actionSet = getRunningActionSet();
91   for(ActionList::iterator it(actionSet->begin()), itNext=it, itend(actionSet->end())
92       ; it != itend ; it=itNext) {
93     ++itNext;
94
95     StorageAction *action = static_cast<StorageAction*>(&*it);
96
97     if (action->type_ == WRITE) {
98       // Update the disk usage
99       // Update the file size
100       // For each action of type write
101       double current_progress = delta * lmm_variable_getvalue(action->getVariable());
102       long int incr = current_progress;
103
104       XBT_DEBUG("%s:\n\t progress =  %.2f, current_progress = %.2f, incr = %ld, lrint(1) = %ld, lrint(2) = %ld",
105                 action->file_->name, action->progress_, current_progress, incr,
106                 lrint(action->progress_ + current_progress), lrint(action->progress_) + incr);
107
108       /* take care of rounding error accumulation */
109       if (lrint(action->progress_ + current_progress) > lrint(action->progress_) + incr)
110         incr++;
111
112       action->progress_ += current_progress;
113
114       action->storage_->usedSize_ += incr;     // disk usage
115       action->file_->current_position += incr; // current_position
116       //  which becomes the new file size
117       action->file_->size = action->file_->current_position;
118
119       action->storage_->content_->erase(action->file_->name);
120       action->storage_->content_->insert({action->file_->name, action->file_->size});
121     }
122
123     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
124
125     if (action->getMaxDuration() > NO_MAX_DURATION)
126       action->updateMaxDuration(delta);
127
128     if (action->getRemainsNoUpdate() > 0 && lmm_get_variable_weight(action->getVariable()) > 0 &&
129         action->storage_->usedSize_ == action->storage_->size_) {
130       action->finish();
131       action->setState(Action::State::failed);
132     } else if (((action->getRemainsNoUpdate() <= 0) && (lmm_get_variable_weight(action->getVariable()) > 0)) ||
133                ((action->getMaxDuration() > NO_MAX_DURATION) && (action->getMaxDuration() <= 0))) {
134       action->finish();
135       action->setState(Action::State::done);
136     }
137   }
138 }
139
140 /************
141  * Resource *
142  ************/
143
144 StorageN11::StorageN11(StorageModel* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite,
145                        const char* type_id, char* content_name, sg_size_t size, char* attach)
146     : StorageImpl(model, name, maxminSystem, bread, bwrite, type_id, content_name, size, attach)
147 {
148   XBT_DEBUG("Create resource with Bread '%f' Bwrite '%f' and Size '%llu'", bread, bwrite, size);
149   simgrid::s4u::Storage::onCreation(this->piface_);
150 }
151
152 StorageAction *StorageN11::open(const char* mount, const char* path)
153 {
154   XBT_DEBUG("\tOpen file '%s'",path);
155
156   sg_size_t size;
157   // if file does not exist create an empty file
158   if (content_->find(path) != content_->end())
159     size = content_->at(path);
160   else {
161     size = 0;
162     content_->insert({path, size});
163     XBT_DEBUG("File '%s' was not found, file created.",path);
164   }
165   surf_file_t file = xbt_new0(s_surf_file_t,1);
166   file->name = xbt_strdup(path);
167   file->size = size;
168   file->mount = xbt_strdup(mount);
169   file->current_position = 0;
170
171   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, OPEN);
172   action->file_         = file;
173
174   return action;
175 }
176
177 StorageAction *StorageN11::close(surf_file_t fd)
178 {
179   XBT_DEBUG("\tClose file '%s' size '%llu'", fd->name, fd->size);
180   // unref write actions from storage
181   for (std::vector<StorageAction*>::iterator it = writeActions_.begin(); it != writeActions_.end();) {
182     StorageAction *write_action = *it;
183     if ((write_action->file_) == fd) {
184       write_action->unref();
185       it = writeActions_.erase(it);
186     } else {
187       ++it;
188     }
189   }
190   free(fd->name);
191   free(fd->mount);
192   xbt_free(fd);
193   StorageAction* action = new StorageN11Action(model(), 0, isOff(), this, CLOSE);
194   return action;
195 }
196
197 StorageAction *StorageN11::read(surf_file_t fd, sg_size_t size)
198 {
199   if(fd->current_position + size > fd->size){
200     if (fd->current_position > fd->size){
201       size = 0;
202     } else {
203       size = fd->size - fd->current_position;
204     }
205     fd->current_position = fd->size;
206   }
207   else
208     fd->current_position += size;
209
210   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, READ);
211   return action;
212 }
213
214 StorageAction *StorageN11::write(surf_file_t fd, sg_size_t size)
215 {
216   char *filename = fd->name;
217   XBT_DEBUG("\tWrite file '%s' size '%llu/%llu'",filename,size,fd->size);
218
219   StorageAction* action = new StorageN11Action(model(), size, isOff(), this, WRITE);
220   action->file_         = fd;
221   /* Substract the part of the file that might disappear from the used sized on the storage element */
222   usedSize_ -= (fd->size - fd->current_position);
223   // If the storage is full before even starting to write
224   if(usedSize_==size_) {
225     action->setState(Action::State::failed);
226   }
227   return action;
228 }
229
230 /**********
231  * Action *
232  **********/
233
234 StorageN11Action::StorageN11Action(Model* model, double cost, bool failed, StorageImpl* storage,
235                                    e_surf_action_storage_type_t type)
236     : StorageAction(model, cost, failed, lmm_variable_new(model->getMaxminSystem(), this, 1.0, -1.0, 3), storage, type)
237 {
238   XBT_IN("(%s,%g", storage->cname(), cost);
239
240   // Must be less than the max bandwidth for all actions
241   lmm_expand(model->getMaxminSystem(), storage->constraint(), getVariable(), 1.0);
242   switch(type) {
243   case OPEN:
244   case CLOSE:
245   case STAT:
246     break;
247   case READ:
248     lmm_expand(model->getMaxminSystem(), storage->constraintRead_, getVariable(), 1.0);
249     break;
250   case WRITE:
251     lmm_expand(model->getMaxminSystem(), storage->constraintWrite_, getVariable(), 1.0);
252
253     //TODO there is something annoying with what's below. Have to sort it out...
254     //    Action *action = this;
255     //    storage->p_writeActions->push_back(action);
256     //    ref();
257     break;
258   default:
259     THROW_UNIMPLEMENTED;
260   }
261   XBT_OUT();
262 }
263
264 int StorageN11Action::unref()
265 {
266   refcount_--;
267   if (not refcount_) {
268     if (action_hook.is_linked())
269       stateSet_->erase(stateSet_->iterator_to(*this));
270     if (getVariable())
271       lmm_variable_free(getModel()->getMaxminSystem(), getVariable());
272     xbt_free(getCategory());
273     delete this;
274     return 1;
275   }
276   return 0;
277 }
278
279 void StorageN11Action::cancel()
280 {
281   setState(Action::State::failed);
282 }
283
284 void StorageN11Action::suspend()
285 {
286   XBT_IN("(%p)", this);
287   if (suspended_ != 2) {
288     lmm_update_variable_weight(getModel()->getMaxminSystem(), getVariable(), 0.0);
289     suspended_ = 1;
290   }
291   XBT_OUT();
292 }
293
294 void StorageN11Action::resume()
295 {
296   THROW_UNIMPLEMENTED;
297 }
298
299 bool StorageN11Action::isSuspended()
300 {
301   return suspended_ == 1;
302 }
303
304 void StorageN11Action::setMaxDuration(double /*duration*/)
305 {
306   THROW_UNIMPLEMENTED;
307 }
308
309 void StorageN11Action::setPriority(double /*priority*/)
310 {
311   THROW_UNIMPLEMENTED;
312 }
313
314 }
315 }