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

#include "abi.h"

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

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

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

    \sa ProjectExplorer::ToolChain
*/

48 49
namespace ProjectExplorer {

50 51 52 53
// --------------------------------------------------------------------------
// Helpers
// --------------------------------------------------------------------------

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

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

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

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

    return result;
}

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

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

        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:
202
        case 97: // ARM, also linux most of the time.
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
            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;
        }
218

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

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

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

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

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

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

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

    if (abiParts.count() >= 2) {
        if (abiParts.at(1) == QLatin1String("unknown"))
hjk's avatar
hjk committed
356
            m_os = UnknownOS;
357
        else if (abiParts.at(1) == QLatin1String("linux"))
hjk's avatar
hjk committed
358
            m_os = LinuxOS;
359 360
        else if (abiParts.at(1) == QLatin1String("bsd"))
            m_os = BsdOS;
361
        else if (abiParts.at(1) == QLatin1String("macos"))
hjk's avatar
hjk committed
362
            m_os = MacOS;
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;
BogDan Vatra's avatar
BogDan Vatra committed
377 378
        else if (abiParts.at(2) == QLatin1String("android") && m_os == LinuxOS)
            m_osFlavor = AndroidLinuxFlavor;
379 380 381 382 383 384
        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
385 386
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
387 388
        else if (abiParts.at(2) == QLatin1String("harmattan") && m_os == LinuxOS)
            m_osFlavor = HarmattanLinuxFlavor;
hjk's avatar
hjk committed
389 390 391 392
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == MacOS)
            m_osFlavor = GenericMacFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == UnixOS)
            m_osFlavor = GenericUnixFlavor;
393 394
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
395 396 397 398 399 400
        else if (abiParts.at(2) == QLatin1String("msvc2005") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2005Flavor;
        else if (abiParts.at(2) == QLatin1String("msvc2008") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2008Flavor;
        else if (abiParts.at(2) == QLatin1String("msvc2010") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2010Flavor;
Tobias Hunger's avatar
Tobias Hunger committed
401 402
        else if (abiParts.at(2) == QLatin1String("msvc2012") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2012Flavor;
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
        isCompat = true;
BogDan Vatra's avatar
BogDan Vatra committed
485 486
    if (osFlavor() == AndroidLinuxFlavor || other.osFlavor() == AndroidLinuxFlavor)
        isCompat = (osFlavor() == other.osFlavor() && architecture() == other.architecture());
487
    return isCompat;
488 489 490 491
}

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

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

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

QString Abi::toString(const OS &o)
{
    switch (o) {
hjk's avatar
hjk committed
532
    case LinuxOS:
533
        return QLatin1String("linux");
534 535
    case BsdOS:
        return QLatin1String("bsd");
hjk's avatar
hjk committed
536
    case MacOS:
537
        return QLatin1String("macos");
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");
BogDan Vatra's avatar
BogDan Vatra committed
553 554
    case ProjectExplorer::Abi::AndroidLinuxFlavor:
        return QLatin1String("android");
555 556 557 558 559 560
    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
561
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
562
        return QLatin1String("maemo");
hjk's avatar
hjk committed
563
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
564
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
565
    case ProjectExplorer::Abi::GenericMacFlavor:
566
        return QLatin1String("generic");
hjk's avatar
hjk committed
567
    case ProjectExplorer::Abi::GenericUnixFlavor:
568
        return QLatin1String("generic");
569 570
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
571 572 573 574 575 576
    case ProjectExplorer::Abi::WindowsMsvc2005Flavor:
        return QLatin1String("msvc2005");
    case ProjectExplorer::Abi::WindowsMsvc2008Flavor:
        return QLatin1String("msvc2008");
    case ProjectExplorer::Abi::WindowsMsvc2010Flavor:
        return QLatin1String("msvc2010");
Tobias Hunger's avatar
Tobias Hunger committed
577 578
    case ProjectExplorer::Abi::WindowsMsvc2012Flavor:
        return QLatin1String("msvc2012");
hjk's avatar
hjk committed
579
    case ProjectExplorer::Abi::WindowsMSysFlavor:
580
        return QLatin1String("msys");
hjk's avatar
hjk committed
581
    case ProjectExplorer::Abi::WindowsCEFlavor:
582
        return QLatin1String("ce");
583
    case ProjectExplorer::Abi::UnknownFlavor: // fall through!
584 585 586 587 588 589 590 591
    default:
        return QLatin1String("unknown");
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

737 738 739 740
    return result;
}

} // namespace ProjectExplorer
741 742 743 744

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

#   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:
762
    QString prefix = QString::fromLocal8Bit(qgetenv("QTC_TEST_EXTRADATALOCATION"));
763 764
    if (prefix.isEmpty())
        return;
765
    prefix += QLatin1String("/projectexplorer/abi");
766

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

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

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

826
    QTest::newRow("dynamic stdc++: mac fat")
827
            << QString::fromLatin1("%1/dynamic/mac-fat.dylib").arg(prefix)
828 829 830
            << (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"));
831
    QTest::newRow("dynamic QtCore: arm linux 32bit")
832
            << QString::fromLatin1("%1/dynamic/arm-linux.so").arg(prefix)
833
            << (QStringList() << QString::fromLatin1("arm-linux-generic-elf-32bit"));
834 835 836
    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
837 838 839
    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
840 841 842
    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
843
    QTest::newRow("dynamic QtCore: mips linux 32bit")
844
            << QString::fromLatin1("%1/dynamic/mips-linux.so").arg(prefix)
Tobias Hunger's avatar
Tobias Hunger committed
845
            << (QStringList() << QString::fromLatin1("mips-linux-generic-elf-32bit"));
846 847 848
    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"));
849
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
850
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
851 852
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 64bit")
853
            << QString::fromLatin1("%1/dynamic/freebsd-elf-64bit.so").arg(prefix)
854 855
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-64bit"));
    QTest::newRow("dynamic QtCore: x86 freebsd 32bit")
856
            << QString::fromLatin1("%1/dynamic/freebsd-elf-32bit.so").arg(prefix)
857
            << (QStringList() << QString::fromLatin1("x86-bsd-freebsd-elf-32bit"));
Tobias Hunger's avatar
Tobias Hunger committed
858 859 860 861

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

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

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

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) {
889
            QVERIFY(l.contains(Abi::UnknownFlavor));
890 891 892 893 894 895 896
            if (l.contains(static_cast<Abi::OSFlavor>(i)))
                ++foundCounter;
        }
        QCOMPARE(foundCounter, 1);
    }
}

Daniel Teske's avatar
Daniel Teske committed
897

898
#endif