object_pool.h 4.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

gejun's avatar
gejun committed
18 19 20 21 22
// bthread - A M:N threading library to make applications more concurrent.

// Author: Ge,Jun (gejun@baidu.com)
// Date: Sun Jul 13 15:04:18 CST 2014

23 24
#ifndef BUTIL_OBJECT_POOL_H
#define BUTIL_OBJECT_POOL_H
gejun's avatar
gejun committed
25 26 27

#include <cstddef>                       // size_t

gejun's avatar
gejun committed
28 29
// ObjectPool is a derivative class of ResourcePool to allocate and
// reuse fixed-size objects without identifiers.
gejun's avatar
gejun committed
30

31
namespace butil {
gejun's avatar
gejun committed
32 33

// Specialize following classes to override default parameters for type T.
34
//   namespace butil {
gejun's avatar
gejun committed
35
//     template <> struct ObjectPoolBlockMaxSize<Foo> {
gejun's avatar
gejun committed
36
//       static const size_t value = 1024;
gejun's avatar
gejun committed
37 38
//     };
//   }
gejun's avatar
gejun committed
39

gejun's avatar
gejun committed
40 41 42
// Memory is allocated in blocks, memory size of a block will not exceed:
//   min(ObjectPoolBlockMaxSize<T>::value,
//       ObjectPoolBlockMaxItem<T>::value * sizeof(T))
gejun's avatar
gejun committed
43
template <typename T> struct ObjectPoolBlockMaxSize {
gejun's avatar
gejun committed
44
    static const size_t value = 64 * 1024; // bytes
gejun's avatar
gejun committed
45 46
};
template <typename T> struct ObjectPoolBlockMaxItem {
gejun's avatar
gejun committed
47
    static const size_t value = 256;
gejun's avatar
gejun committed
48 49
};

gejun's avatar
gejun committed
50 51 52 53 54
// Free objects of each thread are grouped into a chunk before they are merged
// to the global list. Memory size of objects in one free chunk will not exceed:
//   min(ObjectPoolFreeChunkMaxItem<T>::value(),
//       ObjectPoolBlockMaxSize<T>::value,
//       ObjectPoolBlockMaxItem<T>::value * sizeof(T))
gejun's avatar
gejun committed
55
template <typename T> struct ObjectPoolFreeChunkMaxItem {
gejun's avatar
gejun committed
56
    static size_t value() { return 256; }
gejun's avatar
gejun committed
57 58 59 60 61 62 63 64 65 66
};

// ObjectPool calls this function on newly constructed objects. If this
// function returns false, the object is destructed immediately and
// get_object() shall return NULL. This is useful when the constructor
// failed internally(namely ENOMEM).
template <typename T> struct ObjectPoolValidator {
    static bool validate(const T*) { return true; }
};

67
}  // namespace butil
gejun's avatar
gejun committed
68

69
#include "butil/object_pool_inl.h"
gejun's avatar
gejun committed
70

71
namespace butil {
gejun's avatar
gejun committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113

// Get an object typed |T|. The object should be cleared before usage.
// NOTE: T must be default-constructible.
template <typename T> inline T* get_object() {
    return ObjectPool<T>::singleton()->get_object();
}

// Get an object whose constructor is T(arg1)
template <typename T, typename A1>
inline T* get_object(const A1& arg1) {
    return ObjectPool<T>::singleton()->get_object(arg1);
}

// Get an object whose constructor is T(arg1, arg2)
template <typename T, typename A1, typename A2>
inline T* get_object(const A1& arg1, const A2& arg2) {
    return ObjectPool<T>::singleton()->get_object(arg1, arg2);
}

// Return the object |ptr| back. The object is NOT destructed and will be
// returned by later get_object<T>. Similar with free/delete, validity of
// the object is not checked, user shall not return a not-yet-allocated or
// already-returned object otherwise behavior is undefined.
// Returns 0 when successful, -1 otherwise.
template <typename T> inline int return_object(T* ptr) {
    return ObjectPool<T>::singleton()->return_object(ptr);
}

// Reclaim all allocated objects typed T if caller is the last thread called
// this function, otherwise do nothing. You rarely need to call this function
// manually because it's called automatically when each thread quits.
template <typename T> inline void clear_objects() {
    ObjectPool<T>::singleton()->clear_objects();
}

// Get description of objects typed T.
// This function is possibly slow because it iterates internal structures.
// Don't use it frequently like a "getter" function.
template <typename T> ObjectPoolInfo describe_objects() {
    return ObjectPool<T>::singleton()->describe_objects();
}

114
}  // namespace butil
gejun's avatar
gejun committed
115

116
#endif  // BUTIL_OBJECT_POOL_H