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

# Copyright (C) 2017: Paul Beltyukov

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

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

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

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

    16

#

    17

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

    18

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

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

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

    23

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

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import os

    27

import re

    28

import operator

    29

from util.ProcessLogger import ProcessLogger

    30

import hashlib

    31

    32

includes_re = re.compile('\s*#include\s*["<]([^">]*)[">].*')

    33

    34

    36

    """

    37

    This abstract class contains GCC specific code.

    38

    It cannot be used as this and should be inherited in a target specific

    39

    class such as target_linux or target_win32

    40

    """

    41

    def __init__(self, CTRInstance):

    42

        self.CTRInstance = CTRInstance

    43

        self.buildpath = None

    44

        self.SetBuildPath(self.CTRInstance._getBuildPath())

    45

    46

    def getBuilderCFLAGS(self):

    47

        """

    48

        Returns list of builder specific CFLAGS

    49

        """

    50

        return [self.CTRInstance.GetTarget().getcontent().getCFLAGS()]

    51

    52

    def getBuilderLDFLAGS(self):

    53

        """

    54

        Returns list of builder specific LDFLAGS

    55

        """

    56

        return self.CTRInstance.LDFLAGS + \

    57

            [self.CTRInstance.GetTarget().getcontent().getLDFLAGS()]

    58

    59

    def getCompiler(self):

    60

        """

    61

        Returns compiler

    62

        """

    63

        return self.CTRInstance.GetTarget().getcontent().getCompiler()

    64

    65

    def getLinker(self):

    66

        """

    67

        Returns linker

    68

        """

    69

        return self.CTRInstance.GetTarget().getcontent().getLinker()

    70

    71

    def GetBinaryCode(self):

    72

        try:

    73

            return open(self.exe_path, "rb").read()

    74

        except Exception, e:

    75

            return None

    76

    77

    def _GetMD5FileName(self):

    78

        return os.path.join(self.buildpath, "lastbuildPLC.md5")

    79

    80

    def ResetBinaryCodeMD5(self):

    81

        self.md5key = None

    82

        try:

    83

            os.remove(self._GetMD5FileName())

    84

        except Exception, e:

    85

            pass

    86

    87

    def GetBinaryCodeMD5(self):

    88

        if self.md5key is not None:

    89

            return self.md5key

    90

        else:

    91

            try:

    92

                return open(self._GetMD5FileName(), "r").read()

    93

            except Exception, e:

    94

                return None

    95

    96

    def SetBuildPath(self, buildpath):

    97

        if self.buildpath != buildpath:

    98

            self.buildpath = buildpath

    99

            self.exe = self.CTRInstance.GetProjectName() + self.extension

   100

            self.exe_path = os.path.join(self.buildpath, self.exe)

   101

            self.md5key = None

   102

            self.srcmd5 = {}

   103

   104

    def append_cfile_deps(self, src, deps):

   105

        for l in src.splitlines():

   106

            res = includes_re.match(l)

   107

            if res is not None:

   108

                depfn = res.groups()[0]

   109

                if os.path.exists(os.path.join(self.buildpath, depfn)):

   110

                    deps.append(depfn)

   111

   112

    def concat_deps(self, bn):

   113

        # read source

   114

        src = open(os.path.join(self.buildpath, bn), "r").read()

   115

        # update direct dependencies

   116

        deps = []

   117

        self.append_cfile_deps(src, deps)

   118

        # recurse through deps

   119

        # TODO detect cicular deps.

   120

        return reduce(operator.concat, map(self.concat_deps, deps), src)

   121

   122

    def check_and_update_hash_and_deps(self, bn):

   123

        # Get latest computed hash and deps

   124

        oldhash, deps = self.srcmd5.get(bn, (None, []))

   125

        # read source

   126

        src = open(os.path.join(self.buildpath, bn)).read()

   127

        # compute new hash

   128

        newhash = hashlib.md5(src).hexdigest()

   129

        # compare

   130

        match = (oldhash == newhash)

   131

        if not match:

   132

            # file have changed

   133

            # update direct dependencies

   134

            deps = []

   135

            self.append_cfile_deps(src, deps)

   136

            # store that hashand deps

   137

            self.srcmd5[bn] = (newhash, deps)

   138

        # recurse through deps

   139

        # TODO detect cicular deps.

   140

        return reduce(operator.and_, map(self.check_and_update_hash_and_deps, deps), match)

   141

   142

    def calc_source_md5(self):

   143

        wholesrcdata = ""

   144

        for Location, CFilesAndCFLAGS, DoCalls in self.CTRInstance.LocationCFilesAndCFLAGS:

   145

            # Get CFiles list to give it to makefile

   146

            for CFile, CFLAGS in CFilesAndCFLAGS:

   147

                CFileName = os.path.basename(CFile)

   148

                wholesrcdata += self.concat_deps(CFileName)

   149

        return hashlib.md5(wholesrcdata).hexdigest()

   150

   151

    def calc_md5(self):

   152

        return hashlib.md5(self.GetBinaryCode()).hexdigest()

   153

   154

    def build(self):

   155

        # Retrieve compiler and linker

   156

        self.compiler = self.getCompiler()

   157

        self.linker = self.getLinker()

   158

   159

        Builder_CFLAGS = ' '.join(self.getBuilderCFLAGS())

   160

   161

        # ----------------- GENERATE OBJECT FILES ------------------------

   162

        obns = []

   163

        objs = []

   164

        relink = self.GetBinaryCode() is None

   165

        for Location, CFilesAndCFLAGS, DoCalls in self.CTRInstance.LocationCFilesAndCFLAGS:

   166

            if CFilesAndCFLAGS:

   167

                if Location:

   168

                    self.CTRInstance.logger.write(".".join(map(str, Location))+" :\n")

   169

                else:

   170

                    self.CTRInstance.logger.write(_("PLC :\n"))

   171

   172

            for CFile, CFLAGS in CFilesAndCFLAGS:

   173

                if CFile.endswith(".c"):

   174

                    bn = os.path.basename(CFile)

   175

                    obn = os.path.splitext(bn)[0]+".o"

   176

                    objectfilename = os.path.splitext(CFile)[0]+".o"

   177

   178

                    match = self.check_and_update_hash_and_deps(bn)

   179

   180

                    if match:

   181

                        self.CTRInstance.logger.write("   [pass]  "+bn+" -> "+obn+"\n")

   182

                    else:

   183

                        relink = True

   184

   185

                        self.CTRInstance.logger.write("   [CC]  "+bn+" -> "+obn+"\n")

   186

   187

                        status, result, err_result = ProcessLogger(

   188

                            self.CTRInstance.logger,

   189

                            "\"%s\" -c \"%s\" -o \"%s\" %s %s" %

   190

                            (self.compiler, CFile, objectfilename, Builder_CFLAGS, CFLAGS)

   191

                        ).spin()

   192

   193

                        if status:

   194

                            self.srcmd5.pop(bn)

   195

                            self.CTRInstance.logger.write_error(_("C compilation of %s failed.\n") % bn)

   196

                            return False

   197

                    obns.append(obn)

   198

                    objs.append(objectfilename)

   199

                elif CFile.endswith(".o"):

   200

                    obns.append(os.path.basename(CFile))

   201

                    objs.append(CFile)

   202

   203

        # ---------------- GENERATE OUTPUT FILE --------------------------

   204

        # Link all the object files into one binary file

   205

        self.CTRInstance.logger.write(_("Linking :\n"))

   206

        if relink:

   207

            objstring = []

   208

   209

            # Generate list .o files

   210

            listobjstring = '"' + '"  "'.join(objs) + '"'

   211

   212

            ALLldflags = ' '.join(self.getBuilderLDFLAGS())

   213

   214

            self.CTRInstance.logger.write("   [CC]  " + ' '.join(obns)+" -> " + self.exe + "\n")

   215

   216

            status, result, err_result = ProcessLogger(

   217

                self.CTRInstance.logger,

   218

                "\"%s\" %s -o \"%s\" %s" %

   219

                (self.linker,

   220

                 listobjstring,

   221

                 self.exe_path,

   222

                 ALLldflags)

   223

            ).spin()

   224

   225

            if status:

   226

                return False

   227

   228

        else:

   229

            self.CTRInstance.logger.write("   [pass]  " + ' '.join(obns)+" -> " + self.exe + "\n")

   230

   231

        # Calculate md5 key and get data for the new created PLC

   232

        self.md5key = self.calc_md5()

   233

   234

        # Store new PLC filename based on md5 key

   235

        f = open(self._GetMD5FileName(), "w")

   236

        f.write(self.md5key)

   237

        f.close()

   238

   239

        return True