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):

    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

        # Creates fake C funcs proxies

    57

        self._FreePLC()

    58

        self.daemon = daemon

    59

        self.statuschange = statuschange

    60

        self.hmi_frame = None

    61

    62

        # Get the last transfered PLC if connector must be restart

    63

        try:

    64

            self.CurrentPLCFilename=open(

    65

                             self._GetMD5FileName(),

    66

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

    67

        except Exception, e:

    68

            self.PLCStatus = "Empty"

    69

            self.CurrentPLCFilename=None

    70

    71

    def StatusChange(self):

    72

        if self.statuschange is not None:

    73

            self.statuschange(self.PLCStatus)

    74

    75

    def _GetMD5FileName(self):

    76

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

    77

    78

    def _GetLibFileName(self):

    79

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

    80

    81

    82

    def _LoadNewPLC(self):

    83

        """

    84

        Load PLC library

    85

        Declare all functions, arguments and return values

    86

        """

    87

        PLCprint("Load PLC")

    88

        try:

    89

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

    90

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

    91

    92

            self._startPLC = self.PLClibraryHandle.startPLC

    93

            self._startPLC.restype = ctypes.c_int

    94

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

    95

    96

            def StopPLCLock():

    97

                self.PLClibraryLock.acquire()

    98

                self.PLClibraryHandle.stopPLC()

    99

                self.PLClibraryLock.release()

   100

   101

            self._stopPLC = StopPLCLock

   102

            self._stopPLC.restype = None

   103

   104

            self._ResetDebugVariables = self.PLClibraryHandle.ResetDebugVariables

   105

            self._ResetDebugVariables.restype = None

   106

   107

            self._RegisterDebugVariable = self.PLClibraryHandle.RegisterDebugVariable

   108

            self._RegisterDebugVariable.restype = None

   109

            self._RegisterDebugVariable.argtypes = [ctypes.c_int]

   110

   111

            self._IterDebugData = self.PLClibraryHandle.IterDebugData

   112

            self._IterDebugData.restype = ctypes.c_void_p

   113

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

   114

   115

            self._FreeDebugData = self.PLClibraryHandle.FreeDebugData

   116

            self._FreeDebugData.restype = None

   117

   118

            self._WaitDebugData = self.PLClibraryHandle.WaitDebugData

   119

            self._WaitDebugData.restype = ctypes.c_int  

   120

   121

            self._suspendDebug = self.PLClibraryHandle.suspendDebug

   122

            self._suspendDebug.restype = None

   123

   124

            self._resumeDebug = self.PLClibraryHandle.resumeDebug

   125

            self._resumeDebug.restype = None

   126

   127

            self._PythonIterator = self.PLClibraryHandle.PythonIterator

   128

            self._PythonIterator.restype = ctypes.c_char_p

   129

            self._PythonIterator.argtypes = [ctypes.c_char_p]

   130

   131

            return True

   132

        except:

   133

            PLCprint(traceback.format_exc())

   134

            return False

   135

   136

    def _FreePLC(self):

   137

        """

   138

        Unload PLC library.

   139

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

   140

        """

   141

        self.PLClibraryLock.acquire()

   142

        # Forget all refs to library

   143

        self._startPLC = lambda:None

   144

        self._stopPLC = lambda:None

   145

        self._ResetDebugVariables = lambda:None

   146

        self._RegisterDebugVariable = lambda x:None

   147

        self._IterDebugData = lambda x,y:None

   148

        self._FreeDebugData = lambda:None

   149

        self._WaitDebugData = lambda:-1

   150

        self._suspendDebug = lambda:None

   151

        self._resumeDebug = lambda:None

   152

        self._PythonIterator = lambda:""

   153

        self.PLClibraryHandle = None

   154

        # Unload library explicitely

   155

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

   156

            PLCprint("Unload PLC")

   157

            dlclose(self._PLClibraryHandle)

   158

            res = self._DetectDirtyLibs()

   159

        else:

   160

            res = False

   161

   162

        self._PLClibraryHandle = None

   163

        self.PLClibraryLock.release()

   164

        return res

   165

   166

    def _DetectDirtyLibs(self):

   167

        # Detect dirty libs

   168

        # Get lib dependencies (for dirty lib detection)

   169

        if os.name == "posix":

   170

            # parasiting libs listed with ldd

   171

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

   172

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

   173

            for badlib in badlibs:

   174

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

   175

                                  "libwxs",

   176

                                  "libgtk",

   177

                                  "libgdk",

   178

                                  "libatk",

   179

                                  "libpan",

   180

                                  "libX11",

   181

                                  ]:

   182

                    #badhandle = dlopen(badlib, dl.RTLD_NOLOAD)

   183

                    PLCprint("Dirty lib detected :" + badlib)

   184

                    #dlclose(badhandle)

   185

                    return True

   186

        return False

   187

   188

    def PrepareRuntimePy(self):

   189

        self.python_threads_vars = globals().copy()

   190

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

   191

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

   192

        hmifile = os.path.join(self.workingdir, "hmi.py")

   193

        if os.path.exists(hmifile):

   194

            try:

   195

                execfile(hmifile, self.python_threads_vars)

   196

                if os.path.exists(pyfile):

   197

                    try:

   198

                        # TODO handle exceptions in runtime.py

   199

                        # pyfile may redefine _runtime_cleanup

   200

                        # or even call _PythonThreadProc itself.

   201

                        execfile(pyfile, self.python_threads_vars)

   202

                    except:

   203

                        PLCprint(traceback.format_exc())

   204

                if self.python_threads_vars.has_key('wx'):

   205

                    wx = self.python_threads_vars['wx']

   206

                    # try to instanciate the first frame found.

   207

                    for name, obj in self.python_threads_vars.iteritems():

   208

                        # obj is a class

   209

                        if type(obj)==type(type) and issubclass(obj,wx.Frame):

   210

                            def create_frame():

   211

                                self.hmi_frame = obj(None)

   212

                                self.python_threads_vars[name] = self.hmi_frame

   213

                                # keep track of class... never know

   214

                                self.python_threads_vars['Class_'+name] = obj

   215

                                self.hmi_frame.Bind(wx.EVT_CLOSE, OnCloseFrame)

   216

                                self.hmi_frame.Show()

   217

   218

                            def OnCloseFrame(evt):

   219

                                wx.MessageBox("Please stop PLC to close")

   220

                            create_frame()

   221

                            break

   222

            except:

   223

                PLCprint(traceback.format_exc())

   224

        elif os.path.exists(pyfile):

   225

            try:

   226

                # TODO handle exceptions in runtime.py

   227

                # pyfile may redefine _runtime_cleanup

   228

                # or even call _PythonThreadProc itself.

   229

                execfile(pyfile, self.python_threads_vars)

   230

            except:

   231

                PLCprint(traceback.format_exc())

   232

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

   233

        if runtime_begin is not None:

   234

            runtime_begin()

   235

   236

    def FinishRuntimePy(self):

   237

        runtime_cleanup = None

   238

        if self.python_threads_vars is not None:

   239

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

   240

        if runtime_cleanup is not None:

   241

            runtime_cleanup()

   242

        if self.hmi_frame is not None:

   243

            self.hmi_frame.Destroy()

   244

        self.python_threads_vars = None

   245

   246

    def PythonThreadProc(self, debug):

   247

        PLCprint("PythonThreadProc started")

   248

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

   249

        error = None

   250

        if self._LoadNewPLC():

   251

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

   252

                if debug:

   253

                    for idx in self._Idxs:

   254

                        self._RegisterDebugVariable(idx)

   255

                    self._resumeDebug()

   256

                self.PLCStatus = "Started"

   257

                self.StatusChange()

   258

                self.evaluator(self.PrepareRuntimePy)

   259

                res,cmd = "None","None"

   260

                while True:

   261

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

   262

                    cmd = self._PythonIterator(res)

   263

                    #print " -> ", cmd

   264

                    if cmd is None:

   265

                        break

   266

                    try :

   267

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

   268

                    except Exception,e:

   269

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

   270

                        PLCprint(res)

   271

                self.PLCStatus = "Stopped"

   272

                self.StatusChange()

   273

                self.evaluator(self.FinishRuntimePy)

   274

            else:

   275

                error = "starting"

   276

        else:

   277

            error = "loading"

   278

        if error is not None:

   279

            PLCprint("Problem %s PLC"%error)

   280

            self.PLCStatus = "Broken"

   281

        self._FreePLC()

   282

        PLCprint("PythonThreadProc interrupted")

   283

   284

    def StartPLC(self, debug=False):

   285

        PLCprint("StartPLC")

   286

        if self.CurrentPLCFilename is not None:

   287

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

   288

            self.PythonThread.start()

   289

   290

    def StopPLC(self):

   291

        PLCprint("StopPLC")

   292

        if self.PLCStatus == "Started":

   293

            self._stopPLC()

   294

            return True

   295

        return False

   296

   297

    def _Reload(self):

   298

        self.daemon.shutdown(True)

   299

        self.daemon.sock.close()

   300

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

   301

        # never reached

   302

        return 0

   303

   304

    def ForceReload(self):

   305

        # respawn python interpreter

   306

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

   307

        return True

   308

   309

    def GetPLCstatus(self):

   310

        return self.PLCStatus

   311

   312

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

   313

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

   314

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

   315

            NewFileName = md5sum + lib_ext

   316

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

   317

            try:

   318

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

   319

                                       self.CurrentPLCFilename))

   320

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

   321

                    try:

   322

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

   323

                    except:

   324

                        pass

   325

            except:

   326

                pass

   327

   328

            try:

   329

                # Create new PLC file

   330

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

   331

                     'wb').write(data)

   332

   333

                # Store new PLC filename based on md5 key

   334

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

   335

   336

                # Then write the files

   337

                log = file(extra_files_log, "w")

   338

                for fname,fdata in extrafiles:

   339

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

   340

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

   341

                    log.write(fname+'\n')

   342

   343

                # Store new PLC filename

   344

                self.CurrentPLCFilename = NewFileName

   345

            except:

   346

                PLCprint(traceback.format_exc())

   347

                return False

   348

            if self.PLCStatus == "Empty":

   349

                self.PLCStatus = "Stopped"

   350

            return True

   351

        return False

   352

   353

    def MatchMD5(self, MD5):

   354

        try:

   355

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

   356

            return last_md5 == MD5

   357

        except:

   358

            return False

   359

   360

    def SetTraceVariablesList(self, idxs):

   361

        """

   362

        Call ctype imported function to append 

   363

        these indexes to registred variables in PLC debugger

   364

        """

   365

        self._suspendDebug()

   366

        # keep a copy of requested idx

   367

        self._Idxs = idxs[:]

   368

        self._ResetDebugVariables()

   369

        for idx in idxs:

   370

            self._RegisterDebugVariable(idx)

   371

        self._resumeDebug()

   372

   373

    class IEC_STRING(ctypes.Structure):

   374

        """

   375

        Must be changed according to changes in iec_types.h

   376

        """

   377

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

   378

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

   379

   380

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

   381

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

   382

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

   383

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

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

                      } 

   401

   402

    def GetTraceVariables(self):

   403

        """

   404

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

   405

        """

   406

        if self.PLCStatus == "Started":

   407

            self.PLClibraryLock.acquire()

   408

            tick = self._WaitDebugData()

   409

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

   410

            if tick == -1:

   411

                res = None

   412

            else:

   413

                idx = ctypes.c_int()

   414

                typename = ctypes.c_char_p()

   415

                res = []

   416

   417

                for given_idx in self._Idxs:

   418

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

   419

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

   420

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

   421

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

   422

                                                           ctypes.POINTER(c_type)).contents))

   423

                    else:

   424

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

   425

                        res.append(None)

   426

            self._FreeDebugData()

   427

            self.PLClibraryLock.release()

   428

            return tick, res

   429

        return -1, None

   430