abi.cpp 33.6 KB
Newer Older
1 2 3 4 5 6
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
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
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
30 31 32 33 34 35
**
**************************************************************************/

#include "abi.h"

#include <QtCore/QCoreApplication>
Tobias Hunger's avatar
Tobias Hunger committed
36
#include <QtCore/QDebug>
37
#include <QtCore/QtEndian>
38 39 40 41 42
#include <QtCore/QFile>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QSysInfo>

43 44 45 46 47 48 49 50
/*!
    \class ProjectExplorer::Abi

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

    \sa ProjectExplorer::ToolChain
*/

51 52
namespace ProjectExplorer {

53 54 55 56
// --------------------------------------------------------------------------
// Helpers
// --------------------------------------------------------------------------

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

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
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
109 110 111 112 113 114 115 116 117 118 119
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
120
    quint16 machine = getLEUint16(data, 0);
Tobias Hunger's avatar
Tobias Hunger committed
121 122 123 124 125 126 127 128 129
    switch (machine) {
    case 0x8664: // x86_64
        arch = Abi::X86Architecture;
        width = 64;
        break;
    case 0x014c: // i386
        arch = Abi::X86Architecture;
        width = 32;
        break;
130
    case 0x0166: // MIPS, little endian
Tobias Hunger's avatar
Tobias Hunger committed
131
        arch = Abi::MipsArchitecture;
132 133
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
134 135 136 137 138 139 140 141
    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
142
        quint32 image = getLEUint32(data, 64);
143
        if (image == 1) { // Image is 1 for mingw and higher for MSVC (4.something in some encoding)
Tobias Hunger's avatar
Tobias Hunger committed
144
            flavor = Abi::WindowsMSysFlavor;
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
        } 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
161 162 163 164 165 166 167 168
    }

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

    return result;
}

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

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

        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:
            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;
        }
208

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

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

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

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

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

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

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

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

369 370 371 372 373
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
374 375 376
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
377 378 379 380 381 382
        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
383 384 385 386 387 388 389 390 391 392 393 394
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
        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;
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;
hjk's avatar
hjk committed
403 404 405 406
        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;
407 408 409 410 411 412
        else
            return;
    }

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

458 459 460 461 462 463 464 465 466 467 468
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
{
469 470 471 472 473
    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);
474 475 476 477 478 479
    // *-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
480
                  && ((os() == other.os()) && (os() == LinuxOS))
481 482 483
                  && (osFlavor() == GenericLinuxFlavor || other.osFlavor() == GenericLinuxFlavor)
                  && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                  && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0))
484 485
        isCompat = true;
    return isCompat;
486 487 488 489
}

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

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

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

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

hjk's avatar
hjk committed
548
QString Abi::toString(const OSFlavor &of)
549 550
{
    switch (of) {
hjk's avatar
hjk committed
551
    case ProjectExplorer::Abi::GenericLinuxFlavor:
552
        return QLatin1String("generic");
553 554 555 556 557 558
    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
559
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
560
        return QLatin1String("maemo");
hjk's avatar
hjk committed
561
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
562
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
563
    case ProjectExplorer::Abi::MeegoLinuxFlavor:
564
        return QLatin1String("meego");
hjk's avatar
hjk committed
565
    case ProjectExplorer::Abi::GenericMacFlavor:
566
        return QLatin1String("generic");
hjk's avatar
hjk committed
567
    case ProjectExplorer::Abi::SymbianDeviceFlavor:
568
        return QLatin1String("device");
hjk's avatar
hjk committed
569
    case ProjectExplorer::Abi::SymbianEmulatorFlavor:
570
        return QLatin1String("emulator");
hjk's avatar
hjk committed
571
    case ProjectExplorer::Abi::GenericUnixFlavor:
572
        return QLatin1String("generic");
573 574
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
575 576 577 578 579 580
    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
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 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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;
}
639 640 641 642

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

#if defined (Q_OS_WIN)
hjk's avatar
hjk committed
648
    os = WindowsOS;
649 650 651 652 653 654 655 656 657
#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
658
    format = PEFormat;
659
#elif defined (Q_OS_LINUX)
hjk's avatar
hjk committed
660 661 662
    os = LinuxOS;
    subos = GenericLinuxFlavor;
    format = ElfFormat;
663
#elif defined (Q_OS_MAC)
hjk's avatar
hjk committed
664 665 666
    os = MacOS;
    subos = GenericMacFlavor;
    format = MachOFormat;
667 668 669 670 671 672 673
#endif

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

QList<Abi> Abi::abisOfBinary(const QString &path)
{
674
    QList<Abi> tmp;
675
    if (path.isEmpty())
676
        return tmp;
677 678 679

    QFile f(path);
    if (!f.exists())
680
        return tmp;
681 682 683

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

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

        while (!data.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
694
            if ((getUint8(data, 58) != 0x60 || getUint8(data, 59) != 0x0a)) {
695
                qWarning() << path << ": Thought it was an ar-file, but it is not!";
696
                break;
697
            }
698

699 700 701 702 703
            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));
704

Tobias Hunger's avatar
Tobias Hunger committed
705
            int toSkip = 60 + fileNameOffset;
706
            offset += fileLength.toInt() + 60 /* header */;
707 708 709 710 711

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

712 713
            if (!tmp.isEmpty()
                    && tmp.at(0).binaryFormat() != Abi::MachOFormat)
714
                break;
715

716
            offset += (offset % 2); // ar is 2 byte aligned
717
            f.seek(offset);
718
            data = f.read(1024);
719
        }
720
    } else {
721
        tmp = abiOf(data);
722
    }
723 724
    f.close();

725 726 727 728 729 730 731
    // Remove duplicates:
    QList<Abi> result;
    foreach (const Abi &a, tmp) {
        if (!result.contains(a))
            result.append(a);
    }

732 733 734 735
    return result;
}

} // namespace ProjectExplorer
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

// Unit tests:
#ifdef WITH_TESTS
#   include <QTest>
#   include <QtCore/QFileInfo>

#   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:
    QString prefix = qgetenv("QTC_TEST_EXTRADATALOCATION");
    if (prefix.isEmpty())
        return;
760 761
    prefix += "/projectexplorer/abi";

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

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

    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
850 851 852
    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"));
853 854 855 856 857 858 859 860 861 862 863 864 865
}

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

    QList<ProjectExplorer::Abi> result = Abi::abisOfBinary(file);
    QCOMPARE(result.count(), abis.count());
    for (int i = 0; i < abis.count(); ++i)
        QCOMPARE(result.at(i).toString(), abis.at(i));
}

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
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);
    }
}

885
#endif