Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Virtual functions allow for the choice of member function calls to be determined at run time based on the dynamic type of the object that the member function is being called on. This convention supports object-oriented programming practices commonly associated with object inheritance and function overriding. When calling a nonvirtual member function or when using a class member access expression to denote a call, the specified function is called. Otherwise, a virtual function call is made to the final overrider in the dynamic type of the object expression.

However, during the construction and destruction of an object, the rules for virtual method dispatch on that object are restricted. The C++ Standard, [class.cdtor], paragraph 4 [ISO/IEC 14882-2014], states the following:

Member functions, including virtual functions, can be called during construction or destruction. When a virtual function is called directly or indirectly from a constructor or from a destructor, including during the construction or destruction of the class’s non-static data members, and the object to which the call applies is the object (call it x) under construction or destruction, the function called is the final overrider in the constructor’s or destructor’s class and not one overriding it in a more-derived class. If the virtual function call uses an explicit class member access and the object expression refers to the complete object of x or one of that object’s base class subobjects but not x or one of its base class subobjects, the behavior is undefined.

Do not directly or indirectly invoke a virtual function from a constructor or destructor that attempts to call into the object under construction or destruction. Because the order of construction starts with base classes and moves to more derived classes, attempting to call a derived class function from a base class under construction is dangerous. The derived class has not had the opportunity to initialize its resources, which is why calling a virtual function from a constructor does not result in a call to a function in a more derived class. Similarly, an object is destroyed in reverse order from construction, so attempting to call a function in a more derived class from a destructor may access resources that have already been released.

Noncompliant Code Example

In this noncompliant code example, the base class

Non-Compliant Code Example

Consider a design that attempts to seize and release an object's resources through calls to virtual functions from a base class's the constructor and destructor. However, the B::B() constructor calls B::seize() rather than D::seize(). Likewise, the B::~B() destructor calls B::release() rather than D::release().

Code Block
bgColor#FFcccc
langcpp
struct
class B {
  public:
    B() { seize(); }
    virtual ~B() { release(); }
 
  protected:
    virtual void seize() {};
    virtual void release() {};
};

classstruct D : public B {
  public:
    Dvirtual ~D() = {}
    ~D() {}
  default;
 
protected:
    void seize() override {
        B::seize();
        // getGet derived resources...
    }
 
    void release() override {
        // releaseRelease derived resources...
        B::release();
    }
};

D x;

The result of running this code is that no derived class resources will be seized or released during the initialization and destruction of the x object of type D. At the time of the call to seize in the initialization of x() from B::B(), the D constructor has not been entered, and the behavior of the under-construction x object will be to invoke B::seize() rather than D::seize(). A similar situation occurs for the call to release() in the base class destructor. If the functions seize() and release() were declared to be pure virtual functions, the result would be undefined behavior.

Compliant Solution

Avoid calling an object's virtual functions while it is being constructed or destroyedIn this compliant solution, the constructors and destructors call a nonvirtual, private member function (suffixed with mine) instead of calling a virtual function. The result is that each class is responsible for seizing and releasing its own resources.

Code Block
bgColor#ccccff
lang#FFcccccpp

class B {
  void seize_mine();
  void release_mine();
  
public:
    B() {
 seize_mine(); }
  virtual ~B() {  // seize base resources...
   release_mine(); }

protected:
  virtual void seize() { seize_mine(); }
  virtual void virtual ~Brelease() { release_mine(); {
        // release base resources...
 }
};

class D : public B {
  void seize_mine();
  void release_mine();
  
public:
  D() { seize_mine(); }
  virtual ~D() { release_mine(); }

protected:
  void seize() override {
    B::seize();
    seize_mine();
  }
  
  void release() override {
    release_mine();
    B::release();
  }
};

Exceptions

OOP50-CPP-EX1: Because valid use cases exist that involve calling (non-pure) virtual functions from the constructor of a class, it is permissible to call the virtual function with an explicitly qualified ID. The qualified ID signifies to code maintainers that the expected behavior is for the class under construction or destruction to be the final overrider for the function call.

Code Block
bgColor#ccccff
langcpp
struct A {
  A   }
};

class D : public B {
  public:
    D() {
        // seize derived resources...
    }
    ~D() {
    // f();   // release derived resources...
   WRONG!
    A::f();   // Okay
  }
}  virtual void f();

D x};

