1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz runtime.

     5

#

     6

# Copyright (C) 2018: Edouard TISSERANT

     7

#

     8

# See COPYING.Runtime file for copyrights details.

     9

    10

from __future__ import absolute_import

    11

import sys

    14

import six

    15

from six.moves import _thread

    16

    17

    18

class job(object):

    19

    """

    20

    job to be executed by a worker

    21

    """

    22

    def __init__(self, call, *args, **kwargs):

    23

        self.job = (call, args, kwargs)

    24

        self.result = None

    25

        self.success = None

    26

        self.exc_info = None

    27

    28

    def do(self):

    29

        """

    30

        do the job by executing the call, and deal with exceptions

    31

        """

    32

        try:

    33

            call, args, kwargs = self.job

    34

            self.result = call(*args, **kwargs)

    35

            self.success = True

    36

        except Exception:

    37

            self.success = False

    38

            self.exc_info = sys.exc_info()

    39

    40

    41

class worker(object):

    42

    """

    43

    serialize main thread load/unload of PLC shared objects

    44

    """

    45

    def __init__(self):

    46

        # Only one job at a time

    47

        self._finish = False

    48

        self._threadID = None

    49

        self.mutex = Lock()

    50

        self.todo = Condition(self.mutex)

    51

        self.done = Condition(self.mutex)

    52

        self.free = Condition(self.mutex)

    53

        self.job = None

    54

        self.enabled = False

    55

    56

    def reraise(self, job):

    57

        """

    58

        reraise exception happend in a job

    59

        @param job: job where original exception happend

    60

        """

    61

        exc_type = job.exc_info[0]

    62

        exc_value = job.exc_info[1]

    63

        exc_traceback = job.exc_info[2]

    64

        six.reraise(exc_type, exc_value, exc_traceback)

    65

    66

    def runloop(self, *args, **kwargs):

    67

        """

    68

        meant to be called by worker thread (blocking)

    69

        """

    70

        self._threadID = _thread.get_ident()

    71

        self.mutex.acquire()

    72

        self.enabled = True

    73

        if args or kwargs:

    74

            _job = job(*args, **kwargs)

    75

            _job.do()

    76

            # _job.success can't be None after do()

    77

            if not _job.success:

    78

                self.reraise(_job)

    79

    80

        while not self._finish:

    81

            self.todo.wait()

    82

            if self.job is not None:

    83

                self.job.do()

    84

                self.done.notify()

    85

            else:

    86

                break

    87

    88

        self.mutex.release()

    89

   141

    def call(self, *args, **kwargs):

   142

        """

   143

        creates a job, execute it in worker thread, and deliver result.

   144

        if job execution raise exception, re-raise same exception

   145

        meant to be called by non-worker threads, but this is accepted.

   146

        blocking until job done

   147

        """

   148

   149

        _job = job(*args, **kwargs)

   150

   151

        if self._threadID == _thread.get_ident():

   152

            # if caller is worker thread execute immediately

   153

            _job.do()

   154

        else:

   155

            # otherwise notify and wait for completion

   156

            self.mutex.acquire()

   157

            if not self.enabled:

   158

                self.mutex.release()

   159

                raise EOFError("Worker is disabled")

   160

   161

            while self.job is not None:

   162

                self.free.wait()

   163

   164

            self.job = _job

   165

            self.todo.notify()

   166

            self.done.wait()

   167

            self.job = None

   168

            self.free.notify()

   169

            self.mutex.release()

   170

   171

        if _job.success is None:

   172

            raise EOFError("Worker job was interrupted")

   173

   174

        if _job.success:

   175

            return _job.result

   176

        else:

   177

            self.reraise(_job)

   178

   179

    def quit(self):

   180

        """

   181

        unblocks main thread, and terminate execution of runloop()

   182

        """

   183

        # mark queue

   184

        self._finish = True

   185

        self.mutex.acquire()

   186

        self.enabled = False

   187

        self.job = None

   188

        self.todo.notify()

   189

        self.done.notify()

   190

        self.mutex.release()