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
#include <utils/fileutils.h>

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

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

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

    \sa ProjectExplorer::ToolChain
*/

49 50
namespace ProjectExplorer {

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

Tobias Hunger's avatar
Tobias Hunger committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
static quint8 getUint8(const QByteArray &data, int pos)
{
    return static_cast<quint8>(data.at(pos));
}

static quint32 getLEUint32(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 3);
    return (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 3))) << 24)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 2)) << 16))
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 1))) << 8)
            + static_cast<quint8>(ba.at(pos));
}

static quint32 getBEUint32(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 3);
    return (static_cast<quint32>(static_cast<quint8>(ba.at(pos))) << 24)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 1))) << 16)
            + (static_cast<quint32>(static_cast<quint8>(ba.at(pos + 2))) << 8)
            + static_cast<quint8>(ba.at(pos + 3));
}

static quint32 getLEUint16(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 1);
    return (static_cast<quint16>(static_cast<quint8>(ba.at(pos + 1))) << 8) + static_cast<quint8>(ba.at(pos));
}

static quint32 getBEUint16(const QByteArray &ba, int pos)
{
    Q_ASSERT(ba.size() >= pos + 1);
    return (static_cast<quint16>(static_cast<quint8>(ba.at(pos))) << 8) + static_cast<quint8>(ba.at(pos + 1));
}

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
static Abi macAbiForCpu(quint32 type) {
    switch (type) {
    case 7: // CPU_TYPE_X86, CPU_TYPE_I386
        return Abi(Abi::X86Architecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 0x01000000 +  7: // CPU_TYPE_X86_64
        return Abi(Abi::X86Architecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 64);
    case 18: // CPU_TYPE_POWERPC
        return Abi(Abi::PowerPCArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 0x01000000 + 18: // CPU_TYPE_POWERPC64
        return Abi(Abi::PowerPCArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    case 12: // CPU_TYPE_ARM
        return Abi(Abi::ArmArchitecture, Abi::MacOS, Abi::GenericMacFlavor, Abi::MachOFormat, 32);
    default:
        return Abi();
    }
}

Tobias Hunger's avatar
Tobias Hunger committed
107 108 109 110 111 112 113 114 115 116 117
static QList<Abi> parseCoffHeader(const QByteArray &data)
{
    QList<Abi> result;
    if (data.size() < 20)
        return result;

    Abi::Architecture arch = Abi::UnknownArchitecture;
    Abi::OSFlavor flavor = Abi::UnknownFlavor;
    int width = 0;

    // Get machine field from COFF file header
Tobias Hunger's avatar
Tobias Hunger committed
118
    quint16 machine = getLEUint16(data, 0);
Tobias Hunger's avatar
Tobias Hunger committed
119
    switch (machine) {
120 121 122 123 124 125
    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
126 127 128 129 130 131 132 133
    case 0x8664: // x86_64
        arch = Abi::X86Architecture;
        width = 64;
        break;
    case 0x014c: // i386
        arch = Abi::X86Architecture;
        width = 32;
        break;
134
    case 0x0166: // MIPS, little endian
Tobias Hunger's avatar
Tobias Hunger committed
135
        arch = Abi::MipsArchitecture;
136 137
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
138 139 140 141 142 143
    case 0x0200: // ia64
        arch = Abi::ItaniumArchitecture;
        width = 64;
        break;
    }

144
    if (data.size() >= 24) {
Tobias Hunger's avatar
Tobias Hunger committed
145
        // Get Major and Minor Image Version from optional header fields
146 147 148 149
        quint8 minorLinker = data.at(23);
        switch (data.at(22)) {
        case 2:
        case 3: // not yet reached:-)
Tobias Hunger's avatar
Tobias Hunger committed
150
            flavor = Abi::WindowsMSysFlavor;
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
            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
168
                qWarning("%s: Unknown MSVC flavour encountered.", Q_FUNC_INFO);
169
            break;
170
        }
Tobias Hunger's avatar
Tobias Hunger committed
171 172 173 174 175 176 177 178
    }

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

    return result;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#if defined (Q_OS_WIN)
hjk's avatar
hjk committed
646
    os = WindowsOS;
Tobias Hunger's avatar
Tobias Hunger committed
647 648 649
#if _MSC_VER == 1700
    subos = WindowsMsvc2012Flavor;
#elif _MSC_VER == 1600
650 651 652 653 654
    subos = WindowsMsvc2010Flavor;
#elif _MSC_VER == 1500
    subos = WindowsMsvc2008Flavor;
#elif _MSC_VER == 1400
    subos = WindowsMsvc2005Flavor;
655
#elif defined (Q_CC_MINGW)
656 657
    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
#endif

Tobias Hunger's avatar
Tobias Hunger committed
669 670 671 672 673
    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;
674 675
}

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

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

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

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

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

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

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

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

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

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

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

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

738 739 740 741
    return result;
}

} // namespace ProjectExplorer
742 743 744 745

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

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

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

    QTest::newRow("static stdc++: mac fat")
800
            << QString::fromLatin1("%1/static/mac-fat.a").arg(prefix)
801 802 803 804 805
            << (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")
806
            << QString::fromLatin1("%1/dynamic/win-msvc2010-64bit.dll").arg(prefix)
807 808
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2010-pe-64bit"));
    QTest::newRow("dynamic QtCore: win msvc2008 32bit")
809
            << QString::fromLatin1("%1/dynamic/win-msvc2008-32bit.dll").arg(prefix)
810 811
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2008-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msvc2005 32bit")
812
            << QString::fromLatin1("%1/dynamic/win-msvc2005-32bit.dll").arg(prefix)
813 814
            << (QStringList() << QString::fromLatin1("x86-windows-msvc2005-pe-32bit"));
    QTest::newRow("dynamic QtCore: win msys 32bit")
815
            << QString::fromLatin1("%1/dynamic/win-mingw-32bit.dll").arg(prefix)
816
            << (QStringList() << QString::fromLatin1("x86-windows-msys-pe-32bit"));
817 818 819
    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"));
820
    QTest::newRow("dynamic QtCore: wince mips msvc2005 32bit")
821 822
            << QString::fromLatin1("%1/dynamic/wince-32bit.dll").arg(prefix)
            << (QStringList() << QString::fromLatin1("mips-windows-msvc2005-pe-32bit"));
823 824 825 826
    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"));

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

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

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

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

879 880 881 882 883 884 885 886 887 888 889
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) {
890
            QVERIFY(l.contains(Abi::UnknownFlavor));
891 892 893 894 895 896 897
            if (l.contains(static_cast<Abi::OSFlavor>(i)))
                ++foundCounter;
        }
        QCOMPARE(foundCounter, 1);
    }
}

Daniel Teske's avatar
Daniel Teske committed
898

899
#endif