Skip to content

Index

The PhysicalEntity class is the base for all simulated physical entities such as Host, Switch and Router.

Bases: Entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
class vHardwareEntity(Entity):
    def __init__(
        self,
        ipc: int | Callable,
        frequency: int | Callable,
        num_cores: int | Callable,
        cpu_tdps: int | float | Callable,
        cpu_mode: int,
        ram: int | Callable,
        rom: int | Callable,
        architecture: str = Constants.X86,
        label: str | None = None,
        create_at: int
        | float
        | Callable[..., int]
        | Callable[..., float]
        | None = None,
        terminate_at: int
        | float
        | Callable[..., int]
        | Callable[..., float]
        | None = None,
        precursor: Entity | List[Entity] | None = None,
    ) -> None:
        """Create a simulated hardware entity.

        Args:
            ipc (int | Callable): the instructions per cycle (IPC) of the CPU.
            frequency (int | Callable): the frequency of the CPU, in MHz.
            num_cores (int | Callable): the number of cores of the CPU.
            cpu_tdps (int | float | Callable): the thermal design power (TDP) of the CPU, in Watts.
            ram (int | Callable): the RAM of the hardware entity, in GiB.
            rom (int | Callable): the ROM of the hardware entity, in GiB.
            label (str | None, optional): the short name for the entity. Defaults to None.
            create_at (int | float | Callable[..., Any] | None, optional): when the enity should be created. Defaults to None.
            terminate_at (int | float | Callable[..., Any] | None, optional): when the entity should be terminated. Defaults to None.
            precursor (Entity | List[Entity] | None, optional): the presursors that must be terminated before the creation of this entity. Defaults to None.
        """
        super().__init__(label, create_at, terminate_at, precursor)

        self._cpu = vCPU(
            ipc, frequency, num_cores, cpu_tdps, cpu_mode, self, label=f"{label}"
        )
        if callable(ram):
            self._ram = Resource(
                capacity=GiB(round(ram())).bytes, label=f"{self.label}-RAM"
            )
        else:
            self._ram = Resource(capacity=GiB(ram).bytes, label=f"{self.label}-RAM")
        if callable(rom):
            self._rom = Resource(
                capacity=GiB(round(rom())).bytes, label=f"{self.label}-ROM"
            )
        else:
            self._rom = Resource(capacity=GiB(rom).bytes, label=f"{self.label}-ROM")

        if architecture in [Constants.X86, Constants.ARM]:
            self._architecture = architecture
        else:
            raise ValueError(f"Platform {architecture} is not supported.")
        self._NIC = vNIC(host=self, label=f"{self}-NIC")

    def on_creation(self):
        simulation.network.add_node(self)
        self.cpu.create(simulation.now)
        self.NIC.create(simulation.now)
        self.NIC.add_port(
            endpoint=self,
            bandwidth=10000,
            at=simulation.now,
            ip_address=IPv4Address("127.0.0.1"),
        )

    def on_termination(self):
        simulation.network.del_node(self)
        self.cpu.terminate(simulation.now)
        self.NIC.terminate(simulation.now)

    def power_on(self, at: int | float) -> None:
        """Power on the hardware entity"""

        if self.powered_on:
            warnings.warn(f"{self.label} is already powered on.")
            return

        if self.failed:
            warnings.warn(f"{self.label} is failed.")
            return

        if self.terminated:
            warnings.warn(f"{self.label} is terminated.")
            return

        for event in self.events:
            if event.label == f"{self.label} Power On":
                if at > event.at:
                    return

        @self.instant_event(at, label=f"{self.label} Power On", priority=-1)
        def _power_on() -> None:
            if self.powered_on or self.failed or self.terminated:
                return
            self.cpu.power_on(simulation.now)
            self.NIC.power_on(simulation.now)
            self.on_power_on()
            self.state.append(Constants.POWER_ON)
            if Constants.POWER_OFF in self.state:
                self.state.remove(Constants.POWER_OFF)

    def on_power_on(self) -> None:
        """Called when the hardware entity is powered on"""
        simulation.network.add_node(self)

    def power_off(self, at: int | float) -> None:
        """Power off the hardware entity"""

        if self.powered_off:
            warnings.warn(f"{self.label} is already powered off.")
            return
        if self.failed:
            warnings.warn(f"{self.label} is failed.")
            return

        if self.terminated:
            warnings.warn(f"{self.label} is terminated.")
            return

        for event in self.events:
            if event.label == f"{self.label} Power Off":
                if at > event.at:
                    return

        @self.instant_event(at, label=f"{self.label} Power Off", priority=-1)
        def _power_off() -> None:
            if self.powered_off or self.failed or self.terminated:
                return
            self.cpu.power_off(simulation.now)
            self.NIC.power_off(simulation.now)
            self.on_power_off()
            self.state.append(Constants.POWER_OFF)
            if Constants.POWER_ON in self.state:
                self.state.remove(Constants.POWER_ON)

    def on_power_off(self) -> None:
        """Called when the hardware entity is powered off"""
        simulation.network.del_node(self)

    def fail(self, at: int | float) -> None:
        """Fail the hardware entity"""

        if self.failed:
            warnings.warn(f"{self.label} is already failed.")
            return

        if self.terminated:
            warnings.warn(f"{self.label} is terminated.")
            return

        for event in self.events:
            if event.label == f"{self.label} Fail":
                if at > event.at:
                    return

        @self.instant_event(at, label=f"{self.label} Fail")
        def _fail() -> None:
            if self.failed or self.terminated:
                return
            self.cpu.fail(simulation.now)
            self.NIC.fail(simulation.now)
            self.on_fail()
            self.power_off(simulation.now)
            self.state.append(Constants.FAIL)

    def on_fail(self) -> None:
        """Called when the hardware entity fails"""
        pass

    def receive_packet(self, packet: vPacket) -> None:
        """Receive a packet from the NIC. A decoding virtual process will be created if the packet is successfully received. The decoding process simulates the processing delay."""
        if packet.decoded:
            packet.state.remove(Constants.DECODED)

        if packet.in_transmission:
            packet.state.remove(Constants.INTRANSMISSION)

        try:
            packet.get(self.ram, packet.size)
        except:
            packet.drop()
            return
        self.packet_queue.append(packet)
        packet._current_hop = self
        if packet.current_hop is not packet.dst_host:
            packet._next_hop = packet.path[indexOf(packet.path, self) + 1]
        decoder = vDecoder(
            packet=packet,
            length=packet.size,
            host=self,
            label=f"{packet} Decoder",
            create_at=simulation.now,
        )
        logger.info(f"{simulation.now}:\t{self} receives {packet}.")

    def drop_packet(self, packet: vPacket) -> None:
        """Drop a packet from the NIC. It should not be called manually."""
        packet.drop()

    def __str__(self) -> str:
        return f"{self.__class__.__name__}-{self.label}"

    @property
    def powered_on(self) -> bool:
        """Return True if the hardware entity is powered on"""
        return Constants.POWER_ON in self.state

    @property
    def powered_off(self) -> bool:
        """Return True if the hardware entity is powered off"""
        return Constants.POWER_OFF in self.state or Constants.POWER_ON not in self.state

    @property
    def failed(self) -> bool:
        """Return True if the hardware component fails"""
        return Constants.FAIL in self.state

    @property
    def cpu(self) -> vCPU:
        """Return the CPU of the hardware entity"""
        return self._cpu

    @property
    def ram(self) -> Resource:
        """Return the RAM of the hardware entity"""
        return self._ram

    @property
    def rom(self) -> Resource:
        """Return the ROM of the hardware entity"""
        return self._rom

    @property
    def NIC(self) -> vNIC:
        """Return the NIC of the hardware entity"""
        return self._NIC

    @property
    def packet_queue(self):
        """Return the packet queue of the hardware entity"""
        return self.NIC.packet_queue

    @property
    def process_queue(self):
        """Return the process queue of the hardware entity"""
        return self.cpu.process_queue

    @property
    def architecture(self):
        """Return the architecture of the hardware entity"""
        return self._architecture

    def cpu_usage(self, duration: int | float | None = None) -> float:
        """Return the CPU usage of the hardware entity"""
        return self.cpu.usage(duration=duration)

    def cpu_utilization(self, duration: int | float | None = None) -> float:
        """Return the CPU utilization of the hardware entity"""
        return self.cpu.utilization(duration=duration)

    def ram_usage(self, duration: int | float | None = None) -> float:
        """Return the RAM usage of the hardware entity"""
        return self.ram.usage(duration=duration)

    def ram_utilization(self, duration: int | float | None = None) -> float:
        """Return the RAM utilization of the hardware entity"""
        return self.ram.utilization(duration=duration)

