Click here to Skip to main content
15,891,375 members
Articles / Programming Languages / C

Local NEW or Automatic heap cleanup when leaving scope

Rate me:
Please Sign up or sign in to vote.
4.65/5 (20 votes)
29 Sep 2012CPOL8 min read 93.5K   387   26  
Improve exception safety and reducin memory leaks
This is an old version of the currently published article.

Introduction    


Pointers always envied automatic cleanup that is in c++ provided only for big fat slow Static Object or their arrays stored by value.  

Manual cleanup is source of bugs. 

Automatic cleanup provided for static objects saves time lines of code and a lot and I mean really lot of bugs. Bugs by forgetting to match all allocations with deallocations. 
Bugs by memory being leaked when exception or error handler exits something somewhere prematurely and not all control paths contain correct number of release statements. 
Bugs by releasing objects twice or more and corrupting memory by confused condition statements.

Performance  

So we definitely want automatic cleanup that is provided for static objects. But pretty much any program serious about performance will store objects by pointers and not by value because price for reallocation insert or sort is horrendous. 

So can't we have both? Performance and efficiency of pointers and safety and simplicity of static objects by automatic cleanup when leaving scope?

Reinventing Wheel  

Turns out that I am not the first one thinking along those lines and Boost template library already provides us ptr_vector.  vector of shared_ptr or shared_array.
Templates are great when everything is working. But take this example of guy having trouble sorting simple array of pointers and geting responses like

"...The IS specifies that a predicate should not assume that the dereferenced iterator yields a non-const object. Arguments should therefore be taken by reference-to-const or by value.

The IS also specifies that algorithms that take function objects as arguments are permitted to copy those function objects. So in most cases, the overloaded function call operator would be a const member function." 

It it unbelivable what complexity we vere able introduce to "simplify our life"
So if you are like me preffering things small and simple so you know by simple look at source what is going on.
Or just don't plan or can't rewrite tousands of lines of code to use templates stl and boost
Let's try simpler approach.  

Scopes for dynamic heap objects ?  

So how automatic cleanup for static objects work? 
It works by adding pointer of every static object within scope to internal invisible static array and when leaving calling destructors for each of them. Can we make something similar for dynamic objects?
Why not. We can have array of void pointers and store pointers to various object types in one single array.
The only issue are calling proper object specific destructors. Unfortunately as far as I know c++ doesnt allow to get destructor adresses. So the only sollution I come up so far is to use virtual destructor in all stored objects so polymorphysm selects proper one for us. 

First Primitive implementation of Scope.h 

C++
struct Scope { // This is Just simple linked list
       struct Obj { virtual ~Obj() {} };
       Scope*    prev;  Obj* ptr;
       Scope() : prev(0) ,   ptr(0) {}	
      ~Scope() { delete ptr; delete prev; } // deleting all childs in reverse order on exit
};

inline void * __cdecl operator new(unsigned int size,Scope& scope)
{
    void *ptr = (void *)malloc(size); // we add all new objects to this linked list
    if(scope.ptr) { Scope* prev=0; prev=(Scope*)calloc(sizeof(Scope),1); *prev=scope;
    scope.prev=prev; }
    scope.ptr=(Scope::Obj*)ptr; 
    return(ptr);
};

This very simple nothrow new overload just as proof of concept;
Also Scope is very primitive linked list kept simple on purpose. 
 
Beware: only objects having virtual destructor work right now for this scoped new. 

Example code 

#include <stdio.h>
#include <stdlib.h>
#include "Scope.h"   

struct A {  // only objects with virtual destructor are right now supported by Scope
             A(){ printf("\n  A %x",this); }
    virtual ~A(){ printf("\n ~A %x",this); }
};

Scope global; // this one deallocates all associated objects on program exit no matter 
              // what exception or error in program happens

void Test() {
    Scope local; // all objects associated with scope will be deallocated by leaving procedure
    for(int i=0;i<3;i++) {
        A* a=new(local) A();
    }
    A* b=new(global) A(); //associate with global scope
}

void main() {
    Test();
}                 

Output:

   A 689718   A 68b110   A 68b198   A 68b220 ~A 68b198 ~A 68b110 ~A 689718 ~A 68b220

Points of Interest 

The fact that only objects with virtual destructor can be autodeallocated is kinda sad. I hope that some way to get around this limit is found.
Also if you want to autodeallocate memory from malloc/calloc just create new type of Scope and call free instead of delete in its destructor. 

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
Slovakia Slovakia
Past Projects:
[Siemens.sk]Mobile network software: HLR-Inovation for telering.at (Corba)
Medical software: CorRea module for CT scanner
[cauldron.sk]Computer Games:XboxLive/net code for Conan, Knights of the temple II, GeneTroopers, CivilWar, Soldier of fortune II
[www.elveon.com]Computer Games:XboxLive/net code for Elveon game based on Unreal Engine 3
ESET Reasearch.
Looking for job

Comments and Discussions

Discussions on this specific version of this article. Add your comments on how to improve this article here. These comments will not be visible on the final published version of this article.