autorestart can be False, True, unexpected. Add exitcodes to .conf file

supervisord.conf_template

@@ -8,3 +8,6 @@
 startretries=3
 stopwaitsecs=10
 user=vmsuser
+autorestart=unexpected
+# SS$_NORMAL, SS$_FORCEX, SS$_EXITFORCED
+exitcodes=1,11228,11220

supervisord.py

@@ -41,7 +41,43 @@
 
 supervisorctl_pwd = ''
 
+TRUTHY_STRINGS = ('yes', 'true', 'on', '1')
+FALSY_STRINGS = ('no', 'false', 'off', '0')
+
+
+class RestartWhenExitUnexpected:
+    pass
+
+
+class RestartUnconditionally:
+    pass
+
+
+def auto_restart(
+    value: str,
+) -> (
+    Type[RestartUnconditionally]
+    | Type[RestartWhenExitUnexpected]
+    | Literal[False]
+):
+    value = str(value.lower())
+    computed_value = value
+    if value in TRUTHY_STRINGS:
+        computed_value = RestartUnconditionally
+    elif value in FALSY_STRINGS:
+        computed_value = False
+    elif value == 'unexpected':
+        computed_value = RestartWhenExitUnexpected
+    if computed_value not in (
+        RestartWhenExitUnexpected,
+        RestartUnconditionally,
+        False,
+    ):
+        raise ValueError("invalid 'autorestart' value %r" % value)
+    return computed_value
+
+
 class TimerItemType(IntEnum):
     UNDEF = 0
     PROC_STARTING = 1
     PROC_BACKOFF = 2
@@ -44,7 +80,8 @@
 class TimerItemType(IntEnum):
     UNDEF = 0
     PROC_STARTING = 1
     PROC_BACKOFF = 2
+    PROC_STOPPING = 3
 
 
 class TimerItem(object):
@@ -128,6 +165,12 @@
     remain_startretries: int
     timer_item = TimerItem | None
     kill_request: bool
+    autorestart: (
+        Type[RestartUnconditionally]
+        | Type[RestartWhenExitUnexpected]
+        | Literal[False]
+    )
+    exitcodes: List[int]
 
     def __init__(
         self,
@@ -141,6 +184,12 @@
         startsecs: int,
         startretries: int,
         stopwaitsecs: int,
+        autorestart: (
+            Type[RestartUnconditionally]
+            | Type[RestartWhenExitUnexpected]
+            | Literal[False]
+        ),
+        exitcodes: List[int],
     ):
         self.name = name
         self.user = user.encode()
@@ -155,6 +204,8 @@
         self.stopwaitsecs = stopwaitsecs
         self.timer_item = None
         self.kill_request = False
+        self.autorestart = autorestart
+        self.exitcodes = exitcodes
 
         self.process = ProcessInfo()
 
@@ -158,7 +209,7 @@
 
         self.process = ProcessInfo()
 
-    def process_is_running(self) -> bool:
+    def process_exists(self) -> bool:
         return self.process.pid in self.running_processes
 
     def process_is_backoff(self) -> bool:
@@ -167,7 +218,13 @@
     def process_is_fatal(self) -> bool:
         return self.process.state == ProcessStates.FATAL
 
+    def process_is_stopped(self) -> bool:
+        return self.process.state == ProcessStates.STOPPED
+
+    def process_is_stopping(self) -> bool:
+        return self.process.state == ProcessStates.STOPPING
+
     def set_running(self):
         self.process.state = ProcessStates.RUNNING
         self.remain_startretries = self.startretries + 1
 
@@ -170,7 +227,8 @@
     def set_running(self):
         self.process.state = ProcessStates.RUNNING
         self.remain_startretries = self.startretries + 1
 
-    def create_process(self, check_finalsts: bool = True):
+    # def create_process(self, check_finalsts: bool = True):
+    def create_process(self, from_terminated: bool):
         global supervisord_table_name
 
@@ -175,7 +233,15 @@
         global supervisord_table_name
 
-        if check_finalsts and self.process.finalsts in (
-            ssdef.SS__FORCEX,
-            ssdef.SS__EXITFORCED,
+        if self.kill_request:
+            return
+
+        if from_terminated:
+            # program has already been started
+            if not self.autorestart and self.process.finalsts is not None:
+                return
+
+            if (
+                self.autorestart is RestartWhenExitUnexpected
+                and self.process.finalsts in self.exitcodes
             ):
                 return
@@ -180,4 +246,5 @@
             ):
                 return
-        if self.process_is_running():
+
+        if self.process_exists():
             return
@@ -183,4 +250,5 @@
             return