NIC: vNIC property

Return the NIC of the hardware entity

architecture property

Return the architecture of the hardware entity

cpu: vCPU property

Return the CPU of the hardware entity

failed: bool property

Return True if the hardware component fails

packet_queue property

Return the packet queue of the hardware entity

powered_off: bool property

Return True if the hardware entity is powered off

powered_on: bool property

Return True if the hardware entity is powered on

process_queue property

Return the process queue of the hardware entity

ram: Resource property

Return the RAM of the hardware entity

rom: Resource property

Return the ROM of the hardware entity

__init__(ipc, frequency, num_cores, cpu_tdps, cpu_mode, ram, rom, architecture=Constants.X86, label=None, create_at=None, terminate_at=None, precursor=None)

Create a simulated hardware entity.

Parameters:

Name Type Description Default
ipc int | Callable

the instructions per cycle (IPC) of the CPU.

 required
frequency int | Callable

the frequency of the CPU, in MHz.

 required
num_cores int | Callable

the number of cores of the CPU.

 required
cpu_tdps int | float | Callable

the thermal design power (TDP) of the CPU, in Watts.

 required
ram int | Callable

the RAM of the hardware entity, in GiB.

 required
rom int | Callable

the ROM of the hardware entity, in GiB.

 required
label str | None

the short name for the entity. Defaults to None.

 None
