abi.cpp 34.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31

#include "abi.h"

32 33
#include <utils/fileutils.h>

34 35 36 37 38 39
#include <QDebug>
#include <QtEndian>
#include <QFile>
#include <QString>
#include <QStringList>
#include <QSysInfo>
40

41 42 43
/*!
    \class ProjectExplorer::Abi

44 45
    \brief The Abi class represents the Application Binary Interface (ABI) of
    a target platform.
46 47 48 49

    \sa ProjectExplorer::ToolChain
*/

50 51
namespace ProjectExplorer {

52 53 54 55
// --------------------------------------------------------------------------
// Helpers
// --------------------------------------------------------------------------

Tobias Hunger's avatar
Tobias Hunger committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
static quint8 getUint8(const QByteArray &data, int pos)
{
    return static_cast<quint8>(data.at(pos));
}

static quint32 getLEUint32(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 3);
    return (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 3))) << 24)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 2)) << 16))
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 1))) << 8)
            + static_cast<quint8>(ba.at(pos));
}

static quint32 getBEUint32(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 3);
    return (static_cast<quint32>(static_cast<quint8>(ba.at(pos))) << 24)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 1))) << 16)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 2))) << 8)
            + static_cast<quint8>(ba.at(pos + 3));
}

static quint32 getLEUint16(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 1);
    return (static_cast<quint16>(static_cast<quint8>(ba.at(pos + 1))) << 8) + static_cast<quint8>(ba.at(pos));
}

