abi.cpp 33.6 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18 19
**
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
28 29 30 31 32
**
**************************************************************************/

#include "abi.h"

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

41 42 43 44 45 46 47 48
/*!
    \class ProjectExplorer::Abi

    \brief Represents the Application Binary Interface (ABI) of a target platform.

    \sa ProjectExplorer::ToolChain
*/

49 50
namespace ProjectExplorer {

51 52 53 54
// --------------------------------------------------------------------------
// Helpers
// --------------------------------------------------------------------------

Tobias Hunger's avatar
Tobias Hunger committed
55 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
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));
}

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
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
107 108 109 110 111 112 113 114 115 116 117
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
118
    quint16 machine = getLEUint16(data, 0);
Tobias Hunger's avatar
Tobias Hunger committed
119 120 121 122 123 124 125 126 127
    switch (machine) {
    case 0x8664: // x86_64
        arch = Abi::X86Architecture;
        width = 64;
        break;
    case 0x014c: // i386
        arch = Abi::X86Architecture;
        width = 32;
        break;
128
    case 0x0166: // MIPS, little endian
Tobias Hunger's avatar
Tobias Hunger committed
129
        arch = Abi::MipsArchitecture;
130 131
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
132 133 134 135 136 137 138 139
    case 0x0200: // ia64
        arch = Abi::ItaniumArchitecture;
        width = 64;
        break;
    }

    if (data.size() >= 68) {
        // Get Major and Minor Image Version from optional header fields
Tobias Hunger's avatar
Tobias Hunger committed
140
        quint32 image = getLEUint32(data, 64);
141
        if (image == 1) { // Image is 1 for mingw and higher for MSVC (4.something in some encoding)
Tobias Hunger's avatar
Tobias Hunger committed
142
            flavor = Abi::WindowsMSysFlavor;
143 144 145 146 147 148 149 150 151 152 153
        } else {
            switch (data.at(22)) {
            case 8:
                flavor = Abi::WindowsMsvc2005Flavor;
                break;
            case 9:
                flavor = Abi::WindowsMsvc2008Flavor;
                break;
            case 10:
                flavor = Abi::WindowsMsvc2010Flavor;
                break;
Tobias Hunger's avatar
Tobias Hunger committed
154 155 156 157 158
            case 11:
                flavor = Abi::WindowsMsvc2012Flavor;
                break;
            default: // Keep unknown flavor
                qWarning("%s: Unknown MSVC flavour encountered.", Q_FUNC_INFO);
159 160 161
                break;
            }
        }
Tobias Hunger's avatar
Tobias Hunger committed
162 163 164 165 166 167 168 169
    }

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

    return result;
}

