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

    27

import ctypes, os, commands

    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

class PLCObject(pyro.ObjBase):

    44

    _Idxs = []

    45

    def __init__(self, workingdir, daemon, argv, statuschange=None):

    46

        pyro.ObjBase.__init__(self)

    47

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

    48

        self.workingdir = workingdir

    49

        self.PLCStatus = "Stopped"

    50

        self.PLClibraryHandle = None

    51

        # Creates fake C funcs proxies

    52

        self._FreePLC()

    53

        self.daemon = daemon

    54

        self.statuschange = statuschange

    55

    56

        # Get the last transfered PLC if connector must be restart

    57

        try:

    58

            self.CurrentPLCFilename=open(

    59

                             self._GetMD5FileName(),

    60

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

    61

        except Exception, e:

    62

            self.PLCStatus = "Empty"

    63

            self.CurrentPLCFilename=None

    64

    65

    def _GetMD5FileName(self):

    66

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

    67

    68

    def _GetLibFileName(self):

    69

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

    70

    71

    72

    def _LoadNewPLC(self):

    73

        """

    74

        Load PLC library

    75

        Declare all functions, arguments and return values

    76

        """

    77

        print "Load PLC"

    78

        try:

    79

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

    80

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

    81

    82

            self._startPLC = self.PLClibraryHandle.startPLC

    83

            self._startPLC.restype = ctypes.c_int

    84

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

    85

    86

            self._stopPLC = self.PLClibraryHandle.stopPLC

    87

            self._stopPLC.restype = None

    88

    89

            self._ResetDebugVariables = self.PLClibraryHandle.ResetDebugVariables

    90

            self._ResetDebugVariables.restype = None

    91

    92

            self._RegisterDebugVariable = self.PLClibraryHandle.RegisterDebugVariable

    93

            self._RegisterDebugVariable.restype = None

    94

            self._RegisterDebugVariable.argtypes = [ctypes.c_int]

    95

    96

            self._IterDebugData = self.PLClibraryHandle.IterDebugData

    97

            self._IterDebugData.restype = ctypes.c_void_p

    98

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

    99

   100

            self._FreeDebugData = self.PLClibraryHandle.FreeDebugData

   101

            self._FreeDebugData.restype = None

   102

   103

            self._WaitDebugData = self.PLClibraryHandle.WaitDebugData

   104

            self._WaitDebugData.restype = ctypes.c_int  

   105

   106

            self._suspendDebug = self.PLClibraryHandle.suspendDebug

   107

            self._suspendDebug.restype = None

   108

   109

            self._resumeDebug = self.PLClibraryHandle.resumeDebug

   110

            self._resumeDebug.restype = None

   115

   116

            return True

   117

        except:

   118

            print traceback.format_exc()

   119

            return False

   120

   121

    def _FreePLC(self):

   122

        """

   123

        Unload PLC library.

   124

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

   125

        """

   126

        # Forget all refs to library

   127

        self._startPLC = lambda:None

   128

        self._stopPLC = lambda:None

   129

        self._ResetDebugVariables = lambda:None

   130

        self._RegisterDebugVariable = lambda x:None

   131

        self._IterDebugData = lambda x,y:None

   132

        self._FreeDebugData = lambda:None

   133

        self._WaitDebugData = lambda:-1

   134

        self._suspendDebug = lambda:None

   135

        self._resumeDebug = lambda:None

   137

        self.PLClibraryHandle = None

   138

        # Unload library explicitely

   139

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

   140

            print "Unload PLC"

   141

            dlclose(self._PLClibraryHandle)

   142

            res = self._DetectDirtyLibs()

   143

        else:

   144

            res = False

   145

   146

        self._PLClibraryHandle = None

   147

   148

        return res

   149

   150

    def _DetectDirtyLibs(self):

   151

        # Detect dirty libs

   152

        # Get lib dependencies (for dirty lib detection)

   153

        if os.name == "posix":

   154

            # parasiting libs listed with ldd

   155

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

   156

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

   157

            for badlib in badlibs:

   158

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

   159

                                  "libwxs",

   160

                                  "libgtk",

   161

                                  "libgdk",

   162

                                  "libatk",

   163

                                  "libpan",

   164

                                  "libX11",

   165

                                  ]:

   166

                    #badhandle = dlopen(badlib, dl.RTLD_NOLOAD)

   167

                    print "Dirty lib detected :" + badlib

   168

                    #dlclose(badhandle)

   169

                    return True

   170

        return False

   171

   184

   185

    def StartPLC(self, debug=False):

   186

        print "StartPLC"

   187

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

   188

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

   189

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

   190

                if debug:

   191

                    self._resumeDebug()

   192

                self.PLCStatus = "Started"

   193

                if self.statuschange is not None:

   194

                    self.statuschange(self.PLCStatus)

   197

                return True

   198

            else:

   199

                print "_StartPLC did not return 0 !"

   200

                self._DoStopPLC()

   201

        return False

   202

   203

    def _DoStopPLC(self):

   204

        self._stopPLC()

   205

        self.PLCStatus = "Stopped"

   206

        if self.statuschange is not None:

   207

            self.statuschange(self.PLCStatus)

   208

        if self._FreePLC():

   209

            self.PLCStatus = "Dirty"

   210

        return True

   211

   212

    def StopPLC(self):

   213

        if self.PLCStatus == "Started":

   214

            self._DoStopPLC()

   215

            return True

   216

        return False

   217

   218

    def _Reload(self):

   219

        self.daemon.shutdown(True)

   220

        self.daemon.sock.close()

   221

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

   222

        # never reached

   223

        return 0

   224

   225

    def ForceReload(self):

   226

        # respawn python interpreter

   227

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

   228

        return True

   229

   230

    def GetPLCstatus(self):

   231

        return self.PLCStatus

   232

   233

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

   234

        print "NewPLC (%s)"%md5sum

   235

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

   236

            NewFileName = md5sum + lib_ext

   237

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

   238

            try:

   239

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

   240

                                       self.CurrentPLCFilename))

   241

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

   242

                    try:

   243

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

   244

                    except:

   245

                        pass

   246

            except:

   247

                pass

   248

   249

            try:

   250

                # Create new PLC file

   251

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

   252

                     'wb').write(data)

   253

   254

                # Store new PLC filename based on md5 key

   255

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

   256

   257

                # Then write the files

   258

                log = file(extra_files_log, "w")

   259

                for fname,fdata in extrafiles:

   260

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

   261

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

   262

                    log.write(fname+'\n')

   263

   264

                # Store new PLC filename

   265

                self.CurrentPLCFilename = NewFileName

   266

            except:

   267

                print traceback.format_exc()

   268

                return False

   269

            if self.PLCStatus == "Empty":

   270

                self.PLCStatus = "Stopped"

   271

            return True

   272

        return False

   273

   274

    def MatchMD5(self, MD5):

   275

        try:

   276

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

   277

            return last_md5 == MD5

   278

        except:

   279

            return False

   280

   281

    def SetTraceVariablesList(self, idxs):

   282

        """

   283

        Call ctype imported function to append 

   284

        these indexes to registred variables in PLC debugger

   285

        """

   286

        self._suspendDebug()

   287

        # keep a copy of requested idx

   288

        self._Idxs = idxs[:]

   289

        self._ResetDebugVariables()

   290

        for idx in idxs:

   291

            self._RegisterDebugVariable(idx)

   292

        self._resumeDebug()

   300

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

                      } 

   322

   323

    def GetTraceVariables(self):

   324

        """

   325

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

   326

        """

   327

        tick = self._WaitDebugData()

   328

        if tick == -1:

   329

            res = None

   330

        else:

   331

            idx = ctypes.c_int()

   332

            typename = ctypes.c_char_p()

   333

            res = []

   334

   335

            for given_idx in self._Idxs:

   336

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

   337

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

   338

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

   339

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

   340

                                                       ctypes.POINTER(c_type)).contents))

   341

                else:

   342

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

   343

                    res.append(None)

   344

        self._FreeDebugData()

   345

        return tick, res

   346

   347

   348