Versions Compared

Key

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

An object deriving from a base class typically contains additional member variables that extend the base class. When by-value assigning or copying an object of the derived type to an object of the base type, those additional member variables are not copied because there is insufficient space within the base class contains insufficient space in which to store them. This act action is commonly referred to as called slicing the object as because the additional members are "sliced off" the resulting object.

...

In this noncompliant code example, an object of the derived Manager type is passed by value to a function accepting a base Employee type. This results in slicing Consequently, the Manager objects are sliced, resulting in information loss and unexpected behavior when the print() function is called.

...

When f() is called with the Designer argument, the formal parameter in f() is sliced and information is lost. Thus, when When the Employee object is printed, Employee::Print() is called instead of Manager::Print(), resulting in the following output:

Code Block
Employee: Jane Doe

...

Using the same class definitions as abovenoncompliant code example, this compliant solution modifies the definition of f() to require raw pointers to the object, removing the slicing problem:

...

This compliant solution also complies with EXP34-C. Do not dereference null pointers in the implementation of f(). With this definition, the output becomes:

Code Block
Employee: Joe Smith
Employee: Bill Jones
Manager: Jane Doe
Assistant: 
	Employee: Bill Jones

...

Both of the previous compliant solutions depend on consumers of the Employee and Manager types to be declared in a compliant manner with the expected usage of the class hierarchy. This compliant solution ensures that consumers are unable to accidentally slice objects by removing the ability to copy-initialize. If copy-initialization is attempted, as in the original definition of f(), the program is ill-formed and a diagnostic will be emitted. However, such a solution also requires restricts the Manager object to not attempt from attempting to copy-initialize its Employee object, which subtly changes the semantics of the class hierarchy.

...

Code Block
bgColor#ccccff
langcpp
#include <iostream>
#include <string>

class Noncopyable {
  Noncopyable(const Noncopyable &) = delete;
  void operator=(const Noncopyable &) = delete;
  
protected:
  Noncopyable() = default;
};

class Employee : Noncopyable {
  std::string Name;
  
protected:
  virtual void print(std::ostream &OS) const {
    OS << "Employee: " << getName() << std::endl;      
  }
  
public:
  Employee(const std::string &Name) : Name(Name) {}
  const std::string &getName() const { return Name; }
  friend std::ostream &operator<<(std::ostream &OS, const Employee &E) {
    E.print(OS);
    return OS;
  }
};
 
class Manager : public Employee {
  const Employee &Assistant; // Note: thisThis definition has been modified
  
protected:
  void print(std::ostream &OS) const override {
    OS << "Manager: " << getName() << std::endl;
    OS << "Assistant: " << std::endl << "\t" << getAssistant() << std::endl;      
  }
  
public:
  Manager(const std::string &Name, const Employee &Assistant) : Employee(Name), Assistant(Assistant) {}
  const Employee &getAssistant() const { return Assistant; }
};
 
// If f() were declared as accepting an Employee, the program would be
// ill-formed because Employee cannot be copy-initialized.
void f(const Employee &E) {
  std::cout << E;    
}

int main() {
  Employee Coder("Joe Smith");
  Employee Typist("Bill Jones");
  Manager Designer("Jane Doe", Typist);
  
  f(Coder);
  f(Typist);
  f(Designer);
}

...

This noncompliant code example uses the same class definitions of Employee and Manager from above, as in the previous examples and attempts to store Employee objects in a std::vector. However, because std::vector requires a homogeneous list of elements, slicing occurs.

Code Block
bgColor#FFCCCC
langcpp
// In addition to the #includes from the previous example.
#include <vector>
 
void f(const std::vector<Employee> &V) {
  for (const auto &E : V) {
    std::cout << E;
  }
}

int main() {
  Employee Typist("Joe Smith");
  std::vector<Employee> V{Typist, Employee("Bill Jones"), Manager("Jane Doe", Typist)};
  f(V);
}

...

Code Block
bgColor#ccccff
langcpp
// In addition to the #includes from the previous example.
#include <memory>
#include <vector>

void f(const std::vector<std::unique_ptr<Employee>> &V) {
  for (const auto &E : V) {
    std::cout << *E;
  }
}

int main() {
  std::vector<std::unique_ptr<Employee>> V;
  
  V.emplace_back(new Employee("Joe Smith"));
  V.emplace_back(new Employee("Bill Jones"));
  V.emplace_back(new Manager("Jane Doe", *V.front()));
  
  f(V);
}

...

Slicing results in information being lostloss, which could lead to abnormal program execution or denial-of-service attacks.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

OOP51-CPP

Low

Probable

Medium

P4

L3

...

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

Related Guidelines

...

[ISO/IEC 14882-2014]12.8, "Copying and Moving Class Objects"
[Dewhurst 02]Gotcha #38, "Slicing"
[Sutter 00]GotW #22: , "Object Lifetimes - Part I"  

 

...