15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2007, Google Inc.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All rights reserved.
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met:
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions of source code must retain the above copyright
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer.
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions in binary form must reproduce the above
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution.
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Neither the name of Google Inc. nor the names of its
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission.
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ---
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: Arun Sharma
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "config_for_unittests.h"
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "system-alloc.h"
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdio.h>
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined HAVE_STDINT_H
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdint.h>             // to get uintptr_t
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined HAVE_INTTYPES_H
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <inttypes.h>           // another place uintptr_t might be defined
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/types.h>
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <algorithm>
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <limits>
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h"               // for Check_GEImpl, Check_LTImpl, etc
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <gperftools/malloc_extension.h>    // for MallocExtension::instance
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "common.h"                     // for kAddressBits
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ArraySysAllocator : public SysAllocator {
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)public:
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Was this allocator invoked at least once?
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  bool invoked_;
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  ArraySysAllocator() : SysAllocator() {
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    ptr_ = 0;
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    invoked_ = false;
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void* Alloc(size_t size, size_t *actual_size, size_t alignment) {
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    invoked_ = true;
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (size > kArraySize) {
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      return NULL;
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    }
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    void *result = &array_[ptr_];
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    uintptr_t ptr = reinterpret_cast<uintptr_t>(result);
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (actual_size) {
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      *actual_size = size;
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    }
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // Try to get more memory for alignment
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    size_t extra = alignment - (ptr & (alignment-1));
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    size += extra;
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    CHECK_LT(ptr_ + size, kArraySize);
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if ((ptr & (alignment-1)) != 0) {
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      ptr += alignment - (ptr & (alignment-1));
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    }
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    ptr_ += size;
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return reinterpret_cast<void *>(ptr);
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void DumpStats() {
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)private:
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  static const int kArraySize = 8 * 1024 * 1024;
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  char array_[kArraySize];
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // We allocate the next chunk from here
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int ptr_;
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)};
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const int ArraySysAllocator::kArraySize;
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ArraySysAllocator a;
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void TestBasicInvoked() {
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  MallocExtension::instance()->SetSystemAllocator(&a);
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // An allocation size that is likely to trigger the system allocator.
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // XXX: this is implementation specific.
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  char *p = new char[1024 * 1024];
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  delete [] p;
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Make sure that our allocator was invoked.
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  CHECK(a.invoked_);
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if 0  // could port this to various OSs, but won't bother for now
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)TEST(AddressBits, CpuVirtualBits) {
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Check that kAddressBits is as least as large as either the number of bits
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // in a pointer or as the number of virtual bits handled by the processor.
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // To be effective this test must be run on each processor model.
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const int kPointerBits = 8 * sizeof(void*);
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const int kImplementedVirtualBits = NumImplementedVirtualBits();
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  CHECK_GE(kAddressBits, std::min(kImplementedVirtualBits, kPointerBits));
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static void TestBasicRetryFailTest() {
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Check with the allocator still works after a failed allocation.
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // There is no way to call malloc and guarantee it will fail.  malloc takes a
1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // size_t parameter and the C++ standard does not constrain the size of
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // size_t.  For example, consider an implementation where size_t is 32 bits
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // and pointers are 64 bits.
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // It is likely, though, that sizeof(size_t) == sizeof(void*).  In that case,
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // the first allocation here might succeed but the second allocation must
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // fail.
1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //
1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // If the second allocation succeeds, you will have to rewrite or
1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // disable this test.
1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // The weird parens are to avoid macro-expansion of 'max' on windows.
1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  const size_t kHugeSize = (std::numeric_limits<size_t>::max)() / 2;
1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void* p1 = malloc(kHugeSize);
1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void* p2 = malloc(kHugeSize);
1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  CHECK(p2 == NULL);
1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (p1 != NULL) free(p1);
1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  char* q = new char[1024];
1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  CHECK(q != NULL);
1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  delete [] q;
1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int main(int argc, char** argv) {
1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  TestBasicInvoked();
1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  TestBasicRetryFailTest();
1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  printf("PASS\n");
1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return 0;
1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
155