1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of Beremiz, a Integrated Development Environment for

     5

#programming IEC 61131-3 automates supporting plcopen standard and CanFestival. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import Pyro.core as pyro

    26

from threading import Timer, Thread, Lock

    27

import ctypes, os, commands, types, sys

    28

    29

if os.name in ("nt", "ce"):

    30

    from _ctypes import LoadLibrary as dlopen

    31

    from _ctypes import FreeLibrary as dlclose

    32

elif os.name == "posix":

    33

    from _ctypes import dlopen, dlclose

    34

    35

import traceback

    36

    37

lib_ext ={

    38

     "linux2":".so",

    39

     "win32":".dll",

    40

     }.get(sys.platform, "")

    41

    42

def PLCprint(message):

    43

    sys.stdout.write("PLCobject : "+message+"\n")

    44

    sys.stdout.flush()

    45

    46

class PLCObject(pyro.ObjBase):

    47

    _Idxs = []

    48

    def __init__(self, workingdir, daemon, argv, statuschange, evaluator, website):

    49

        pyro.ObjBase.__init__(self)

    50

        self.evaluator = evaluator

    51

        self.argv = [workingdir] + argv # force argv[0] to be "path" to exec...

    52

        self.workingdir = workingdir

    53

        self.PLCStatus = "Stopped"

    54

        self.PLClibraryHandle = None

    55

        self.PLClibraryLock = Lock()

    56

        self.DummyIteratorLock = None

    57

        # Creates fake C funcs proxies

    58

        self._FreePLC()

    59

        self.daemon = daemon

    60

        self.statuschange = statuschange

    61

        self.hmi_frame = None

    62

        self.website = website

    63

    64

        # Get the last transfered PLC if connector must be restart

    65

        try:

    66

            self.CurrentPLCFilename=open(

    67

                             self._GetMD5FileName(),

    68

                             "r").read().strip() + lib_ext

    69

        except Exception, e:

    70

            self.PLCStatus = "Empty"

    71

            self.CurrentPLCFilename=None

    72

    73

    def StatusChange(self):

    74

        if self.statuschange is not None:

    75

            self.statuschange(self.PLCStatus)

    76

    77

    def _GetMD5FileName(self):

    78

        return os.path.join(self.workingdir, "lasttransferedPLC.md5")

    79

    80

    def _GetLibFileName(self):

    81

        return os.path.join(self.workingdir,self.CurrentPLCFilename)

    82

    83

    84

    def _LoadNewPLC(self):

    85

        """

    86

        Load PLC library

    87

        Declare all functions, arguments and return values

    88

        """

    89

        PLCprint("Load PLC")

    90

        try:

    91

            self._PLClibraryHandle = dlopen(self._GetLibFileName())

    92

            self.PLClibraryHandle = ctypes.CDLL(self.CurrentPLCFilename, handle=self._PLClibraryHandle)

    93

    94

            self._startPLC = self.PLClibraryHandle.startPLC

    95

            self._startPLC.restype = ctypes.c_int

    96

            self._startPLC.argtypes = [ctypes.c_int, ctypes.POINTER(ctypes.c_char_p)]

    97

    98

            self.DummyIteratorLock = Lock()

    99

            self.DummyIteratorLock.acquire()

   100

   101

            self._PythonIterator = getattr(self.PLClibraryHandle, "PythonIterator", None)

   102

            if self._PythonIterator is not None:

   103

                self._PythonIterator.restype = ctypes.c_char_p

   104

                self._PythonIterator.argtypes = [ctypes.c_char_p]

   105

   106

                def StopPLCLock():

   107

                    self.PLClibraryLock.acquire()

   108

                    self.PLClibraryHandle.stopPLC()

   109

                    self.PLClibraryLock.release()

   110

   111

            else:

   112

                def DummyIterator(res):

   113

                    self.DummyIteratorLock.acquire()

   114

                    self.DummyIteratorLock.release()

   115

                    return None

   116

                self._PythonIterator = DummyIterator

   117

   118

                def StopPLCLock():

   119

                    self.PLClibraryLock.acquire()

   120

                    self.PLClibraryHandle.stopPLC()

   121

                    self.DummyIteratorLock.release()

   122

                    self.PLClibraryLock.release()

   123

   124

            self._stopPLC = StopPLCLock

   125

            self._stopPLC.restype = None

   126

   127

            self._ResetDebugVariables = self.PLClibraryHandle.ResetDebugVariables

   128

            self._ResetDebugVariables.restype = None

   129

   130

            self._RegisterDebugVariable = self.PLClibraryHandle.RegisterDebugVariable

   131

            self._RegisterDebugVariable.restype = None

   132

            self._RegisterDebugVariable.argtypes = [ctypes.c_int]

   133

   134

            self._IterDebugData = self.PLClibraryHandle.IterDebugData

   135

            self._IterDebugData.restype = ctypes.c_void_p

   136

            self._IterDebugData.argtypes = [ctypes.POINTER(ctypes.c_int), ctypes.POINTER(ctypes.c_char_p)]

   137

   138

            self._FreeDebugData = self.PLClibraryHandle.FreeDebugData

   139

            self._FreeDebugData.restype = None

   140

   141

            self._WaitDebugData = self.PLClibraryHandle.WaitDebugData

   142

            self._WaitDebugData.restype = ctypes.c_int  

   143

   144

            self._suspendDebug = self.PLClibraryHandle.suspendDebug

   145

            self._suspendDebug.restype = None

   146

   147

            self._resumeDebug = self.PLClibraryHandle.resumeDebug

   148

            self._resumeDebug.restype = None

   149

   150

            return True

   151

        except:

   152

            PLCprint(traceback.format_exc())

   153

            return False

   154

   155

    def _FreePLC(self):

   156

        """

   157

        Unload PLC library.

   158

        This is also called by __init__ to create dummy C func proxies

   159

        """

   160

        self.PLClibraryLock.acquire()

   161

        # Forget all refs to library

   162

        self._startPLC = lambda:None

   163

        self._stopPLC = lambda:None

   164

        self._ResetDebugVariables = lambda:None

   165

        self._RegisterDebugVariable = lambda x:None

   166

        self._IterDebugData = lambda x,y:None

   167

        self._FreeDebugData = lambda:None

   168

        self._WaitDebugData = lambda:-1

   169

        self._suspendDebug = lambda:None

   170

        self._resumeDebug = lambda:None

   171

        self._PythonIterator = lambda:""

   172

        self.PLClibraryHandle = None

   173

        # Unload library explicitely

   174

        if getattr(self,"_PLClibraryHandle",None) is not None:

   175

            dlclose(self._PLClibraryHandle)

   176

            self._PLClibraryHandle = None

   177

   178

        self.PLClibraryLock.release()

   179

        return False

   180

   181

    def PrepareRuntimePy(self):

   182

        self.python_threads_vars = globals().copy()

   183

        self.python_threads_vars["WorkingDir"] = self.workingdir

   184

        self.python_threads_vars["website"] = self.website

   185

        self.python_threads_vars["_runtime_begin"] = []

   186

        self.python_threads_vars["_runtime_cleanup"] = []

   187

   188

        for filename in os.listdir(self.workingdir):

   189

            name, ext = os.path.splitext(filename)

   190

            if name.upper().startswith("RUNTIME") and ext.upper() == ".PY":

   191

                try:

   192

                    # TODO handle exceptions in runtime.py

   193

                    # pyfile may redefine _runtime_cleanup

   194

                    # or even call _PythonThreadProc itself.

   195

                    execfile(os.path.join(self.workingdir, filename), self.python_threads_vars)

   196

                except:

   197

                    PLCprint(traceback.format_exc())

   198

                runtime_begin = self.python_threads_vars.get("_%s_begin" % name, None)

   199

                if runtime_begin is not None:

   200

                    self.python_threads_vars["_runtime_begin"].append(runtime_begin)

   201

                runtime_cleanup = self.python_threads_vars.get("_%s_cleanup" % name, None)

   202

                if runtime_cleanup is not None:

   203

                    self.python_threads_vars["_runtime_cleanup"].append(runtime_cleanup)

   204

   205

        for runtime_begin in self.python_threads_vars.get("_runtime_begin", []):

   206

            runtime_begin()

   207

   208

        if self.website is not None:

   209

            self.website.PLCStarted()

   210

   211

    def FinishRuntimePy(self):

   212

        for runtime_cleanup in self.python_threads_vars.get("_runtime_cleanup", []):

   213

            runtime_cleanup()    

   214

        if self.website is not None:

   215

            self.website.PLCStopped()

   216

        self.python_threads_vars = None

   217

   218

    def PythonThreadProc(self, debug):

   219

        PLCprint("PythonThreadProc started")

   220

        c_argv = ctypes.c_char_p * len(self.argv)

   221

        error = None

   222

        if self._LoadNewPLC():

   223

            if self._startPLC(len(self.argv),c_argv(*self.argv)) == 0:

   224

                if debug:

   225

                    for idx in self._Idxs:

   226

                        self._RegisterDebugVariable(idx)

   227

                    self._resumeDebug()

   228

                self.PLCStatus = "Started"

   229

                self.StatusChange()

   230

                self.evaluator(self.PrepareRuntimePy)

   231

                res,cmd = "None","None"

   232

                while True:

   233

                    #print "_PythonIterator(", res, ")",

   234

                    cmd = self._PythonIterator(res)

   235

                    #print " -> ", cmd

   236

                    if cmd is None:

   237

                        break

   238

                    try :

   239

                        res = str(self.evaluator(eval,cmd,self.python_threads_vars))

   240

                    except Exception,e:

   241

                        res = "#EXCEPTION : "+str(e)

   242

                        PLCprint(res)

   243

                self.PLCStatus = "Stopped"

   244

                self.StatusChange()

   245

                self.evaluator(self.FinishRuntimePy)

   246

            else:

   247

                error = "starting"

   248

        else:

   249

            error = "loading"

   250

        if error is not None:

   251

            PLCprint("Problem %s PLC"%error)

   252

            self.PLCStatus = "Broken"

   253

        self._FreePLC()

   254

        PLCprint("PythonThreadProc interrupted")

   255

   256

    def StartPLC(self, debug=False):

   257

        PLCprint("StartPLC")

   258

        if self.CurrentPLCFilename is not None:

   259

            self.PLCStatus = "Starting"

   260

            self.PythonThread = Thread(target=self.PythonThreadProc, args=[debug])

   261

            self.PythonThread.start()

   262

   263

    def StopPLC(self):

   264

        PLCprint("StopPLC")

   265

        if self.PLCStatus == "Started":

   266

            self._stopPLC()

   267

            return True

   268

        return False

   269

   270

    def _Reload(self):

   271

        self.daemon.shutdown(True)

   272

        self.daemon.sock.close()

   273

        os.execv(sys.executable,[sys.executable]+sys.argv[:])

   274

        # never reached

   275

        return 0

   276

   277

    def ForceReload(self):

   278

        # respawn python interpreter

   279

        Timer(0.1,self._Reload).start()

   280

        return True

   281

   282

    def GetPLCstatus(self):

   283

        return self.PLCStatus

   284

   285

    def NewPLC(self, md5sum, data, extrafiles):

   286

        PLCprint("NewPLC (%s)"%md5sum)

   287

        if self.PLCStatus in ["Stopped", "Empty", "Broken"]:

   288

            NewFileName = md5sum + lib_ext

   289

            extra_files_log = os.path.join(self.workingdir,"extra_files.txt")

   290

            try:

   291

                os.remove(os.path.join(self.workingdir,

   292

                                       self.CurrentPLCFilename))

   293

                for filename in file(extra_files_log, "r").readlines() + [extra_files_log]:

   294

                    try:

   295

                        os.remove(os.path.join(self.workingdir, filename.strip()))

   296

                    except:

   297

                        pass

   298

            except:

   299

                pass

   300

   301

            try:

   302

                # Create new PLC file

   303

                open(os.path.join(self.workingdir,NewFileName),

   304

                     'wb').write(data)

   305

   306

                # Store new PLC filename based on md5 key

   307

                open(self._GetMD5FileName(), "w").write(md5sum)

   308

   309

                # Then write the files

   310

                log = file(extra_files_log, "w")

   311

                for fname,fdata in extrafiles:

   312

                    fpath = os.path.join(self.workingdir,fname)

   313

                    open(fpath, "wb").write(fdata)

   314

                    log.write(fname+'\n')

   315

   316

                # Store new PLC filename

   317

                self.CurrentPLCFilename = NewFileName

   318

            except:

   319

                PLCprint(traceback.format_exc())

   320

                return False

   321

            if self.PLCStatus == "Empty":

   322

                self.PLCStatus = "Stopped"

   323

            return True

   324

        return False

   325

   326

    def MatchMD5(self, MD5):

   327

        try:

   328

            last_md5 = open(self._GetMD5FileName(), "r").read()

   329

            return last_md5 == MD5

   330

        except:

   331

            return False

   332

   333

    def SetTraceVariablesList(self, idxs):

   334

        """

   335

        Call ctype imported function to append 

   336

        these indexes to registred variables in PLC debugger

   337

        """

   338

        self._suspendDebug()

   339

        # keep a copy of requested idx

   340

        self._Idxs = idxs[:]

   341

        self._ResetDebugVariables()

   342

        for idx in idxs:

   343

            self._RegisterDebugVariable(idx)

   344

        self._resumeDebug()

   345

   346

    class IEC_STRING(ctypes.Structure):

   347

        """

   348

        Must be changed according to changes in iec_types.h

   349

        """

   350

        _fields_ = [("len", ctypes.c_uint8),

   351

                    ("body", ctypes.c_char * 127)] 

   352

   353

    TypeTranslator = {"BOOL" :       (ctypes.c_uint8, lambda x:x.value!=0),

   354

                      "STEP" :       (ctypes.c_uint8, lambda x:x.value),

   355

                      "TRANSITION" : (ctypes.c_uint8, lambda x:x.value),

   356

                      "ACTION" :     (ctypes.c_uint8, lambda x:x.value),

   357

                      "SINT" :       (ctypes.c_int8, lambda x:x.value),

   358

                      "USINT" :      (ctypes.c_uint8, lambda x:x.value),

   359

                      "BYTE" :       (ctypes.c_uint8, lambda x:x.value),

   360

                      "STRING" :     (IEC_STRING, lambda x:x.body[:x.len]),

   361

                      "INT" :        (ctypes.c_int16, lambda x:x.value),

   362

                      "UINT" :       (ctypes.c_uint16, lambda x:x.value),

   363

                      "WORD" :       (ctypes.c_uint16, lambda x:x.value),

   364

                      "WSTRING" :    (None, None),#TODO

   365

                      "DINT" :       (ctypes.c_int32, lambda x:x.value),

   366

                      "UDINT" :      (ctypes.c_uint32, lambda x:x.value),

   367

                      "DWORD" :      (ctypes.c_uint32, lambda x:x.value),

   368

                      "LINT" :       (ctypes.c_int64, lambda x:x.value),

   369

                      "ULINT" :      (ctypes.c_uint64, lambda x:x.value),

   370

                      "LWORD" :      (ctypes.c_uint64, lambda x:x.value),

   371

                      "REAL" :       (ctypes.c_float, lambda x:x.value),

   372

                      "LREAL" :      (ctypes.c_double, lambda x:x.value),

   373

                      } 

   374

   375

    def GetTraceVariables(self):

   376

        """

   377

        Return a list of variables, corresponding to the list of required idx

   378

        """

   379

        if self.PLCStatus == "Started":

   380

            self.PLClibraryLock.acquire()

   381

            tick = self._WaitDebugData()

   382

            #PLCprint("Debug tick : %d"%tick)

   383

            if tick == 2**32 - 1:

   384

                tick = -1

   385

                res = None

   386

            else:

   387

                idx = ctypes.c_int()

   388

                typename = ctypes.c_char_p()

   389

                res = []

   390

   391

                for given_idx in self._Idxs:

   392

                    buffer=self._IterDebugData(ctypes.byref(idx), ctypes.byref(typename))

   393

                    c_type,unpack_func = self.TypeTranslator.get(typename.value, (None,None))

   394

                    if c_type is not None and given_idx == idx.value:

   395

                        res.append(unpack_func(ctypes.cast(buffer,

   396

                                                           ctypes.POINTER(c_type)).contents))

   397

                    else:

   398

                        PLCprint("Debug error idx : %d, expected_idx %d, type : %s"%(idx.value, given_idx,typename.value))

   399

                        res.append(None)

   400

            self._FreeDebugData()

   401

            self.PLClibraryLock.release()

   402

            return tick, res

   403

        return -1, None

   404