libstdc++-v3/include/ext/throw_allocator.h

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 2, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  32
  33 // Permission to use, copy, modify, sell, and distribute this software
  34 // is hereby granted without fee, provided that the above copyright
  35 // notice appears in all copies, and that both that copyright notice
  36 // and this permission notice appear in supporting documentation. None
  37 // of the above authors, nor IBM Haifa Research Laboratories, make any
  38 // representation about the suitability of this software for any
  39 // purpose. It is provided "as is" without express or implied
  40 // warranty.
  41
  42 /** @file ext/throw_allocator.h
  43  *  This file is a GNU extension to the Standard C++ Library.
  44  *
  45  *  Contains an exception-throwing allocator, useful for testing
  46  *  exception safety. In addition, allocation addresses are stored and
  47  *  sanity checked.
  48  */
  49
  50 #ifndef _THROW_ALLOCATOR_H
  51 #define _THROW_ALLOCATOR_H 1
  52
  53 #include <cmath>
  54 #include <ctime>
  55 #include <map>
  56 #include <set>
  57 #include <string>
  58 #include <ostream>
  59 #include <stdexcept>
  60 #include <utility>
  61 #include <tr1/random>
  62 #include <bits/functexcept.h>
  63 #include <bits/stl_move.h>
  64
  65 _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
  66
  67   class twister_rand_gen
  68   {
  69   public:
  70     twister_rand_gen(unsigned int seed =
  71                      static_cast<unsigned int>(std::time(0)));
  72
  73     void
  74     init(unsigned int);
  75
  76     double
  77     get_prob();
  78
  79   private:
  80     std::tr1::mt19937 _M_generator;
  81   };
  82
  83   /// Thown by throw_allocator.
  84   struct forced_exception_error : public std::exception
  85   { };
  86
  87   // Substitute for concurrence_error object in the case of -fno-exceptions.
  88   inline void
  89   __throw_forced_exception_error()
  90   {
  91 #if __EXCEPTIONS
  92     throw forced_exception_error();
  93 #else
  94     __builtin_abort();
  95 #endif
  96   }
  97
  98   /// Base class.
  99   class throw_allocator_base
 100   {
 101   public:
 102     void
 103     init(unsigned long seed);
 104
 105     static void
 106     set_throw_prob(double throw_prob);
 107
 108     static double
 109     get_throw_prob();
 110
 111     static void
 112     set_label(size_t l);
 113
 114     static bool
 115     empty();
 116
 117     struct group_throw_prob_adjustor
 118     {
 119       group_throw_prob_adjustor(size_t size)
 120       : _M_throw_prob_orig(_S_throw_prob)
 121       {
 122         _S_throw_prob =
 123           1 - std::pow(double(1 - _S_throw_prob), double(0.5 / (size + 1)));
 124       }
 125
 126       ~group_throw_prob_adjustor()
 127       { _S_throw_prob = _M_throw_prob_orig; }
 128
 129     private:
 130       const double _M_throw_prob_orig;
 131     };
 132
 133     struct zero_throw_prob_adjustor
 134     {
 135       zero_throw_prob_adjustor() : _M_throw_prob_orig(_S_throw_prob)
 136       { _S_throw_prob = 0; }
 137
 138       ~zero_throw_prob_adjustor()
 139       { _S_throw_prob = _M_throw_prob_orig; }
 140
 141     private:
 142       const double _M_throw_prob_orig;
 143     };
 144
 145   protected:
 146     static void
 147     insert(void*, size_t);
 148
 149     static void
 150     erase(void*, size_t);
 151
 152     static void
 153     throw_conditionally();
 154
 155     // See if a particular address and size has been allocated by this
 156     // allocator.
 157     static void
 158     check_allocated(void*, size_t);
 159
 160     // See if a given label has been allocated by this allocator.
 161     static void
 162     check_allocated(size_t);
 163
 164   private:
 165     typedef std::pair<size_t, size_t>           alloc_data_type;
 166     typedef std::map<void*, alloc_data_type>    map_type;
 167     typedef map_type::value_type                entry_type;
 168     typedef map_type::const_iterator            const_iterator;
 169     typedef map_type::const_reference           const_reference;
 170
 171     friend std::ostream&
 172     operator<<(std::ostream&, const throw_allocator_base&);
 173
 174     static entry_type
 175     make_entry(void*, size_t);
 176
 177     static void
 178     print_to_string(std::string&);
 179
 180     static void
 181     print_to_string(std::string&, const_reference);
 182
 183     static twister_rand_gen     _S_g;
 184     static map_type             _S_map;
 185     static double               _S_throw_prob;
 186     static size_t               _S_label;
 187   };
 188
 189   /// Allocator class with logging and exception control.
 190   template<typename T>
 191     class throw_allocator : public throw_allocator_base
 192     {
 193     public:
 194       typedef size_t                            size_type;
 195       typedef ptrdiff_t                         difference_type;
 196       typedef T                                 value_type;
 197       typedef value_type*                       pointer;
 198       typedef const value_type*                 const_pointer;
 199       typedef value_type&                       reference;
 200       typedef const value_type&                 const_reference;
 201
 202
 203       template<typename U>
 204       struct rebind
 205       {
 206         typedef throw_allocator<U> other;
 207       };
 208
 209       throw_allocator() throw() { }
 210
 211       throw_allocator(const throw_allocator&) throw() { }
 212
 213       template<typename U>
 214       throw_allocator(const throw_allocator<U>&) throw() { }
 215
 216       ~throw_allocator() throw() { }
 217
 218       size_type
 219       max_size() const throw()
 220       { return std::allocator<value_type>().max_size(); }
 221
 222       pointer
 223       allocate(size_type __n, std::allocator<void>::const_pointer hint = 0)
 224       {
 225         if (__builtin_expect(__n > this->max_size(), false))
 226           std::__throw_bad_alloc();
 227
 228         throw_conditionally();
 229         value_type* const a = std::allocator<value_type>().allocate(__n, hint);
 230         insert(a, sizeof(value_type) * __n);
 231         return a;
 232       }
 233
 234       void
 235       construct(pointer __p, const T& val)
 236       { return std::allocator<value_type>().construct(__p, val); }
 237
 238 #ifdef __GXX_EXPERIMENTAL_CXX0X__
 239       template<typename... _Args>
 240         void
 241         construct(pointer __p, _Args&&... __args)
 242         {
 243           return std::allocator<value_type>().
 244             construct(__p, std::forward<_Args>(__args)...);
 245         }
 246 #endif
 247
 248       void
 249       destroy(pointer __p)
 250       { std::allocator<value_type>().destroy(__p); }
 251
 252       void
 253       deallocate(pointer __p, size_type __n)
 254       {
 255         erase(__p, sizeof(value_type) * __n);
 256         std::allocator<value_type>().deallocate(__p, __n);
 257       }
 258
 259       void
 260       check_allocated(pointer __p, size_type __n)
 261       { throw_allocator_base::check_allocated(__p, sizeof(value_type) * __n); }
 262
 263       void
 264       check_allocated(size_type label)
 265       { throw_allocator_base::check_allocated(label); }
 266     };
 267
 268   template<typename T>
 269     inline bool
 270     operator==(const throw_allocator<T>&, const throw_allocator<T>&)
 271     { return true; }
 272
 273   template<typename T>
 274     inline bool
 275     operator!=(const throw_allocator<T>&, const throw_allocator<T>&)
 276     { return false; }
 277
 278   std::ostream&
 279   operator<<(std::ostream& os, const throw_allocator_base& alloc)
 280   {
 281     std::string error;
 282     throw_allocator_base::print_to_string(error);
 283     os << error;
 284     return os;
 285   }
 286
 287   // XXX Should be in .cc.
 288   twister_rand_gen::
 289   twister_rand_gen(unsigned int seed) : _M_generator(seed)  { }
 290
 291   void
 292   twister_rand_gen::
 293   init(unsigned int seed)
 294   { _M_generator.seed(seed); }
 295
 296   double
 297   twister_rand_gen::
 298   get_prob()
 299   {
 300     const double eng_min = _M_generator.min();
 301     const double eng_range =
 302       static_cast<const double>(_M_generator.max() - eng_min);
 303
 304     const double eng_res =
 305       static_cast<const double>(_M_generator() - eng_min);
 306
 307     const double ret = eng_res / eng_range;
 308     _GLIBCXX_DEBUG_ASSERT(ret >= 0 && ret <= 1);
 309     return ret;
 310   }
 311
 312   twister_rand_gen throw_allocator_base::_S_g;
 313
 314   throw_allocator_base::map_type
 315   throw_allocator_base::_S_map;
 316
 317   double throw_allocator_base::_S_throw_prob;
 318
 319   size_t throw_allocator_base::_S_label = 0;
 320
 321   throw_allocator_base::entry_type
 322   throw_allocator_base::make_entry(void* p, size_t size)
 323   { return std::make_pair(p, alloc_data_type(_S_label, size)); }
 324
 325   void
 326   throw_allocator_base::init(unsigned long seed)
 327   { _S_g.init(seed); }
 328
 329   void
 330   throw_allocator_base::set_throw_prob(double throw_prob)
 331   { _S_throw_prob = throw_prob; }
 332
 333   double
 334   throw_allocator_base::get_throw_prob()
 335   { return _S_throw_prob; }
 336
 337   void
 338   throw_allocator_base::set_label(size_t l)
 339   { _S_label = l; }
 340
 341   void
 342   throw_allocator_base::insert(void* p, size_t size)
 343   {
 344     const_iterator found_it = _S_map.find(p);
 345     if (found_it != _S_map.end())
 346       {
 347         std::string error("throw_allocator_base::insert");
 348         error += "double insert!";
 349         error += '\n';
 350         print_to_string(error, make_entry(p, size));
 351         print_to_string(error, *found_it);
 352         std::__throw_logic_error(error.c_str());
 353       }
 354     _S_map.insert(make_entry(p, size));
 355   }
 356
 357   bool
 358   throw_allocator_base::empty()
 359   { return _S_map.empty(); }
 360
 361   void
 362   throw_allocator_base::erase(void* p, size_t size)
 363   {
 364     check_allocated(p, size);
 365     _S_map.erase(p);
 366   }
 367
 368   void
 369   throw_allocator_base::check_allocated(void* p, size_t size)
 370   {
 371     const_iterator found_it = _S_map.find(p);
 372     if (found_it == _S_map.end())
 373       {
 374         std::string error("throw_allocator_base::check_allocated by value ");
 375         error += "null erase!";
 376         error += '\n';
 377         print_to_string(error, make_entry(p, size));
 378         std::__throw_logic_error(error.c_str());
 379       }
 380
 381     if (found_it->second.second != size)
 382       {
 383         std::string error("throw_allocator_base::check_allocated by value ");
 384         error += "wrong-size erase!";
 385         error += '\n';
 386         print_to_string(error, make_entry(p, size));
 387         print_to_string(error, *found_it);
 388         std::__throw_logic_error(error.c_str());
 389       }
 390   }
 391
 392   void
 393   throw_allocator_base::check_allocated(size_t label)
 394   {
 395     std::string found;
 396     const_iterator it = _S_map.begin();
 397     while (it != _S_map.end())
 398       {
 399         if (it->second.first == label)
 400           print_to_string(found, *it);
 401         ++it;
 402       }
 403
 404     if (!found.empty())
 405       {
 406         std::string error("throw_allocator_base::check_allocated by label ");
 407         error += '\n';
 408         error += found;
 409         std::__throw_logic_error(error.c_str());
 410       }
 411   }
 412
 413   void
 414   throw_allocator_base::throw_conditionally()
 415   {
 416     if (_S_g.get_prob() < _S_throw_prob)
 417       __throw_forced_exception_error();
 418   }
 419
 420   void
 421   throw_allocator_base::print_to_string(std::string& s)
 422   {
 423     const_iterator begin = throw_allocator_base::_S_map.begin();
 424     const_iterator end = throw_allocator_base::_S_map.end();
 425     for (; begin != end; ++begin)
 426       print_to_string(s, *begin);
 427   }
 428
 429   void
 430   throw_allocator_base::print_to_string(std::string& s, const_reference ref)
 431   {
 432     char buf[40];
 433     const char tab('\t');
 434     s += "address: ";
 435     __builtin_sprintf(buf, "%p", ref.first);
 436     s += buf;
 437     s += tab;
 438     s += "label: ";
 439     unsigned long l = static_cast<unsigned long>(ref.second.first);
 440     __builtin_sprintf(buf, "%lu", l);
 441     s += buf;
 442     s += tab;
 443     s += "size: ";
 444     l = static_cast<unsigned long>(ref.second.second);
 445     __builtin_sprintf(buf, "%lu", l);
 446     s += buf;
 447     s += '\n';
 448   }
 449
 450 _GLIBCXX_END_NAMESPACE
 451
 452 #endif