abi.cpp 34.3 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 154 155 156 157 158
        } else {
            switch (data.at(22)) {
            case 8:
                flavor = Abi::WindowsMsvc2005Flavor;
                break;
            case 9:
                flavor = Abi::WindowsMsvc2008Flavor;
                break;
            case 10:
                flavor = Abi::WindowsMsvc2010Flavor;
                break;
            default:
                // Keep unknown flavor
                break;
            }
        }
Tobias Hunger's avatar
Tobias Hunger committed
159 160 161 162 163 164 165 166
    }

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

    return result;
}

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

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

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

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

Tobias Hunger's avatar
Tobias Hunger committed
261
            quint32 type = isLE ? getLEUint32(data, pos) : getBEUint32(data, pos);
262 263 264
            result.append(macAbiForCpu(type));
            pos += 20;
        }
265
    } else if (data.size() >= 20
Tobias Hunger's avatar
Tobias Hunger committed
266 267
               && getUint8(data, 16) == 'E' && getUint8(data, 17) == 'P'
               && getUint8(data, 18) == 'O' && getUint8(data, 19) == 'C') {
268
        result.append(Abi(Abi::ArmArchitecture, Abi::SymbianOS, Abi::SymbianDeviceFlavor, Abi::ElfFormat, 32));
269
    } else if (data.size() >= 64){
Tobias Hunger's avatar
Tobias Hunger committed
270
        // Windows PE: values are LE (except for a few exceptions which we will not use here).
271

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

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

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

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

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

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

368 369 370 371 372
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
373 374 375
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
BogDan Vatra's avatar
BogDan Vatra committed
376 377
        else if (abiParts.at(2) == QLatin1String("android") && m_os == LinuxOS)
            m_osFlavor = AndroidLinuxFlavor;
378 379 380 381 382 383
        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
384 385
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
386 387
        else if (abiParts.at(2) == QLatin1String("harmattan") && m_os == LinuxOS)
            m_osFlavor = HarmattanLinuxFlavor;
hjk's avatar
hjk committed
388 389 390 391 392 393 394 395 396 397
        else if (abiParts.at(2) == QLatin1String("meego") && m_os == LinuxOS)
            m_osFlavor = MeegoLinuxFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == MacOS)
            m_osFlavor = GenericMacFlavor;
        else if (abiParts.at(2) == QLatin1String("device") && m_os == SymbianOS)
            m_osFlavor = SymbianDeviceFlavor;
        else if (abiParts.at(2) == QLatin1String("emulator") && m_os == SymbianOS)
            m_osFlavor = SymbianEmulatorFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == UnixOS)
            m_osFlavor = GenericUnixFlavor;
398 399
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
400 401 402 403 404 405
        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;
hjk's avatar
hjk committed
406 407 408 409
        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;
410 411 412 413 414 415
        else
            return;
    }

    if (abiParts.count() >= 4) {
        if (abiParts.at(3) == QLatin1String("unknown"))
hjk's avatar
hjk committed
416
            m_binaryFormat = UnknownFormat;
417
        else if (abiParts.at(3) == QLatin1String("elf"))
hjk's avatar
hjk committed
418
            m_binaryFormat = ElfFormat;
419
        else if (abiParts.at(3) == QLatin1String("pe"))
hjk's avatar
hjk committed
420
            m_binaryFormat = PEFormat;
421
        else if (abiParts.at(3) == QLatin1String("mach_o"))
hjk's avatar
hjk committed
422
            m_binaryFormat = MachOFormat;
423
        else if (abiParts.at(3) == QLatin1String("qml_rt"))
hjk's avatar
hjk committed
424
            m_binaryFormat = RuntimeQmlFormat;
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 455
        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
456 457 458 459 460
bool Abi::operator != (const Abi &other) const
{
    return !operator ==(other);
}

461 462 463 464 465 466 467 468 469 470 471
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
{
472 473 474 475 476
    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);
477 478 479 480 481 482
    // *-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
483
                  && ((os() == other.os()) && (os() == LinuxOS))
484 485 486
                  && (osFlavor() == GenericLinuxFlavor || other.osFlavor() == GenericLinuxFlavor)
                  && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                  && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0))
