How can I get rid of this Heisenbug in my doubly-linked list data structure? - c++

Question

I am implementing a modified doubly-linked data structure and while I was unit testing the functions, I encountered a Heisenbug that I can't get rid of.
Specific piece of code that I get the random segmentation fault is below:
case CURSOR_LIST_COPY_CONSTRUCTOR:
{
// Test to construct a cursor list by using the copy constructor.
if (verbose) {
os << "\nCURSOR_LIST_COPY_CONSTRUCTOR:" << std::endl <<
"Starting the construction operation:" <<
std::endl;
}
anil::cursor_list my_cursor_list;
my_cursor_list.append(1);
anil::cursor_list my_copied_cursor_list = my_cursor_list;
if (&my_copied_cursor_list == nullptr &&
my_copied_cursor_list.index() != -1 &&
my_copied_cursor_list.size() != 1 &&
my_copied_cursor_list.front_data() != 1 &&
my_copied_cursor_list.back_data() != 1) {
if (verbose) {
os << "Copy construction unsuccessful!" << std::endl;
}
return false;
} else {
if (verbose) {
os << "Copy construction successful!" << std::endl;
}
return true;
}
return false;
break;
}
Two runs out of ten give me a segmentation fault at my_copied_cursor_list.front_data() != 1. Initially I couldn't get to replicate this bug inside gdb but after using the command set disable-randomization off, which I learned from an answer to the question segfault only when NOT using debugger, inside gdb, I was able to replicate the same bug.
The source code for the front data is as following:
int anil::cursor_list::front_data() {
if (this != nullptr && this->is_empty() == false) {
return this->front->data;
}
}
I tried to put return this->front->data; into an if statement in order to test if this->front was somehow nullptr; however, even when I did it, it still somehow caused a segmentation fault. This was what I tried and failed:
int anil::cursor_list::front_data() {
if (this != nullptr && this->is_empty() == false) {
if (this->front != nullptr) {
return this->front->data;
}
}
}
The code for the append() function is as following:
void anil::cursor_list::append(int new_data) {
if (this != nullptr) {
cursor_list_node* new_node = new cursor_list_node;
new_node->data = new_data;
new_node->next = nullptr;
new_node->previous = this->back;
if (this->is_empty() == false) {
this->back->next = new_node;
} else {
this->front = new_node;
}
this->back = new_node;
++this->m_size;
}
}
The code for the class declaration is as following:
#ifndef ANIL_CURSOR_LIST_H
#define ANIL_CURSOR_LIST_H
#include <cstddef>
#include <iostream>
namespace anil {
class cursor_list_node {
private:
int data;
cursor_list_node* next;
cursor_list_node* previous;
friend class cursor_list;
};
class cursor_list {
private:
// Data:
int m_index;
int m_size;
cursor_list_node* front;
cursor_list_node* back;
cursor_list_node* cursor;
// Functions:
void delete_list();
public:
cursor_list() : m_index(-1), m_size(0), front(nullptr), back(nullptr),
cursor(nullptr) {}
cursor_list(cursor_list& copied_list);
bool is_empty();
int size();
int index();
int front_data();
int back_data();
int cursor_data();
bool operator==(cursor_list& rhs); // rhs = right hand side
cursor_list& operator= (cursor_list& rhs); // rhs = right hand side
friend std::ostream& operator<<(std::ostream& out, const cursor_list& rhs); // rhs = right hand side
void clear();
void move_cursor_front();
void move_cursor_back();
void move_cursor_prev();
void move_cursor_next();
void prepend(int new_data);
void append(int new_data);
void insert_before_cursor(int new_data);
void insert_after_cursor(int new_data);
void delete_front();
void delete_back();
void delete_cursor();
~cursor_list();
};
}
#endif /* ANIL_CURSOR_LIST_H */
The segmentation fault message inside gdb is as following:
Program received signal SIGSEGV, Segmentation fault.
0x00000000004018c8 in anil::cursor_list::front_data (this=0x7ffe055100c0)
at anil_cursor_list.cpp:82
82 return this->front->data;
My operating system is as following:
Distributor ID: Ubuntu
Description: Ubuntu 16.04.6 LTS
Release: 16.04
Codename: xenial
Lastly, the entire source code for the data structure can be found at https://github.com/Karipso/Karipso-Public/blob/master/cpp_practice_codes/data_structures/cursor_list/anil_cursor_list.cpp and https://github.com/Karipso/Karipso-Public/blob/master/cpp_practice_codes/data_structures/cursor_list/anil_cursor_list.h.
Similarly, the source code for the unit tests can be found at: https://github.com/Karipso/Karipso-Public/blob/master/cpp_practice_codes/data_structures/cursor_list/main.cpp
Finally, the makefile is located at https://github.com/Karipso/Karipso-Public/blob/master/cpp_practice_codes/data_structures/cursor_list/Makefile
Can someone help me determine what this bug is caused by?
Update: I tried to run the program using gdb line by line using next and step and printed this and this->front before the seg fault. This is the result:
Breakpoint 1, run_tests (os=..., bst_test=1, verbose=false) at main.cpp:121
121 anil::cursor_list my_copied_cursor_list = my_cursor_list;
(gdb) next
138 if (my_copied_cursor_list.index() != -1) {}
(gdb)
139 if (my_copied_cursor_list.size() != 1) {}
(gdb)
140 if (my_copied_cursor_list.front_data() != 1) {}
(gdb) step
anil::cursor_list::front_data (this=0x7ffc683c4500) at anil_cursor_list.cpp:79
79 if (this != nullptr && this->is_empty() == false) {
(gdb) next
80 return this->front->data;
(gdb) print this
$7 = (anil::cursor_list * const) 0x7ffc683c4500
(gdb) print this->front
$8 = (anil::cursor_list_node *) 0xe92cb976bc5a2900
(gdb) next
Program received signal SIGSEGV, Segmentation fault.
0x0000000000401956 in anil::cursor_list::front_data (this=0x7ffc683c4500)
at anil_cursor_list.cpp:80
80 return this->front->data;
Update-2: I think, I was able to get rid of the Heisenbug. After adding the initializations for all member variables of the cursor_list class, the program stopped giving seg-faults. So, I updated the copy constructor to be as following:
this->m_index = -1;
this->m_size = 0;
this->front = nullptr;
this->back = nullptr;
this->cursor = nullptr;
if (copied_cursor_list.is_empty() == false) {
for (cursor_list_node* it = copied_cursor_list.front; it != nullptr;
it = it->next) {
this->append(it->data);
}
}
I will do some experimentation to figure out why append() function wasn't properly initializing the front pointer and update the post if I can figure out the exact cascade of events that lead to that faulty initialization or lack of initialization.

Answer 1

if (this != nullptr)
You aren't allowed to check that. Compilers can and will change this to if(true).
Calling nullptr->blah() is already UB, so within blah the compiler is free to assume nullptr is not null.
int anil::cursor_list::front_data
Not all return paths return a value. Falling off the end is UB.
The compiler is free to remove your if checks guarding the return path, because segfaulting is allowed in UB.
Fixing this might not fix your crash, but with UB in your code, compilers are permitted to generate code that crashes in nonsense ways.
To fix your problem, you should make a much much simpler linked list with fewer operations.
Then unit test that.
Then wrap that simpler linked list in your rich API. And unit test your rich API.
Then when you have a crash in your rich API unit tests, you can write up a minimal unit test in your simple API.