ACE_Obstack_T< CHAR > Class Template Reference

Define a simple "mark and release" memory allocation utility. More...

#include <Obstack_T.h>

Collaboration diagram for ACE_Obstack_T< CHAR >:

[legend]List of all members.

Public Member Functions
	ACE_Obstack_T (size_t size=(4096 *sizeof(CHAR))-sizeof(ACE_Obchunk), ACE_Allocator *allocator_strategy=0)
	~ACE_Obstack_T (void)
int	request (size_t len)
CHAR *	grow (CHAR c)
void	grow_fast (CHAR c)
CHAR *	freeze (void)
CHAR *	copy (const CHAR *data, size_t len)
size_t	length (void) const
size_t	size (void) const
void	unwind (void *obj)
void	release (void)
void	dump (void) const
	Dump the state of an object.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Protected Member Functions
ACE_Obchunk *	new_chunk (void)
void	unwind_i (void *obj)
Protected Attributes
ACE_Allocator *	allocator_strategy_
	Pointer to the allocator used by this Obstack.
size_t	size_
	Current size of the Obstack;.
ACE_Obchunk *	head_
	Head of the Obchunk chain.
ACE_Obchunk *	curr_
	Pointer to the current Obchunk.

---

Detailed Description

template<class CHAR>
class ACE_Obstack_T< CHAR >

Define a simple "mark and release" memory allocation utility.

The implementation is similar to the GNU obstack utility, which is used extensively in the GCC compiler.

Definition at line 38 of file Obstack_T.h.

---

Constructor & Destructor Documentation

template<class CHAR>

ACE_Obstack_T< CHAR >::ACE_Obstack_T	(	size_t	size = (4096 *sizeof(CHAR))-sizeof(ACE_Obchunk),
		ACE_Allocator *	allocator_strategy = 0
	)

Definition at line 124 of file Obstack_T.cpp.

References ACE_ALLOCATOR, ACE_TRACE, ACE_Obstack_T< CHAR >::curr_, ACE_Obstack_T< CHAR >::head_, ACE_Allocator::instance(), and ACE_Obstack_T< CHAR >::new_chunk().

  : allocator_strategy_ (allocator_strategy),
    size_ (size),
    head_ (0),
    curr_ (0)
{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::ACE_Obstack");

  if (this->allocator_strategy_ == 0)
    ACE_ALLOCATOR (this->allocator_strategy_,
                   ACE_Allocator::instance ());

  this->head_ = this->new_chunk ();
  this->curr_ = this->head_;
}

template<class CHAR>

ACE_Obstack_T< CHAR >::~ACE_Obstack_T

(

void

)

Definition at line 142 of file Obstack_T.cpp.

References ACE_TRACE, ACE_Obstack_T< CHAR >::allocator_strategy_, ACE_Allocator::free(), ACE_Obstack_T< CHAR >::head_, and ACE_Obchunk::next_.

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::~ACE_Obstack_T");

  ACE_Obchunk *temp = this->head_;

  while (temp != 0)
    {
      ACE_Obchunk *next = temp->next_;
      temp->next_  = 0;
      this->allocator_strategy_->free (temp);
      temp = next;
    }
}

---

Member Function Documentation

template<class CHAR>

CHAR * ACE_Obstack_T< CHAR >::copy	(	const CHAR *	data,
		size_t	len
	)

Copy the data into the current Obchunk and freeze the current block. Return the starting address of the current building block, 0 if error occurs. len specify the string length, not the actually data size.

Definition at line 158 of file Obstack_T.cpp.

References ACE_TRACE, ACE_Obchunk::cur_, ACE_Obstack_T< CHAR >::curr_, ACE_Obstack_T< CHAR >::freeze(), and ACE_OS::memcpy().

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::copy");

  if (this->request (len) != 0)
    return 0;

  size_t tsize = len * sizeof (CHAR);
  ACE_OS::memcpy (this->curr_->cur_, s, tsize);
  this->curr_->cur_ += tsize ;
  return this->freeze ();
}

template<class CHAR>

ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_Obstack_T< CHAR >::dump

(

void

)

const

Dump the state of an object.

Definition at line 23 of file Obstack_T.cpp.

References ACE_BEGIN_DUMP, ACE_DEBUG, ACE_END_DUMP, ACE_TEXT, ACE_TRACE, and LM_DEBUG.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_Obstack_T<CHAR>::dump");

  ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
  ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("size_ = %d\n"), this->size_));
  ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("head_ = %x\n"), this->head_));
  ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("curr_ = %x\n"), this->curr_));
  ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
#endif /* ACE_HAS_DUMP */
}

template<class CHAR>

CHAR * ACE_Obstack_T< CHAR >::freeze

(

void

)

Freeze the current building block by null terminating it. Return the starting address of the current building block, 0 if error occurs.

Definition at line 214 of file Obstack_T.cpp.

References ACE_Obchunk::block_, ACE_Obchunk::cur_, and ACE_Obstack_T< CHAR >::curr_.

