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

    27

from __future__ import absolute_import

    28

import os

    29

import re

    30

import operator

    31

import hashlib

    32

from functools import reduce

    33

from util.ProcessLogger import ProcessLogger

    34

    35

    36

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

    37

    38

    39

class toolchain_gcc(object):

    40

    """

    41

    This abstract class contains GCC specific code.

    42

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

    43

    class such as target_linux or target_win32

    44

    """

    45

    def __init__(self, CTRInstance):

    46

        self.CTRInstance = CTRInstance

    47

        self.buildpath = None

    48

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

    49

    50

    def getBuilderCFLAGS(self):

    51

        """

    52

        Returns list of builder specific CFLAGS

    53

        """

    54

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

    55

    56

    def getBuilderLDFLAGS(self):

    57

        """

    58

        Returns list of builder specific LDFLAGS

    59

        """

    60

        return self.CTRInstance.LDFLAGS + \

    61

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

    62

    63

    def getCompiler(self):

    64

        """

    65

        Returns compiler

    66

        """

    67

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

    68

    69

    def getLinker(self):

    70

        """

    71

        Returns linker

    72

        """

    73

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

    74

    75

    def GetBinaryCode(self):

    76

        try:

    77

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

    78

        except Exception:

    79

            return None

    80

    81

    def _GetMD5FileName(self):

    82

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

    83

    84

    def ResetBinaryCodeMD5(self):

    85

        self.md5key = None

    86

        try:

    87

            os.remove(self._GetMD5FileName())

    88

        except Exception:

    89

            pass

    90

    91

    def GetBinaryCodeMD5(self):

    92

        if self.md5key is not None:

    93

            return self.md5key

    94

        else:

    95

            try:

    96

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

    97

            except Exception:

    98

                return None

    99

   100

    def SetBuildPath(self, buildpath):

   101

        if self.buildpath != buildpath:

   102

            self.buildpath = buildpath

   103

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

   104

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

   105

            self.md5key = None

   106

            self.srcmd5 = {}

   107

   108

    def append_cfile_deps(self, src, deps):

   109

        for l in src.splitlines():

   110

            res = includes_re.match(l)

   111

            if res is not None:

   112

                depfn = res.groups()[0]

   113

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

   114

                    deps.append(depfn)

   115

   116

    def concat_deps(self, bn):

   117

        # read source

   118

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

   119

        # update direct dependencies

   120

        deps = []

   121

        self.append_cfile_deps(src, deps)

   122

        # recurse through deps

   123

        # TODO detect cicular deps.

   124

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

   125

   126

    def check_and_update_hash_and_deps(self, bn):

   127

        # Get latest computed hash and deps

   128

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

   129

        # read source

   130

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

   131

        # compute new hash

   132

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

   133

        # compare

   134

        match = (oldhash == newhash)

   135

        if not match:

   136

            # file have changed

   137

            # update direct dependencies

   138

            deps = []

   139

            self.append_cfile_deps(src, deps)

   140

            # store that hashand deps

   141

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

   142

        # recurse through deps

   143

        # TODO detect cicular deps.

   144

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

   145

   146

    def calc_source_md5(self):

   147

        wholesrcdata = ""

   148

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

   149

            # Get CFiles list to give it to makefile

   150

            for CFile, _CFLAGS in CFilesAndCFLAGS:

   151

                CFileName = os.path.basename(CFile)

   152

                wholesrcdata += self.concat_deps(CFileName)

   153

        return hashlib.md5(wholesrcdata).hexdigest()

   154

   155

    def calc_md5(self):

   156

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

   157

   158

    def build(self):

   159

        # Retrieve compiler and linker

   160

        self.compiler = self.getCompiler()

   161

        self.linker = self.getLinker()

   162

   163

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

   164

   165

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

   166

        obns = []

   167

        objs = []

   168

        relink = self.GetBinaryCode() is None

   169

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

   170

            if CFilesAndCFLAGS:

   171

                if Location:

   172

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

   173

                else:

   174

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

   175

   176

            for CFile, CFLAGS in CFilesAndCFLAGS:

   177

                if CFile.endswith(".c"):

   178

                    bn = os.path.basename(CFile)

   179

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

   180

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

   181

   182

                    match = self.check_and_update_hash_and_deps(bn)

   183

   184

                    if match:

   185

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

   186

                    else:

   187

                        relink = True

   188

   189

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

   190

   191

                        status, _result, _err_result = ProcessLogger(

   192

                            self.CTRInstance.logger,

   193

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

   194

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

   195

                        ).spin()

   196

   197

                        if status:

   198

                            self.srcmd5.pop(bn)

   199

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

   200

                            return False

   201

                    obns.append(obn)

   202

                    objs.append(objectfilename)

   203

                elif CFile.endswith(".o"):

   204

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

   205

                    objs.append(CFile)

   206

   207

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

   208

        # Link all the object files into one binary file

   209

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

   210

        if relink:

   211

            # Generate list .o files

   212

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

   213

   214

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

   215

   216

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

   217

   218

            status, _result, _err_result = ProcessLogger(

   219

                self.CTRInstance.logger,

   220

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

   221

                (self.linker,

   222

                 listobjstring,

   223

                 self.exe_path,

   224

                 ALLldflags)

   225

            ).spin()

   226

   227

            if status:

   228

                return False

   229

   230

        else:

   231

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

   232

   233

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

   234

        self.md5key = self.calc_md5()

   235

   236

        # Store new PLC filename based on md5 key

   237

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

   238

        f.write(self.md5key)

   239

        f.close()

   240

   241

        return True