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

    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

        cflags = [self.CTRInstance.GetTarget().getcontent().getCFLAGS()]

    55

        if "CFLAGS" in os.environ:

    56

            cflags.append(os.environ["CFLAGS"])

    57

        if "SYSROOT" in os.environ:

    58

            cflags.append("--sysroot="+os.environ["SYSROOT"])

    59

        return cflags

    60

    61

    def getBuilderLDFLAGS(self):

    62

        """

    63

        Returns list of builder specific LDFLAGS

    64

        """

    65

        ldflags = self.CTRInstance.LDFLAGS + \

    66

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

    67

        if "LDLAGS" in os.environ:

    68

            ldflags.append(os.environ["LDLAGS"])

    69

        if "SYSROOT" in os.environ:

    70

            ldflags.append("--sysroot="+os.environ["SYSROOT"])

    71

        return ldflags

    72

    73

    def getCompiler(self):

    74

        """

    75

        Returns compiler

    76

        """

    77

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

    78

    79

    def getLinker(self):

    80

        """

    81

        Returns linker

    82

        """

    83

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

    84

    85

    def GetBinaryPath(self):

    86

        return self.bin_path

    87

    88

    def _GetMD5FileName(self):

    89

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

    90

    91

    def ResetBinaryMD5(self):

    92

        self.md5key = None

    93

        try:

    94

            os.remove(self._GetMD5FileName())

    95

        except Exception:

    96

            pass

    97

    98

    def GetBinaryMD5(self):

    99

        if self.md5key is not None:

   100

            return self.md5key

   101

        else:

   102

            try:

   103

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

   104

            except Exception:

   105

                return None

   106

   107

    def SetBuildPath(self, buildpath):

   108

        if self.buildpath != buildpath:

   109

            self.buildpath = buildpath

   110

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

   111

            self.bin_path = os.path.join(self.buildpath, self.bin)

   112

            self.md5key = None

   113

            self.srcmd5 = {}

   114

   115

    def append_cfile_deps(self, src, deps):

   116

        for l in src.splitlines():

   117

            res = includes_re.match(l)

   118

            if res is not None:

   119

                depfn = res.groups()[0]

   120

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

   121

                    deps.append(depfn)

   122

   123

    def concat_deps(self, bn):

   124

        # read source

   125

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

   126

        # update direct dependencies

   127

        deps = []

   128

        self.append_cfile_deps(src, deps)

   129

        # recurse through deps

   130

        # TODO detect cicular deps.

   131

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

   132

   133

    def check_and_update_hash_and_deps(self, bn):

   134

        # Get latest computed hash and deps

   135

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

   136

        # read source

   137

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

   138

        # compute new hash

   139

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

   140

        # compare

   141

        match = (oldhash == newhash)

   142

        if not match:

   143

            # file have changed

   144

            # update direct dependencies

   145

            deps = []

   146

            self.append_cfile_deps(src, deps)

   147

            # store that hashand deps

   148

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

   149

        # recurse through deps

   150

        # TODO detect cicular deps.

   151

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

   152

   153

    def calc_source_md5(self):

   154

        wholesrcdata = ""

   155

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

   156

            # Get CFiles list to give it to makefile

   157

            for CFile, _CFLAGS in CFilesAndCFLAGS:

   158

                CFileName = os.path.basename(CFile)

   159

                wholesrcdata += self.concat_deps(CFileName)

   160

        return hashlib.md5(wholesrcdata).hexdigest()

   161

   162

    def build(self):

   163

        # Retrieve compiler and linker

   164

        self.compiler = self.getCompiler()

   165

        self.linker = self.getLinker()

   166

   167

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

   168

   169

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

   170

        obns = []

   171

        objs = []

   172

        relink = not os.path.exists(self.bin_path)

   173

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

   174

            if CFilesAndCFLAGS:

   175

                if Location:

   176

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

   177

                else:

   178

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

   179

   180

            for CFile, CFLAGS in CFilesAndCFLAGS:

   181

                if CFile.endswith(".c"):

   182

                    bn = os.path.basename(CFile)

   183

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

   184

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

   185

   186

                    match = self.check_and_update_hash_and_deps(bn)

   187

   188

                    if match:

   189

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

   190

                    else:

   191

                        relink = True

   192

   193

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

   194

   195

                        status, _result, _err_result = ProcessLogger(

   196

                            self.CTRInstance.logger,

   197

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

   198

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

   199

                        ).spin()

   200

   201

                        if status:

   202

                            self.srcmd5.pop(bn)

   203

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

   204

                            return False

   205

                    obns.append(obn)

   206

                    objs.append(objectfilename)

   207

                elif CFile.endswith(".o"):

   208

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

   209

                    objs.append(CFile)

   210

   211

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

   212

        # Link all the object files into one binary file

   213

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

   214

        if relink:

   215

            # Generate list .o files

   216

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

   217

   218

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

   219

   220

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

   221

   222

            status, _result, _err_result = ProcessLogger(

   223

                self.CTRInstance.logger,

   224

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

   225

                (self.linker,

   226

                 listobjstring,

   227

                 self.bin_path,

   228

                 ALLldflags)

   229

            ).spin()

   230

   231

            if status:

   232

                return False

   233

   234

        else:

   235

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

   236

   237

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

   238

        self.md5key = hashlib.md5(open(self.bin_path, "rb").read()).hexdigest()

   239

   240

        # Store new PLC filename based on md5 key

   241

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

   242

        f.write(self.md5key)

   243

        f.close()

   244

   245

        return True