Skip to content

vInstruction

Bases: Entity

Base for simulated instructions.

Source code in PyCloudSim\entity\v_instruction.py 
17
18
19
20
21
22
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
class vInstruction(Entity):
    """Base for simulated instructions."""

    def __init__(
        self,
        process: vProcess | vContainerProcess | vDeamon | vDecoder,
        create_at: int | float | Callable[..., int] | Callable[..., float] | None,
    ) -> None:
        """Create a simulated instruction. It will be consumed by the simulated CPU core. Once all simulated instruction of a process is consumed, the process is considered to be successfully executed."""
        super().__init__(f"{process.label}-{len(process.instructions)}", create_at)
        self._process = process
        self._instruction = bytes()

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

    def on_creation(self):
        """Populate the instruction with random bytes to simulate RAM usage."""
        if self.process.host is None:
            raise RuntimeError(f"{self} is not associated a host")

        if self.process.host.architecture == Constants.X86:
            self._instruction = randbytes(randint(1, 16))
        elif self.process.host.architecture == Constants.ARM:
            self._instruction = randbytes(4)
        else:
            raise RuntimeError(f"{self.process.host} has an unknown architecture")
        self.process.instructions.append(self)
        self.process.unscheduled_instructions.append(self)

    def on_termination(self):
        """Terminate the simulated instruction. Called when the instruction is consumed by the CPU core."""
        # clear out the resource usage
        if self.process.container is not None:
            if self.process.container.host is not None:
                self.process.container._cpu_usage -= (1 * 1000) / (
                    self.process.container.host.cpu.ipc
                    * self.process.container.host.cpu.frequency
                )
                self.process.container._ram_usage -= self.length

    @property
    def process(self):
        """Return the process that this instruction belongs to."""
        return self._process

    @property
    def instruction(self) -> bytes:
        """The instruction"""
        return self._instruction

    @property
    def length(self) -> int:
        """The length of the instruction"""
        return len(self.instruction) * 100000

instruction: bytes property

The instruction

length: int property

The length of the instruction

process property

Return the process that this instruction belongs to.

__init__(process, create_at)

Create a simulated instruction. It will be consumed by the simulated CPU core. Once all simulated instruction of a process is consumed, the process is considered to be successfully executed.

Source code in PyCloudSim\entity\v_instruction.py 
20
21
22
23
24
25
26
27
28
def __init__(
    self,
    process: vProcess | vContainerProcess | vDeamon | vDecoder,
    create_at: int | float | Callable[..., int] | Callable[..., float] | None,
) -> None:
    """Create a simulated instruction. It will be consumed by the simulated CPU core. Once all simulated instruction of a process is consumed, the process is considered to be successfully executed."""
    super().__init__(f"{process.label}-{len(process.instructions)}", create_at)
    self._process = process
    self._instruction = bytes()

on_creation()

Populate the instruction with random bytes to simulate RAM usage.

Source code in PyCloudSim\entity\v_instruction.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
def on_creation(self):
    """Populate the instruction with random bytes to simulate RAM usage."""
    if self.process.host is None:
        raise RuntimeError(f"{self} is not associated a host")

    if self.process.host.architecture == Constants.X86:
        self._instruction = randbytes(randint(1, 16))
    elif self.process.host.architecture == Constants.ARM:
        self._instruction = randbytes(4)
    else:
        raise RuntimeError(f"{self.process.host} has an unknown architecture")
    self.process.instructions.append(self)
    self.process.unscheduled_instructions.append(self)

on_termination()

Terminate the simulated instruction. Called when the instruction is consumed by the CPU core.

Source code in PyCloudSim\entity\v_instruction.py 
47
48
49
50
51
52
53
54
55
56
def on_termination(self):
    """Terminate the simulated instruction. Called when the instruction is consumed by the CPU core."""
    # clear out the resource usage
    if self.process.container is not None:
        if self.process.container.host is not None:
            self.process.container._cpu_usage -= (1 * 1000) / (
                self.process.container.host.cpu.ipc
                * self.process.container.host.cpu.frequency
            )
            self.process.container._ram_usage -= self.length

vContainerProcess

Bases: vProcess