Referenced by ACE_Obstack_T< CHAR >::copy().

{
  CHAR *retv = reinterpret_cast<CHAR *> (this->curr_->block_);
  * (reinterpret_cast<CHAR *> (this->curr_->cur_)) = 0;

  this->curr_->cur_ += sizeof (CHAR);
  this->curr_->block_ = this->curr_->cur_;
  return retv;
}

template<class CHAR>

CHAR * ACE_Obstack_T< CHAR >::grow

(

CHAR

c

)

Inserting a new CHAR c into the current building block without freezing (null terminating) the block. This function will create new chunk by checking the boundary of current Obchunk. Return the location c gets inserted to, or 0 if error.

Definition at line 93 of file Obstack_T.cpp.

References ACE_TRACE, ACE_Obchunk::cur_, and ACE_Obstack_T< CHAR >::curr_.

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::grow");

  if (this->request (1) == 0)
    {
      CHAR *retv = reinterpret_cast<CHAR *> (this->curr_->cur_);
      this->curr_->cur_ += sizeof (CHAR);
      *retv = c;
      return retv;
    }
  else
    return 0;
}

template<class CHAR>

void ACE_Obstack_T< CHAR >::grow_fast

(

CHAR

c

)

Inserting a new CHAR c into the current building block without freezing (null terminating) the block and without checking for out-of-bound error.

Definition at line 207 of file Obstack_T.cpp.

References ACE_Obchunk::cur_, and ACE_Obstack_T< CHAR >::curr_.

{
  * (reinterpret_cast<CHAR *> (this->curr_->cur_)) = c;
  this->curr_->cur_ += sizeof (CHAR);
}

template<class CHAR>

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE size_t ACE_Obstack_T< CHAR >::length

(

void

)

const

Return the maximum length or size of a string that can be put into this Obstack. size = length * sizeof (CHAR).

Deprecated:

No need to use this function as you can put objects of arbitrary lengths into the obstack now.

Definition at line 8 of file Obstack_T.inl.

References ACE_Obstack_T< CHAR >::size_.

{
  return this->size_ / sizeof (CHAR);
}

template<class CHAR>

ACE_Obchunk * ACE_Obstack_T< CHAR >::new_chunk

(

void

)

[protected]

Definition at line 109 of file Obstack_T.cpp.

References ACE_NEW_MALLOC_RETURN, and ACE_TRACE.

Referenced by ACE_Obstack_T< CHAR >::ACE_Obstack_T(), and ACE_Obstack_T< CHAR >::request().

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::new_chunk");

  ACE_Obchunk *temp = 0;

  ACE_NEW_MALLOC_RETURN (temp,
                         static_cast<ACE_Obchunk *> (this->allocator_strategy_->malloc
                             (sizeof (class ACE_Obchunk) + this->size_)),
                         ACE_Obchunk (this->size_),
                         0);
  return temp;
}

template<class CHAR>

void ACE_Obstack_T< CHAR >::release

(

void

)

"Release" the entire stack of Obchunks, putting it back on the free list.

Definition at line 198 of file Obstack_T.cpp.

References ACE_TRACE, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, ACE_Obstack_T< CHAR >::curr_, and ACE_Obstack_T< CHAR >::head_.

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::release");

  this->curr_ = this->head_;
  this->curr_->block_ = this->curr_->cur_ = this->curr_->contents_;
}

template<class CHAR>

int ACE_Obstack_T< CHAR >::request

(

size_t

len

)

Request Obstack to prepare a block at least len long for building a new string. Return -1 if fail, 0 if success.

Definition at line 37 of file Obstack_T.cpp.

References ACE_TRACE, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, ACE_Obstack_T< CHAR >::curr_, ACE_OS::memcpy(), ACE_Obstack_T< CHAR >::new_chunk(), ACE_Obchunk::next_, and ACE_Obstack_T< CHAR >::size_.

{
  ACE_TRACE ("ACE_Obstack_T<CHAR>::request");

  // normalize the length.
  len *= sizeof (CHAR);

  // Check to see if there's room for the requested length, including
  // any part of an existing string, if any.
  size_t resulting_len = (this->curr_->cur_ - this->curr_->block_) + len;

  // Increase the length of the underlying chunks if the request made is
  // for bigger sized chunks.
  if (this->size_ < resulting_len)
    this->size_ = this->size_ << 1;

  // We now know the request will fit; see if it can fit in the current
  // chunk or will need a new one.
  if (this->curr_->cur_ + len >= this->curr_->end_)
    {
      // Need a new chunk. Save the current one so the current string can be
      // copied to the new chunk.
      ACE_Obchunk *temp = this->curr_;
      if (this->curr_->next_ == 0)
        {
          // We must allocate new memory.
          ACE_Obchunk* tmp = this->new_chunk();
          if (!tmp)
            return -1;
          this->curr_->next_ = tmp;
          this->curr_ = this->curr_->next_;
        }
      else
        {
          // We can reuse previously allocated memory.
          this->curr_ = this->curr_->next_;
          this->curr_->block_ = this->curr_->cur_ = this->curr_->contents_;
        }

      // Copy any initial characters to the new chunk.
      if (temp->cur_ != temp->block_)
        {
          size_t datasize = temp->cur_ - temp->block_;
          ACE_OS::memcpy (this->curr_->block_,
                          temp->block_,
                          datasize);
          this->curr_->cur_ = this->curr_->block_ + datasize;
          // Reset the old chunk.
          temp->cur_ = temp->block_;
        }
    }

  return 0;
}