+
         try:
             v = lib.get_logical(
                 self.process_name + b'_PID',
@@ -224,6 +292,7 @@
                 self.timer_item.cancel = True
                 self.timer_item = None
 
+        self.process.finalsts = None
         userpro = starlet.create_user_profile(usrnam=self.user)[1]
         persona_id = starlet.persona_create(usrpro=userpro)[1]
         persona_previous_id = starlet.persona_assume(persona_id)[1]
@@ -280,9 +349,13 @@
         )
 
     def kill(self):
-        if self.process_is_backoff():
-            self.process.state = ProcessStates.FATAL
+        if self.process_is_stopped():
+            return
+
+        if self.process_is_backoff() or self.process_is_fatal():
+            self.process.state = ProcessStates.STOPPED
+            self.remain_startretries = self.startretries + 1
             if self.timer_item:
                 self.timer_item.cancel = True
             self.timer_item = None
             return
@@ -285,12 +358,9 @@
             if self.timer_item:
                 self.timer_item.cancel = True
             self.timer_item = None
             return
-        if self.process_is_fatal():
-            self.process.state = ProcessStates.STOPPED
-            self.remain_startretries = self.startretries + 1
-            return
-        if not self.process_is_running():
+
+        if not self.process_exists() or self.kill_request:
             return
 
         self.kill_request = True
@@ -298,5 +368,6 @@
         pid = self.process.pid
         if self.process.state == ProcessStates.STOPPING:
             starlet.delprc(self.process.pid)
+        else:
             starlet.forcex(pid, code=ssdef.SS__FORCEX)
         self.process.state = ProcessStates.STOPPING
@@ -301,5 +372,11 @@
             starlet.forcex(pid, code=ssdef.SS__FORCEX)
         self.process.state = ProcessStates.STOPPING
+        if self.timer_item:
+            self.timer_item.cancel
+        self.timer_item = TimerItem(TimerItemType.PROC_STOPPING, self)
+        timer_queue.put(
+            PrioritizedItem(current_tick + self.stopwaitsecs, self.timer_item)
+        )
 
     def set_terminated(self, finalsts: int, end_time: datetime.datetime):
         global supervisord_table_name
@@ -432,6 +509,7 @@
     except OSError:
         pass
 
+
 def dispatch_cmd(res: bytes, fcmd_r: mbxqio.MBXQIO):
     global supervisorctl_pwd
     jscmd = json.loads(res)
@@ -518,8 +596,8 @@
                     f'{acc.acc_l_finalsts}'
                 )
                 pgm.set_terminated(acc.acc_l_finalsts, acc.acc_q_termtime)
-                if not stsdef.vms_status_success(acc.acc_l_finalsts):
-                    pgm.create_process()
+                # if not stsdef.vms_status_success(acc.acc_l_finalsts):
+                pgm.create_process(True)
             except KeyError:
                 pass
         case AstParamType.CMD:
@@ -542,5 +620,4 @@
                     timer_queue.put(itm)
                     return
                 itm.item.done = True
-                if itm.item.typ == TimerItemType.PROC_STARTING:
                 val: Program = itm.item.value
@@ -546,2 +623,4 @@
                 val: Program = itm.item.value
+                match itm.item.typ:
+                    case TimerItemType.PROC_STARTING:
                         val.set_running()
@@ -547,7 +626,8 @@
                         val.set_running()
-                elif itm.item.typ == TimerItemType.PROC_BACKOFF:
-                    val: Program = itm.item.value
-                    val.create_process()
+                    case TimerItemType.PROC_BACKOFF:
+                        val.create_process(False)
+                    case TimerItemType.PROC_STOPPING:
+                        val.kill()
 
 
 def run(chan: int, chancmd: int, chancmd_r: int):
@@ -562,7 +642,7 @@
 
         for pgm in Program.programs.values():
             if pgm.autostart:
-                pgm.create_process()
+                pgm.create_process(False)
 
         timer_astctx = vmsast.AstContext(vmsast.M_WAKE | vmsast.M_QUEUE)
         timer_astctx.param = AstParam(AstParamType.TIMER)
@@ -652,6 +732,10 @@
             startsecs = config[sn].getint('startsecs', 10)
             startretries = config[sn].getint('startretries', 3)
             stopwaitsecs = config[sn].getint('stopwaitsescs', 10)
+            autorestart = auto_restart(
+                config[sn].get('autorestart', 'unexpected')
+            )
+            exitcodes = config[sn].get('exitcodes', '1').split(',')
             user = config[sn]['user']
             p = Program(
                 name=name,
@@ -664,6 +748,10 @@
                 startsecs=startsecs,
                 startretries=startretries,
                 stopwaitsecs=stopwaitsecs,
+                autorestart=autorestart,
+                exitcodes=[
+                    int(exitcode) for exitcode in exitcodes if exitcode != ''
+                ],
             )
             Program.programs[name] = p
 
@@ -674,4 +762,3 @@
 
 if __name__ == '__main__':
     main()
-