AsyncFlow/src/asyncflow/resources/server_containers.py at main · AsyncFlow-Sim/AsyncFlow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
"""
Definition of support structures for the simulation runtime.

After Pydantic validation, this module provides TypedDicts and helpers
to build SimPy Containers for each server in the topology, improving
readability and ensuring a single point of truth for resource setup.
"""


from typing import TypedDict

import simpy

from asyncflow.config.constants import ServerResourceName
from asyncflow.schemas.topology.nodes import ServerResources

# ==============================================================
# DICT FOR THE REGISTRY TO INITIALIZE RESOURCES FOR EACH SERVER
# ==============================================================


class ServerContainers(TypedDict):
    """
    Mapping of resource names to their SimPy Container instances for a server.

    - CPU: simpy.Container for CPU cores.
    - RAM: simpy.Container for RAM in megabytes.
    """

    CPU: simpy.Container
    RAM: simpy.Container

# Central funcrion to initialize  the dictionary with ram and cpu container
def build_containers(
    env: simpy.Environment,
    spec: ServerResources,
    ) -> ServerContainers:
    """
    Construct and return a mapping of SimPy Containers for a server's CPU and RAM.

    Given a SimPy environment and a validated ServerResources spec, this function
    initializes one simpy.Container for CPU (with capacity equal to cpu_cores)
    and one for RAM (with capacity equal to ram_mb), then returns them in a
    ServerContainers TypedDict keyed by "CPU" and "RAM".

    Parameters
    ----------
    env : simpy.Environment
        The simulation environment in which the Containers will be created.
    spec : ServerResources
        A Pydantic model instance defining the server's cpu_cores and ram_mb.

    Returns
    -------
    ServerContainers
        A TypedDict with exactly two entries:
        - "CPU":   simpy.Container initialized with spec.cpu_cores
        - "RAM":   simpy.Container initialized with spec.ram_mb

    """
    return {
        ServerResourceName.CPU.value: simpy.Container(
            env, capacity=spec.cpu_cores, init=spec.cpu_cores,
        ),
        ServerResourceName.RAM.value: simpy.Container(
            env, capacity=spec.ram_mb, init=spec.ram_mb,
        ),
    }