One Definition Rule
The One Definition Rule is an important rule of the C++ programming language that prescribes that classes/structs and non-inline functions cannot have more than one definition in the entire program and templates and types cannot have more than one definition by translation unit. It is defined in the ISO C++ Standard 2003, at section 3.2. Some other programming languages have similar but differently defined rules towards the same objective.
Summary
In short, the ODR states that:- In any translation unit, a template, type, function, or object can have no more than one definition. Some of these can have any number of declarations. A definition provides an instance.
- In the entire program, an object or non-inline function cannot have more than one definition; if an object or function is used, it must have exactly one definition. You can declare an object or function that is never used, in which case you don't have to provide a definition. In no event can there be more than one definition.
- Some things, like types, templates, and extern inline functions, can be defined in more than one translation unit. For a given entity, each definition must have the same sequence of tokens. Non-extern objects and functions in different translation units are different entities, even if their names and types are the same.
Examples
In general, a translation unit shall contain no more than one definition of any class type. In this example, two definitions of the class typeMyClass occur in the same translation unit. This typically occurs if a header file is included twice by the same source file without appropriate header guards.class MyClass ; // first definition of MyClass
class MyClass ; // error, second definition of MyClass
In the following, forming a pointer to
MyStruct or defining a function taking a reference to MyStruct are examples of legal constructs, because they do not require the type of MyStruct to be complete. Therefore, a definition is not required.ISO/IEC. ISO/IEC 14882:2003(E): Programming Languages - C++ §3.2 One definition rule para. 4 Defining an object of type
MyStruct, a function taking an argument of type MyStruct, or using MyStruct in a sizeof expression are examples of contexts where S must be complete, and therefore require a definition.struct MyStruct; // declaration of MyStruct
MyStruct* p; // ok, no definition required
void f; // ok, no definition required
void f; // ok, no definition required
MyStruct f; // ok, no definition required - this is a function declaration only!
MyStruct s; // error, definition required
sizeof; // error, definition required
More than one definition
In certain cases, there can be more than one definition of a type or a template. A program consisting of multiple header files and source files will typically have more than one definition of a type, but not more than one definition per translation unit.If a program contains more than one definition of a type, then each definition must be equivalent.ISO/IEC. ISO/IEC 14882:2003(E): Programming Languages - C++ §3.2 One definition rule para. 5
Definitions of static const data members
In pre-standard C++, all static data members required a definition outside of their class. However, during the C++ standardization process it was decided to lift this requirement for static const integral members. The intent was to allow uses such as:struct MyClass ;
char data; // N "used" without out-of-class definition
without a namespace scope definition for
N.Nevertheless, the wording of the 1998 C++ standard still required a definition if the member was used in the program.ISO/IEC. ISO/IEC 14882:1998(E): Programming Languages - C++ §9.4.2 Static data members para. 4 This included the member appearing anywhere except as the operand to sizeof or typeid, effectively making the above ill-formed.ISO/IEC. ISO/IEC 14882:1998(E): Programming Languages - C++ §3.2 One definition rule para. 2
This was identified as a defect, and the wording was adjusted to allow such a member to appear anywhere a constant expression is required, without requiring an out-of-class definition. This includes array bounds, case expressions, static member initializers, and nontype template arguments.ISO/IEC. ISO/IEC 14882:2003(E): Programming Languages - C++ §5.19 Constant expressions para. 1
struct MyClass1 ;
char data; // Legal per C++03
template
struct MyClass2;
template <>
struct MyClass2
However, using a static const integral member anywhere except where an integral constant-expression is required, requires a definition:
struct MyClass ;
int main
This requirement was relaxed in a later standard, C++11.
Example showing unexpected side effects
We need 4 files: "", "", "", "".module;
export org.wikipedia.examples.Base;
export import org.wikipedia.examples.Dummy1;
export import org.wikipedia.examples.Dummy2;
export namespace org::wikipedia::examples
module;
export module org.wikipedia.examples.Dummy2;
import std;
import org.wikipedia.examples.Base;
export namespace org::wikipedia::examples
module;
export module org.wikipedia.examples.Dummy2;
import std;
import org.wikipedia.examples.Base;
export org::wikipedia::examples
import org.wikipedia.examples.Base;
using namespace org::wikipedia::examples;
int main
When executed the expected output is:
odr ONE dummy: Hello
odr TWO dummy: World
But the likely output is:
odr ONE dummy: Hello
odr ONE dummy: Hello
The problem is, that the C++ linker has to figure out how to build the virtual method table for the
Dummy classes, and that only works if the class names are different.