abi.cpp 34 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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 119 120 121 122 123 124 125 126
    switch (machine) {
    case 0x8664: // x86_64
        arch = Abi::X86Architecture;
        width = 64;
        break;
    case 0x014c: // i386
        arch = Abi::X86Architecture;
        width = 32;
        break;
127
    case 0x0166: // MIPS, little endian
Tobias Hunger's avatar
Tobias Hunger committed
128
        arch = Abi::MipsArchitecture;
129 130
        width = 32;
        break;
Tobias Hunger's avatar
Tobias Hunger committed
131 132 133 134 135 136
    case 0x0200: // ia64
        arch = Abi::ItaniumArchitecture;
        width = 64;
        break;
    }

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

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

    return result;
}

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

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

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

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

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

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

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

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

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

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

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

363 364 365 366 367
            return;
    }

    if (abiParts.count() >= 3) {
        if (abiParts.at(2) == QLatin1String("unknown"))
hjk's avatar
hjk committed
368 369 370
            m_osFlavor = UnknownFlavor;
        else if (abiParts.at(2) == QLatin1String("generic") && m_os == LinuxOS)
            m_osFlavor = GenericLinuxFlavor;
BogDan Vatra's avatar
BogDan Vatra committed
371 372
        else if (abiParts.at(2) == QLatin1String("android") && m_os == LinuxOS)
            m_osFlavor = AndroidLinuxFlavor;
373 374 375 376 377 378
        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
379 380
        else if (abiParts.at(2) == QLatin1String("maemo") && m_os == LinuxOS)
            m_osFlavor = MaemoLinuxFlavor;
381 382
        else if (abiParts.at(2) == QLatin1String("harmattan") && m_os == LinuxOS)
            m_osFlavor = HarmattanLinuxFlavor;
hjk's avatar
hjk committed
383 384 385 386
        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;
387 388
        else if (abiParts.at(2) == QLatin1String("solaris") && m_os == UnixOS)
            m_osFlavor = SolarisUnixFlavor;
389 390 391 392 393 394
        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
395 396
        else if (abiParts.at(2) == QLatin1String("msvc2012") && m_os == WindowsOS)
            m_osFlavor = WindowsMsvc2012Flavor;
hjk's avatar
hjk committed
397 398 399 400
        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;
401 402 403 404 405 406
        else
            return;
    }

    if (abiParts.count() >= 4) {
        if (abiParts.at(3) == QLatin1String("unknown"))
hjk's avatar
hjk committed
407
            m_binaryFormat = UnknownFormat;
408
        else if (abiParts.at(3) == QLatin1String("elf"))
hjk's avatar
hjk committed
409
            m_binaryFormat = ElfFormat;
410
        else if (abiParts.at(3) == QLatin1String("pe"))
hjk's avatar
hjk committed
411
            m_binaryFormat = PEFormat;
412
        else if (abiParts.at(3) == QLatin1String("mach_o"))
hjk's avatar
hjk committed
413
            m_binaryFormat = MachOFormat;
414
        else if (abiParts.at(3) == QLatin1String("qml_rt"))
hjk's avatar
hjk committed
415
            m_binaryFormat = RuntimeQmlFormat;
416 417 418 419 420 421 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
        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
447 448 449 450 451
bool Abi::operator != (const Abi &other) const
{
    return !operator ==(other);
}

452 453 454 455 456 457 458 459 460 461 462
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
{
463 464 465 466 467
    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);
468 469 470 471 472 473
    // *-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
474
                  && ((os() == other.os()) && (os() == LinuxOS))
475 476 477
                  && (osFlavor() == GenericLinuxFlavor || other.osFlavor() == GenericLinuxFlavor)
                  && (binaryFormat() == other.binaryFormat() || other.binaryFormat() == Abi::UnknownFormat)
                  && ((wordWidth() == other.wordWidth() && wordWidth() != 0) || other.wordWidth() == 0))
478
        isCompat = true;
BogDan Vatra's avatar
BogDan Vatra committed
479 480
    if (osFlavor() == AndroidLinuxFlavor || other.osFlavor() == AndroidLinuxFlavor)
        isCompat = (osFlavor() == other.osFlavor() && architecture() == other.architecture());
481
    return isCompat;
482 483 484 485
}

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

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

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

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

