Policies/Binary Compatibility Examples

From KDE Community Wiki

This page is meant as examples of things you cannot do in C++ when maintaining binary compatibility.

Unexport or remove a class

Before After 
class KDECORE_EXPORT KUrl
{
   // [...]
};
 
class KUrl
{
   // [...]
};

Reason: the symbols for the class above are not added to the exported symbols list of the library, so other libraries and applications cannot see them.

Change the class hierarchy

Before After 
class MyClass: public BaseClass
{
   // [...]
};
 
class MyClass: public BaseClass, public OtherBaseClass
{
   // [...]
};
class MyClass: public BaseClass1, public BaseClass2
{
   // [...]
};
 
class MyClass: public BaseClass2, public BaseClass1
{
   // [...]
};

Reason: the size and/or order of member data in the class changes, causing existing code to allocate too much or too little memory, read/write data at the wrong offsets.

Change the template arguments of a template class

Before After 
template<typename T1>
class MyTemplateClass
{
    // [...]
};
 
template<typename T1, typename T2 = void>
class MyTemplateClass
{
    // [...]
};
// GCC mangling before: _Z3foo15MyTemplateClassIiE
//              after:  _Z3foo15MyTemplateClassIivE
void foo(MyTemplateClass<int>);

Reason: the mangling of the functions related to this template type change because its template expansion changes too. This can happen both for member functions (for example, the constructor) as well as functions that take it as a parameter.

Unexport a function

Before After 
Q_CORE_EXPORT const char *qVersion();
 
const char *qVersion();
namespace KSocketFactory {
    KDECORE_EXPORT QTcpSocket *connectToHost(...);
}
 
namespace KSocketFactory {
    QTcpSocket *connectToHost(...);
}

Reason: the symbols for the functions above are not added to the exported symbols list of the library, so other libraries and applications cannot see them.

Inline a function

Before After 
int square(int n);
 
inline int square(int n) { return n * n; }
int square(int n) { return n * n; }
 
inline int square(int n) { return n * n; }
class Math
{
    int square(int n);
};

// the following could be in a .cpp
int Math::square(int n)
{ return n * n; }
 
class Math
{
    int square(int n);
};

// the following could be in a .cpp
inline int Math::square(int n)
{ return n * n; }
class Math
{
    int square(int n);
};

// the following could be in a .cpp
int Math::square(int n)
{ return n * n; }
 
class Math
{
    int square(int n)
    { return n * n; }
};

Reason: when a function is declared inline and the compiler does inline it at its call point, the compiler does not have to emit an out-of-line copy. Code that exists and was calling this function will therefore not be able to resolve the function anymore. Also, when compiling with GCC and -fvisibility-inlines-hidden, if the compiler does emit an out-of-line copy, it will be hidden (not added to the exported symbols table) and therefore not accessible from other libraries.

Change the parameters of a function

Before After 
// GCC mangling: _Z11doSomethingii
// MSVC mangling: ?doSomething@@YAXHH@Z
void doSomething(int i1, int i2);
 
// GCC mangling: _Z11doSomethingis
// MSVC mangling: ?doSomething@@YAXHF@Z
void doSomething(int i1, short i2);
// GCC mangling: _Z11doSomethingii
// MSVC mangling: ?doSomething@@YAXHH@Z
void doSomething(int i1, int i2);
 
// GCC mangling: _Z11doSomethingiii
// MSVC mangling: ?doSomething@@YAXHHH@Z
void doSomething(int i1, int i2, int i3 = 0);
// GCC mangling: _Z11doSomethingRi
// MSVC mangling: ?doSomething@@YAXABH@Z
void doSomething(int &i1);
 
// GCC mangling: _Z11doSomethingRKi
// MSVC mangling: ?doSomething@@YAXAAH@Z
void doSomething(const int &i1);
void doSomething(int i1);
 
void doSomething(const int i1); // breaks with Sun CC
// GCC mangling: _Z11doSomethingPc
// MSVC mangling: ?doSomething@@YAXPAD@Z (32-bit)
void doSomething(char *ptr);
 
// GCC mangling: _Z11doSomethingPKc
// MSVC mangling: ?doSomething@@YAXPBD@Z (32-bit)
void doSomething(const char *ptr);

Reason: changing the parameters of a function (adding new or changing existing) changes the mangled name of that function. The reason for that is that the C++ language allows overloading of functions with the same name but slightly different parameters.

I don't have the mangled name for the Sun CC example above, that compiler does enforce the constness of POD types in both declaration and implementation.

Change the return type

Before After 
// GCC mangling: _Z8positionv
// MSVC mangling: ?position@@YA_JXZ
qint64 position();
 
// GCC mangling: _Z8positionv
// MSVC mangling: ?position@@YAHXZ
int position();
// GCC mangling: _Z4namev
// MSVC mangling: ?position@@YAVQByteArray@@DXZ
QByteArray name();
 