Source code in PyCloudSim\entity\v_process.py 
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
class vContainerProcess(vProcess):
    def __init__(
        self,
        container: vContainer,
        length: int | Callable[..., int],
        priority: int | Callable[..., int] = 0,
        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 process that runs in a container."""
        super().__init__(length, priority, label, create_at, terminate_at, precursor)
        self._container = container

    def on_initiate(self):
        """The initiation procedure of the simulated process."""
        super().on_initiate()
        if self.container is None:
            raise ValueError(f"{self} is not assigned to a container.")

        self.container.process_queue.append(self)
        self.container.host.cpu.process_queue.append(self)

    @property
    def container(self):
        """The container that executes this process"""
        return self._container

    @property
    def host(self):
        """The host that executes this process"""
        return self.container.host

container property

The container that executes this process

host property

The host that executes this process

__init__(container, length, priority=0, label=None, create_at=None, terminate_at=None, precursor=None)

Create a simulated process that runs in a container.

Source code in PyCloudSim\entity\v_process.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
def __init__(
    self,
    container: vContainer,
    length: int | Callable[..., int],
    priority: int | Callable[..., int] = 0,
    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 process that runs in a container."""
    super().__init__(length, priority, label, create_at, terminate_at, precursor)
    self._container = container

on_initiate()

The initiation procedure of the simulated process.

Source code in PyCloudSim\entity\v_process.py 
174
175
176
177
178
179
180
181
def on_initiate(self):
    """The initiation procedure of the simulated process."""
    super().on_initiate()
    if self.container is None:
        raise ValueError(f"{self} is not assigned to a container.")

    self.container.process_queue.append(self)
    self.container.host.cpu.process_queue.append(self)

vDeamon

Bases: vProcess

Source code in PyCloudSim\entity\v_process.py 
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
class vDeamon(vProcess):
    def __init__(
        self,
        container: vContainer,
        length: int | Callable[..., int],
        priority: int | Callable[..., int] = 0,
        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 deamon that belongs to a container."""
        super().__init__(length, priority, label, create_at, terminate_at, precursor)
        self._container = container

    def on_initiate(self):
        super().on_initiate()
        if self.container is None:
            raise ValueError(f"{self} is not assigned to a container.")

        self.container.process_queue.append(self)
        self.container.host.cpu.process_queue.append(self)

    def on_fail(self) -> None:
        super().on_fail()
        self.container.fail(simulation.now)

    @property
    def container(self):
        """The container that executes this process"""
        return self._container

    @property
    def host(self):
        """The host that executes this process"""
        return self.container.host

    @property
    def deamon(self):
        return True

container property

The container that executes this process

host property

The host that executes this process

__init__(container, length, priority=0, label=None, create_at=None, terminate_at=None, precursor=None)

Create a simulated deamon that belongs to a container.

Source code in PyCloudSim\entity\v_process.py 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
def __init__(
    self,
    container: vContainer,
    length: int | Callable[..., int],
    priority: int | Callable[..., int] = 0,
    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 deamon that belongs to a container."""
    super().__init__(length, priority, label, create_at, terminate_at, precursor)
    self._container = container

vDecoder

Bases: vProcess

Source code in PyCloudSim\entity\v_process.py 
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
class vDecoder(vProcess):
    def __init__(
        self,
        packet: vPacket,
        host: vHardwareEntity,
        length: int | Callable[..., int],
        priority: int | Callable[..., int] = 0,
        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 decoder that decodes a packet. It will be automatically created when a packet is received by a host."""
        super().__init__(length, priority, label, create_at, terminate_at, precursor)
        self._packet = packet
        self._host = host

    def on_initiate(self):
        """The initiation procedure of the simulated decoder."""
        super().on_initiate()
        if self.host is None:
            raise ValueError(f"{self} is not assigned to a host.")
        self.host.process_queue.append(self)

    def on_success(self):
        super().on_success()
        self.packet.state.append(Constants.DECODED)
        logger.info(f"{simulation.now}:\t{self.packet} is decoded.")
        if self.packet.current_hop is self.packet.dst_host:
            self.packet.success(simulation.now)

    def on_fail(self) -> None:
        super().on_fail()
        self.packet.fail(simulation.now)

    @property
    def packet(self):
        """The packet that is decoded"""
        return self._packet

    @property
    def host(self):
        """The host that decodes the packet"""
        return self._host

host property

The host that decodes the packet

packet property

The packet that is decoded

__init__(packet, host, length, priority=0, label=None, create_at=None, terminate_at=None, precursor=None)

Create a simulated decoder that decodes a packet. It will be automatically created when a packet is received by a host.

Source code in PyCloudSim\entity\v_process.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
def __init__(
    self,
    packet: vPacket,
    host: vHardwareEntity,
    length: int | Callable[..., int],
    priority: int | Callable[..., int] = 0,
    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 decoder that decodes a packet. It will be automatically created when a packet is received by a host."""
    super().__init__(length, priority, label, create_at, terminate_at, precursor)
    self._packet = packet
    self._host = host

on_initiate()

The initiation procedure of the simulated decoder.

Source code in PyCloudSim\entity\v_process.py 
269
270
271
272
273
274
def on_initiate(self):
    """The initiation procedure of the simulated decoder."""
    super().on_initiate()
    if self.host is None:
        raise ValueError(f"{self} is not assigned to a host.")
    self.host.process_queue.append(self)