folly/experimental/fibers/GuardPageAllocator.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #pragma once
  17
  18 #include <memory>
  19
  20 namespace folly { namespace fibers {
  21
  22 class StackCacheEntry;
  23
  24 /**
  25  * Stack allocator that protects an extra memory page after
  26  * the end of the stack.
  27  * Will only add extra memory pages up to a certain number of allocations
  28  * to avoid creating too many memory maps for the process.
  29  */
  30 class GuardPageAllocator {
  31  public:
  32   GuardPageAllocator();
  33   ~GuardPageAllocator();
  34
  35   /**
  36    * @return pointer to the bottom of the allocated stack of `size' bytes.
  37    */
  38   unsigned char* allocate(size_t size);
  39
  40   /**
  41    * Deallocates the previous result of an `allocate(size)' call.
  42    */
  43   void deallocate(unsigned char* limit, size_t size);
  44
  45  private:
  46   std::unique_ptr<StackCacheEntry> stackCache_;
  47   std::allocator<unsigned char> fallbackAllocator_;
  48 };
  49
  50 }}  // folly::fibers