// GCC mangling: _Z4namev
// MSVC mangling: ?position@@YAVQString@@XZ
QString name();
// GCC mangling: _Z4namev
// MSVC mangling: ?position@@YAPBDXZ
const char *name();
 
// GCC mangling: _Z4namev
// MSVC mangling: ?position@@YAVQString@@XZ
QString name();
// GCC mangling: _Z12createDevicev
// MSVC mangling: ?createDevice@@YAPAVQTcpSocket@@XZ
QTcpSocket *createDevice();
 
// GCC mangling: _Z12createDevicev (unchanged)
// MSVC mangling: ?createDevice@@YAPAVQIODevice@@XZ
QIODevice *createDevice();
// GCC mangling: _ZNK10QByteArray2atEi
// MSVC mangling: ?at@QByteArray@@QBA?BDH@Z
const char QByteArray::at(int) const;
 
// GCC mangling: _ZNK10QByteArray2atEi (unchanged)
// MSVC mangling: ?at@QByteArray@@QBADH@Z
char QByteArray::at(int) const;
// GCC mangling: _ZN6QEvent17registerEventTypeEi
// MSVC mangling: ?registerEventType@QEvent@@QAAXH@Z
int QEvent::registerEventType(int)
 
// GCC mangling: _ZN6QEvent17registerEventTypeEi (unchanged)
// MSVC mangling: ?registerEventType@QEvent@@QAAXW4Type@V0@@@Z
QEvent::Type QEvent::registerEventType(int)

Reason: changing the return type changes the mangled name of the function names in some compilers (GCC notably does not encode the return type). However, even if the mangling doesn't change, the convention on how the return types are handled may change.

In the first example above, the return type changed from a 64- to a 32-bit integer, which means on some architectures, the upper half of the return register may contain garbage. In the second example, the return type changed from QByteArray to QString, which are two incompatible types.

In the third example, the return type changed from a simple integer (a POD) to a QString -- in this case, the compiler usually needs to pass a hidden implicit first parameter, which won't be there. In this case, existing code calling the function will more than likely crash, due to trying to dereference the implicit QString* parameter that isn't there.

In the fourth example, the return type changed from one POD type (an int) to another (an enum), which is also carried by an int. The calling sequence is most likely the same in all compilers, however the mangling of the symbol name changed, meaning that calls will fail due to an unresolved symbol.

Change the access rights

Before After 
class MyClass
{
protected:
    // GCC mangling: _ZN7MyClass11doSomethingEv
    // MSVC mangling: ?doSomething@MyClass@@IAAXXZ
    void doSomething();
};
 
class MyClass
{
public:
    // GCC mangling: _ZN7MyClass11doSomethingEv (unchanged)
    // MSVC mangling: ?doSomething@MyClass@@QAAXXZ
    void doSomething();
};

Reason: some compilers encode the protection type of a function in its mangled name.

Change the CV-qualifiers of a member function

Before After 
class MyClass
{
public:
    // GCC mangling: _ZNK7MyClass9somethingEv
    // MSVC mangling: ?something@MyClass@QBAHXZ
    int something() const;
};
 
class MyClass
{
public:
    // GCC mangling: _ZN7MyClass9somethingEv
    // MSVC mangling: ?something@MyClass@QAAHXZ
    int something();
};

Reason: compilers encode the constness of a function in the mangled name. The reason they all do that is because the C++ standard allows overloading of functions that differ only by the constness.

Change the type of global data

Before After 
// GCC mangling: data (undecorated)
// MSVC mangling: ?data@@3HA
int data = 42;
 
// GCC mangling: data (undecorated)
// MSVC mangling: ?data@@3FA
short data = 42;
class MyClass
{
public:
    // GCC mangling: _ZN7MyClass4dataE
    // MSVC mangling: ?data@MyClass@@2HA
    static int data;
};
 
class MyClass
{
public:
    // GCC mangling: _ZN7MyClass4dataE
    // MSVC mangling: ?data@MyClass@@2FA
    static short data;
};

Reason: some compilers encode the type of the global data in its mangled name. Especially note that some compilers mangle even for simple data types that would be allowed in C, meaning the extern "C" qualifier makes a difference too.

Even if the mangling doesn't change, changing the type often changes the size of the data as well. That means code that was accessing the global data may be access too many or too few bytes.

Change the CV-qualifiers of global data

Before After 
// MSVC mangling: ?data@@3HA
int data = 42;
 
// MSVC mangling: ?data@@3HB
const int data = 42;
class MyClass
{
public:
    // MSVC mangling: ?data@MyClass@@2HA
    static int data;
};
 
class MyClass
{
public:
    // MSVC mangling: ?data@MyClass@@2HB
    static const int data;
};
class MyClass
{
public:
    static int data;
};
 
class MyClass
{
public:
    // the compiler won't even create a symbol
    static const int data = 42;
};

Reason: some compilers encode the CV-qualifiers of the global data in its mangled name. Especially note that a static const value declared in the class itself can be considered for "inlining" -- that is, the compiler doesn't need to generate an external symbol for the value since all implementations are guaranteed to know it.

