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

    12

from threading import Lock, Condition

    13

import six

    14

from six.moves import _thread

    15

    16

    17

class job(object):

    18

    """

    19

    job to be executed by a worker

    20

    """

    21

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

    22

        self.job = (call, args, kwargs)

    23

        self.result = None

    24

        self.success = False

    25

        self.exc_info = None

    26

    27

    def do(self):

    28

        """

    29

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

    30

        """

    31

        try:

    32

            call, args, kwargs = self.job

    33

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

    34

            self.success = True

    35

        except Exception:

    36

            self.success = False

    37

            self.exc_info = sys.exc_info()

    38

    39

    40

class worker(object):

    41

    """

    42

    serialize main thread load/unload of PLC shared objects

    43

    """

    44

    def __init__(self):

    45

        # Only one job at a time

    46

        self._finish = False

    47

        self._threadID = None

    48

        self.mutex = Lock()

    49

        self.todo = Condition(self.mutex)

    50

        self.done = Condition(self.mutex)

    51

        self.free = Condition(self.mutex)

    52

        self.job = None

    53

    54

    def reraise(self, job):

    55

        """

    56

        reraise exception happend in a job

    57

        @param job: job where original exception happend

    58

        """

    59

        exc_type = job.exc_info[0]

    60

        exc_value = job.exc_info[1]

    61

        exc_traceback = job.exc_info[2]

    62

        six.reraise(exc_type, exc_value, exc_traceback)

    63

    64

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

    65

        """

    66

        meant to be called by worker thread (blocking)

    67

        """

    68

        self._threadID = _thread.get_ident()

    69

        self.mutex.acquire()

    70

        if args or kwargs:

    71

            _job = job(*args, **kwargs)

    72

            _job.do()

    73

            if not _job.success:

    74

                self.reraise(_job)

    75

    76

        while not self._finish:

    77

            self.todo.wait()

    78

            if self.job is not None:

    79

                self.job.do()

    80

                self.done.notify()

    81

            else:

    82

                break

    83

    84

        self.mutex.release()

    85

    86

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

    87

        """

    88

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

    89

        if job execution raise exception, re-raise same exception

    90

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

    91

        blocking until job done

    92

        """

    93

    94

        _job = job(*args, **kwargs)

    95

    96

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

    97

            # if caller is worker thread execute immediately

    98

            _job.do()

    99

        else:

   100

            # otherwise notify and wait for completion

   101

            self.mutex.acquire()

   102

   103

            while self.job is not None:

   104

                self.free.wait()

   105

   106

            self.job = _job

   107

            self.todo.notify()

   108

            self.done.wait()

   109

            self.job = None

   110

            self.free.notify()

   111

            self.mutex.release()

   112

   113

        if _job.success:

   114

            return _job.result

   115

        else:

   116

            self.reraise(_job)

   117

   118

    def quit(self):

   119

        """

   120

        unblocks main thread, and terminate execution of runloop()

   121

        """

   122

        # mark queue

   123

        self._finish = True

   124

        self.mutex.acquire()

   125

        self.job = None

   126

        self.todo.notify()

   127

        self.mutex.release()