Merge branch 'update-0.2'

Author: bbengfort

.gitignore

@@ -59,3 +59,5 @@ target/
 
 .DS_Store
 conf/gvas.yaml
+docs/slate
+.ipynb_checkpoints

conf/gvas-example.yaml

@@ -13,3 +13,30 @@
 ## Set application environment
 debug:   True
 testing: False
+
+## Visualization parameters
+vizualization:
+    # The Seaborn style can be one of darkgrid, whitegrid, dark, white, ticks
+    style: whitegrid
+
+    # The Seaborn context can be one of paper, notebook, talk, poster
+    context: paper
+
+    # The Seaborn palette can be one of null, deep, muted, pastel, bright, dark, or colorblind
+    palette: null
+
+## Global simulation parameters
+random_seed:  42
+max_sim_time: 1000
+
+defaults:
+  network:
+    capacity: 500
+    base_latency: 10
+  cluster:
+    size: 4
+  rack:
+    size: 96
+  node:
+    cpus: 4
+    memory: 16

gvas/__init__.py

@@ -24,7 +24,7 @@
 
 __version_info__ = {
     'major': 0,
-    'minor': 1,
+    'minor': 2,
     'micro': 0,
     'releaselevel': 'final',
     'serial': 0,

gvas/base.py

@@ -0,0 +1,89 @@
+# gvas.base
+# The base API for simulation processes and scripts.
+#
+# Author:   Benjamin Bengfort <[email protected]>
+# Created:  Mon Nov 23 17:40:57 2015 -0500
+#
+# Copyright (C) 2015 University of Maryland
+# For license information, see LICENSE.txt
+#
+# ID: base.py [] [email protected] $
+
+"""
+The base API for simulation processes and scripts.
+"""
+
+##########################################################################
+## Imports
+##########################################################################
+
+import simpy
+import random
+
+from gvas.config import settings
+from gvas.dynamo import Sequence
+
+##########################################################################
+## Base Process Objects
+##########################################################################
+
+
+class Process(object):
+    """
+    Base process object.
+    """
+
+    def __init__(self, env):
+        self.env    = env
+        self.action = env.process(self.run())
+
+    def run(self):
+        raise NotImplementedError("Processes must implement a run method.")
+
+
+class NamedProcess(Process):
+    """
+    A process with a sequence counter and self identification.
+    """
+
+    counter = Sequence()
+
+    def __init__(self, env):
+        self._id = self.counter.next()
+        super(NamedProcess, self).__init__(env)
+
+    @property
+    def name(self):
+        return "{} #{}".format(self.__class__.__name__, self._id)
+
+
+##########################################################################
+## Base Simulation Script
+##########################################################################
+
+class Simulation(object):
+    """
+    Defines a script that every simulation implements.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Instantiates the simpy environment and other configurations.
+        """
+        random.seed(kwargs.get('random_seed', settings.random_seed))
+
+        self.max_sim_time = kwargs.get('max_sim_time', settings.max_sim_time)
+        self.env = simpy.Environment()
+
+    def script(self):
+        """
+        Use the environment to generate a script.
+        """
+        raise NotImplementedError("Every simulation requires a script.")
+
+    def run(self):
+        """
+        The entry point for all simulations.
+        """
+        self.script()
+        self.env.run(until=self.max_sim_time)

gvas/cluster/__init__.py

@@ -0,0 +1,30 @@
+# gvas.cluster
+# Simulation classes to model distributed system components.
+#
+# Author:   Allen Leis <[email protected]>
+# Created:  Fri Dec 04 16:48:51 2015 -0500
+#
+# Copyright (C) 2015 Allen Leis
+# For license information, see LICENSE.txt
+#
+# ID: __init__.py [] [email protected] $
+
+"""
+Simulation classes to model distributed system components.
+"""
+
+##########################################################################
+# Imports
+##########################################################################
+
+from .cluster import Cluster
+from .rack import Rack
+from .node import Node
+from .program import Program
+
+##########################################################################
+# Execution
+##########################################################################
+
+if __name__ == '__main__':
+    pass

gvas/cluster/base.py

@@ -0,0 +1,66 @@
+# gvas.cluster.base
+# Base classes for cluster simulation framework.
+#
+# Author:   Allen Leis <[email protected]>
+# Created:  Fri Dec 04 16:49:32 2015 -0500
+#
+# Copyright (C) 2015 Allen Leis
+# For license information, see LICENSE.txt
+#
+# ID: base.py [] [email protected] $
+
+"""
+Base classes for cluster simulation framework.
+"""
+
+##########################################################################
+# Imports
+##########################################################################
+
+from gvas.base import NamedProcess
+from .network import Network
+
+##########################################################################
+# Classes
+##########################################################################
+
+class Machine(NamedProcess):
+
+    def __init__(self, env, *args, **kwargs):
+        self._network = Network.create(env, parent=self).next()
+        super(Machine, self).__init__(env)
+
+    @classmethod
+    def create(self, *args, **kwargs):
+        """
+        Generalized factory method to return a generator that can produce
+        new instances.
+        """
+        raise NotImplementedError('Subclasses should override this method.')
+
+    def send(self, *args, **kwargs):
+        """
+        Generalized method to put message onto the contained network.
+        """
+        raise NotImplementedError('Subclasses should override this method.')
+
+    def recv(self, *args, **kwargs):
+        """
+        Generalized method to obtain a message from the contained network.
+        """
+        raise NotImplementedError('Subclasses should override this method.')
+
+    @property
+    def network(self):
+        """
+        Returns a reference to the underlying Network instance
+        """
+        return self._network
+
+
+##########################################################################
+# Execution
+##########################################################################
+
+if __name__ == '__main__':
+    pass

gvas/cluster/cluster.py

@@ -0,0 +1,159 @@
+# gvas.cluster.cluster
+# Simulation class to model a cluster of resources.
+#
+# Author:   Allen Leis <[email protected]>
+# Created:  Fri Dec 04 16:50:27 2015 -0500
+#
+# Copyright (C) 2015 Allen Leis
+# For license information, see LICENSE.txt
+#
+# ID: cluster.py [] [email protected] $
+
+"""
+Simulation class to model a cluster of resources.
+"""
+
+##########################################################################
+# Imports
+##########################################################################
+
+from gvas.config import settings
+from gvas.exceptions import ClusterLacksCapacity
+from .base import Machine
+from .rack import Rack
+from .node import Node
+
+##########################################################################
+# Classes
+##########################################################################
+
+class Cluster(Machine):
+
+    def __init__(self, env, *args, **kwargs):
+        rack_options = kwargs.get('rack_options', {})
+        node_options = kwargs.get('node_options', {})
+        self.rack_generator = kwargs.get(
+            'rack_generator',
+            Rack.create(
+                env,
+                cluster=self,
+                node_options=node_options,
+                **rack_options
+            )
+        )
+        self.size = kwargs.get(
+            'size',
+            settings.defaults.cluster.size
+        )
+        node_options = kwargs.get('node_options', {})
+        self.node_generator = kwargs.get(
+            'node_generator',
+            Node.create(env, **node_options)
+        )
+
+        racks = [self.rack_generator.next() for i in range(self.size)]
+        self.racks = dict((r.id, r) for r in racks)
+        super(self.__class__, self).__init__(env, *args, **kwargs)
+
+    @classmethod
+    def create(cls, env, *args, **kwargs):
+        """
+        Generalized factory method to return a generator that can produce
+        new instances.
+        """
+        while True:
+            yield cls(env, *args, **kwargs)
+
+    def filter(self, evaluator):
+        """
+        Uses the evaluator function to test against the Node instances and
+        return a list of matches.
+        """
+        pass
+
+    def first(self, evaluator):
+        """
+        Uses the evaluator function to test against the Node instances and
+        return the first match.
+        """
+        pass
+
+    def send(self, *args, **kwargs):
+        """
+        Generalized method to put message onto the contained network.
+        """
+        pass
+
+    def recv(self, *args, **kwargs):
+        """
+        Generalized method to obtain a message from the contained network.
+        """
+        pass
+
+    def add(self, node=None, rack=None, rack_id=None):
+        """
+        Adds a node to the cluster.  Will add the node to the specified rack or
+        rack_id.  Otherwise, will choose the first rack with available space.
+        """
+        if not rack:
+            if rack_id:
+                rack = self.racks[rack_id]
+            rack = self.first_available_rack
+
+        if not node:
+            node = self.node_generator.next()
+
+        rack.add(node)
+        return node
+
+
+    def remove(self, node):
+        """
+        Removes a node from the cluster.
+        """
+        pass
+
+    def run(self):
+        """
+        Method to kickoff process simulation.
+        """
+        # TODO: placeholder code
+        yield self.env.timeout(1)
+
+    @property
+    def id(self):
+        """
+        The unqiue identifier for this instance.
+
+        Note that the _id property is initially set in the NamedProcess
+        ancestor class and so all subclasses may share the same Sequence.
+        """
+        return self._id
+
+    @property
+    def first_available_rack(self):
+        """
+
+        """
+        ids = sorted(self.racks.keys())
+
+        for id in ids:
+            if not self.racks[id].full:
+                return self.racks[id]
+
+        else:
+            raise ClusterLacksCapacity()
+
+
+
+
+
+
+
+
+##########################################################################
+# Execution
+##########################################################################
+
+if __name__ == '__main__':
+    pass