170 171 172
static QList<Abi> abiOf(const QByteArray &data)
{
    QList<Abi> result;
Tobias Hunger's avatar
Tobias Hunger committed
173 174
    if (data.size() <= 8)
        return result;
175 176

    if (data.size() >= 20
Tobias Hunger's avatar
Tobias Hunger committed
177 178
            && getUint8(data, 0) == 0x7f && getUint8(data, 1) == 'E' && getUint8(data, 2) == 'L'
            && getUint8(data, 3) == 'F') {
179
        // ELF format:
Tobias Hunger's avatar
Tobias Hunger committed
180 181 182
        bool isLE = (getUint8(data, 5) == 1);
        quint16 machine = isLE ? getLEUint16(data, 18) : getBEUint16(data, 18);
        quint8 osAbi = getUint8(data, 7);
183 184 185 186 187 188 189 190 191 192 193

        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:
194
        case 97: // ARM, also linux most of the time.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
            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;
        }
210

211 212
        switch (machine) {
        case 3: // EM_386
213
            result.append(Abi(Abi::X86Architecture, os, flavor, Abi::ElfFormat, 32));
214 215
            break;
        case 8: // EM_MIPS
Tobias Hunger's avatar
Tobias Hunger committed
216
            result.append(Abi(Abi::MipsArchitecture, os, flavor, Abi::ElfFormat, 32));
217 218
            break;
        case 20: // EM_PPC
219
            result.append(Abi(Abi::PowerPCArchitecture, os, flavor, Abi::ElfFormat, 32));
220 221
            break;
        case 21: // EM_PPC64
222
            result.append(Abi(Abi::PowerPCArchitecture, os, flavor, Abi::ElfFormat, 64));
223
            break;
224
        case 40: // EM_ARM
225
            result.append(Abi(Abi::ArmArchitecture, os, flavor, Abi::ElfFormat, 32));
226
            break;
227
        case 62: // EM_X86_64
228
            result.append(Abi(Abi::X86Architecture, os, flavor, Abi::ElfFormat, 64));
229
            break;
Tobias Hunger's avatar
Tobias Hunger committed
230 231 232
        case 42: // EM_SH
            result.append(Abi(Abi::ShArchitecture, os, flavor, Abi::ElfFormat, 32));
            break;
233
        case 50: // EM_IA_64
234
            result.append(Abi(Abi::ItaniumArchitecture, os, flavor, Abi::ElfFormat, 64));
235 236 237 238
            break;
        default:
            ;;
        }
Tobias Hunger's avatar
Tobias Hunger committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    } 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);
259 260 261 262 263
        int pos = 8;
        for (quint32 i = 0; i < count; ++i) {
            if (data.size() <= pos + 4)
                break;

Tobias Hunger's avatar
Tobias Hunger committed
264
            quint32 type = isLE ? getLEUint32(data, pos) : getBEUint32(data, pos);
265 266 267
            result.append(macAbiForCpu(type));
            pos += 20;
        }
268
    } else if (data.size() >= 64){
Tobias Hunger's avatar
Tobias Hunger committed
269
        // Windows PE: values are LE (except for a few exceptions which we will not use here).
270

Tobias Hunger's avatar
Tobias Hunger committed
271
        // MZ header first (ZM is also allowed, but rarely used)
Robert Loehning's avatar
Robert Loehning committed
272 273 274 275
        const quint8 firstChar = getUint8(data, 0);
        const quint8 secondChar = getUint8(data, 1);
        if ((firstChar != 'M' || secondChar != 'Z') && (firstChar != 'Z' || secondChar != 'M'))
            return result;
276 277

        // Get PE/COFF header position from MZ header:
Tobias Hunger's avatar
Tobias Hunger committed
278
        qint32 pePos = getLEUint32(data, 60);
279 280
        if (pePos <= 0 || data.size() < pePos + 4 + 20) // PE magic bytes plus COFF header
            return result;
Tobias Hunger's avatar
Tobias Hunger committed
281 282
        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
283
            result = parseCoffHeader(data.mid(pePos + 4));
284 285 286 287 288 289 290 291
    }
    return result;
}

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

292
Abi::Abi(const Architecture &a, const OS &o,
hjk's avatar
hjk committed
293
         const OSFlavor &of, const BinaryFormat &f, unsigned char w) :
294 295 296
    m_architecture(a), m_os(o), m_osFlavor(of), m_binaryFormat(f), m_wordWidth(w)
{
    switch (m_os) {
hjk's avatar
hjk committed
297 298
    case ProjectExplorer::Abi::UnknownOS:
        m_osFlavor = UnknownFlavor;
299
        break;
hjk's avatar
hjk committed
300
    case ProjectExplorer::Abi::LinuxOS:
301
        if (m_osFlavor < GenericLinuxFlavor || m_osFlavor > MaemoLinuxFlavor)
hjk's avatar
hjk committed
302
            m_osFlavor = UnknownFlavor;
303
        break;
304 305
    case ProjectExplorer::Abi::BsdOS:
        m_osFlavor = FreeBsdFlavor;
306
        break;
hjk's avatar
hjk committed
307 308 309
    case ProjectExplorer::Abi::MacOS:
        if (m_osFlavor < GenericMacFlavor || m_osFlavor > GenericMacFlavor)
            m_osFlavor = UnknownFlavor;
310
        break;
hjk's avatar
hjk committed
311 312 313
    case ProjectExplorer::Abi::UnixOS:
        if (m_osFlavor < GenericUnixFlavor || m_osFlavor > GenericUnixFlavor)
            m_osFlavor = UnknownFlavor;
314
        break;
hjk's avatar
hjk committed
315
    case ProjectExplorer::Abi::WindowsOS:
316
        if (m_osFlavor < WindowsMsvc2005Flavor || m_osFlavor > WindowsCEFlavor)
hjk's avatar
hjk committed
317
            m_osFlavor = UnknownFlavor;
318 319 320 321 322
        break;
    }
}

