abi.cpp 34 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

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

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

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

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

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

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

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

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

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

370 371 372 373 374
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
375 376 377
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
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 386 387 388 389 390 391 392 393 394 395
        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;
396 397
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
398 399 400 401 402 403
        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
404 405 406 407
        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;
408 409 410 411 412 413
        else
            return;
    }

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

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

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

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

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

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

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

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

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

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
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;
}
640 641 642 643

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

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

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

Tobias Hunger's avatar
Tobias Hunger committed
673
QList<Abi> Abi::abisOfBinary(const Utils::FileName &path)
674
{
675
    QList<Abi> tmp;
676
    if (path.isEmpty())
677
        return tmp;
678

Tobias Hunger's avatar
Tobias Hunger committed
679
    QFile f(path.toString());
680
    if (!f.exists())
681
        return tmp;
682 683 684

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

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

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

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

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

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

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

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

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

733 734 735 736
    return result;
}

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

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

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

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

    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
854 855 856
    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"));
857 858 859 860 861 862 863
}

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

Tobias Hunger's avatar
Tobias Hunger committed
864
    QList<ProjectExplorer::Abi> result = Abi::abisOfBinary(Utils::FileName::fromString(file));
865 866 867 868 869
    QCOMPARE(result.count(), abis.count());
    for (int i = 0; i < abis.count(); ++i)
        QCOMPARE(result.at(i).toString(), abis.at(i));
}

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
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);
    }
}

889
#endif