Even for compilers that don't encode the CV-qualifiers of global data, adding const may make the compiler place the variable in a read-only section of memory. Code that tried to write it will probably crash.

Add a virtual member function to a class without any

Before After 
struct Data
{
    int i;
};
 
struct Data
{
    int i;
    virtual int j();
};

Reason: a class without any virtual members or bases is guaranteed to be exactly like a C structure, for compatibility with that language (that is a POD structure). On some compilers, structures/classes with bases that are POD themselves are also POD. However, as soon as there's one virtual base or virtual member function, the compiler is free to arrange the structure in a C++ manner, which usually means inserting a hidden pointer at the beginning or the end of the structure, pointing to the virtual table of that class. This changes the size and offset of the elements in the structure.

Add new virtuals to a non-leaf class

Before After 
class MyClass
{
public:
    virtual ~MyClass();
    virtual void foo();
};
 
class MyClass
{
public:
    virtual ~MyClass();
    virtual void foo();
    virtual void bar();
};

Reason: the addition of a new virtual function to a class that is non-leaf (that is, there is at least one class deriving from this class) changes the layout of the virtual table (the virtual table is basically a list of function pointers, pointing to the functions that are active in this class level). To accommodate the new virtual, the compiler must add a new entry to this table, but existing derived classes won't know about it and will not have the entry in their virtual tables.

Change the order of the declaration of virtual functions

Before After 
class MyClass
{
public:
    virtual ~MyClass();
    virtual void foo();
    virtual void bar();
};
 
class MyClass
{
public:
    virtual ~MyClass();
    virtual void bar();
    virtual void foo();
};

Reason: the compiler places the pointers to the functions implementing the virtual functions in the order that they are declared in the class. By changing the order of the declaration, the order of the entries in the virtual table changes too.

Note: the order is inherited from the parent classes, so overriding a virtual will allocate the entry in the parent's order.

Override a virtual that doesn't come from a primary base

class PrimaryBase
{
public:
    virtual ~PrimaryBase();
    virtual void foo();
};

class SecondaryBase
{
public:
    virtual ~SecondaryBase();
    virtual void bar();
};
Before After 
class MyClass: public PrimaryBase, public SecondaryBase
{
public:
    ~MyClass();
    void foo();
};
 
class MyClass: public PrimaryBase, public SecondaryBase
{
public:
    ~MyClass();
    void foo();
    void bar();
};

Reason: this is a tricky case. When dealing with multiple-inheritance of classes with virtual tables, the compiler must create multiple virtual tables to guarantee polymorphism works (that is, when your MyClass object is stored in a PrimaryBase or SecondaryBase pointer). The virtual table for the primary base is shared with the class's own virtual table, because they have the same layout at the beginning. However, if you override a virtual coming from a non-primary base, it is the same as adding a new virtual, since that primary base did not have the virtual by that name.

Note: this applies to any case of multiple-inheritance, even if it's not a direct base. In the example above, if we had MyOtherClass deriving from MyClass, the same restriction would apply.

Override a virtual with a covariant return with different top address

struct Data1 { int i; };
class BaseClass
{
public:
    virtual Data1 *get();
};

struct Data0 { int i; };
struct Complex1: Data0, Data1 { };
struct Complex2: virtual Data1 { };
Before After 
class MyClass: public BaseClass
{
public:
};
 
class MyClass: public BaseClass
{
public:
    Complex1 *get();
};
class MyClass: public BaseClass
{
public:
};
 
class MyClass: public BaseClass
{
public:
    Complex2 *get();
};

Reason: this is another tricky case, like the above one and also for the same reason: the compiler must add a second entry to the virtual table, just as if a new virtual function had been added, which changes the layout of the virtual table and breaks derived classes.

Covariant calls happen when the function overriding a virtual from a parent class returns a class different from the parent (this is allowed by the C++ standard, so the code above is perfectly valid and calling p->get() with p of type BaseClass will call MyClass::get). If the more-derived type doesn't have the same top-address such as Complex1 and Complex2 above, when compared to Data1, then the compiler needs to generate a stub function (usually called a "thunk") to adjust the value of the pointer returned. It places the address to that thunk in the entry corresponding to the parent's virtual function in the virtual table. However, it also adds a new entry for calls made which return the new top-address.

Remove class finality

Before After 
class MyClass final : public BaseClass
{
   // [...]
};
 
class MyClass : public BaseClass
{
   // [...]
};

Reason: The final identifier allows the compiler to apply devirtualizalization optimization when calling a virtual function. If it can determine that a given call is always going to run through MyClass's implementation it will bypass the virtual table and call the function directly. Changing finality removes this optimization option, but already built software may have already been optimization with finality assumptions. This of course only applies to classes with at least one virtual member.

Retrieved from "https://community.kde.org/index.php?title=Policies/Binary_Compatibility_Examples&oldid=86685"