Abi::Abi(const QString &abiString) :
hjk's avatar
hjk committed
323 324
    m_architecture(UnknownArchitecture), m_os(UnknownOS),
    m_osFlavor(UnknownFlavor), m_binaryFormat(UnknownFormat), m_wordWidth(0)
325 326 327 328
{
    QStringList abiParts = abiString.split(QLatin1Char('-'));
    if (abiParts.count() >= 1) {
        if (abiParts.at(0) == QLatin1String("unknown"))
hjk's avatar
hjk committed
329
            m_architecture = UnknownArchitecture;
330
        else if (abiParts.at(0) == QLatin1String("arm"))
hjk's avatar
hjk committed
331
            m_architecture = ArmArchitecture;
332
        else if (abiParts.at(0) == QLatin1String("x86"))
hjk's avatar
hjk committed
333
            m_architecture = X86Architecture;
334
        else if (abiParts.at(0) == QLatin1String("mips"))
Tobias Hunger's avatar
Tobias Hunger committed
335
            m_architecture = MipsArchitecture;
336
        else if (abiParts.at(0) == QLatin1String("ppc"))
hjk's avatar
hjk committed
337
            m_architecture = PowerPCArchitecture;
338
        else if (abiParts.at(0) == QLatin1String("itanium"))
hjk's avatar
hjk committed
339
            m_architecture = ItaniumArchitecture;
Tobias Hunger's avatar
Tobias Hunger committed
340 341
        else if (abiParts.at(0) == QLatin1String("sh"))
            m_architecture = ShArchitecture;
342 343 344 345 346 347
        else
            return;
    }

    if (abiParts.count() >= 2) {
        if (abiParts.at(1) == QLatin1String("unknown"))
hjk's avatar
hjk committed
348
            m_os = UnknownOS;
349
        else if (abiParts.at(1) == QLatin1String("linux"))
hjk's avatar
hjk committed
350
            m_os = LinuxOS;
351 352
        else if (abiParts.at(1) == QLatin1String("bsd"))
            m_os = BsdOS;
353
        else if (abiParts.at(1) == QLatin1String("macos"))
hjk's avatar
hjk committed
354
            m_os = MacOS;
355
        else if (abiParts.at(1) == QLatin1String("unix"))
hjk's avatar
hjk committed
356
            m_os = UnixOS;
357
        else if (abiParts.at(1) == QLatin1String("windows"))
hjk's avatar
hjk committed
358
            m_os = WindowsOS;
359
        else
360

361 362 363 364 365
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
366 367 368
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
BogDan Vatra's avatar
BogDan Vatra committed
369 370
        else if (abiParts.at(2) == QLatin1String("android") && m_os == LinuxOS)
            m_osFlavor = AndroidLinuxFlavor;
371 372 373 374 375 376
        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
377 378
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
379 380
        else if (abiParts.at(2) == QLatin1String("harmattan") && m_os == LinuxOS)
            m_osFlavor = HarmattanLinuxFlavor;
hjk's avatar
hjk committed
381 382 383 384
        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;
385 386
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
387 388 389 390 391 392
        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
393 394
        else if (abiParts.at(2) == QLatin1String("msvc2012") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2012Flavor;
hjk's avatar
hjk committed
395 396 397 398
        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;
399 400 401 402 403 404
        else
            return;
    }

    if (abiParts.count() >= 4) {
        if (abiParts.at(3) == QLatin1String("unknown"))
hjk's avatar
hjk committed
405
            m_binaryFormat = UnknownFormat;
406
        else if (abiParts.at(3) == QLatin1String("elf"))
hjk's avatar
hjk committed
407
            m_binaryFormat = ElfFormat;
408
        else if (abiParts.at(3) == QLatin1String("pe"))
hjk's avatar
hjk committed
409
            m_binaryFormat = PEFormat;
410
        else if (abiParts.at(3) == QLatin1String("mach_o"))
hjk's avatar
hjk committed
411
            m_binaryFormat = MachOFormat;
412
        else if (abiParts.at(3) == QLatin1String("qml_rt"))
hjk's avatar
hjk committed
413
            m_binaryFormat = RuntimeQmlFormat;
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
        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
445 446 447 448 449
bool Abi::operator != (const Abi &other) const
{
    return !operator ==(other);
}

450 451 452 453 454 455 456 457 458 459 460
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
{
461 462 463 464 465
    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);
466 467 468 469 470 471
    // *-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
472
                  && ((os() == other.os()) && (os() == LinuxOS))
473 474 475
                  && (osFlavor() == GenericLinuxFlavor || other.osFlavor() == GenericLinuxFlavor)
                  && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                  && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0))
476
        isCompat = true;
BogDan Vatra's avatar
BogDan Vatra committed
477 478
    if (osFlavor() == AndroidLinuxFlavor || other.osFlavor() == AndroidLinuxFlavor)
        isCompat = (osFlavor() == other.osFlavor() && architecture() == other.architecture());
479
    return isCompat;
480 481 482 483
}

