Logo AND Algorithmique Numérique Distribuée

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