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

import thread

    13

from threading import Lock, Condition

    14

    15

    16

class job(object):

    17

    """

    18

    job to be executed by a worker

    19

    """

    20

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

    21

        self.job = (call, args, kwargs)

    22

        self.result = None

    23

        self.success = False

    24

        self.exc_info = None

    25

    26

    def do(self):

    27

        """

    28

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

    29

        """

    30

        try:

    31

            call, args, kwargs = self.job

    32

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

    33

            self.success = True

    34

        except Exception:

    35

            self.success = False

    36

            self.exc_info = sys.exc_info()

    37

    38

    39

class worker(object):

    40

    """

    41

    serialize main thread load/unload of PLC shared objects

    42

    """

    43

    def __init__(self):

    44

        # Only one job at a time

    45

        self._finish = False

    46

        self._threadID = None

    47

        self.mutex = Lock()

    48

        self.todo = Condition(self.mutex)

    49

        self.done = Condition(self.mutex)

    50

        self.free = Condition(self.mutex)

    51

        self.job = None

    52

    53

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

    54

        """

    55

        meant to be called by worker thread (blocking)

    56

        """

    57

        self._threadID = thread.get_ident()

    58

        if args or kwargs:

    59

            _job = job(*args, **kwargs)

    60

            _job.do()

    61

            if _job.success:

    62

                # result is ignored

    63

                pass

    64

            else:

    65

                raise _job.exc_info[0], _job.exc_info[1], _job.exc_info[2]

    66

        self.mutex.acquire()

    67

        while not self._finish:

    68

            self.todo.wait()

    69

            if self.job is not None:

    70

                self.job.do()

    71

                self.done.notify()

    72

            else:

    73

                self.free.notify()

    74

        self.mutex.release()

    75

    76

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

    77

        """

    78

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

    79

        if job execution raise exception, re-raise same exception

    80

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

    81

        blocking until job done

    82

        """

    83

    84

        _job = job(*args, **kwargs)

    85

    86

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

    87

            # if caller is worker thread execute immediately

    88

            _job.do()

    89

        else:

    90

            # otherwise notify and wait for completion

    91

            self.mutex.acquire()

    92

    93

            while self.job is not None:

    94

                self.free.wait()

    95

    96

            self.job = _job

    97

            self.todo.notify()

    98

            self.done.wait()

    99

            _job = self.job

   100

            self.job = None

   101

            self.mutex.release()

   102

   103

        if _job.success:

   104

            return _job.result

   105

        else:

   106

            raise _job.exc_info[0], _job.exc_info[1], _job.exc_info[2]

   107

   108

    def quit(self):

   109

        """

   110

        unblocks main thread, and terminate execution of runloop()

   111

        """

   112

        # mark queue

   113

        self._finish = True

   114

        self.mutex.acquire()

   115

        self.job = None

   116

        self.todo.notify()

   117

        self.mutex.release()