template<class CHAR>

ACE_INLINE size_t ACE_Obstack_T< CHAR >::size

(

void

)

const

Definition at line 14 of file Obstack_T.inl.

References ACE_Obstack_T< CHAR >::size_.

{
  return this->size_;
}

template<class CHAR>

void ACE_Obstack_T< CHAR >::unwind

(

void *

obj

)

"Unwind" the stack. If obj is a null pointer, everything allocated in the stack is released. Otherwise, obj must be an address of an object allocated in the stack. In this case, obj is released along with everthing allocated in the Obstack since obj.

Definition at line 173 of file Obstack_T.cpp.

References ACE_Obchunk::block_, ACE_Obchunk::cur_, ACE_Obstack_T< CHAR >::curr_, ACE_Obchunk::end_, and ACE_Obstack_T< CHAR >::unwind_i().

{
  if (obj >= this->curr_->contents_ && obj < this->curr_->end_)
    this->curr_->block_ = this->curr_->cur_ = reinterpret_cast<char*> (obj);
  else
    this->unwind_i (obj);
}

template<class CHAR>

void ACE_Obstack_T< CHAR >::unwind_i

(

void *

obj

)

[protected]

Search through the list of Obchunks and release them. Helper funtion used by unwind.

Definition at line 182 of file Obstack_T.cpp.

References ACE_ERROR, ACE_TEXT, ACE_Obchunk::block_, ACE_Obchunk::contents_, ACE_Obchunk::cur_, ACE_Obstack_T< CHAR >::curr_, ACE_Obchunk::end_, ACE_Obstack_T< CHAR >::head_, LM_ERROR, and ACE_Obchunk::next_.

Referenced by ACE_Obstack_T< CHAR >::unwind().

{
  ACE_Obchunk* curr = this->head_;
  while (curr != 0 && (curr->contents_ > obj || curr->end_ < obj))
      curr = curr->next_;
  if (curr)
    {
      this->curr_ = curr;
      this->curr_->block_ = this->curr_->cur_ = reinterpret_cast<char*> (obj);
    }
  else if (obj != 0)
    ACE_ERROR ((LM_ERROR,
                ACE_TEXT ("Deletion of non-existent object.\n%a")));
}

---

Member Data Documentation

template<class CHAR>

ACE_Obstack_T< CHAR >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 96 of file Obstack_T.h.

template<class CHAR>

ACE_Allocator* ACE_Obstack_T< CHAR >::allocator_strategy_ [protected]

Pointer to the allocator used by this Obstack.

Definition at line 106 of file Obstack_T.h.

Referenced by ACE_Obstack_T< CHAR >::~ACE_Obstack_T().

template<class CHAR>

class ACE_Obchunk* ACE_Obstack_T< CHAR >::curr_ [protected]

Pointer to the current Obchunk.

Definition at line 116 of file Obstack_T.h.

Referenced by ACE_Obstack_T< CHAR >::ACE_Obstack_T(), ACE_Obstack_T< CHAR >::copy(), ACE_Obstack_T< CHAR >::freeze(), ACE_Obstack_T< CHAR >::grow(), ACE_Obstack_T< CHAR >::grow_fast(), ACE_Obstack_T< CHAR >::release(), ACE_Obstack_T< CHAR >::request(), ACE_Obstack_T< CHAR >::unwind(), and ACE_Obstack_T< CHAR >::unwind_i().

template<class CHAR>

class ACE_Obchunk* ACE_Obstack_T< CHAR >::head_ [protected]

Head of the Obchunk chain.

Definition at line 113 of file Obstack_T.h.

Referenced by ACE_Obstack_T< CHAR >::ACE_Obstack_T(), ACE_Obstack_T< CHAR >::release(), ACE_Obstack_T< CHAR >::unwind_i(), and ACE_Obstack_T< CHAR >::~ACE_Obstack_T().

template<class CHAR>

size_t ACE_Obstack_T< CHAR >::size_ [protected]

Current size of the Obstack;.

Definition at line 109 of file Obstack_T.h.

Referenced by ACE_Obstack_T< CHAR >::length(), ACE_Obstack_T< CHAR >::request(), and ACE_Obstack_T< CHAR >::size().

---

The documentation for this class was generated from the following files:

• Obstack_T.h
• Obstack_T.cpp
• Obstack_T.inl

---