Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
please sonar and simplify simcalls (before killing them)
[simgrid.git] / src / surf / HostImpl.hpp
1 /* Copyright (c) 2004-2016. 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 "surf_interface.hpp"
7 #include "cpu_interface.hpp"
8 #include "network_interface.hpp"
9 #include "src/surf/PropertyHolder.hpp"
10
11 #include "StorageImpl.hpp"
12 #include <xbt/base.h>
13
14 #ifndef SURF_HOST_INTERFACE_HPP_
15 #define SURF_HOST_INTERFACE_HPP_
16
17 /***********
18  * Classes *
19  ***********/
20
21 namespace simgrid {
22 namespace surf {
23
24 class XBT_PRIVATE HostModel;
25 class XBT_PRIVATE HostImpl;
26 class XBT_PRIVATE HostAction;
27 }
28 }
29
30 /*********
31  * Tools *
32  *********/
33
34 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
35
36 /*********
37  * Model *
38  *********/
39
40 namespace simgrid {
41 namespace surf {
42
43 /** @ingroup SURF_host_interface
44  * @brief SURF Host model interface class
45  * @details A model is an object which handle the interactions between its Resources and its Actions
46  */
47 class HostModel : public Model {
48 public:
49   HostModel() : Model() {}
50
51   virtual void ignoreEmptyVmInPmLMM();
52   virtual Action* executeParallelTask(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
53                                       double rate);
54 };
55
56 /************
57  * Resource *
58  ************/
59 /** @ingroup SURF_host_interface
60  * @brief SURF Host interface class
61  * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
62  */
63 class HostImpl : public simgrid::surf::PropertyHolder {
64
65 public:
66   explicit HostImpl(s4u::Host* host);
67   virtual ~HostImpl() = default;
68
69   /** @brief Return the storage of corresponding mount point */
70   virtual simgrid::surf::StorageImpl* findStorageOnMountList(const char* storage);
71
72   /** @brief Get the xbt_dynar_t of storages attached to the Host */
73   virtual void getAttachedStorageList(std::vector<const char*>* storages);
74
75   /**
76    * @brief Close a file
77    *
78    * @param fd The file descriptor to close
79    * @return The StorageAction corresponding to the closing
80    */
81   virtual Action* close(surf_file_t fd);
82
83   /**
84    * @brief Unlink a file
85    * @details [long description]
86    *
87    * @param fd [description]
88    * @return [description]
89    */
90   virtual int unlink(surf_file_t fd);
91
92   /**
93    * @brief Read a file
94    *
95    * @param fd The file descriptor to read
96    * @param size The size in bytes to read
97    * @return The StorageAction corresponding to the reading
98    */
99   virtual Action* read(surf_file_t fd, sg_size_t size);
100
101   /**
102    * @brief Write a file
103    *
104    * @param fd The file descriptor to write
105    * @param size The size in bytes to write
106    * @return The StorageAction corresponding to the writing
107    */
108   virtual Action* write(surf_file_t fd, sg_size_t size);
109
110   /**
111    * @brief Move a file to another location on the *same mount point*.
112    * @details [long description]
113    *
114    * @param fd The file descriptor
115    * @param fullpath The new full path
116    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
117    * full path is not on the same mount point
118    */
119   virtual int fileMove(surf_file_t fd, const char* fullpath);
120
121   std::map<std::string, simgrid::surf::StorageImpl*> storage_;
122   simgrid::s4u::Host* piface_ = nullptr;
123
124   simgrid::s4u::Host* getHost() { return piface_; }
125 };
126 }
127 }
128
129 #endif /* SURF_Host_INTERFACE_HPP_ */