hjk's avatar
hjk committed
542
QString Abi::toString(const OSFlavor &of)
543 544
{
    switch (of) {
hjk's avatar
hjk committed
545
    case ProjectExplorer::Abi::GenericLinuxFlavor:
546
        return QLatin1String("generic");
BogDan Vatra's avatar
BogDan Vatra committed
547 548
    case ProjectExplorer::Abi::AndroidLinuxFlavor:
        return QLatin1String("android");
549 550 551 552 553 554
    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
555
    case ProjectExplorer::Abi::MaemoLinuxFlavor:
556
        return QLatin1String("maemo");
hjk's avatar
hjk committed
557
    case ProjectExplorer::Abi::HarmattanLinuxFlavor:
558
        return QLatin1String("harmattan");
hjk's avatar
hjk committed
559
    case ProjectExplorer::Abi::GenericMacFlavor:
560
        return QLatin1String("generic");
hjk's avatar
hjk committed
561
    case ProjectExplorer::Abi::GenericUnixFlavor:
562
        return QLatin1String("generic");
563 564
    case ProjectExplorer::Abi::SolarisUnixFlavor:
        return QLatin1String("solaris");
565 566 567 568 569 570
    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
571 572
    case ProjectExplorer::Abi::WindowsMsvc2012Flavor:
        return QLatin1String("msvc2012");
hjk's avatar
hjk committed
573
    case ProjectExplorer::Abi::WindowsMSysFlavor:
574
        return QLatin1String("msys");
hjk's avatar
hjk committed
575
    case ProjectExplorer::Abi::WindowsCEFlavor:
576
        return QLatin1String("ce");
577
    case ProjectExplorer::Abi::UnknownFlavor: // fall through!
578 579 580 581 582 583 584 585
    default:
        return QLatin1String("unknown");
    }
}

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

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

607 608 609 610 611 612 613
QList<Abi::OSFlavor> Abi::flavorsForOs(const Abi::OS &o)
{
    QList<OSFlavor> result;
    switch (o) {
    case BsdOS:
        return result << FreeBsdFlavor << OpenBsdFlavor << NetBsdFlavor;
    case LinuxOS:
614 615
        return result << GenericLinuxFlavor << HarmattanLinuxFlavor << MaemoLinuxFlavor
                      << AndroidLinuxFlavor;;
616 617 618 619 620 621
    case MacOS:
        return result << GenericMacFlavor;
    case UnixOS:
        return result << GenericUnixFlavor << SolarisUnixFlavor;
    case WindowsOS:
        return result << WindowsMsvc2005Flavor << WindowsMsvc2008Flavor << WindowsMsvc2010Flavor
Tobias Hunger's avatar
Tobias Hunger committed
622
                      << WindowsMsvc2012Flavor << WindowsMSysFlavor << WindowsCEFlavor;
623 624 625 626 627 628 629
    case UnknownOS:
        return result << UnknownFlavor;
    default:
        break;
    }
    return result;
}
630 631 632 633

Abi Abi::hostAbi()
{
    Architecture arch = QTC_CPU; // define set by qmake
hjk's avatar
hjk committed
634 635 636
    OS os = UnknownOS;
    OSFlavor subos = UnknownFlavor;
    BinaryFormat format = UnknownFormat;
637 638

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

Tobias Hunger's avatar
Tobias Hunger committed
662 663 664 665 666
    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;
667 668
}

Tobias Hunger's avatar
Tobias Hunger committed
669
QList<Abi> Abi::abisOfBinary(const Utils::FileName &path)
670
{
671
    QList<Abi> tmp;
672
    if (path.isEmpty())
673
        return tmp;
674

Tobias Hunger's avatar
Tobias Hunger committed
675
    QFile f(path.toString());
676
    if (!f.exists())
677
        return tmp;
678

Montel Laurent's avatar
Montel Laurent committed
679 680 681
    if (!f.open(QFile::ReadOnly))
        return tmp;

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

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

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

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

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

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

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

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

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

731 732 733 734
    return result;
}

} // namespace ProjectExplorer
735 736 737 738

// Unit tests:
#ifdef WITH_TESTS
#   include <QTest>
739
#   include <QFileInfo>
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

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

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

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

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

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

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

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

887
#endif