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

    29

    30

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

    31

    from _ctypes import LoadLibrary as dlopen

    32

    from _ctypes import FreeLibrary as dlclose

    33

elif os.name == "posix":

    34

    from _ctypes import dlopen, dlclose

    35

    36

import os,sys,traceback

    37

    38

lib_ext ={

    39

     "linux2":".so",

    40

     "win32":".dll",

    41

     }.get(sys.platform, "")

    42

    43

def PLCprint(message):

    44

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

    45

    sys.stdout.flush()

    46

    47

class PLCObject(pyro.ObjBase):

    48

    _Idxs = []

    50

        pyro.ObjBase.__init__(self)

    52

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

    53

        self.workingdir = workingdir

    54

        self.PLCStatus = "Stopped"

    55

        self.PLClibraryHandle = None

    56

        # Creates fake C funcs proxies

    57

        self._FreePLC()

    58

        self.daemon = daemon

    59

        self.statuschange = statuschange

    60

        self.python_threads_vars = None

    62

    63

        # Get the last transfered PLC if connector must be restart

    64

        try:

    65

            self.CurrentPLCFilename=open(

    66

                             self._GetMD5FileName(),

    67

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

    68

        except Exception, e:

    69

            self.PLCStatus = "Empty"

    70

            self.CurrentPLCFilename=None

    71

    72

    def StatusChange(self):

    73

        if self.statuschange is not None:

    74

            self.statuschange(self.PLCStatus)

    75

    76

    def _GetMD5FileName(self):

    77

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

    78

    79

    def _GetLibFileName(self):

    80

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

    81

    82

    83

    def _LoadNewPLC(self):

    84

        """

    85

        Load PLC library

    86

        Declare all functions, arguments and return values

    87

        """

    88

        PLCprint("Load PLC")

    89

        try:

    90

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

    91

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

    92

    93

            self._startPLC = self.PLClibraryHandle.startPLC

    94

            self._startPLC.restype = ctypes.c_int

    95

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

    96

    97

            self._stopPLC = self.PLClibraryHandle.stopPLC

    98

            self._stopPLC.restype = None

    99

   100

            self._ResetDebugVariables = self.PLClibraryHandle.ResetDebugVariables

   101

            self._ResetDebugVariables.restype = None

   102

   103

            self._RegisterDebugVariable = self.PLClibraryHandle.RegisterDebugVariable

   104

            self._RegisterDebugVariable.restype = None

   105

            self._RegisterDebugVariable.argtypes = [ctypes.c_int]

   106

   107

            self._IterDebugData = self.PLClibraryHandle.IterDebugData

   108

            self._IterDebugData.restype = ctypes.c_void_p

   109

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

   110

   111

            self._FreeDebugData = self.PLClibraryHandle.FreeDebugData

   112

            self._FreeDebugData.restype = None

   113

   114

            self._WaitDebugData = self.PLClibraryHandle.WaitDebugData

   115

            self._WaitDebugData.restype = ctypes.c_int  

   116

   117

            self._suspendDebug = self.PLClibraryHandle.suspendDebug

   118

            self._suspendDebug.restype = None

   119

   120

            self._resumeDebug = self.PLClibraryHandle.resumeDebug

   121

            self._resumeDebug.restype = None

   122

   123

            self._PythonIterator = self.PLClibraryHandle.PythonIterator

   124

            self._PythonIterator.restype = ctypes.c_char_p

   125

            self._PythonIterator.argtypes = [ctypes.c_char_p]

   126

   127

            return True

   128

        except:

   129

            PLCprint(traceback.format_exc())

   130

            return False

   131

   132

    def _FreePLC(self):

   133

        """

   134

        Unload PLC library.

   135

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

   136

        """

   137

        # Forget all refs to library

   138

        self._startPLC = lambda:None

   139

        self._stopPLC = lambda:None

   140

        self._ResetDebugVariables = lambda:None

   141

        self._RegisterDebugVariable = lambda x:None

   142

        self._IterDebugData = lambda x,y:None

   143

        self._FreeDebugData = lambda:None

   144

        self._WaitDebugData = lambda:-1

   145

        self._suspendDebug = lambda:None

   146

        self._resumeDebug = lambda:None

   147

        self._PythonIterator = lambda:""

   148

        self.PLClibraryHandle = None

   149

        # Unload library explicitely

   150

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

   151

            PLCprint("Unload PLC")

   152

            dlclose(self._PLClibraryHandle)

   153

            res = self._DetectDirtyLibs()

   154

        else:

   155

            res = False

   156

   157

        self._PLClibraryHandle = None

   158

   159

        return res

   160

   161

    def _DetectDirtyLibs(self):

   162

        # Detect dirty libs

   163

        # Get lib dependencies (for dirty lib detection)

   164

        if os.name == "posix":

   165

            # parasiting libs listed with ldd

   166

            badlibs = [ toks.split()[0] for toks in commands.getoutput(

   167

                            "ldd "+self._GetLibFileName()).splitlines() ]

   168

            for badlib in badlibs:

   169

                if badlib[:6] in ["libwx_",

   170

                                  "libwxs",

   171

                                  "libgtk",

   172

                                  "libgdk",

   173

                                  "libatk",

   174

                                  "libpan",

   175

                                  "libX11",

   176

                                  ]:

   177

                    #badhandle = dlopen(badlib, dl.RTLD_NOLOAD)

   178

                    PLCprint("Dirty lib detected :" + badlib)

   179

                    #dlclose(badhandle)

   180

                    return True

   181

        return False

   182

   183

    def PrepareRuntimePy(self):

   184

        self.python_threads_vars = globals().copy()

   185

        pyfile = os.path.join(self.workingdir, "runtime.py")

   187

        if os.path.exists(pyfile):

   188

            try:

   189

                # TODO handle exceptions in runtime.py

   190

                # pyfile may redefine _runtime_cleanup

   191

                # or even call _PythonThreadProc itself.

   194

                execfile(pyfile, self.python_threads_vars)

   206

            except:

   207

                PLCprint(traceback.format_exc())

   208

   209

    def BeginRuntimePy(self):

   210

        runtime_begin = self.python_threads_vars.get("_runtime_begin",None)

   211

        if runtime_begin is not None:

   213

   214

    def FinishRuntimePy(self):

   215

        runtime_cleanup = self.python_threads_vars.get("_runtime_cleanup",None)

   216

        if runtime_cleanup is not None:

   220

        self.python_threads_vars = None

   221

   222

    def PythonThreadProc(self):

   223

        PLCprint("PythonThreadProc started")

   224

        self.BeginRuntimePy()

   225

        res,cmd = "None","None"

   226

        while self.PLCStatus == "Started":

   227

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

   228

            cmd = self._PythonIterator(res)

   229

            #print " -> ", cmd

   230

            if cmd is None:

   231

                break

   232

            try :

   234

            except Exception,e:

   235

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

   236

                PLCprint(res)

   237

        PLCprint("PythonThreadProc interrupted")

   238

   239

    def StartPLC(self, debug=False):

   240

        PLCprint("StartPLC")

   241

        if self.CurrentPLCFilename is not None and self.PLCStatus == "Stopped":

   242

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

   243

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

   244

                if debug:

   245

                    self._resumeDebug()

   246

                self.PLCStatus = "Started"

   247

                self.StatusChange()

   249

                self.PythonThread = Thread(target=self.PythonThreadProc)

   250

                self.PythonThread.start()

   251

                return True

   252

            else:

   253

                PLCprint("Problem starting PLC")

   254

                self._DoStopPLC()

   255

        return False

   256

   257

    def _DoStopPLC(self):

   258

        self._stopPLC()

   259

        self.PLCStatus = "Stopped"

   260

        self.PythonThread.join(timeout=1)

   261

        if self.PythonThread.isAlive():

   262

            PLCprint("Python thread couldn't be killed")

   263

        self.FinishRuntimePy()

   264

        if self._FreePLC():

   265

            self.PLCStatus = "Dirty"

   266

        self.StatusChange()

   267

        return True

   268

   269

    def StopPLC(self):

   270

        if self.PLCStatus == "Started":

   271

            self._DoStopPLC()

   272

            return True

   273

        return False

   274

   275

    def _Reload(self):

   276

        self.daemon.shutdown(True)

   277

        self.daemon.sock.close()

   278

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

   279

        # never reached

   280

        return 0

   281

   282

    def ForceReload(self):

   283

        # respawn python interpreter

   284

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

   285

        return True

   286

   287

    def GetPLCstatus(self):

   288

        return self.PLCStatus

   289

   290

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

   291

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

   292

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

   293

            NewFileName = md5sum + lib_ext

   294

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

   295

            try:

   296

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

   297

                                       self.CurrentPLCFilename))

   298

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

   299

                    try:

   300

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

   301

                    except:

   302

                        pass

   303

            except:

   304

                pass

   305

   306

            try:

   307

                # Create new PLC file

   308

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

   309

                     'wb').write(data)

   310

   311

                # Store new PLC filename based on md5 key

   312

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

   313

   314

                # Then write the files

   315

                log = file(extra_files_log, "w")

   316

                for fname,fdata in extrafiles:

   317

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

   318

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

   319

                    log.write(fname+'\n')

   320

   321

                # Store new PLC filename

   322

                self.CurrentPLCFilename = NewFileName

   323

            except:

   324

                PLCprint(traceback.format_exc())

   325

                return False

   326

            if self.PLCStatus == "Empty":

   327

                self.PLCStatus = "Stopped"

   328

            return True

   329

        return False

   330

   331

    def MatchMD5(self, MD5):

   332

        try:

   333

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

   334

            return last_md5 == MD5

   335

        except:

   336

            return False

   337

   338

    def SetTraceVariablesList(self, idxs):

   339

        """

   340

        Call ctype imported function to append 

   341

        these indexes to registred variables in PLC debugger

   342

        """

   343

        self._suspendDebug()

   344

        # keep a copy of requested idx

   345

        self._Idxs = idxs[:]

   346

        self._ResetDebugVariables()

   347

        for idx in idxs:

   348

            self._RegisterDebugVariable(idx)

   349

        self._resumeDebug()

   350

   351

    class IEC_STRING(ctypes.Structure):

   352

        """

   353

        Must be changed according to changes in iec_types.h

   354

        """

   355

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

   356

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

   357

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

                      } 

   379

   380

    def GetTraceVariables(self):

   381

        """

   382

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

   383

        """

   384

        if self.PLCStatus == "Started":

   385

            tick = self._WaitDebugData()

   386

            if tick == -1:

   387

                res = None

   388

            else:

   389

                idx = ctypes.c_int()

   390

                typename = ctypes.c_char_p()

   391

                res = []

   392

   393

                for given_idx in self._Idxs:

   394

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

   395

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

   396

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

   397

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

   398

                                                           ctypes.POINTER(c_type)).contents))

   399

                    else:

   400

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

   401

                        res.append(None)

   402

            self._FreeDebugData()

   403

            return tick, res

   404

        return -1, None

   405

   406

   407