dv-flow-mgr 0.0.1.13468776985a1__tar.gz → 0.0.1.13489806632a1__tar.gz

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dv-flow-mgr
-Version: 0.0.1.13468776985a1
+Version: 0.0.1.13489806632a1
 Summary: DV Flow Manager is a build system for silicon design
 Author-email: Matthew Ballance <matt.ballance@gmail.com>
 License:                                  Apache License

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/docs/Steps.md

@@ -65,4 +65,45 @@ Result Data
 - Something needs to process result
   - Save memento in central store (map of task-execution records)
     - Organize with start/finish times, etc
-- 
+
+# 
+- Create a task type from YAML
+  - Taskdef
+- Create a task and parameter changes
+  - Params are given a value (most-common)
+  - Or, a mutator class instance to append/prepend/etc
+
+files = factory.mkTask("std.FileSet", 
+  srcdir=os.path.join(os.path.abspath(__file__)),
+  params=dict(
+    basedir="foo",
+    fileType="systemVerilog",
+    include="*.sv"
+  ))
+
+simImg = factory.mkTask("hdlsim.SimImg", needs=[files])
+
+runner.run(simImg)
+
+## Task constructor 
+- Creates the parameter-type data structure
+- Creates the parameter-evaluation stack (stack of param-type structs)
+- Creates the task (holding eval stack)
+
+
+
+- Python layer than can be used with or wihout YAML meta-data
+  - Define Task, Define Params
+  - Maybe decorator to wrap Task as a Ctor?
+  - Must be able to work with YAML-defined content
+- YAML layer simply populates Python layer
+
+  @Task.ctor(MyParams)
+  class MyTask(Task):
+    # Creates an inner static method ctor that can be passed as the constructor
+
+factory.addTaskType(MyTask.ctor)
+
+
+
+

dv_flow_mgr-0.0.1.13489806632a1/docs/Tasks.md