Note that it is perfectly legitimate OOP50-CPP-EX2: It is permissible to call virtual functions of other, fully constructed objects a virtual function that has the final virt-specifier from a constructor or destructor, as in this example.

...

Code Block

...

bgColor

...

#ccccff

...

lang

...

Remediation Cost

...

Priority

...

Level

...

OBJ30-CPP

...

1 (low)

...

1 (unlikely)

...

2 (medium)

...

P2

...

L3

cpp
struct A {
  A();
  virtual void f();
};
 
struct B : A {
  B() : A() {
    f();  // Okay
  }
  void f() override final;
};

Similarly, it is permissible to call a virtual function from a constructor or destructor of a class that has the final class-virt-specifier, as in this example.

Code Block
bgColor#ccccff
langcpp
struct A {
  A();
  virtual void f();
};
 
struct B final : A {
  B() : A() {
    f();  // Okay
  }
  void f() override;
};

In either case, f() must be the final overrider, guaranteeing consistent behavior of the function being called.

Risk Assessment

Rule

Severity

Likelihood

Detectable

Repairable

Priority

Level

OOP50-CPP

Low

Unlikely

Yes

No

P2

L3

Automated Detection

Tool

Version

Checker

Description

Astrée

Include Page
Astrée_V
Astrée_V

virtual-call-in-constructor
invalid_function_pointer
Fully checked
Axivion Bauhaus Suite

Include Page
Axivion Bauhaus Suite_V
Axivion Bauhaus Suite_V

CertC++-OOP50
Clang
Include Page
Clang_V
Clang_V
clang-analyzer-alpha.cplusplus.VirtualCallChecked by clang-tidy
CodeSonar
Include Page
CodeSonar_V
CodeSonar_V

LANG.STRUCT.VCALL_IN_CTOR

LANG.STRUCT.VCALL_IN_DTOR

Virtual Call in Constructor

Virtual Call in Destructor

Helix QAC

Include Page
Helix QAC_V
Helix QAC_V

C++4260, C++4261, C++4273, C++4274, C++4275, C++4276, C++4277, C++4278, C++4279, C++4280, C++4281, C++4282


Klocwork
Include Page
Klocwork_V
Klocwork_V

CERT.OOP.CTOR.VIRTUAL_FUNC


LDRA tool suite
Include Page
LDRA_V
LDRA_V

467 S, 92 D

Fully implemented

Parasoft C/C++test
Include Page
Parasoft_V
Parasoft_V

CERT_CPP-OOP50-a
CERT_CPP-OOP50-b
CERT_CPP-OOP50-c
CERT_CPP-OOP50-d

Avoid calling virtual functions from constructors
Avoid calling virtual functions from destructors
Do not use dynamic type of an object under construction
Do not use dynamic type of an object under destruction

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C++: OOP50-CPPChecks for virtual function call from constructors and destructors (rule fully covered)
PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V1053
RuleChecker
Include Page
RuleChecker_V
RuleChecker_V
virtual-call-in-constructor
Fully checked
Security Reviewer - Static Reviewer

Include Page
Security Reviewer - Static Reviewer_V
Security Reviewer - Static Reviewer_V

 UNSAFE_07Fully implemented
SonarQube C/C++ Plugin
Include Page
SonarQube C/C++ Plugin_V
SonarQube C/C++ Plugin_V
S1699

Related Vulnerabilities

Search for other vulnerabilities resulting from the violation of this rule on the CERT website.

Bibliography

[Dewhurst 2002]Gotcha #75, "Calling Virtual Functions in Constructors and Destructors"
[ISO/IEC 14882-2014]

Subclause 5.5, "Pointer-to-Member Operators"

[Lockheed Martin 2005]AV Rule 71.1, "A class's virtual functions shall not be invoked from its destructor or any of its constructors"
[Sutter 2004]Item 49, "Avoid Calling Virtual Functions in Constructors and Destructors"


...

Image Added Image Added Image Added

References

Wiki Markup
\[[Dewhurst 03|AA. C++ References#Dewhurst 04]\]  Gotcha 75: Calling Virtual Functions in Constructors and Destructors
\[[Sutter 04|AA. C++ References#Sutter 04]\] Item 49:  Avoid calling virtual functions in constructors and destructors.

OBJ06-CPP. Create a copy constructor and assignment operator for non copyable objects      13. Object Orientation (OBJ)      OBJ33-CPP. Do not slice polymorphic objects