487
        isCompat = true;
BogDan Vatra's avatar
BogDan Vatra committed
488 489
    if (osFlavor() == AndroidLinuxFlavor || other.osFlavor() == AndroidLinuxFlavor)
        isCompat = (osFlavor() == other.osFlavor() && architecture() == other.architecture());
490
    return isCompat;
491 492 493 494
}

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

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

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

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

hjk's avatar
hjk committed
553
QString Abi::toString(const OSFlavor &of)
554 555
{
    switch (of) {
hjk's avatar
hjk committed
556
    case ProjectExplorer::Abi::GenericLinuxFlavor:
557
        return QLatin1String("generic");
BogDan Vatra's avatar
BogDan Vatra committed
558 559
    case ProjectExplorer::Abi::AndroidLinuxFlavor:
        return QLatin1String("android");
560 561 562 563 564 565
    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
566
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
567
        return QLatin1String("maemo");
hjk's avatar
hjk committed
568
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
569
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
570
    case ProjectExplorer::Abi::MeegoLinuxFlavor:
571
        return QLatin1String("meego");
hjk's avatar
hjk committed
572
    case ProjectExplorer::Abi::GenericMacFlavor:
573
        return QLatin1String("generic");
hjk's avatar
hjk committed
574
    case ProjectExplorer::Abi::SymbianDeviceFlavor:
575
        return QLatin1String("device");
hjk's avatar
hjk committed
576
    case ProjectExplorer::Abi::SymbianEmulatorFlavor:
577
        return QLatin1String("emulator");
hjk's avatar
hjk committed
578
    case ProjectExplorer::Abi::GenericUnixFlavor:
579
        return QLatin1String("generic");
580 581
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
582 583 584 585 586 587
    case ProjectExplorer::Abi::WindowsMsvc2005Flavor:
        return QLatin1String("msvc2005");
    case ProjectExplorer::Abi::WindowsMsvc2008Flavor:
        return QLatin1String("msvc2008");
    case ProjectExplorer::Abi::WindowsMsvc2010Flavor:
        return QLatin1String("msvc2010");
hjk's avatar
hjk committed
588
    case ProjectExplorer::Abi::WindowsMSysFlavor:
589
        return QLatin1String("msys");
hjk's avatar
hjk committed
590
    case ProjectExplorer::Abi::WindowsCEFlavor:
591
        return QLatin1String("ce");
592
    case ProjectExplorer::Abi::UnknownFlavor: // fall through!
593 594 595 596 597 598 599 600
    default:
        return QLatin1String("unknown");
    }
}

QString Abi::toString(const BinaryFormat &bf)
{
    switch (bf) {
hjk's avatar
hjk committed
601
    case ElfFormat:
602
        return QLatin1String("elf");
hjk's avatar
hjk committed
603
    case PEFormat:
604
        return QLatin1String("pe");
hjk's avatar
hjk committed
605
    case MachOFormat:
606
        return QLatin1String("mach_o");
hjk's avatar
hjk committed
607
    case RuntimeQmlFormat:
608
        return QLatin1String("qml_rt");
hjk's avatar
hjk committed
609
    case UnknownFormat: // fall through!
610 611 612 613 614 615 616 617 618 619 620 621
    default:
        return QLatin1String("unknown");
    }
}

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

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
QList<Abi::OSFlavor> Abi::flavorsForOs(const Abi::OS &o)
{
    QList<OSFlavor> result;
    switch (o) {
    case BsdOS:
        return result << FreeBsdFlavor << OpenBsdFlavor << NetBsdFlavor;
    case LinuxOS:
        return result << GenericLinuxFlavor << HarmattanLinuxFlavor << MaemoLinuxFlavor << MeegoLinuxFlavor;
    case MacOS:
        return result << GenericMacFlavor;
    case SymbianOS:
        return  result << SymbianDeviceFlavor << SymbianEmulatorFlavor;
    case UnixOS:
        return result << GenericUnixFlavor << SolarisUnixFlavor;
    case WindowsOS:
        return result << WindowsMsvc2005Flavor << WindowsMsvc2008Flavor << WindowsMsvc2010Flavor
                      << WindowsMSysFlavor << WindowsCEFlavor;
    case UnknownOS:
        return result << UnknownFlavor;
    default:
        break;
    }
    return result;
}
646 647 648 649