static quint32 getBEUint16(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 1);
    return (static_cast<quint16>(static_cast<quint8>(ba.at(pos))) << 8) + static_cast<quint8>(ba.at(pos + 1));
}

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
static Abi macAbiForCpu(quint32 type) {
    switch (type) {
    case 7: // CPU_TYPE_X86, CPU_TYPE_I386
        return Abi(Abi::X86Architecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 0x01000000 +  7: // CPU_TYPE_X86_64
        return Abi(Abi::X86Architecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 64);
    case 18: // CPU_TYPE_POWERPC
        return Abi(Abi::PowerPCArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 0x01000000 + 18: // CPU_TYPE_POWERPC64
        return Abi(Abi::PowerPCArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 12: // CPU_TYPE_ARM
        return Abi(Abi::ArmArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    default:
        return Abi();
    }
}

Tobias Hunger's avatar
Tobias Hunger committed
108 109 110 111 112 113 114 115 116 117 118
static QList<Abi> parseCoffHeader(const QByteArray &data)
{
    QList<Abi> result;
    if (data.size() < 20)
        return result;

    Abi::Architecture arch = Abi::UnknownArchitecture;
    Abi::OSFlavor flavor = Abi::UnknownFlavor;
    int width = 0;

    // Get machine field from COFF file header
Tobias Hunger's avatar
Tobias Hunger committed
119
    quint16 machine = getLEUint16(data, 0);
Tobias Hunger's avatar
Tobias Hunger committed
120
    switch (machine) {
121 122 123 124 125 126
    case 0x01c0: // ARM LE
    case 0x01c2: // ARM or thumb
    case 0x01c4: // ARMv7 thumb
        arch = Abi::ArmArchitecture;
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
127 128 129 130 131 132 133 134
    case 0x8664: // x86_64
        arch = Abi::X86Architecture;
        width = 64;
        break;
    case 0x014c: // i386
        arch = Abi::X86Architecture;
        width = 32;
        break;
135
    case 0x0166: // MIPS, little endian
Tobias Hunger's avatar
Tobias Hunger committed
136
        arch = Abi::MipsArchitecture;
137 138
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
139 140 141 142 143 144
    case 0x0200: // ia64
        arch = Abi::ItaniumArchitecture;
        width = 64;
        break;
    }

145
    if (data.size() >= 24) {
Tobias Hunger's avatar
Tobias Hunger committed
146
        // Get Major and Minor Image Version from optional header fields
147 148 149 150
        quint8 minorLinker = data.at(23);
        switch (data.at(22)) {
        case 2:
        case 3: // not yet reached:-)
Tobias Hunger's avatar
Tobias Hunger committed
151
            flavor = Abi::WindowsMSysFlavor;
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
            break;
        case 8:
            flavor = Abi::WindowsMsvc2005Flavor;
            break;
        case 9:
            flavor = Abi::WindowsMsvc2008Flavor;
            break;
        case 10:
            flavor = Abi::WindowsMsvc2010Flavor;
            break;
        case 11:
            flavor = Abi::WindowsMsvc2012Flavor;
            break;
        default: // Keep unknown flavor
            if (minorLinker != 0)
                flavor = Abi::WindowsMSysFlavor; // MSVC seems to avoid using minor numbers
            else
Tobias Hunger's avatar
Tobias Hunger committed
169
                qWarning("%s: Unknown MSVC flavour encountered.", Q_FUNC_INFO);
170
            break;
171
        }
Tobias Hunger's avatar
Tobias Hunger committed
172 173 174 175 176 177 178 179
    }

    if (arch != Abi::UnknownArchitecture && width != 0)
        result.append(Abi(arch, Abi::WindowsOS, flavor, Abi::PEFormat, width));

    return result;
}

180 181 182
static QList<Abi> abiOf(const QByteArray &data)
{
    QList<Abi> result;
Tobias Hunger's avatar
Tobias Hunger committed
183 184
    if (data.size() <= 8)
        return result;
185 186

    if (data.size() >= 20
Tobias Hunger's avatar
Tobias Hunger committed
187 188
            && getUint8(data, 0) == 0x7f && getUint8(data, 1) == 'E' && getUint8(data, 2) == 'L'
            && getUint8(data, 3) == 'F') {
189
        // ELF format:
Tobias Hunger's avatar
Tobias Hunger committed
190 191 192
        bool isLE = (getUint8(data, 5) == 1);
        quint16 machine = isLE ? getLEUint16(data, 18) : getBEUint16(data, 18);
        quint8 osAbi = getUint8(data, 7);
193 194 195 196 197 198 199 200 201 202 203

        Abi::OS os = Abi::UnixOS;
        Abi::OSFlavor flavor = Abi::GenericUnixFlavor;
        // http://www.sco.com/developers/gabi/latest/ch4.eheader.html#elfid
        switch (osAbi) {
        case 2: // NetBSD:
            os = Abi::BsdOS;
            flavor = Abi::NetBsdFlavor;
            break;
        case 3: // Linux:
        case 0: // no extra info available: Default to Linux:
204
        case 97: // ARM, also linux most of the time.
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
            os = Abi::LinuxOS;
            flavor = Abi::GenericLinuxFlavor;
            break;
        case 6: // Solaris:
            os = Abi::UnixOS;
            flavor = Abi::SolarisUnixFlavor;
            break;
        case 9: // FreeBSD:
            os = Abi::BsdOS;
            flavor = Abi::FreeBsdFlavor;
            break;
        case 12: // OpenBSD:
            os = Abi::BsdOS;
            flavor = Abi::OpenBsdFlavor;
        }
220

221 222
        switch (machine) {
        case 3: // EM_386
223
            result.append(Abi(Abi::X86Architecture, os, flavor, Abi::ElfFormat, 32));
224 225
            break;
        case 8: // EM_MIPS
Tobias Hunger's avatar
Tobias Hunger committed
226
            result.append(Abi(Abi::MipsArchitecture, os, flavor, Abi::ElfFormat, 32));
227 228
            break;
        case 20: // EM_PPC
229
            result.append(Abi(Abi::PowerPCArchitecture, os, flavor, Abi::ElfFormat, 32));
230 231
            break;
        case 21: // EM_PPC64
232
            result.append(Abi(Abi::PowerPCArchitecture, os, flavor, Abi::ElfFormat, 64));
233
            break;
234
        case 40: // EM_ARM
235
            result.append(Abi(Abi::ArmArchitecture, os, flavor, Abi::ElfFormat, 32));
236
            break;
237
        case 62: // EM_X86_64
238
            result.append(Abi(Abi::X86Architecture, os, flavor, Abi::ElfFormat, 64));
239
            break;
Tobias Hunger's avatar
Tobias Hunger committed
240 241 242
        case 42: // EM_SH
            result.append(Abi(Abi::ShArchitecture, os, flavor, Abi::ElfFormat, 32));
            break;
243
        case 50: // EM_IA_64
244
            result.append(Abi(Abi::ItaniumArchitecture, os, flavor, Abi::ElfFormat, 64));
245 246 247 248
            break;
        default:
            ;;
        }
Tobias Hunger's avatar
Tobias Hunger committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    } else if (((getUint8(data, 0) == 0xce || getUint8(data, 0) == 0xcf)
             && getUint8(data, 1) == 0xfa && getUint8(data, 2) == 0xed && getUint8(data, 3) == 0xfe
            )
            ||
            (getUint8(data, 0) == 0xfe && getUint8(data, 1) == 0xed && getUint8(data, 2) == 0xfa
             && (getUint8(data, 3) == 0xce || getUint8(data, 3) == 0xcf)
            )
           ) {
            // Mach-O format (Mac non-fat binary, 32 and 64bit magic):
            quint32 type = (getUint8(data, 1) ==  0xfa) ? getLEUint32(data, 4) : getBEUint32(data, 4);
            result.append(macAbiForCpu(type));
    } else if ((getUint8(data, 0) == 0xbe && getUint8(data, 1) == 0xba
                && getUint8(data, 2) == 0xfe && getUint8(data, 3) == 0xca)
               ||
               (getUint8(data, 0) == 0xca && getUint8(data, 1) == 0xfe
                && getUint8(data, 2) == 0xba && getUint8(data, 3) == 0xbe)
              ) {
        // Mach-0 format Fat binary header:
        bool isLE = (getUint8(data, 0) == 0xbe);
        quint32 count = isLE ? getLEUint32(data, 4) : getBEUint32(data, 4);
269 270 271 272 273
        int pos = 8;
        for (quint32 i = 0; i < count; ++i) {
            if (data.size() <= pos + 4)
                break;

Tobias Hunger's avatar
Tobias Hunger committed
274
            quint32 type = isLE ? getLEUint32(data, pos) : getBEUint32(data, pos);
275 276 277
            result.append(macAbiForCpu(type));
            pos += 20;
        }
278
    } else if (data.size() >= 64){
Tobias Hunger's avatar
Tobias Hunger committed
279
        // Windows PE: values are LE (except for a few exceptions which we will not use here).
280

Tobias Hunger's avatar
Tobias Hunger committed
281
        // MZ header first (ZM is also allowed, but rarely used)
Robert Loehning's avatar
Robert Loehning committed
282 283 284 285
        const quint8 firstChar = getUint8(data, 0);
        const quint8 secondChar = getUint8(data, 1);
        if ((firstChar != 'M' || secondChar != 'Z') && (firstChar != 'Z' || secondChar != 'M'))
            return result;
286 287

        // Get PE/COFF header position from MZ header:
Tobias Hunger's avatar
Tobias Hunger committed
288
        qint32 pePos = getLEUint32(data, 60);
289 290
        if (pePos <= 0 || data.size() < pePos + 4 + 20) // PE magic bytes plus COFF header
            return result;
Tobias Hunger's avatar
Tobias Hunger committed
291 292
        if (getUint8(data, pePos) == 'P' && getUint8(data, pePos + 1) == 'E'
            && getUint8(data, pePos + 2) == 0 && getUint8(data, pePos + 3) == 0)
Tobias Hunger's avatar
Tobias Hunger committed
293
            result = parseCoffHeader(data.mid(pePos + 4));
294 295 296 297 298 299 300 301
    }
    return result;
}

// --------------------------------------------------------------------------
// Abi
// --------------------------------------------------------------------------

302
Abi::Abi(const Architecture &a, const OS &o,
hjk's avatar
hjk committed
303
         const OSFlavor &of, const BinaryFormat &f, unsigned char w) :
304 305 306
    m_architecture(a), m_os(o), m_osFlavor(of), m_binaryFormat(f), m_wordWidth(w)
{
    switch (m_os) {
hjk's avatar
hjk committed
307 308
    case ProjectExplorer::Abi::UnknownOS:
        m_osFlavor = UnknownFlavor;
309
        break;
hjk's avatar
hjk committed
310
    case ProjectExplorer::Abi::LinuxOS:
311
        if (m_osFlavor < GenericLinuxFlavor || m_osFlavor > MaemoLinuxFlavor)
hjk's avatar
hjk committed
312
            m_osFlavor = UnknownFlavor;
313
        break;
314 315
    case ProjectExplorer::Abi::BsdOS:
        m_osFlavor = FreeBsdFlavor;
316
        break;
hjk's avatar
hjk committed
317 318 319
    case ProjectExplorer::Abi::MacOS:
        if (m_osFlavor < GenericMacFlavor || m_osFlavor > GenericMacFlavor)
            m_osFlavor = UnknownFlavor;
320
        break;
hjk's avatar
hjk committed
321 322 323
    case ProjectExplorer::Abi::UnixOS:
        if (m_osFlavor < GenericUnixFlavor || m_osFlavor > GenericUnixFlavor)
            m_osFlavor = UnknownFlavor;
324
        break;
hjk's avatar
hjk committed
325
    case ProjectExplorer::Abi::WindowsOS:
326
        if (m_osFlavor < WindowsMsvc2005Flavor || m_osFlavor > WindowsCEFlavor)
hjk's avatar
hjk committed
327
            m_osFlavor = UnknownFlavor;
328 329 330 331 332
        break;
    }
}

Abi::Abi(const QString &abiString) :
hjk's avatar
hjk committed
333 334
    m_architecture(UnknownArchitecture), m_os(UnknownOS),
    m_osFlavor(UnknownFlavor), m_binaryFormat(UnknownFormat), m_wordWidth(0)
335 336 337 338
{
    QStringList abiParts = abiString.split(QLatin1Char('-'));
    if (abiParts.count() >= 1) {
        if (abiParts.at(0) == QLatin1String("unknown"))
hjk's avatar
hjk committed
339
            m_architecture = UnknownArchitecture;
340
        else if (abiParts.at(0) == QLatin1String("arm"))
hjk's avatar
hjk committed
341
            m_architecture = ArmArchitecture;
342
        else if (abiParts.at(0) == QLatin1String("x86"))
hjk's avatar
hjk committed
343
            m_architecture = X86Architecture;
344
        else if (abiParts.at(0) == QLatin1String("mips"))
Tobias Hunger's avatar
Tobias Hunger committed
345
            m_architecture = MipsArchitecture;
346
        else if (abiParts.at(0) == QLatin1String("ppc"))
hjk's avatar
hjk committed
347
            m_architecture = PowerPCArchitecture;
348
        else if (abiParts.at(0) == QLatin1String("itanium"))
hjk's avatar
hjk committed
349
            m_architecture = ItaniumArchitecture;
Tobias Hunger's avatar
Tobias Hunger committed
350 351
        else if (abiParts.at(0) == QLatin1String("sh"))
            m_architecture = ShArchitecture;
352 353 354 355 356 357
        else
            return;
    }

    if (abiParts.count() >= 2) {
        if (abiParts.at(1) == QLatin1String("unknown"))
hjk's avatar
hjk committed
358
            m_os = UnknownOS;
359
        else if (abiParts.at(1) == QLatin1String("linux"))
hjk's avatar
hjk committed
360
            m_os = LinuxOS;
361 362
        else if (abiParts.at(1) == QLatin1String("bsd"))
            m_os = BsdOS;
363
        else if (abiParts.at(1) == QLatin1String("macos"))
hjk's avatar
hjk committed
364
            m_os = MacOS;
365
        else if (abiParts.at(1) == QLatin1String("unix"))
hjk's avatar
hjk committed
366
            m_os = UnixOS;
367
        else if (abiParts.at(1) == QLatin1String("windows"))
hjk's avatar
hjk committed
368
            m_os = WindowsOS;
369
        else
370

371 372 373 374 375
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
376 377 378
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
BogDan Vatra's avatar
BogDan Vatra committed
379 380
        else if (abiParts.at(2) == QLatin1String("android") && m_os == LinuxOS)
            m_osFlavor = AndroidLinuxFlavor;
381 382 383 384 385 386
        else if (abiParts.at(2) == QLatin1String("freebsd") && m_os == BsdOS)
            m_osFlavor = FreeBsdFlavor;
        else if (abiParts.at(2) == QLatin1String("netbsd") && m_os == BsdOS)
            m_osFlavor = NetBsdFlavor;
        else if (abiParts.at(2) == QLatin1String("openbsd") && m_os == BsdOS)
            m_osFlavor = OpenBsdFlavor;
hjk's avatar
hjk committed
387 388
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
389 390
        else if (abiParts.at(2) == QLatin1String("harmattan") && m_os == LinuxOS)
            m_osFlavor = HarmattanLinuxFlavor;
hjk's avatar
hjk committed
391 392 393 394
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == MacOS)
            m_osFlavor = GenericMacFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == UnixOS)
            m_osFlavor = GenericUnixFlavor;
395 396
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
397 398 399 400 401 402
        else if (abiParts.at(2) == QLatin1String("msvc2005") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2005Flavor;
        else if (abiParts.at(2) == QLatin1String("msvc2008") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2008Flavor;
        else if (abiParts.at(2) == QLatin1String("msvc2010") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2010Flavor;
Tobias Hunger's avatar
Tobias Hunger committed
403 404
        else if (abiParts.at(2) == QLatin1String("msvc2012") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2012Flavor;
hjk's avatar
hjk committed
405 406 407 408
        else if (abiParts.at(2) == QLatin1String("msys") && m_os == WindowsOS)
            m_osFlavor = WindowsMSysFlavor;
        else if (abiParts.at(2) == QLatin1String("ce") && m_os == WindowsOS)
            m_osFlavor = WindowsCEFlavor;
409 410 411 412 413 414
        else
            return;
    }

    if (abiParts.count() >= 4) {
        if (abiParts.at(3) == QLatin1String("unknown"))
hjk's avatar
hjk committed
415
            m_binaryFormat = UnknownFormat;
416
        else if (abiParts.at(3) == QLatin1String("elf"))
hjk's avatar
hjk committed
417
            m_binaryFormat = ElfFormat;
418
        else if (abiParts.at(3) == QLatin1String("pe"))
hjk's avatar
hjk committed
419
            m_binaryFormat = PEFormat;
420
        else if (abiParts.at(3) == QLatin1String("mach_o"))
hjk's avatar
hjk committed
421
            m_binaryFormat = MachOFormat;
422
        else if (abiParts.at(3) == QLatin1String("qml_rt"))
hjk's avatar
hjk committed
423
            m_binaryFormat = RuntimeQmlFormat;
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
        else
            return;
    }

    if (abiParts.count() >= 5) {
        const QString &bits = abiParts.at(4);
        if (!bits.endsWith(QLatin1String("bit")))
            return;

        bool ok = false;
        int bitCount = bits.left(bits.count() - 3).toInt(&ok);
        if (!ok)
            return;
        if (bitCount != 8 && bitCount != 16 && bitCount != 32 && bitCount != 64)
            return;
        m_wordWidth = bitCount;
    }
}

QString Abi::toString() const
{
    QStringList dn;
    dn << toString(m_architecture);
    dn << toString(m_os);
    dn << toString(m_osFlavor);
    dn << toString(m_binaryFormat);
    dn << toString(m_wordWidth);

    return dn.join(QLatin1String("-"));
}

Tobias Hunger's avatar
Tobias Hunger committed
455 456 457 458 459
bool Abi::operator != (const Abi &other) const
{
    return !operator ==(other);
}

460 461 462 463 464 465 466 467 468 469 470
bool Abi::operator == (const Abi &other) const
{
    return m_architecture == other.m_architecture
            && m_os == other.m_os
            && m_osFlavor == other.m_osFlavor
            && m_binaryFormat == other.m_binaryFormat
            && m_wordWidth == other.m_wordWidth;
}

bool Abi::isCompatibleWith(const Abi &other) const
{
471 472 473 474 475
    bool isCompat = (architecture() == other.architecture() || other.architecture() == Abi::UnknownArchitecture)
                     && (os() == other.os() || other.os() == Abi::UnknownOS)
                     && (osFlavor() == other.osFlavor() || other.osFlavor() == Abi::UnknownFlavor)
                     && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                     && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0);
476 477 478 479 480 481
    // *-linux-generic-* is compatible with *-linux-* (both ways): This is for the benefit of
    // people building Qt themselves using e.g. a meego toolchain.
    //
    // We leave it to the specific targets to catch filter out the tool chains that do not
    // work for them.
    if (!isCompat && (architecture() == other.architecture() || other.architecture() == Abi::UnknownArchitecture)
Tobias Hunger's avatar
Tobias Hunger committed
482
                  && ((os() == other.os()) && (os() == LinuxOS))
483 484 485
                  && (osFlavor() == GenericLinuxFlavor || other.osFlavor() == GenericLinuxFlavor)
                  && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                  && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0))
486
        isCompat = true;
BogDan Vatra's avatar
BogDan Vatra committed
487 488
    if (osFlavor() == AndroidLinuxFlavor || other.osFlavor() == AndroidLinuxFlavor)
        isCompat = (osFlavor() == other.osFlavor() && architecture() == other.architecture());
489
    return isCompat;
490 491 492 493
}

bool Abi::isValid() const
{
hjk's avatar
hjk committed
494 495 496 497
    return m_architecture != UnknownArchitecture
            && m_os != UnknownOS
            && m_osFlavor != UnknownFlavor
            && m_binaryFormat != UnknownFormat
498 499 500
            && m_wordWidth != 0;
}

Tobias Hunger's avatar
Tobias Hunger committed
501 502 503 504 505 506 507 508 509
bool Abi::isNull() const
{
    return m_architecture == UnknownArchitecture
            && m_os == UnknownOS
            && m_osFlavor == UnknownFlavor
            && m_binaryFormat == UnknownFormat
            && m_wordWidth == 0;
}

510 511 512
QString Abi::toString(const Architecture &a)
{
    switch (a) {
hjk's avatar
hjk committed
513
    case ArmArchitecture:
514
        return QLatin1String("arm");
hjk's avatar
hjk committed
515
    case X86Architecture:
516
        return QLatin1String("x86");
Tobias Hunger's avatar
Tobias Hunger committed
517
    case MipsArchitecture:
518
        return QLatin1String("mips");
hjk's avatar
hjk committed
519
    case PowerPCArchitecture:
520
        return QLatin1String("ppc");
hjk's avatar
hjk committed
521
    case ItaniumArchitecture:
522
        return QLatin1String("itanium");
Tobias Hunger's avatar
Tobias Hunger committed
523
    case ShArchitecture:
Tobias Hunger's avatar
Tobias Hunger committed
524
        return QLatin1String("sh");
hjk's avatar
hjk committed
525
    case UnknownArchitecture: // fall through!
526 527 528 529 530 531 532 533
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(const OS &o)
{
    switch (o) {
hjk's avatar
hjk committed
534
    case LinuxOS:
535
        return QLatin1String("linux");
536 537
    case BsdOS:
        return QLatin1String("bsd");
hjk's avatar
hjk committed
538
    case MacOS:
539
        return QLatin1String("macos");
hjk's avatar
hjk committed
540
    case UnixOS:
541
        return QLatin1String("unix");
hjk's avatar
hjk committed
542
    case WindowsOS:
543
        return QLatin1String("windows");
hjk's avatar
hjk committed
544
    case UnknownOS: // fall through!
545 546 547 548 549
    default:
        return QLatin1String("unknown");
    };
}

hjk's avatar
hjk committed
550
QString Abi::toString(const OSFlavor &of)
551 552
{
    switch (of) {
hjk's avatar
hjk committed
553
    case ProjectExplorer::Abi::GenericLinuxFlavor:
554
        return QLatin1String("generic");
BogDan Vatra's avatar
BogDan Vatra committed
555 556
    case ProjectExplorer::Abi::AndroidLinuxFlavor:
        return QLatin1String("android");
557 558 559 560 561 562
    case ProjectExplorer::Abi::FreeBsdFlavor:
        return QLatin1String("freebsd");
    case ProjectExplorer::Abi::NetBsdFlavor:
        return QLatin1String("netbsd");
    case ProjectExplorer::Abi::OpenBsdFlavor:
        return QLatin1String("openbsd");
hjk's avatar
hjk committed
563
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
564
        return QLatin1String("maemo");
hjk's avatar
hjk committed
565
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
566
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
567
    case ProjectExplorer::Abi::GenericMacFlavor:
568
        return QLatin1String("generic");
hjk's avatar
hjk committed
569
    case ProjectExplorer::Abi::GenericUnixFlavor:
570
        return QLatin1String("generic");
571 572
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
573 574 575 576 577 578
    case ProjectExplorer::Abi::WindowsMsvc2005Flavor:
        return QLatin1String("msvc2005");
    case ProjectExplorer::Abi::WindowsMsvc2008Flavor:
        return QLatin1String("msvc2008");
    case ProjectExplorer::Abi::WindowsMsvc2010Flavor:
        return QLatin1String("msvc2010");
Tobias Hunger's avatar
Tobias Hunger committed
579 580
    case ProjectExplorer::Abi::WindowsMsvc2012Flavor:
        return QLatin1String("msvc2012");
hjk's avatar
hjk committed
581
    case ProjectExplorer::Abi::WindowsMSysFlavor:
582
        return QLatin1String("msys");
hjk's avatar
hjk committed
583
    case ProjectExplorer::Abi::WindowsCEFlavor:
584
        return QLatin1String("ce");
585
    case ProjectExplorer::Abi::UnknownFlavor: // fall through!
586 587 588 589 590 591 592 593
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(const BinaryFormat &bf)
{
    switch (bf) {
hjk's avatar
hjk committed
594
    case ElfFormat:
595
        return QLatin1String("elf");
hjk's avatar
hjk committed
596
    case PEFormat:
597
        return QLatin1String("pe");
hjk's avatar
hjk committed
598
    case MachOFormat:
599
        return QLatin1String("mach_o");
hjk's avatar
hjk committed
600
    case RuntimeQmlFormat:
601
        return QLatin1String("qml_rt");
hjk's avatar
hjk committed
602
    case UnknownFormat: // fall through!
603 604 605 606 607 608 609 610 611 612 613 614
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(int w)
{
    if (w == 0)
        return QLatin1String("unknown");
    return QString::fromLatin1("%1bit").arg(w);
}

615 616 617 618 619
QList<Abi::OSFlavor> Abi::flavorsForOs(const Abi::OS &o)
{
    QList<OSFlavor> result;
    switch (o) {
    case BsdOS:
620
        return result << FreeBsdFlavor << OpenBsdFlavor << NetBsdFlavor << UnknownFlavor;
621
    case LinuxOS:
622
        return result << GenericLinuxFlavor << HarmattanLinuxFlavor << MaemoLinuxFlavor
623
                      << AndroidLinuxFlavor << UnknownFlavor;
624
    case MacOS:
625
        return result << GenericMacFlavor << UnknownFlavor;
626
    case UnixOS:
627
        return result << GenericUnixFlavor << SolarisUnixFlavor << UnknownFlavor;
628 629
    case WindowsOS:
        return result << WindowsMsvc2005Flavor << WindowsMsvc2008Flavor << WindowsMsvc2010Flavor
630
                      << WindowsMsvc2012Flavor << WindowsMSysFlavor << WindowsCEFlavor << UnknownFlavor;
631 632 633 634 635 636 637
    case UnknownOS:
        return result << UnknownFlavor;
    default:
        break;
    }
    return result;
}
638 639 640 641

Abi Abi::hostAbi()
{
    Architecture arch = QTC_CPU; // define set by qmake
hjk's avatar
hjk committed
642 643 644
    OS os = UnknownOS;
    OSFlavor subos = UnknownFlavor;
    BinaryFormat format = UnknownFormat;
645 646

#if defined (Q_OS_WIN)
hjk's avatar
hjk committed
647
    os = WindowsOS;
Tobias Hunger's avatar
Tobias Hunger committed
648 649 650
#if _MSC_VER == 1700
    subos = WindowsMsvc2012Flavor;
#elif _MSC_VER == 1600
651 652 653 654 655
    subos = WindowsMsvc2010Flavor;
#elif _MSC_VER == 1500
    subos = WindowsMsvc2008Flavor;
#elif _MSC_VER == 1400
    subos = WindowsMsvc2005Flavor;
656
#elif defined (Q_CC_MINGW)
657 658
    subos = WindowsMSysFlavor;
#endif
hjk's avatar
hjk committed
659
    format = PEFormat;
660
#elif defined (Q_OS_LINUX)
hjk's avatar
hjk committed
661 662 663
    os = LinuxOS;
    subos = GenericLinuxFlavor;
    format = ElfFormat;
664
#elif defined (Q_OS_MAC)
hjk's avatar
hjk committed
665 666 667
    os = MacOS;
    subos = GenericMacFlavor;
    format = MachOFormat;
668 669
#endif

Tobias Hunger's avatar
Tobias Hunger committed
670 671 672 673 674
    const Abi result(arch, os, subos, format, QSysInfo::WordSize);
    if (!result.isValid())
        qWarning("Unable to completely determine the host ABI (%s).",
                 qPrintable(result.toString()));
    return result;
675 676
}

Tobias Hunger's avatar
Tobias Hunger committed
677
QList<Abi> Abi::abisOfBinary(const Utils::FileName &path)
678
{
679
    QList<Abi> tmp;
680
    if (path.isEmpty())
681
        return tmp;
682

Tobias Hunger's avatar
Tobias Hunger committed
683
    QFile f(path.toString());
684
    if (!f.exists())
685
        return tmp;
686

Montel Laurent's avatar
Montel Laurent committed
687 688 689
    if (!f.open(QFile::ReadOnly))
        return tmp;

690
    QByteArray data = f.read(1024);
691
    if (data.size() >= 67
Tobias Hunger's avatar
Tobias Hunger committed
692 693 694
            && getUint8(data, 0) == '!' && getUint8(data, 1) == '<' && getUint8(data, 2) == 'a'
            && getUint8(data, 3) == 'r' && getUint8(data, 4) == 'c' && getUint8(data, 5) == 'h'
            && getUint8(data, 6) == '>' && getUint8(data, 7) == 0x0a) {
695
        // We got an ar file: possibly a static lib for ELF, PE or Mach-O
696 697 698 699 700

        data = data.mid(8); // Cut of ar file magic
        quint64 offset = 8;

        while (!data.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
701
            if ((getUint8(data, 58) != 0x60 || getUint8(data, 59) != 0x0a)) {
Tobias Hunger's avatar
Tobias Hunger committed
702
                qWarning() << path.toString() << ": Thought it was an ar-file, but it is not!";
703
                break;
704
            }
705

706 707 708 709
            const QString fileName = QString::fromLocal8Bit(data.mid(0, 16));
            quint64 fileNameOffset = 0;
            if (fileName.startsWith(QLatin1String("#1/")))
                fileNameOffset = fileName.mid(3).toInt();
710
            const QString fileLength = QString::fromLatin1(data.mid(48, 10));
711

Tobias Hunger's avatar
Tobias Hunger committed
712
            int toSkip = 60 + fileNameOffset;
713
            offset += fileLength.toInt() + 60 /* header */;
714 715 716 717 718

            tmp.append(abiOf(data.mid(toSkip)));
            if (tmp.isEmpty() && fileName == QLatin1String("/0              "))
                tmp = parseCoffHeader(data.mid(toSkip, 20)); // This might be windws...

719 720
            if (!tmp.isEmpty()
                    && tmp.at(0).binaryFormat() != Abi::MachOFormat)
721
                break;
722

723
            offset += (offset % 2); // ar is 2 byte aligned
724
            f.seek(offset);
725
            data = f.read(1024);
726
        }
727
    } else {
728
        tmp = abiOf(data);
729
    }
730 731
    f.close();

732 733 734 735 736 737 738
    // Remove duplicates:
    QList<Abi> result;
    foreach (const Abi &a, tmp) {
        if (!result.contains(a))
            result.append(a);
    }

739 740 741 742
    return result;
}

} // namespace ProjectExplorer
743 744 745 746

// Unit tests:
#ifdef WITH_TESTS
#   include <QTest>
747
#   include <QFileInfo>
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

#   include "projectexplorer.h"

void ProjectExplorer::ProjectExplorerPlugin::testAbiOfBinary_data()
{
    QTest::addColumn<QString>("file");
    QTest::addColumn<QStringList>("abis");

    QTest::newRow("no file")
            << QString()
            << (QStringList());
    QTest::newRow("non existing file")
            << QString::fromLatin1("/does/not/exist")
            << (QStringList());

    // Set up prefix for test data now that we can be sure to have some tests to run:
764
    QString prefix = QString::fromLocal8Bit(qgetenv("QTC_TEST_EXTRADATALOCATION"));
765 766
    if (prefix.isEmpty())
        return;
767
    prefix += QLatin1String("/projectexplorer/abi");
768

769 770 771 772 773 774 775 776 777 778
    QFileInfo fi(prefix);
    if (!fi.exists() || !fi.isDir())
        return;
    prefix = fi.absoluteFilePath();

    QTest::newRow("text file")
            << QString::fromLatin1("%1/broken/text.txt").arg(prefix)
            << (QStringList());

    QTest::newRow("static QtCore: win msvc2008")
779
            << QString::fromLatin1("%1/static/win-msvc2008-release.lib").arg(prefix)
780
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
781
    QTest::newRow("static QtCore: win msvc2008 II")
782
            << QString::fromLatin1("%1/static/win-msvc2008-release2.lib").arg(prefix)
783
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-64bit"));
784
    QTest::newRow("static QtCore: win msvc2008 (debug)")
785
            << QString::fromLatin1("%1/static/win-msvc2008-debug.lib").arg(prefix)
786
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
787
    QTest::newRow("static QtCore: win mingw")
788
            << QString::fromLatin1("%1/static/win-mingw.a").arg(prefix)
789
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
790
    QTest::newRow("static QtCore: mac (debug)")
791
            << QString::fromLatin1("%1/static/mac-32bit-debug.a").arg(prefix)
792 793
            << (QStringList() << QString::fromLatin1("x86-macos-generic-mach_o-32bit"));
    QTest::newRow("static QtCore: linux 32bit")
794
            << QString::fromLatin1("%1/static/linux-32bit-release.a").arg(prefix)
795 796
            << (QStringList() << QString::fromLatin1("x86-linux-generic-elf-32bit"));
    QTest::newRow("static QtCore: linux 64bit")
797
            << QString::fromLatin1("%1/static/linux-64bit-release.a").arg(prefix)
798 799 800
            << (QStringList() << QString::fromLatin1("x86-linux-generic-elf-64bit"));

    QTest::newRow("static stdc++: mac fat")
801
            << QString::fromLatin1("%1/static/mac-fat.a").arg(prefix)
802 803 804 805 806
            << (QStringList() << QString::fromLatin1("x86-macos-generic-mach_o-32bit")
                              << QString::fromLatin1("ppc-macos-generic-mach_o-32bit")
                              << QString::fromLatin1("x86-macos-generic-mach_o-64bit"));

    QTest::newRow("dynamic QtCore: win msvc2010 64bit")
807
            << QString::fromLatin1("%1/dynamic/win-msvc2010-64bit.dll").arg(prefix)
808 809
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2010-pe-64bit"));
    QTest::newRow("dynamic QtCore: win msvc2008 32bit")
810
            << QString::fromLatin1("%1/dynamic/win-msvc2008-32bit.dll").arg(prefix)
811 812
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2008-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msvc2005 32bit")
813
            << QString::fromLatin1("%1/dynamic/win-msvc2005-32bit.dll").arg(prefix)
814 815
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2005-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msys 32bit")
816
            << QString::fromLatin1("%1/dynamic/win-mingw-32bit.dll").arg(prefix)
817
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
818 819 820
    QTest::newRow("dynamic QtCore: win mingw 64bit")
            << QString::fromLatin1("%1/dynamic/win-mingw-64bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-64bit"));
821
    QTest::newRow("dynamic QtCore: wince mips msvc2005 32bit")
822 823
            << QString::fromLatin1("%1/dynamic/wince-32bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("mips-windows-msvc2005-pe-32bit"));
824 825 826 827
    QTest::newRow("dynamic QtCore: wince arm msvc2008 32bit")
            << QString::fromLatin1("%1/dynamic/arm-win-ce-pe-32bit").arg(prefix)
            << (QStringList() << QString::fromLatin1("arm-windows-msvc2008-pe-32bit"));

828
    QTest::newRow("dynamic stdc++: mac fat")
829
            << QString::fromLatin1("%1/dynamic/mac-fat.dylib").arg(prefix)
830 831 832
            << (QStringList() << QString::fromLatin1("x86-macos-generic-mach_o-32bit")
                              << QString::fromLatin1("ppc-macos-generic-mach_o-32bit")
                              << QString::fromLatin1("x86-macos-generic-mach_o-64bit"));
833
    QTest::newRow("dynamic QtCore: arm linux 32bit")
834
            << QString::fromLatin1("%1/dynamic/arm-linux.so").arg(prefix)
835
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
836 837 838
    QTest::newRow("dynamic QtCore: arm linux 32bit, using ARM as OSABI")
            << QString::fromLatin1("%1/dynamic/arm-linux2.so").arg(prefix)
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
839 840 841
    QTest::newRow("dynamic QtCore: arm linux 32bit (angstrom)")
            << QString::fromLatin1("%1/dynamic/arm-angstrom-linux.so").arg(prefix)
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
842 843 844
    QTest::newRow("dynamic QtCore: sh4 linux 32bit")
            << QString::fromLatin1("%1/dynamic/sh4-linux.so").arg(prefix)
            << (QStringList() << QString::fromLatin1("sh-linux-generic-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
845
    QTest::newRow("dynamic QtCore: mips linux 32bit")
846
            << QString::fromLatin1("%1/dynamic/mips-linux.so").arg(prefix)
Tobias Hunger's avatar
Tobias Hunger committed
847
            << (QStringList() << QString::fromLatin1("mips-linux-generic-elf-32bit"));
848 849 850
    QTest::newRow("dynamic QtCore: projectexplorer/abi/static/win-msvc2010-32bit.libppc be linux 32bit")
            << QString::fromLatin1("%1/dynamic/ppcbe-linux-32bit.so").arg(prefix)
            << (QStringList() << QString::fromLatin1("ppc-linux-generic-elf-32bit"));
851
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
852
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
853 854
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
855
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
856 857
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 32bit")
858
            << QString::fromLatin1("%1/dynamic/freebsd-elf-32bit.so").arg(prefix)
859
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
860 861 862 863

    QTest::newRow("executable: x86 win 32bit cygwin executable")
            << QString::fromLatin1("%1/executable/cygwin-32bit.exe").arg(prefix)
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
864 865 866
    QTest::newRow("executable: x86 win 32bit mingw executable")
            << QString::fromLatin1("%1/executable/mingw-32bit.exe").arg(prefix)
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
867 868 869 870 871 872 873
}

void ProjectExplorer::ProjectExplorerPlugin::testAbiOfBinary()
{
    QFETCH(QString, file);
    QFETCH(QStringList, abis);

Tobias Hunger's avatar
Tobias Hunger committed
874
    QList<ProjectExplorer::Abi> result = Abi::abisOfBinary(Utils::FileName::fromString(file));
875 876 877 878 879
    QCOMPARE(result.count(), abis.count());
    for (int i = 0; i < abis.count(); ++i)
        QCOMPARE(result.at(i).toString(), abis.at(i));
}

880 881 882 883 884 885 886 887 888 889 890
void ProjectExplorer::ProjectExplorerPlugin::testFlavorForOs()
{
    QList<QList<ProjectExplorer::Abi::OSFlavor> > flavorLists;
    for (int i = 0; i != static_cast<int>(Abi::UnknownOS); ++i)
        flavorLists.append(Abi::flavorsForOs(static_cast<Abi::OS>(i)));

    int foundCounter = 0;
    for (int i = 0; i != Abi::UnknownFlavor; ++i) {
        foundCounter = 0;
        // make sure i is in exactly on of the flavor lists!
        foreach (const QList<Abi::OSFlavor> &l, flavorLists) {
891
            QVERIFY(l.contains(Abi::UnknownFlavor));
892 893 894 895 896 897 898
            if (l.contains(static_cast<Abi::OSFlavor>(i)))
                ++foundCounter;
        }
        QCOMPARE(foundCounter, 1);
    }
}

Daniel Teske's avatar
Daniel Teske committed
899

900
#endif