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

class job(object):

    16

    """

    17

    job to be executed by a worker

    18

    """

    19

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

    20

        self.job = (call, args, kwargs)

    21

        self.result = None

    22

        self.success = False

    23

        self.exc_info = None

    24

    25

    def do(self):

    26

        """

    27

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

    28

        """

    29

        try:

    30

            call, args, kwargs = self.job

    31

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

    32

            self.success = True

    33

        except Exception:

    34

            self.success = False

    35

            self.exc_info = sys.exc_info()

    36

    37

    38

class worker(object):

    39

    """

    40

    serialize main thread load/unload of PLC shared objects

    41

    """

    42

    def __init__(self):

    43

        # Only one job at a time

    44

        self._finish = False

    45

        self._threadID = None

    46

        self.mutex = Lock()

    47

        self.todo = Condition(self.mutex)

    48

        self.done = Condition(self.mutex)

    49

        self.free = Condition(self.mutex)

    50

        self.job = None

    51

    52

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

    53

        """

    54

        meant to be called by worker thread (blocking)

    55

        """

    56

        self._threadID = thread.get_ident()

    57

        if args or kwargs:

    58

            _job = job(*args, **kwargs)

    59

            _job.do()

    60

            if _job.success:

    61

                # result is ignored

    62

                pass

    63

            else:

    64

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

    65

        self.mutex.acquire()

    66

        while not self._finish:

    67

            self.todo.wait()

    68

            if self.job is not None:

    69

                self.job.do()

    70

                self.done.notify()

    71

            else:

    72

                self.free.notify()

    73

        self.mutex.release()

    74

    75

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

    76

        """

    77

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

    78

        if job execution raise exception, re-raise same exception

    79

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

    80

        blocking until job done

    81

        """

    82

    83

        _job = job(*args, **kwargs)

    84

    85

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

    86

            # if caller is worker thread execute immediately

    87

            _job.do()

    88

        else:

    89

            # otherwise notify and wait for completion

    90

            self.mutex.acquire()

    91

    92

            while self.job is not None:

    93

                self.free.wait()

    94

    95

            self.job = _job

    96

            self.todo.notify()

    97

            self.done.wait()

    98

            _job = self.job

    99

            self.job = None

   100

            self.mutex.release()

   101

   102

        if _job.success:

   103

            return _job.result

   104

        else:

   105

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

   106

   107

    def quit(self):

   108

        """

   109

        unblocks main thread, and terminate execution of runloop()

   110

        """

   111

        # mark queue

   112

        self._finish = True

   113

        self.mutex.acquire()

   114

        self.job = None

   115

        self.todo.notify()

   116

        self.mutex.release()