bool Abi::isValid() const
{
hjk's avatar
hjk committed
484 485 486 487
    return m_architecture != UnknownArchitecture
            && m_os != UnknownOS
            && m_osFlavor != UnknownFlavor
            && m_binaryFormat != UnknownFormat
488 489 490
            && m_wordWidth != 0;
}

Tobias Hunger's avatar
Tobias Hunger committed
491 492 493 494 495 496 497 498 499
bool Abi::isNull() const
{
    return m_architecture == UnknownArchitecture
            && m_os == UnknownOS
            && m_osFlavor == UnknownFlavor
            && m_binaryFormat == UnknownFormat
            && m_wordWidth == 0;
}

500 501 502
QString Abi::toString(const Architecture &a)
{
    switch (a) {
hjk's avatar
hjk committed
503
    case ArmArchitecture:
504
        return QLatin1String("arm");
hjk's avatar
hjk committed
505
    case X86Architecture:
506
        return QLatin1String("x86");
Tobias Hunger's avatar
Tobias Hunger committed
507
    case MipsArchitecture:
508
        return QLatin1String("mips");
hjk's avatar
hjk committed
509
    case PowerPCArchitecture:
510
        return QLatin1String("ppc");
hjk's avatar
hjk committed
511
    case ItaniumArchitecture:
512
        return QLatin1String("itanium");
Tobias Hunger's avatar
Tobias Hunger committed
513
    case ShArchitecture:
Tobias Hunger's avatar
Tobias Hunger committed
514
        return QLatin1String("sh");
hjk's avatar
hjk committed
515
    case UnknownArchitecture: // fall through!
516 517 518 519 520 521 522 523
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(const OS &o)
{
    switch (o) {
hjk's avatar
hjk committed
524
    case LinuxOS:
525
        return QLatin1String("linux");
526 527
    case BsdOS:
        return QLatin1String("bsd");
hjk's avatar
hjk committed
528
    case MacOS:
529
        return QLatin1String("macos");
hjk's avatar
hjk committed
530
    case UnixOS:
531
        return QLatin1String("unix");
hjk's avatar
hjk committed
532
    case WindowsOS:
533
        return QLatin1String("windows");
hjk's avatar
hjk committed
534
    case UnknownOS: // fall through!
535 536 537 538 539
    default:
        return QLatin1String("unknown");
    };
}

hjk's avatar
hjk committed
540
QString Abi::toString(const OSFlavor &of)
541 542
{
    switch (of) {
hjk's avatar
hjk committed
543
    case ProjectExplorer::Abi::GenericLinuxFlavor:
544
        return QLatin1String("generic");
BogDan Vatra's avatar
BogDan Vatra committed
545 546
    case ProjectExplorer::Abi::AndroidLinuxFlavor:
        return QLatin1String("android");
547 548 549 550 551 552
    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
553
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
554
        return QLatin1String("maemo");
hjk's avatar
hjk committed
555
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
556
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
557
    case ProjectExplorer::Abi::GenericMacFlavor:
558
        return QLatin1String("generic");
hjk's avatar
hjk committed
559
    case ProjectExplorer::Abi::GenericUnixFlavor:
560
        return QLatin1String("generic");
561 562
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
563 564 565 566 567 568
    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
569 570
    case ProjectExplorer::Abi::WindowsMsvc2012Flavor:
        return QLatin1String("msvc2012");
hjk's avatar
hjk committed
571
    case ProjectExplorer::Abi::WindowsMSysFlavor:
572
        return QLatin1String("msys");
hjk's avatar
hjk committed
573
    case ProjectExplorer::Abi::WindowsCEFlavor:
574
        return QLatin1String("ce");
575
    case ProjectExplorer::Abi::UnknownFlavor: // fall through!
576 577 578 579 580 581 582 583
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(const BinaryFormat &bf)
{
    switch (bf) {
hjk's avatar
hjk committed
584
    case ElfFormat:
585
        return QLatin1String("elf");
hjk's avatar
hjk committed
586
    case PEFormat:
587
        return QLatin1String("pe");
hjk's avatar
hjk committed
588
    case MachOFormat:
589
        return QLatin1String("mach_o");
hjk's avatar
hjk committed
590
    case RuntimeQmlFormat:
591
        return QLatin1String("qml_rt");
hjk's avatar
hjk committed
592
    case UnknownFormat: // fall through!
593 594 595 596 597 598 599 600 601 602 603 604
    default:
        return QLatin1String("unknown");
    }
}

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

605 606 607 608 609 610 611
QList<Abi::OSFlavor> Abi::flavorsForOs(const Abi::OS &o)
{
    QList<OSFlavor> result;
    switch (o) {
    case BsdOS:
        return result << FreeBsdFlavor << OpenBsdFlavor << NetBsdFlavor;
    case LinuxOS:
612 613
        return result << GenericLinuxFlavor << HarmattanLinuxFlavor << MaemoLinuxFlavor
                      << AndroidLinuxFlavor;;
614 615 616 617 618 619
    case MacOS:
        return result << GenericMacFlavor;
    case UnixOS:
        return result << GenericUnixFlavor << SolarisUnixFlavor;
    case WindowsOS:
        return result << WindowsMsvc2005Flavor << WindowsMsvc2008Flavor << WindowsMsvc2010Flavor
Tobias Hunger's avatar
Tobias Hunger committed
620
                      << WindowsMsvc2012Flavor << WindowsMSysFlavor << WindowsCEFlavor;
621 622 623 624 625 626 627
    case UnknownOS:
        return result << UnknownFlavor;
    default:
        break;
    }
    return result;
}
628 629 630 631

Abi Abi::hostAbi()
{
    Architecture arch = QTC_CPU; // define set by qmake
hjk's avatar
hjk committed
632 633 634
    OS os = UnknownOS;
    OSFlavor subos = UnknownFlavor;
    BinaryFormat format = UnknownFormat;
635 636

#if defined (Q_OS_WIN)
hjk's avatar
hjk committed
637
    os = WindowsOS;
Tobias Hunger's avatar
Tobias Hunger committed
638 639 640
#if _MSC_VER == 1700
    subos = WindowsMsvc2012Flavor;
#elif _MSC_VER == 1600
641 642 643 644 645
    subos = WindowsMsvc2010Flavor;
#elif _MSC_VER == 1500
    subos = WindowsMsvc2008Flavor;
#elif _MSC_VER == 1400
    subos = WindowsMsvc2005Flavor;
646
#elif defined (Q_CC_MINGW)
647 648
    subos = WindowsMSysFlavor;
#endif
hjk's avatar
hjk committed
649
    format = PEFormat;
650
#elif defined (Q_OS_LINUX)
hjk's avatar
hjk committed
651 652 653
    os = LinuxOS;
    subos = GenericLinuxFlavor;
    format = ElfFormat;
654
#elif defined (Q_OS_MAC)
hjk's avatar
hjk committed
655 656 657
    os = MacOS;
    subos = GenericMacFlavor;
    format = MachOFormat;
658 659
#endif

Tobias Hunger's avatar
Tobias Hunger committed
660 661 662 663 664
    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;
665 666
}

Tobias Hunger's avatar
Tobias Hunger committed
667
QList<Abi> Abi::abisOfBinary(const Utils::FileName &path)
668
{
669
    QList<Abi> tmp;
670
    if (path.isEmpty())
671
        return tmp;
672

Tobias Hunger's avatar
Tobias Hunger committed
673
    QFile f(path.toString());
674
    if (!f.exists())
675
        return tmp;
676 677 678

    f.open(QFile::ReadOnly);
    QByteArray data = f.read(1024);
679
    if (data.size() >= 67
Tobias Hunger's avatar
Tobias Hunger committed
680 681 682
            && 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) {
683
        // We got an ar file: possibly a static lib for ELF, PE or Mach-O
684 685 686 687 688

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

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

694 695 696 697 698
            const QString fileName = QString::fromLocal8Bit(data.mid(0, 16));
            quint64 fileNameOffset = 0;
            if (fileName.startsWith(QLatin1String("#1/")))
                fileNameOffset = fileName.mid(3).toInt();
            const QString fileLength = QString::fromAscii(data.mid(48, 10));
699

Tobias Hunger's avatar
Tobias Hunger committed
700
            int toSkip = 60 + fileNameOffset;
701
            offset += fileLength.toInt() + 60 /* header */;
702 703 704 705 706

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

707 708
            if (!tmp.isEmpty()
                    && tmp.at(0).binaryFormat() != Abi::MachOFormat)
709
                break;
710

711
            offset += (offset % 2); // ar is 2 byte aligned
712
            f.seek(offset);
713
            data = f.read(1024);
714
        }
715
    } else {
716
        tmp = abiOf(data);
717
    }
718 719
    f.close();

720 721 722 723 724 725 726
    // Remove duplicates:
    QList<Abi> result;
    foreach (const Abi &a, tmp) {
        if (!result.contains(a))
            result.append(a);
    }

727 728 729 730
    return result;
}

} // namespace ProjectExplorer
731 732 733 734

// Unit tests:
#ifdef WITH_TESTS
#   include <QTest>
735
#   include <QFileInfo>
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

#   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:
752
    QString prefix = QString::fromLocal8Bit(qgetenv("QTC_TEST_EXTRADATALOCATION"));
753 754
    if (prefix.isEmpty())
        return;
755
    prefix += QLatin1String("/projectexplorer/abi");
756

757 758 759 760 761 762 763 764 765 766
    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")
767
            << QString::fromLatin1("%1/static/win-msvc2008-release.lib").arg(prefix)
768
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
769
    QTest::newRow("static QtCore: win msvc2008 II")
770
            << QString::fromLatin1("%1/static/win-msvc2008-release2.lib").arg(prefix)
771
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-64bit"));
772
    QTest::newRow("static QtCore: win msvc2008 (debug)")
773
            << QString::fromLatin1("%1/static/win-msvc2008-debug.lib").arg(prefix)
774
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
775
    QTest::newRow("static QtCore: win mingw")
776
            << QString::fromLatin1("%1/static/win-mingw.a").arg(prefix)
777
            << (QStringList() << QString::fromLatin1("x86-windows-unknown-pe-32bit"));
778
    QTest::newRow("static QtCore: mac (debug)")
779
            << QString::fromLatin1("%1/static/mac-32bit-debug.a").arg(prefix)
780 781
            << (QStringList() << QString::fromLatin1("x86-macos-generic-mach_o-32bit"));
    QTest::newRow("static QtCore: linux 32bit")
782
            << QString::fromLatin1("%1/static/linux-32bit-release.a").arg(prefix)
783 784
            << (QStringList() << QString::fromLatin1("x86-linux-generic-elf-32bit"));
    QTest::newRow("static QtCore: linux 64bit")
785
            << QString::fromLatin1("%1/static/linux-64bit-release.a").arg(prefix)
786 787 788
            << (QStringList() << QString::fromLatin1("x86-linux-generic-elf-64bit"));

    QTest::newRow("static stdc++: mac fat")
789
            << QString::fromLatin1("%1/static/mac-fat.a").arg(prefix)
790 791 792 793
            << (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"));

Tobias Hunger's avatar
Tobias Hunger committed
794 795 796
    QTest::newRow("dynamic QtCore: win msvc2012 64bit")
            << QString::fromLatin1("/tmp/win-msvc2012-64bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2012-pe-64bit"));
797
    QTest::newRow("dynamic QtCore: win msvc2010 64bit")
798
            << QString::fromLatin1("%1/dynamic/win-msvc2010-64bit.dll").arg(prefix)
799 800
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2010-pe-64bit"));
    QTest::newRow("dynamic QtCore: win msvc2008 32bit")
801
            << QString::fromLatin1("%1/dynamic/win-msvc2008-32bit.dll").arg(prefix)
802 803
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2008-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msvc2005 32bit")
804
            << QString::fromLatin1("%1/dynamic/win-msvc2005-32bit.dll").arg(prefix)
805 806
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2005-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msys 32bit")
807
            << QString::fromLatin1("%1/dynamic/win-mingw-32bit.dll").arg(prefix)
808
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
809 810 811
    QTest::newRow("dynamic QtCore: wince msvc2005 32bit")
            << QString::fromLatin1("%1/dynamic/wince-32bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("mips-windows-msvc2005-pe-32bit"));
812
    QTest::newRow("dynamic stdc++: mac fat")
813
            << QString::fromLatin1("%1/dynamic/mac-fat.dylib").arg(prefix)
814 815 816
            << (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"));
817
    QTest::newRow("dynamic QtCore: arm linux 32bit")
818
            << QString::fromLatin1("%1/dynamic/arm-linux.so").arg(prefix)
819
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
820 821 822
    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
823 824 825
    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
826 827 828
    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
829
    QTest::newRow("dynamic QtCore: mips linux 32bit")
830
            << QString::fromLatin1("%1/dynamic/mips-linux.so").arg(prefix)
Tobias Hunger's avatar
Tobias Hunger committed
831
            << (QStringList() << QString::fromLatin1("mips-linux-generic-elf-32bit"));
832 833 834
    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"));
835
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
836
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
837 838
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
839
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
840 841
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 32bit")
842
            << QString::fromLatin1("%1/dynamic/freebsd-elf-32bit.so").arg(prefix)
843
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
844 845 846 847

    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
848 849 850
    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"));
851 852 853 854 855 856 857
}

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

Tobias Hunger's avatar
Tobias Hunger committed
858
    QList<ProjectExplorer::Abi> result = Abi::abisOfBinary(Utils::FileName::fromString(file));
859 860 861 862 863
    QCOMPARE(result.count(), abis.count());
    for (int i = 0; i < abis.count(); ++i)
        QCOMPARE(result.at(i).toString(), abis.at(i));
}

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
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) {
            QVERIFY(!l.contains(Abi::UnknownFlavor));
            if (l.contains(static_cast<Abi::OSFlavor>(i)))
                ++foundCounter;
        }
        QCOMPARE(foundCounter, 1);
    }
}

883
#endif