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

import hashlib

    30

    31

from util.ProcessLogger import ProcessLogger

    32

    33

    34

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

    35

    36

    37

class toolchain_gcc(object):

    38

    """

    39

    This abstract class contains GCC specific code.

    40

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

    41

    class such as target_linux or target_win32

    42

    """

    43

    def __init__(self, CTRInstance):

    44

        self.CTRInstance = CTRInstance

    45

        self.buildpath = None

    46

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

    47

    48

    def getBuilderCFLAGS(self):

    49

        """

    50

        Returns list of builder specific CFLAGS

    51

        """

    52

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

    53

    54

    def getBuilderLDFLAGS(self):

    55

        """

    56

        Returns list of builder specific LDFLAGS

    57

        """

    58

        return self.CTRInstance.LDFLAGS + \

    59

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

    60

    61

    def getCompiler(self):

    62

        """

    63

        Returns compiler

    64

        """

    65

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

    66

    67

    def getLinker(self):

    68

        """

    69

        Returns linker

    70

        """

    71

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

    72

    73

    def GetBinaryCode(self):

    74

        try:

    75

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

    76

        except Exception:

    77

            return None

    78

    79

    def _GetMD5FileName(self):

    80

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

    81

    82

    def ResetBinaryCodeMD5(self):

    83

        self.md5key = None

    84

        try:

    85

            os.remove(self._GetMD5FileName())

    86

        except Exception:

    87

            pass

    88

    89

    def GetBinaryCodeMD5(self):

    90

        if self.md5key is not None:

    91

            return self.md5key

    92

        else:

    93

            try:

    94

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

    95

            except Exception:

    96

                return None

    97

    98

    def SetBuildPath(self, buildpath):

    99

        if self.buildpath != buildpath:

   100

            self.buildpath = buildpath

   101

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

   102

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

   103

            self.md5key = None

   104

            self.srcmd5 = {}

   105

   106

    def append_cfile_deps(self, src, deps):

   107

        for l in src.splitlines():

   108

            res = includes_re.match(l)

   109

            if res is not None:

   110

                depfn = res.groups()[0]

   111

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

   112

                    deps.append(depfn)

   113

   114

    def concat_deps(self, bn):

   115

        # read source

   116

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

   117

        # update direct dependencies

   118

        deps = []

   119

        self.append_cfile_deps(src, deps)

   120

        # recurse through deps

   121

        # TODO detect cicular deps.

   122

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

   123

   124

    def check_and_update_hash_and_deps(self, bn):

   125

        # Get latest computed hash and deps

   126

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

   127

        # read source

   128

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

   129

        # compute new hash

   130

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

   131

        # compare

   132

        match = (oldhash == newhash)

   133

        if not match:

   134

            # file have changed

   135

            # update direct dependencies

   136

            deps = []

   137

            self.append_cfile_deps(src, deps)

   138

            # store that hashand deps

   139

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

   140

        # recurse through deps

   141

        # TODO detect cicular deps.

   142

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

   143

   144

    def calc_source_md5(self):

   145

        wholesrcdata = ""

   146

        for _Location, CFilesAndCFLAGS, _DoCalls in self.CTRInstance.LocationCFilesAndCFLAGS:

   147

            # Get CFiles list to give it to makefile

   148

            for CFile, _CFLAGS in CFilesAndCFLAGS:

   149

                CFileName = os.path.basename(CFile)

   150

                wholesrcdata += self.concat_deps(CFileName)

   151

        return hashlib.md5(wholesrcdata).hexdigest()

   152

   153

    def calc_md5(self):

   154

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

   155

   156

    def build(self):

   157

        # Retrieve compiler and linker

   158

        self.compiler = self.getCompiler()

   159

        self.linker = self.getLinker()

   160

   161

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

   162

   163

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

   164

        obns = []

   165

        objs = []

   166

        relink = self.GetBinaryCode() is None

   167

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

   168

            if CFilesAndCFLAGS:

   169

                if Location:

   170

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

   171

                else:

   172

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

   173

   174

            for CFile, CFLAGS in CFilesAndCFLAGS:

   175

                if CFile.endswith(".c"):

   176

                    bn = os.path.basename(CFile)

   177

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

   178

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

   179

   180

                    match = self.check_and_update_hash_and_deps(bn)

   181

   182

                    if match:

   183

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

   184

                    else:

   185

                        relink = True

   186

   187

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

   188

   189

                        status, _result, _err_result = ProcessLogger(

   190

                            self.CTRInstance.logger,

   191

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

   192

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

   193

                        ).spin()

   194

   195

                        if status:

   196

                            self.srcmd5.pop(bn)

   197

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

   198

                            return False

   199

                    obns.append(obn)

   200

                    objs.append(objectfilename)

   201

                elif CFile.endswith(".o"):

   202

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

   203

                    objs.append(CFile)

   204

   205

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

   206

        # Link all the object files into one binary file

   207

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

   208

        if relink:

   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