create_at int | float | Callable[..., Any] | None

when the enity should be created. Defaults to None.

 None
terminate_at int | float | Callable[..., Any] | None

when the entity should be terminated. Defaults to None.

 None
precursor Entity | List[Entity] | None

the presursors that must be terminated before the creation of this entity. Defaults to None.

 None
Source code in PyCloudSim\entity\v_hardware_entity.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def __init__(
    self,
    ipc: int | Callable,
    frequency: int | Callable,
    num_cores: int | Callable,
    cpu_tdps: int | float | Callable,
    cpu_mode: int,
    ram: int | Callable,
    rom: int | Callable,
    architecture: str = Constants.X86,
    label: str | None = None,
    create_at: int
    | float
    | Callable[..., int]
    | Callable[..., float]
    | None = None,
    terminate_at: int
    | float
    | Callable[..., int]
    | Callable[..., float]
    | None = None,
    precursor: Entity | List[Entity] | None = None,
) -> None:
    """Create a simulated hardware entity.

    Args:
        ipc (int | Callable): the instructions per cycle (IPC) of the CPU.
        frequency (int | Callable): the frequency of the CPU, in MHz.
        num_cores (int | Callable): the number of cores of the CPU.
        cpu_tdps (int | float | Callable): the thermal design power (TDP) of the CPU, in Watts.
        ram (int | Callable): the RAM of the hardware entity, in GiB.
        rom (int | Callable): the ROM of the hardware entity, in GiB.
        label (str | None, optional): the short name for the entity. Defaults to None.
        create_at (int | float | Callable[..., Any] | None, optional): when the enity should be created. Defaults to None.
        terminate_at (int | float | Callable[..., Any] | None, optional): when the entity should be terminated. Defaults to None.
        precursor (Entity | List[Entity] | None, optional): the presursors that must be terminated before the creation of this entity. Defaults to None.
    """
    super().__init__(label, create_at, terminate_at, precursor)

    self._cpu = vCPU(
        ipc, frequency, num_cores, cpu_tdps, cpu_mode, self, label=f"{label}"
    )
    if callable(ram):
        self._ram = Resource(
            capacity=GiB(round(ram())).bytes, label=f"{self.label}-RAM"
        )
    else:
        self._ram = Resource(capacity=GiB(ram).bytes, label=f"{self.label}-RAM")
    if callable(rom):
        self._rom = Resource(
            capacity=GiB(round(rom())).bytes, label=f"{self.label}-ROM"
        )
    else:
        self._rom = Resource(capacity=GiB(rom).bytes, label=f"{self.label}-ROM")

    if architecture in [Constants.X86, Constants.ARM]:
        self._architecture = architecture
    else:
        raise ValueError(f"Platform {architecture} is not supported.")
    self._NIC = vNIC(host=self, label=f"{self}-NIC")

cpu_usage(duration=None)

Return the CPU usage of the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
283
284
285
def cpu_usage(self, duration: int | float | None = None) -> float:
    """Return the CPU usage of the hardware entity"""
    return self.cpu.usage(duration=duration)

cpu_utilization(duration=None)

Return the CPU utilization of the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
287
288
289
def cpu_utilization(self, duration: int | float | None = None) -> float:
    """Return the CPU utilization of the hardware entity"""
    return self.cpu.utilization(duration=duration)

drop_packet(packet)

Drop a packet from the NIC. It should not be called manually.

Source code in PyCloudSim\entity\v_hardware_entity.py 
226
227
228
def drop_packet(self, packet: vPacket) -> None:
    """Drop a packet from the NIC. It should not be called manually."""
    packet.drop()

fail(at)

