Sign in to follow this  
Dekowta

Ref counting

Recommended Posts

Dekowta    269

I have a slight problem which I have a solution to but want to check to see if I need to do it.

I have a structure that inherits from another structure and I need the cast ability in angel script to typecast the inherited object to the base class.
However this requires the object to be a reference however I would rather the object be of value type since its only a structure to send to a function to create another object.

If i created the class with no ref counter I take I would have to delete the object within C++ and ensure the angel script object/s is also cleaned up as well.

I can still inherit and add a ref counter but I would rather not have to do this.

Thanks

Share this post


Link to post
Share on other sites
WitchLord    4677

With asOBJ_NOCOUNT you're telling AngelScript the objects of the type will be allocated on the heap just like any other reference type but that AngelScript doesn't need to increment and decrement the references. All the rules that apply to asOBJ_REF are also valid for asOBJ_REF with asOBJ_NOCOUNT so they will allow the ref cast behaviour.

 

Of course without the reference counting you'll be responsible for identifying when no more references to the object exists and the memory can be released.

Share this post


Link to post
Share on other sites
Dekowta    269

I take it by that then if I was to go

obj@ OBJA = obj();

obj@ OBJB = OBJA;

 

with ref counting the object OBJA will have a ref count of 2. If I was to make OBJA NULL I take it the ref count of the object will go down to 1 and OBJB will still be valid until it comes out of scope or is equal to NULL?

If I didnt use ref counting and I made OBJA NULL does OBJB still exist and I would have to explicitly make it equal to NULL to also remove it even if OBJB went out of scope.

Sorry if this is all a bit basic I have a rough understanding of it but I just want to make sure im not doing anything that will cause memory leaks and corruptions.

Share this post


Link to post
Share on other sites
WitchLord    4677
obj() creates the object instance that is allocated somewhere on the heap.

OBJA and OBJB are both handles that refer to the same object instance. And as long as there are any references the object instance should not be destroyed and deallocated, or you'll end up with what's often called "dangling pointers". Access to an invalid object through such dangling pointers can cause unexpected behaviour, in the best case it will immediately crash the application, but in a worst case it will cause less noticeable bugs that can be very difficult to find.

With reference counting the obj knows exactly how many handles are referring to it, and can thus easily know when it is safe to destroy and deallocate the object.

Without reference counting you'll have a difficult time to know how many handles there are. But with careful design of your application you'll be able know when it is not possible to exist any handles, and the object can be destroyed, e.g if there are no active script contexts and there are no global variables in the scripts you know that the script can't hold any references to the object.

Share this post


Link to post
Share on other sites
Dekowta    269

How then would I go about implementing reference counting on a C++ object I don't have access to adding a reference counter directly to the object?
 

Share this post


Link to post
Share on other sites
WitchLord    4677

There are a many different possibilities.

 

One is to create a thin wrapper structure, like what I've done with the std::string class here:

 

http://svn.code.sf.net/p/angelscript/code/trunk/sdk/tests/test_feature/source/scriptstring.h

http://svn.code.sf.net/p/angelscript/code/trunk/sdk/tests/test_feature/source/scriptstring.cpp

 

Another is to keep the ref counter in a lookup map. For example something like this:

 

std::map<Object*, int> refCounters;
void Object_AddRef(Object *obj)
{
   std::map<Object*,int>::iterator it = refCounters.find(obj);
   if( it != refCounters.end() )
     it->second++;
   else
     refCounters.insert(std::map<Object*,int>::pair(obj, 1);
}
void Object_Release(Object *obj)
{
   std::map<Object*,int>::iterator it = refCounters.find(obj);
   if( it != refCounters.end() )
   {
     if( --(it->second) == 0 )
     {
       delete obj;
       refCounters.erase(it);
     }
   }
}
// Register these with AngelScript like this:
engine->RegisterObjectBehaviour("Object", asBEHAVE_ADDREF, "void f()", asFUNCTION(Object_AddRef), asCALL_CDECL_OBJLAST);
engine->RegisterObjectBehaviour("Object", asBEHAVE_RELEASE, "void f()", asFUNCTION(Object_Release), asCALL_CDECL_OBJLAST);

 

Please forgive coding errors, I'm writing this from memory.

 

The first alternative is probably more performatic, but has the drawback that you're actually using a different object type than the true type. In many cases this will not be a problem, but in others you'll need to wrap your application functions to translate the real object into the wrapper object so it will have the reference counter.

 

The second alternative should work pretty seamlessly, though the performance might suffer somewhat if you have a lot of operations on this object as the look-up into the map will add significant overhead. 

Share this post


Link to post
Share on other sites
Dekowta    269

Thanks for the reply.

Sorry didn't reply sooner thought I had done already.

Seems to have worked fine though the object still seems to exist after the ref count reaches 0 and the object is deleted. For example:
 

 

Aclass@ myclass = Aclass();

void initalise()
{
    Print("init");
    myclass.printA();
}

void update()
{
    myclass.printA();
}
 


The add ref function is called and then the remove ref before the initalise function is called yet the myclass object works as intended and now my map has no objects stored.

not really sure what is going on though im sure im doing something wrong.


The class is registered as followed
 

AngelManager::registerClass("Aclass", 0, asOBJ_REF);
AngelManager::registerClassBehaviour("Aclass", "Aclass@ f()", asBEHAVE_FACTORY, asFUNCTION(createA));
AngelManager::registerClassBehaviour("Aclass", "void f()", asBEHAVE_ADDREF, asFUNCTION(ObjectA_AddRef), asCALL_CDECL_OBJLAST);
AngelManager::registerClassBehaviour("Aclass", "void f()", asBEHAVE_RELEASE, asFUNCTION(ObjectA_Release), asCALL_CDECL_OBJLAST);
AngelManager::registerClassMethod("Aclass", "void printA()", asMETHOD(Aclass, printA));


 

Share this post


Link to post
Share on other sites
WitchLord    4677

You need to make sure the object is added to the map with the factory function, i.e. when the factory function returns the handle the refCount should be at least 1 (it can be higher if you're storing the handle elsewhere too).

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this