91dc3023c2a2ee4f793470edad80fb01366bf206
[folly.git] / folly / fibers / GuardPageAllocator.h
1 /*
2  * Copyright 2017 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 {
21 namespace fibers {
22
23 class StackCacheEntry;
24
25 /**
26  * Stack allocator that protects an extra memory page after
27  * the end of the stack.
28  * Will only add extra memory pages up to a certain number of allocations
29  * to avoid creating too many memory maps for the process.
30  */
31 class GuardPageAllocator {
32  public:
33   /**
34    * @param useGuardPages if true, protect limited amount of stacks with guard
35    *                      pages, otherwise acts as std::allocator.
36    */
37   explicit GuardPageAllocator(bool useGuardPages);
38   ~GuardPageAllocator();
39
40   /**
41    * @return pointer to the bottom of the allocated stack of `size' bytes.
42    */
43   unsigned char* allocate(size_t size);
44
45   /**
46    * Deallocates the previous result of an `allocate(size)' call.
47    */
48   void deallocate(unsigned char* limit, size_t size);
49
50  private:
51   std::unique_ptr<StackCacheEntry> stackCache_;
52   std::allocator<unsigned char> fallbackAllocator_;
53   bool useGuardPages_{true};
54 };
55 }
56 } // folly::fibers