Fail the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
def fail(self, at: int | float) -> None:
    """Fail the hardware entity"""

    if self.failed:
        warnings.warn(f"{self.label} is already failed.")
        return

    if self.terminated:
        warnings.warn(f"{self.label} is terminated.")
        return

    for event in self.events:
        if event.label == f"{self.label} Fail":
            if at > event.at:
                return

    @self.instant_event(at, label=f"{self.label} Fail")
    def _fail() -> None:
        if self.failed or self.terminated:
            return
        self.cpu.fail(simulation.now)
        self.NIC.fail(simulation.now)
        self.on_fail()
        self.power_off(simulation.now)
        self.state.append(Constants.FAIL)

on_fail()

Called when the hardware entity fails

Source code in PyCloudSim\entity\v_hardware_entity.py 
196
197
198
def on_fail(self) -> None:
    """Called when the hardware entity fails"""
    pass

on_power_off()

Called when the hardware entity is powered off

Source code in PyCloudSim\entity\v_hardware_entity.py 
166
167
168
def on_power_off(self) -> None:
    """Called when the hardware entity is powered off"""
    simulation.network.del_node(self)

on_power_on()

Called when the hardware entity is powered on

Source code in PyCloudSim\entity\v_hardware_entity.py 
132
133
134
def on_power_on(self) -> None:
    """Called when the hardware entity is powered on"""
    simulation.network.add_node(self)

power_off(at)

Power off the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
def power_off(self, at: int | float) -> None:
    """Power off the hardware entity"""

    if self.powered_off:
        warnings.warn(f"{self.label} is already powered off.")
        return
    if self.failed:
        warnings.warn(f"{self.label} is failed.")
        return

    if self.terminated:
        warnings.warn(f"{self.label} is terminated.")
        return

    for event in self.events:
        if event.label == f"{self.label} Power Off":
            if at > event.at:
                return

    @self.instant_event(at, label=f"{self.label} Power Off", priority=-1)
    def _power_off() -> None:
        if self.powered_off or self.failed or self.terminated:
            return
        self.cpu.power_off(simulation.now)
        self.NIC.power_off(simulation.now)
        self.on_power_off()
        self.state.append(Constants.POWER_OFF)
        if Constants.POWER_ON in self.state:
            self.state.remove(Constants.POWER_ON)

power_on(at)

Power on the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def power_on(self, at: int | float) -> None:
    """Power on the hardware entity"""

    if self.powered_on:
        warnings.warn(f"{self.label} is already powered on.")
        return

    if self.failed:
        warnings.warn(f"{self.label} is failed.")
        return

    if self.terminated:
        warnings.warn(f"{self.label} is terminated.")
        return

    for event in self.events:
        if event.label == f"{self.label} Power On":
            if at > event.at:
                return

    @self.instant_event(at, label=f"{self.label} Power On", priority=-1)
    def _power_on() -> None:
        if self.powered_on or self.failed or self.terminated:
            return
        self.cpu.power_on(simulation.now)
        self.NIC.power_on(simulation.now)
        self.on_power_on()
        self.state.append(Constants.POWER_ON)
        if Constants.POWER_OFF in self.state:
            self.state.remove(Constants.POWER_OFF)

ram_usage(duration=None)

Return the RAM usage of the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
291
292
293
def ram_usage(self, duration: int | float | None = None) -> float:
    """Return the RAM usage of the hardware entity"""
    return self.ram.usage(duration=duration)

ram_utilization(duration=None)

Return the RAM utilization of the hardware entity

Source code in PyCloudSim\entity\v_hardware_entity.py 
295
296
297
def ram_utilization(self, duration: int | float | None = None) -> float:
    """Return the RAM utilization of the hardware entity"""
    return self.ram.utilization(duration=duration)

receive_packet(packet)

Receive a packet from the NIC. A decoding virtual process will be created if the packet is successfully received. The decoding process simulates the processing delay.

Source code in PyCloudSim\entity\v_hardware_entity.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
def receive_packet(self, packet: vPacket) -> None:
    """Receive a packet from the NIC. A decoding virtual process will be created if the packet is successfully received. The decoding process simulates the processing delay."""
    if packet.decoded:
        packet.state.remove(Constants.DECODED)

    if packet.in_transmission:
        packet.state.remove(Constants.INTRANSMISSION)

    try:
        packet.get(self.ram, packet.size)
    except:
        packet.drop()
        return
    self.packet_queue.append(packet)
    packet._current_hop = self
    if packet.current_hop is not packet.dst_host:
        packet._next_hop = packet.path[indexOf(packet.path, self) + 1]
    decoder = vDecoder(
        packet=packet,
        length=packet.size,
        host=self,
        label=f"{packet} Decoder",
        create_at=simulation.now,
    )
    logger.info(f"{simulation.now}:\t{self} receives {packet}.")