Abi Abi::hostAbi()
{
    Architecture arch = QTC_CPU; // define set by qmake
hjk's avatar
hjk committed
650 651 652
    OS os = UnknownOS;
    OSFlavor subos = UnknownFlavor;
    BinaryFormat format = UnknownFormat;
653 654

#if defined (Q_OS_WIN)
hjk's avatar
hjk committed
655
    os = WindowsOS;
656 657 658 659 660 661 662 663 664
#if _MSC_VER == 1600
    subos = WindowsMsvc2010Flavor;
#elif _MSC_VER == 1500
    subos = WindowsMsvc2008Flavor;
#elif _MSC_VER == 1400
    subos = WindowsMsvc2005Flavor;
#elif defined (mingw32)
    subos = WindowsMSysFlavor;
#endif
hjk's avatar
hjk committed
665
    format = PEFormat;
666
#elif defined (Q_OS_LINUX)
hjk's avatar
hjk committed
667 668 669
    os = LinuxOS;
    subos = GenericLinuxFlavor;
    format = ElfFormat;
670
#elif defined (Q_OS_MAC)
hjk's avatar
hjk committed
671 672 673
    os = MacOS;
    subos = GenericMacFlavor;
    format = MachOFormat;
674 675 676 677 678
#endif

    return Abi(arch, os, subos, format, QSysInfo::WordSize);
}

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

Tobias Hunger's avatar
Tobias Hunger committed
685
    QFile f(path.toString());
686
    if (!f.exists())
687
        return tmp;
688 689 690

    f.open(QFile::ReadOnly);
    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 710
            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));
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: symbian")
807
            << QString::fromLatin1("%1/dynamic/symbian.dll").arg(prefix)
808 809
            << (QStringList() << QString::fromLatin1("arm-symbian-device-elf-32bit"));
    QTest::newRow("dynamic QtCore: win msvc2010 64bit")
810
            << QString::fromLatin1("%1/dynamic/win-msvc2010-64bit.dll").arg(prefix)
811 812
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2010-pe-64bit"));
    QTest::newRow("dynamic QtCore: win msvc2008 32bit")
813
            << QString::fromLatin1("%1/dynamic/win-msvc2008-32bit.dll").arg(prefix)
814 815
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2008-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msvc2005 32bit")
816
            << QString::fromLatin1("%1/dynamic/win-msvc2005-32bit.dll").arg(prefix)
817 818
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2005-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msys 32bit")
819
            << QString::fromLatin1("%1/dynamic/win-mingw-32bit.dll").arg(prefix)
820
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
821 822 823
    QTest::newRow("dynamic QtCore: wince msvc2005 32bit")
            << QString::fromLatin1("%1/dynamic/wince-32bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("mips-windows-msvc2005-pe-32bit"));
824
    QTest::newRow("dynamic stdc++: mac fat")
825
            << QString::fromLatin1("%1/dynamic/mac-fat.dylib").arg(prefix)
826 827 828
            << (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"));
829
    QTest::newRow("dynamic QtCore: arm linux 32bit")
830
            << QString::fromLatin1("%1/dynamic/arm-linux.so").arg(prefix)
831
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
832 833 834
    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
835 836 837
    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
838 839 840
    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
841
    QTest::newRow("dynamic QtCore: mips linux 32bit")
842
            << QString::fromLatin1("%1/dynamic/mips-linux.so").arg(prefix)
Tobias Hunger's avatar
Tobias Hunger committed
843
            << (QStringList() << QString::fromLatin1("mips-linux-generic-elf-32bit"));
844 845 846
    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"));
847
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
848
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
849 850
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
851
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
852 853
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 32bit")
854
            << QString::fromLatin1("%1/dynamic/freebsd-elf-32bit.so").arg(prefix)
855
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
856 857 858 859

    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
860 861 862
    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"));
863 864 865 866 867 868 869
}

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

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

876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
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);
    }
}

895
#endif