TAO/tao/Unbounded_Octet_Sequence_T.h

   1 #ifndef guard_unbounded_octet_sequence_hpp
   2 #define guard_unbounded_octet_sequence_hpp
   3 /**
   4  * @file
   5  *
   6  * @brief Implement octet sequences
   7  *
   8  * @author Johnny Willemsen
   9  */
  10 #include "tao/orbconf.h"
  11
  12 #include "tao/Unbounded_Value_Sequence_T.h"
  13 #include "ace/OS_NS_string.h"
  14
  15 #if (TAO_NO_COPY_OCTET_SEQUENCES == 1)
  16
  17 #include /**/ "tao/TAO_Export.h"
  18 #include "tao/Unbounded_Value_Allocation_Traits_T.h"
  19 #include "tao/Value_Traits_T.h"
  20 #include "tao/Range_Checking_T.h"
  21
  22 #include "tao/Basic_Types.h"
  23 #include "ace/Message_Block.h"
  24 #include "ace/OS_Memory.h"
  25 #include "ace/checked_iterator.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 namespace TAO
  30 {
  31 template<>
  32 class TAO_Export unbounded_value_sequence<CORBA::Octet>
  33 {
  34 public:
  35   typedef CORBA::Octet value_type;
  36   typedef CORBA::Octet element_type;
  37   typedef CORBA::Octet const const_value_type;
  38   typedef value_type & subscript_type;
  39   typedef value_type const & const_subscript_type;
  40   typedef ::CORBA::ULong size_type;
  41
  42   typedef details::unbounded_value_allocation_traits<value_type,true> allocation_traits;
  43   typedef details::value_traits<value_type,true> element_traits;
  44   typedef details::generic_sequence<value_type, allocation_traits, element_traits> implementation_type;
  45   typedef details::range_checking<value_type,true> range;
  46
  47   inline unbounded_value_sequence<CORBA::Octet>()
  48     : maximum_ (allocation_traits::default_maximum())
  49     , length_ (0)
  50     , buffer_ (allocation_traits::default_buffer_allocation())
  51     , release_ (buffer_ != 0)
  52     , mb_ (0)
  53   {}
  54   inline explicit unbounded_value_sequence<CORBA::Octet>(CORBA::ULong maximum)
  55     : maximum_(maximum)
  56     , length_(0)
  57     , buffer_(allocbuf(maximum_))
  58     , release_(true)
  59     , mb_ (0)
  60   {}
  61   inline unbounded_value_sequence<CORBA::Octet>(
  62       CORBA::ULong maximum,
  63       CORBA::ULong length,
  64       value_type * data,
  65       CORBA::Boolean release = false)
  66     : maximum_ (maximum),
  67       length_ (length),
  68       buffer_ (data),
  69       release_ (release),
  70       mb_ (0)
  71   {}
  72   inline ~unbounded_value_sequence<CORBA::Octet>() {
  73     if (mb_)
  74       ACE_Message_Block::release (mb_);
  75     if (release_)
  76       freebuf(buffer_);
  77   }
  78   /// Create a sequence of octets from a single message block (i.e. it
  79   /// ignores any chaining in the message block).
  80   inline unbounded_value_sequence<CORBA::Octet> (CORBA::ULong length,
  81                                                  const ACE_Message_Block* mb)
  82     : maximum_ (length)
  83     , length_ (length)
  84     , buffer_ (reinterpret_cast <CORBA::Octet *>(mb->rd_ptr ()))
  85     , release_ (false)
  86     , mb_(0) {
  87     // Get the message block flags.
  88     ACE_Message_Block::Message_Flags const flg = mb->self_flags ();
  89
  90     // If the DONT_DELETE flag is disabled just a duplicate would
  91     // help. If the DONT_DELETE flag is enabled a deep copy is needed as
  92     // the contents would be on stack. Just incrementing the ref count
  93     // on the stack based data block would only crash the program when
  94     // the stack unwinds
  95     if (ACE_BIT_DISABLED (flg,
  96                           ACE_Message_Block::DONT_DELETE))
  97       {
  98         this->mb_ = ACE_Message_Block::duplicate (mb);
  99       }
 100     else
 101       {
 102         // As we are in CORBA mode, all the data blocks would be aligned
 103         // on an 8 byte boundary
 104         ACE_Message_Block msgb (*mb, ACE_CDR::MAX_ALIGNMENT);
 105
 106         // Get the base pointer of the incoming message block
 107         char *const start = ACE_ptr_align_binary (mb->base (),
 108                                                   ACE_CDR::MAX_ALIGNMENT);
 109
 110         // Get the read and write displacements in the incoming stream
 111         size_t const rd_pos = mb->rd_ptr () - start;
 112         size_t const wr_pos = mb->wr_ptr () - start;
 113
 114         this->mb_ = ACE_Message_Block::duplicate (&msgb);
 115
 116         this->mb_->rd_ptr (rd_pos);
 117         this->mb_->wr_ptr (wr_pos);
 118       }
 119   }
 120   inline CORBA::ULong maximum() const {
 121     return maximum_;
 122   }
 123   inline CORBA::Boolean release() const {
 124     return release_;
 125   }
 126   inline CORBA::ULong length() const {
 127     return length_;
 128   }
 129   inline void length(CORBA::ULong length) {
 130     if (length <= maximum_)
 131       {
 132         if (this->mb_ == 0)
 133           {
 134             length_ = length;
 135           }
 136         else
 137           {
 138             unbounded_value_sequence<CORBA::Octet> tmp(length);
 139             tmp.length_ = length;
 140             element_traits::copy_range(
 141               buffer_,
 142               buffer_ + length,
 143               ACE_make_checked_array_iterator (tmp.buffer_, tmp.length_));
 144             swap(tmp);
 145           }
 146         return;
 147       }
 148
 149     unbounded_value_sequence<CORBA::Octet> tmp(length);
 150     tmp.length_ = length;
 151     element_traits::copy_range(
 152       buffer_,
 153       buffer_ + length_,
 154       ACE_make_checked_array_iterator (tmp.buffer_, tmp.length_));
 155     swap(tmp);
 156   }
 157   inline value_type const & operator[](CORBA::ULong i) const {
 158     range::check(i, length_, maximum_, "operator[]() const");
 159     return buffer_[i];
 160   }
 161   inline value_type & operator[](CORBA::ULong i) {
 162     range::check(i, length_, maximum_, "operator[]() non-const");
 163     return buffer_[i];
 164   }
 165   inline void replace(
 166       CORBA::ULong maximum,
 167       CORBA::ULong length,
 168       value_type * data,
 169       CORBA::Boolean release = false) {
 170     unbounded_value_sequence<CORBA::Octet> tmp(maximum, length, data, release);
 171     swap(tmp);
 172   }
 173   inline value_type const * get_buffer() const {
 174     if (buffer_ == 0)
 175       {
 176         buffer_ = allocbuf(maximum_);
 177         release_ = true;
 178       }
 179     return buffer_;
 180   }
 181   inline value_type * get_buffer(CORBA::Boolean orphan = false) {
 182     if (orphan && !release_)
 183     {
 184       return 0;
 185     }
 186     if (buffer_ == 0)
 187     {
 188       buffer_ = allocbuf(maximum_);
 189       if (!orphan)
 190         {
 191           release_ = true;
 192         }
 193     }
 194     if (!orphan)
 195     {
 196       return buffer_;
 197     }
 198
 199     unbounded_value_sequence<CORBA::Octet> tmp;
 200     swap(tmp);
 201     tmp.release_ = false;
 202
 203     return tmp.buffer_;
 204   }
 205
 206   // moved inside the class to resolve namespace lookup issues.
 207   // This is a replacement for the commented block below.
 208   inline bool operator== (const unbounded_value_sequence<CORBA::Octet> & rhs) const {
 209     unbounded_value_sequence<CORBA::Octet> const & lhs = *this;
 210     CORBA::ULong const len = lhs.length();
 211
 212     // We use the subscript operator instead of get_buffer() to avoid a
 213     // potential buffer allocation.
 214     return
 215       (len == rhs.length()
 216        && (len == 0
 217            ? true
 218            : ACE_OS::memcmp(&lhs[0], &rhs[0], len) == 0));
 219   }
 220
 221   inline bool operator!= (const unbounded_value_sequence<CORBA::Octet> & rhs) const
 222   {
 223     return !this->operator==(rhs);
 224   }
 225
 226   inline void swap(unbounded_value_sequence & rhs) throw() {
 227     std::swap (mb_, rhs.mb_);
 228     std::swap (maximum_, rhs.maximum_);
 229     std::swap (length_, rhs.length_);
 230     std::swap (buffer_, rhs.buffer_);
 231     std::swap (release_, rhs.release_);
 232   }
 233   static value_type * allocbuf(CORBA::ULong maximum) {
 234     return allocation_traits::allocbuf(maximum);
 235   }
 236   static void freebuf(value_type * buffer) {
 237     allocation_traits::freebuf(buffer);
 238   }
 239
 240   /// Returns the underlying message block, the caller must *not*
 241   /// release the copy.
 242   inline ACE_Message_Block* mb (void) const {
 243     return mb_;
 244   }
 245
 246   /// Replaces the current buffer with @a mb, using only @a length bytes.
 247   /// It takes a duplicate of <mb> so the user still owns it.
 248   inline void replace (CORBA::ULong length, const ACE_Message_Block* mb) {
 249     unbounded_value_sequence<CORBA::Octet> s (length, mb);
 250     swap (s);
 251   }
 252
 253   unbounded_value_sequence<CORBA::Octet> (
 254     const unbounded_value_sequence<CORBA::Octet> &rhs)
 255     : maximum_ (0)
 256     , length_ (0)
 257     , buffer_(0)
 258     , release_(false)
 259     , mb_ (0)
 260   {
 261     if (rhs.maximum_ == 0 || rhs.buffer_ == 0)
 262     {
 263       maximum_ = rhs.maximum_;
 264       length_ = rhs.length_;
 265       return;
 266     }
 267     unbounded_value_sequence<CORBA::Octet> tmp(rhs.maximum_);
 268     tmp.length_ = rhs.length_;
 269     if (rhs.mb_ == 0)
 270       {
 271         ACE_OS::memcpy (tmp.buffer_,
 272                         rhs.buffer_,
 273                         rhs.length_);
 274       }
 275     else
 276       {
 277         size_t offset = 0;
 278         for (const ACE_Message_Block *i = rhs.mb_; i != 0; i = i->cont ())
 279           {
 280             ACE_OS::memcpy (tmp.buffer_ + offset,
 281                             i->rd_ptr (),
 282                             i->length ());
 283
 284             offset += i->length ();
 285           }
 286       }
 287     swap(tmp);
 288   }
 289
 290   unbounded_value_sequence<CORBA::Octet> &
 291   operator= (const unbounded_value_sequence<CORBA::Octet> & rhs)
 292   {
 293     unbounded_value_sequence<CORBA::Octet> tmp(rhs);
 294     swap(tmp);
 295     return * this;
 296   }
 297
 298 private:
 299   /// The maximum number of elements the buffer can contain.
 300   CORBA::ULong maximum_;
 301
 302   /// The current number of elements in the buffer.
 303   CORBA::ULong length_;
 304
 305   /// The buffer with all the elements, casting must be done in derived
 306   /// classes.
 307   mutable value_type * buffer_;
 308
 309   /// If true then the sequence should release the buffer when it is
 310   /// destroyed.
 311   mutable CORBA::Boolean release_;
 312   ACE_Message_Block* mb_;
 313 };
 314
 315 } // namespace TAO
 316
 317 TAO_END_VERSIONED_NAMESPACE_DECL
 318
 319 #endif /* TAO_NO_COPY_OCTET_SEQUENCES == 1 */
 320
 321 #if (TAO_NO_COPY_OCTET_SEQUENCES == 0)
 322
 323 // This doesn't work always for unexplained reason. At least
 324 // PortableServer::Active_Object_Map.cpp fails to compile with some compilers.
 325 // But I'm keeping this in for the moment so that it may be
 326 // resurrected if need be
 327 inline
 328 bool
 329 operator== (const TAO_VERSIONED_NAMESPACE_NAME::TAO::unbounded_value_sequence<CORBA::Octet> & lhs,
 330             const TAO_VERSIONED_NAMESPACE_NAME::TAO::unbounded_value_sequence<CORBA::Octet> & rhs)
 331 {
 332   ::CORBA::ULong const rlen = rhs.length ();
 333
 334   if (rlen != lhs.length ())
 335     {
 336       return false;
 337     }
 338
 339   const CORBA::Octet * rhs_buff = rhs.get_buffer ();
 340   const CORBA::Octet * lhs_buff = lhs.get_buffer ();
 341   const bool result = (ACE_OS::memcmp (lhs_buff, rhs_buff, rlen) == 0);
 342
 343   return result;
 344 }
 345
 346 inline
 347 bool
 348 operator!= (const TAO_VERSIONED_NAMESPACE_NAME::TAO::unbounded_value_sequence<CORBA::Octet> & lhs,
 349             const TAO_VERSIONED_NAMESPACE_NAME::TAO::unbounded_value_sequence<CORBA::Octet> & rhs)
 350 {
 351   return !(lhs == rhs);
 352 }
 353 #endif /* TAO_NO_COPY_OCTET_SEQUENCES==0 */
 354
 355 #endif // guard_unbounded_octet_sequence_hpp