@@ -0,0 +1,19 @@
+
+A task graph is composed of task nodes. A task is defined as the combination
+of:
+- behavior
+- parameters data structure
+- rules/process for specifying parameter values
+
+Task behavior must:
+- accept input data composed of:
+  - parameter data structure with values populated
+  - change notification
+  - (optional) meta-data
+- produce result data composed of:
+  - list of parameter sets
+  - change notification
+  - (optional) meta-data
+  - (optional) markers
+  - execution status
+

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dv-flow-mgr"
-version = "0.0.1.13468776985a1"
+version = "0.0.1.13489806632a1"
 dependencies = [
     'pydantic',
     'pyyaml',

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/package.py

@@ -22,7 +22,7 @@
 import dataclasses as dc
 import logging
 from typing import Any, ClassVar, Dict
-from .task import TaskCtor
+from .task_ctor import TaskCtor
 
 @dc.dataclass
 class Package(object):

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/package_def.py

@@ -33,7 +33,8 @@ from typing import Any, Dict, List, Callable, Tuple, ClassVar
 from .fragment_def import FragmentDef
 from .package import Package
 from .package_import_spec import PackageImportSpec, PackageSpec
-from .task import TaskCtor, TaskCtorProxy, TaskCtorCls, TaskCtorParam, TaskCtorParamCls
+#from .task import TaskCtorCls, TaskCtorParam, TaskCtorParamCls
+from .task_ctor import TaskCtor
 from .task_def import TaskDef, TaskSpec
 from .std.task_null import TaskNull
 from .type_def import TypeDef

dv_flow_mgr-0.0.1.13489806632a1/src/dv_flow/mgr/task.py

@@ -0,0 +1,182 @@
+#****************************************************************************
+#* task.py
+#*
+#* Copyright 2023 Matthew Ballance and Contributors
+#*
+#* Licensed under the Apache License, Version 2.0 (the "License"); you may 
+#* not use this file except in compliance with the License.  
+#* You may obtain a copy of the License at:
+#*
+#*   http://www.apache.org/licenses/LICENSE-2.0
+#*
+#* Unless required by applicable law or agreed to in writing, software 
+#* distributed under the License is distributed on an "AS IS" BASIS, 
+#* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+#* See the License for the specific language governing permissions and 
+#* limitations under the License.
+#*
+#* Created on:
+#*     Author: 
+#*
+#****************************************************************************
+import os
+import json
+import dataclasses as dc
+import logging
+from pydantic import BaseModel
+from typing import Any, Callable, ClassVar, Dict, List, Tuple
+from .task_data import TaskData, TaskDataInput, TaskDataOutput, TaskDataResult
+from .task_memento import TaskMemento
+from .task_ctor import TaskParamsCtor
+from .task_params_ctor import TaskParamsCtor
+from .task_runner import TaskRunner
+
+# @dc.dataclass
+# class TaskSpec(object):
+#     name : str
+
+# class TaskParams(BaseModel):
+#     pass
+
+
+# @dc.dataclass
+# class TaskCtorParam(TaskCtor):
+#     params : Dict[str,Any] = dc.field(default_factory=dict)
+
+#     _log : ClassVar = logging.getLogger("TaskCtorParam")
+
+#     def mkTask(self, name : str, depends, rundir, srcdir=None, params=None):
+#         self._log.debug("--> %s::mkTask" % self.name)
+#         if params is None:
+#             params = self.mkParams()
+#         if srcdir is None:
+#             srcdir = self.srcdir
+
+#         ret = self.uses.mkTask(name, depends, rundir, srcdir, params)
+
+#         self.applyParams(ret.params)
+#         self._log.debug("<-- %s::mkTask" % self.name)
+
+#         return ret
+
+#     def applyParams(self, params):
+#         self._log.debug("--> %s::applyParams: %s %s" % (self.name, str(type(self.params)), str(type(params))))
+#         if self.params is not None:
+#             for k,v in self.params.items():
+#                 self._log.debug("  change %s %s=>%s" % (
+#                     k, 
+#                     str(getattr(params, k)),
+#                     str(v)))
+#                 setattr(params, k, v)
+#         else:
+#             self._log.debug("  no params")
+#         self._log.debug("<-- %s::applyParams: %s" % (self.name, str(self.params)))
+
+# @dc.dataclass
+# class TaskCtorParamCls(TaskCtor):
+#     params_ctor : Callable = None
+
+#     _log : ClassVar = logging.getLogger("TaskCtorParamType")
+
+#     def mkParams(self):
+#         self._log.debug("--> %s::mkParams" % str(self.name))
+#         params = self.params_ctor()
+#         self._log.debug("<-- %s::mkParams: %s" % (str(self.name), str(type(params))))
+#         return params
+
+# @dc.dataclass
+# class TaskCtorCls(TaskCtor):
+#     task_ctor : Callable = None
+
+#     _log : ClassVar = logging.getLogger("TaskCtorCls")
+
+#     def mkTask(self, name : str, depends, rundir, srcdir=None, params=None):
+#         self._log.debug("--> %s::mkTask (%s) srcdir=%s" % (self.name, str(self.task_ctor), srcdir))
+
+#         if srcdir is None:
+#             srcdir = self.srcdir
+
+#         if params is None:
+#             params = self.mkParams()
+
+#         ret = self.task_ctor(
+#             name=name, 
+#             depends=depends, 
+#             rundir=rundir, 
+#             srcdir=srcdir, 
+#             params=params)
+
+#         # Update parameters on the way back
+#         self.applyParams(ret.params)
+
+#         self._log.debug("<-- %s::mkTask" % self.name)
+#         return ret
+
+# @dc.dataclass
+# class TaskCtorProxy(TaskCtor):
+#     task_ctor : TaskCtor = None
+#     param_ctor : Callable = None
+
+#     _log : ClassVar = logging.getLogger("TaskCtorProxy")
+
+#     def mkTask(self, *args, **kwargs):
+#         self._log.debug("--> %s::mkTask" % self.name)
+#         ret = self.task_ctor.mkTask(*args, **kwargs)
+#         self._log.debug("<-- %s::mkTask" % self.name)
+#         return ret
+
+#     def mkParams(self, params=None):
+#         self._log.debug("--> %s::mkParams: %s" % (self.name, str(self.params)))
+
+#         if params is None and self.param_ctor is not None:
+#             params = self.param_ctor()
+
+#         params = self.task_ctor.mkParams(params)
+
+#         if self.params is not None:
+#             for k,v in self.params.items():
+#                 self._log.debug("  change %s %s=>%s" % (
+#                     k, 
+#                     str(getattr(params, k)),
+#                     str(v)))
+#                 setattr(params, k, v)
+#         self._log.debug("<-- %s::mkParams: %s" % (self.name, str(self.params)))
+#         return params
+
+
+@dc.dataclass
+class Task(object):
+    """Executable view of a task"""
+    # Ctor fields -- must specify on construction
+    name : str
+    srcdir : str
+    params : TaskParamsCtor 
+
+    # Runtime fields -- these get populated during execution
+    changed : bool = False
+    needs : List['Task'] = dc.field(default_factory=list)
+    dependents : List['Task'] = dc.field(default_factory=list)
+    rundir : str = dc.field(default=None)
+    output : TaskDataOutput = dc.field(default=None)
+
+    _log : ClassVar = logging.getLogger("Task")
+
+    async def run(self,
+                  runner : 'TaskRunner',
+                  input : TaskDataInput) -> TaskDataResult:
+        raise NotImplementedError("TaskImpl.run() not implemented")
+    
+    @staticmethod
+    def ctor(paramT):
+        def wrapper(T):
+            def mk_task(name, srcdir, params):
+                return T(name, srcdir, params)
+            def mk_params(**params):
+                ctor = TaskParamsCtor(paramT)
+                ctor.values.append(paramT(**params))
+                return ctor
+            T.mkTask = mk_task
+            T.mkParams = mk_params
+            return T
+        return wrapper
+

dv_flow_mgr-0.0.1.13489806632a1/src/dv_flow/mgr/task_ctor.py

@@ -0,0 +1,43 @@
+import os
+import json
+import dataclasses as dc
+import logging
+from pydantic import BaseModel
+from typing import Any, Callable, ClassVar, Dict, List, Tuple
+from .task_data import TaskDataOutput, TaskDataResult
+
+# TaskParamsCtor accepts an evaluation context and returns a task parameter object
+TaskParamsCtor = Callable[[object], Any]
+
+@dc.dataclass
+class TaskCtor(object):
+    name : str
+    uses : 'TaskCtor' = None
+    srcdir : str = None
+
+    _log : ClassVar = logging.getLogger("TaskCtor")
+
+    def mkTask(self, name : str, srcdir=None) -> 'Task':
+        """Creates a task object"""
+        if srcdir is None:
+            srcdir = self.srcdir
+
+        if self.uses is not None:
+            return self.uses.mkTask(name, srcdir)
+        else:
+            raise NotImplementedError("TaskCtor.mkTask() not implemented for %s" % str(type(self)))
+    
+    def mkParams(self, params=None) -> TaskParamsCtor:
+        """Creates a list of task-parameter objects used produce the params object"""
+        self._log.debug("--> %s::mkParams" % self.name)
+        if self.uses is not None:
+            params = self.uses.mkParams()
+        else:
+            params = TaskParams()
+        self._log.debug("<-- %s::mkParams: %s" % (self.name, str(params)))
+
+        return params
+
+    def applyParams(self, params):
+        if self.uses is not None:
+            self.uses.applyParams(params)

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/task_data.py

@@ -27,6 +27,16 @@ from typing import Any, ClassVar, Dict, Set, List, Tuple
 from .fileset import FileSet
 from toposort import toposort
 
+class TaskMarkerLoc(BaseModel):
+    path : str
+    line : int = dc.Field(default=-1)
+    pos : int = dc.Field(default=-1)
+
+class TaskMarker(BaseModel):
+    msg : str
+    severity : str
+    loc : TaskMarkerLoc = dc.Field(default=None)
+
 class TaskDataInput(BaseModel):
     changed : bool
     srcdir : str
@@ -35,11 +45,11 @@ class TaskDataInput(BaseModel):
     memento : Any
 
 class TaskDataResult(BaseModel):
-    changed : bool
-    output : List[Any]
-    memento : Any
-    markers : List[Any]
-    status : int
+    changed : bool = dc.Field(default=True)
+    output : List[Any] = dc.Field(default_factory=list)
+    memento : Any = dc.Field(default=None)
+    markers : List[TaskMarker] = dc.Field(default_factory=list)
+    status : int = dc.Field(default=0)
 
 class TaskDataOutput(BaseModel):
     changed : bool

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/task_def.py

@@ -40,7 +40,7 @@ class TaskDef(BaseModel):
     doc : str = dc.Field(default="")
     depends : List[Union[str,TaskSpec]] = dc.Field(default_factory=list, alias="needs")
     params: List[ParamDef] = dc.Field(default_factory=list, alias="with")
-    out: List[TaskOutput] = dc.Field(default_factory=list)
+#    out: List[TaskOutput] = dc.Field(default_factory=list)
 
     def copy(self) -> 'TaskDef':
         ret = TaskDef(

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/task_graph_builder.py

@@ -25,7 +25,7 @@ import logging
 from .package import Package
 from .package_def import PackageDef, PackageSpec
 from .pkg_rgy import PkgRgy
-from .task import Task, TaskCtor, TaskSpec
+from .task import Task
 from typing import Dict, List
 
 @dc.dataclass
@@ -37,7 +37,7 @@ class TaskGraphBuilder(object):
     _pkg_s : List[Package] = dc.field(default_factory=list)
     _pkg_m : Dict[PackageSpec,Package] = dc.field(default_factory=dict)
     _pkg_spec_s : List[PackageDef] = dc.field(default_factory=list)
-    _task_m : Dict[TaskSpec,Task] = dc.field(default_factory=dict)
+    _task_m : Dict['TaskSpec',Task] = dc.field(default_factory=dict)
     _logger : logging.Logger = None
 
     def __post_init__(self):
@@ -173,7 +173,7 @@ class TaskGraphBuilder(object):
 
         return pkg
         
-    def getTaskCtor(self, spec : TaskSpec, pkg : PackageDef = None) -> 'TaskCtor':
+    def getTaskCtor(self, spec : 'TaskSpec', pkg : PackageDef = None) -> 'TaskCtor':
         self._logger.debug("--> getTaskCtor %s" % spec.name)
         spec_e = spec.name.split(".")
         task_name = spec_e[-1]

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/task_graph_runner.py

@@ -21,20 +21,19 @@
 #****************************************************************************
 import asyncio
 import os
-import yaml
 import dataclasses as dc
-from typing import Any, Callable, ClassVar, Dict, List
+from typing import Any, Callable, ClassVar, Dict, List, Tuple
 from .task import Task
 from .task_data import TaskData
+from .task_runner import TaskRunner
 
 @dc.dataclass
-class TaskGraphRunner(object):
+class TaskGraphRunner(TaskRunner):
     """Session manages execution of a task graph"""
 
-    rundir : str
-
     _inst : ClassVar['TaskGraphRunner'] = None
 
+
     # Search path for .dfs files
     create_subprocess : Callable = asyncio.create_subprocess_exec
     _root_dir : str = None

{dv_flow_mgr-0.0.1.13468776985a1 → dv_flow_mgr-0.0.1.13489806632a1}/src/dv_flow/mgr/task_graph_runner_local.py

@@ -30,7 +30,7 @@ from .fragment_def import FragmentDef
 from .package import Package
 from .pkg_rgy import PkgRgy
 from .package_def import PackageDef, PackageSpec
-from .task import Task, TaskSpec, TaskCtor
+from .task import Task
 from .task_data import TaskData
 from .task_graph_runner import TaskGraphRunner
 

dv_flow_mgr-0.0.1.13489806632a1/src/dv_flow/mgr/task_node.py

@@ -0,0 +1,80 @@
+
+import dataclasses as dc
+import logging
+from typing import Any, Callable, ClassVar, Dict, List
+from .task_data import TaskDataInput, TaskDataOutput, TaskDataResult
+from .task_params_ctor import TaskParamsCtor
+
+@dc.dataclass
+class TaskNode(object):
+    """Executable view of a task"""
+    # Ctor fields -- must specify on construction
+    name : str
+    srcdir : str
+    # This can be the resolved parameters
+    params : TaskParamsCtor 
+
+    task : Callable[['TaskRunner','TaskDataInput'],'TaskDataResult']
+
+    # Runtime fields -- these get populated during execution
+    changed : bool = False
+    needs : List['TaskNode'] = dc.field(default_factory=list)
+    rundir : str = dc.field(default=None)
+    output : TaskDataOutput = dc.field(default=None)
+
+    _log : ClassVar = logging.getLogger("TaskNode")
+
+    def __hash__(self):
+        return id(self)
+    
+@staticmethod
+def task(paramT):
+    def wrapper(T):
+        ctor = TaskNodeCtorWrapper(T.__name__, T, paramT)
+        return ctor
+    return wrapper
+
+@dc.dataclass
+class TaskNodeCtor(object):
+    """
+    Factory for a specific task type
+    - Produces a task parameters object, applying value-setting instructions
+    - Produces a TaskNode
+    """
+    name : str
+
+
+    def mkTaskNode(self, srcdir, params, name=None) -> TaskNode:
+        raise NotImplementedError("mkTaskNode in type %s" % str(type(self)))
+
+    def mkTaskParams(self, params : Dict) -> Any:
+        raise NotImplementedError("mkTaskParams in type %s" % str(type(self)))
+
+@dc.dataclass
+class TaskNodeCtorWrapper(TaskNodeCtor):
+    T : Any
+    paramT : Any
+
+    def __call__(self, 
+                 srcdir, 
+                 name=None, 
+                 params=None, 
+                 needs=None,
+                 **kwargs):
+        """Convenience method for direct creation of tasks"""
+        if params is None:
+            params = self.mkTaskParams(kwargs)
+        
+        node = self.mkTaskNode(srcdir, params, name)
+        if needs is not None:
+            node.needs.extend(needs)
+        return node
+
+    def mkTaskNode(self, srcdir, params, name=None) -> TaskNode:
+        node = TaskNode(name, srcdir, params, self.T)
+        return node
+
+    def mkTaskParams(self, params : Dict) -> Any:
+        obj = self.paramT()
+        # TODO: apply user-specified params
+        return obj

dv_flow_mgr-0.0.1.13489806632a1/src/dv_flow/mgr/task_params_ctor.py

@@ -0,0 +1,31 @@
+import dataclasses as dc
+from typing import Any, List
+
+
+@dc.dataclass
+class TaskParamsCtor(object):
+
+    paramT : Any = None
+    # List of parameter-setting sets, starting with inner-most
+    values : List[Any] = dc.field(default_factory=list)
+
+    def mk(self, input) -> Any:
+        params = self.paramT()
+
+        # Now, process each field 
+        for field in dc.fields(self.paramT):
+            # Find the outer-most setting of the value
+            last_value_i = -1
+            for i in range(len(self.values)-1, -1, -1):
+                if hasattr(self.values[i], field.name) and getattr(self.values[i], field.name) is not None:
+                    val = getattr(self.values[i], field.name)
+                    # TODO: check if 'val' is a set or mutator
+                    last_value_i = i
+                    break
+            for i in range(last_value_i, -1, -1):
+                if hasattr(self.values[i], field.name):
+                    val = getattr(self.values[i], field.name)
+                    setattr(params, field.name, val)
+
+        print("params: %s" % str(params))
+        return params