resource_pool_inl.h 23.1 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_RESOURCE_POOL_INL_H
#define BUTIL_RESOURCE_POOL_INL_H
gejun's avatar
gejun committed
25 26 27 28

#include <iostream>                      // std::ostream
#include <pthread.h>                     // pthread_mutex_t
#include <algorithm>                     // std::max, std::min
29 30 31 32
#include "butil/atomicops.h"              // butil::atomic
#include "butil/macros.h"                 // BAIDU_CACHELINE_ALIGNMENT
#include "butil/scoped_lock.h"            // BAIDU_SCOPED_LOCK
#include "butil/thread_local.h"           // thread_atexit
gejun's avatar
gejun committed
33 34
#include <vector>

35
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
gejun's avatar
gejun committed
36
#define BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_ADD1                \
37
    (_global_nfree.fetch_add(1, butil::memory_order_relaxed))
gejun's avatar
gejun committed
38
#define BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_SUB1                \
39
    (_global_nfree.fetch_sub(1, butil::memory_order_relaxed))
gejun's avatar
gejun committed
40 41 42 43 44
#else
#define BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_ADD1
#define BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_SUB1
#endif

45
namespace butil {
gejun's avatar
gejun committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    
template <typename T>
struct ResourceId {
    uint64_t value;

    operator uint64_t() const {
        return value;
    }

    template <typename T2>
    ResourceId<T2> cast() const {
        ResourceId<T2> id = { value };
        return id;
    }
};

template <typename T, size_t NITEM> 
struct ResourcePoolFreeChunk {
    size_t nfree;
    ResourceId<T> ids[NITEM];
};
gejun's avatar
gejun committed
67 68 69 70 71 72
// for gcc 3.4.5
template <typename T> 
struct ResourcePoolFreeChunk<T, 0> {
    size_t nfree;
    ResourceId<T> ids[0];
};
gejun's avatar
gejun committed
73 74 75 76 77 78 79 80 81

struct ResourcePoolInfo {
    size_t local_pool_num;
    size_t block_group_num;
    size_t block_num;
    size_t item_num;
    size_t block_item_num;
    size_t free_chunk_item_num;
    size_t total_size;
82
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
gejun's avatar
gejun committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    size_t free_item_num;
#endif
};

static const size_t RP_MAX_BLOCK_NGROUP = 65536;
static const size_t RP_GROUP_NBLOCK_NBIT = 16;
static const size_t RP_GROUP_NBLOCK = (1UL << RP_GROUP_NBLOCK_NBIT);
static const size_t RP_INITIAL_FREE_LIST_SIZE = 1024;

template <typename T>
class ResourcePoolBlockItemNum {
    static const size_t N1 = ResourcePoolBlockMaxSize<T>::value / sizeof(T);
    static const size_t N2 = (N1 < 1 ? 1 : N1);
public:
    static const size_t value = (N2 > ResourcePoolBlockMaxItem<T>::value ?
                                 ResourcePoolBlockMaxItem<T>::value : N2);
};


template <typename T>
class BAIDU_CACHELINE_ALIGNMENT ResourcePool {
public:
    static const size_t BLOCK_NITEM = ResourcePoolBlockItemNum<T>::value;
gejun's avatar
gejun committed
106
    static const size_t FREE_CHUNK_NITEM = BLOCK_NITEM;
gejun's avatar
gejun committed
107 108 109 110

    // Free identifiers are batched in a FreeChunk before they're added to
    // global list(_free_chunks).
    typedef ResourcePoolFreeChunk<T, FREE_CHUNK_NITEM>      FreeChunk;
gejun's avatar
gejun committed
111
    typedef ResourcePoolFreeChunk<T, 0> DynamicFreeChunk;
gejun's avatar
gejun committed
112 113 114

    // When a thread needs memory, it allocates a Block. To improve locality,
    // items in the Block are only used by the thread.
115
    // To support cache-aligned objects, align Block.items by cacheline.
gejun's avatar
gejun committed
116 117
    struct BAIDU_CACHELINE_ALIGNMENT Block {
        char items[sizeof(T) * BLOCK_NITEM];
118
        size_t nitem;
gejun's avatar
gejun committed
119 120 121 122 123 124 125 126

        Block() : nitem(0) {}
    };

    // A Resource addresses at most RP_MAX_BLOCK_NGROUP BlockGroups,
    // each BlockGroup addresses at most RP_GROUP_NBLOCK blocks. So a
    // resource addresses at most RP_MAX_BLOCK_NGROUP * RP_GROUP_NBLOCK Blocks.
    struct BlockGroup {
127 128
        butil::atomic<size_t> nblock;
        butil::atomic<Block*> blocks[RP_GROUP_NBLOCK];
gejun's avatar
gejun committed
129 130 131 132 133

        BlockGroup() : nblock(0) {
            // We fetch_add nblock in add_block() before setting the entry,
            // thus address_resource() may sees the unset entry. Initialize
            // all entries to NULL makes such address_resource() return NULL.
134
            memset(blocks, 0, sizeof(butil::atomic<Block*>) * RP_GROUP_NBLOCK);
gejun's avatar
gejun committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
        }
    };


    // Each thread has an instance of this class.
    class BAIDU_CACHELINE_ALIGNMENT LocalPool {
    public:
        explicit LocalPool(ResourcePool* pool)
            : _pool(pool)
            , _cur_block(NULL)
            , _cur_block_index(0) {
            _cur_free.nfree = 0;
        }

        ~LocalPool() {
            // Add to global _free_chunks if there're some free resources
            if (_cur_free.nfree) {
                _pool->push_free_chunk(_cur_free);
            }

            _pool->clear_from_destructor_of_local_pool();
        }

        static void delete_local_pool(void* arg) {
            delete(LocalPool*)arg;
        }

        // We need following macro to construct T with different CTOR_ARGS
        // which may include parenthesis because when T is POD, "new T()"
        // and "new T" are different: former one sets all fields to 0 which
        // we don't want.
#define BAIDU_RESOURCE_POOL_GET(CTOR_ARGS)                              \
        /* Fetch local free id */                                       \
        if (_cur_free.nfree) {                                          \
            const ResourceId<T> free_id = _cur_free.ids[--_cur_free.nfree]; \
            *id = free_id;                                              \
            BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_SUB1;                   \
            return unsafe_address_resource(free_id);                    \
        }                                                               \
        /* Fetch a FreeChunk from global.                               \
           TODO: Popping from _free needs to copy a FreeChunk which is  \
           costly, but hardly impacts amortized performance. */         \
        if (_pool->pop_free_chunk(_cur_free)) {                         \
            --_cur_free.nfree;                                          \
            const ResourceId<T> free_id =  _cur_free.ids[_cur_free.nfree]; \
            *id = free_id;                                              \
            BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_SUB1;                   \
            return unsafe_address_resource(free_id);                    \
        }                                                               \
        /* Fetch memory from local block */                             \
        if (_cur_block && _cur_block->nitem < BLOCK_NITEM) {            \
            id->value = _cur_block_index * BLOCK_NITEM + _cur_block->nitem; \
            T* p = new ((T*)_cur_block->items + _cur_block->nitem) T CTOR_ARGS; \
            if (!ResourcePoolValidator<T>::validate(p)) {               \
                p->~T();                                                \
                return NULL;                                            \
            }                                                           \
            ++_cur_block->nitem;                                        \
            return p;                                                   \
        }                                                               \
        /* Fetch a Block from global */                                 \
        _cur_block = add_block(&_cur_block_index);                      \
        if (_cur_block != NULL) {                                       \
            id->value = _cur_block_index * BLOCK_NITEM + _cur_block->nitem; \
            T* p = new ((T*)_cur_block->items + _cur_block->nitem) T CTOR_ARGS; \
            if (!ResourcePoolValidator<T>::validate(p)) {               \
                p->~T();                                                \
                return NULL;                                            \
            }                                                           \
            ++_cur_block->nitem;                                        \
            return p;                                                   \
        }                                                               \
        return NULL;                                                    \
 

        inline T* get(ResourceId<T>* id) {
            BAIDU_RESOURCE_POOL_GET();
        }

        template <typename A1>
        inline T* get(ResourceId<T>* id, const A1& a1) {
            BAIDU_RESOURCE_POOL_GET((a1));
        }

        template <typename A1, typename A2>
        inline T* get(ResourceId<T>* id, const A1& a1, const A2& a2) {
            BAIDU_RESOURCE_POOL_GET((a1, a2));
        }

#undef BAIDU_RESOURCE_POOL_GET

        inline int return_resource(ResourceId<T> id) {
            // Return to local free list
            if (_cur_free.nfree < ResourcePool::free_chunk_nitem()) {
                _cur_free.ids[_cur_free.nfree++] = id;
                BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_ADD1;
                return 0;
            }
            // Local free list is full, return it to global.
            // For copying issue, check comment in upper get()
            if (_pool->push_free_chunk(_cur_free)) {
                _cur_free.nfree = 1;
                _cur_free.ids[0] = id;
                BAIDU_RESOURCE_POOL_FREE_ITEM_NUM_ADD1;
                return 0;
            }
            return -1;
        }

    private:
        ResourcePool* _pool;
        Block* _cur_block;
        size_t _cur_block_index;
        FreeChunk _cur_free;
    };

    static inline T* unsafe_address_resource(ResourceId<T> id) {
        const size_t block_index = id.value / BLOCK_NITEM;
        return (T*)(_block_groups[(block_index >> RP_GROUP_NBLOCK_NBIT)]
254
                    .load(butil::memory_order_consume)
gejun's avatar
gejun committed
255
                    ->blocks[(block_index & (RP_GROUP_NBLOCK - 1))]
256
                    .load(butil::memory_order_consume)->items) +
gejun's avatar
gejun committed
257 258 259 260 261 262 263 264
               id.value - block_index * BLOCK_NITEM;
    }

    static inline T* address_resource(ResourceId<T> id) {
        const size_t block_index = id.value / BLOCK_NITEM;
        const size_t group_index = (block_index >> RP_GROUP_NBLOCK_NBIT);
        if (__builtin_expect(group_index < RP_MAX_BLOCK_NGROUP, 1)) {
            BlockGroup* bg =
265
                _block_groups[group_index].load(butil::memory_order_consume);
gejun's avatar
gejun committed
266 267
            if (__builtin_expect(bg != NULL, 1)) {
                Block* b = bg->blocks[block_index & (RP_GROUP_NBLOCK - 1)]
268
                           .load(butil::memory_order_consume);
gejun's avatar
gejun committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
                if (__builtin_expect(b != NULL, 1)) {
                    const size_t offset = id.value - block_index * BLOCK_NITEM;
                    if (__builtin_expect(offset < b->nitem, 1)) {
                        return (T*)b->items + offset;
                    }
                }
            }
        }

        return NULL;
    }

    inline T* get_resource(ResourceId<T>* id) {
        LocalPool* lp = get_or_new_local_pool();
        if (__builtin_expect(lp != NULL, 1)) {
            return lp->get(id);
        }
        return NULL;
    }

    template <typename A1>
    inline T* get_resource(ResourceId<T>* id, const A1& arg1) {
        LocalPool* lp = get_or_new_local_pool();
        if (__builtin_expect(lp != NULL, 1)) {
            return lp->get(id, arg1);
        }
        return NULL;
    }

    template <typename A1, typename A2>
    inline T* get_resource(ResourceId<T>* id, const A1& arg1, const A2& arg2) {
        LocalPool* lp = get_or_new_local_pool();
        if (__builtin_expect(lp != NULL, 1)) {
            return lp->get(id, arg1, arg2);
        }
        return NULL;
    }

    inline int return_resource(ResourceId<T> id) {
        LocalPool* lp = get_or_new_local_pool();
        if (__builtin_expect(lp != NULL, 1)) {
            return lp->return_resource(id);
        }
        return -1;
    }

    void clear_resources() {
        LocalPool* lp = _local_pool;
        if (lp) {
            _local_pool = NULL;
319
            butil::thread_atexit_cancel(LocalPool::delete_local_pool, lp);
gejun's avatar
gejun committed
320 321 322 323 324
            delete lp;
        }
    }

    static inline size_t free_chunk_nitem() {
gejun's avatar
gejun committed
325 326
        const size_t n = ResourcePoolFreeChunkMaxItem<T>::value();
        return n < FREE_CHUNK_NITEM ? n : FREE_CHUNK_NITEM;
gejun's avatar
gejun committed
327 328 329 330 331
    }
    
    // Number of all allocated objects, including being used and free.
    ResourcePoolInfo describe_resources() const {
        ResourcePoolInfo info;
332 333
        info.local_pool_num = _nlocal.load(butil::memory_order_relaxed);
        info.block_group_num = _ngroup.load(butil::memory_order_acquire);
gejun's avatar
gejun committed
334 335 336 337
        info.block_num = 0;
        info.item_num = 0;
        info.free_chunk_item_num = free_chunk_nitem();
        info.block_item_num = BLOCK_NITEM;
338
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
339
        info.free_item_num = _global_nfree.load(butil::memory_order_relaxed);
gejun's avatar
gejun committed
340 341 342
#endif

        for (size_t i = 0; i < info.block_group_num; ++i) {
343
            BlockGroup* bg = _block_groups[i].load(butil::memory_order_consume);
gejun's avatar
gejun committed
344 345 346
            if (NULL == bg) {
                break;
            }
347
            size_t nblock = std::min(bg->nblock.load(butil::memory_order_relaxed),
gejun's avatar
gejun committed
348 349 350
                                     RP_GROUP_NBLOCK);
            info.block_num += nblock;
            for (size_t j = 0; j < nblock; ++j) {
351
                Block* b = bg->blocks[j].load(butil::memory_order_consume);
gejun's avatar
gejun committed
352 353 354 355 356 357 358 359 360 361
                if (NULL != b) {
                    info.item_num += b->nitem;
                }
            }
        }
        info.total_size = info.block_num * info.block_item_num * sizeof(T);
        return info;
    }

    static inline ResourcePool* singleton() {
362
        ResourcePool* p = _singleton.load(butil::memory_order_consume);
gejun's avatar
gejun committed
363 364 365 366
        if (p) {
            return p;
        }
        pthread_mutex_lock(&_singleton_mutex);
367
        p = _singleton.load(butil::memory_order_consume);
gejun's avatar
gejun committed
368 369
        if (!p) {
            p = new ResourcePool();
370
            _singleton.store(p, butil::memory_order_release);
gejun's avatar
gejun committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
        } 
        pthread_mutex_unlock(&_singleton_mutex);
        return p;
    }

private:
    ResourcePool() {
        _free_chunks.reserve(RP_INITIAL_FREE_LIST_SIZE);
        pthread_mutex_init(&_free_chunks_mutex, NULL);
    }

    ~ResourcePool() {
        pthread_mutex_destroy(&_free_chunks_mutex);
    }

    // Create a Block and append it to right-most BlockGroup.
    static Block* add_block(size_t* index) {
        Block* const new_block = new(std::nothrow) Block;
        if (NULL == new_block) {
            return NULL;
        }

        size_t ngroup;
        do {
395
            ngroup = _ngroup.load(butil::memory_order_acquire);
gejun's avatar
gejun committed
396 397
            if (ngroup >= 1) {
                BlockGroup* const g =
398
                    _block_groups[ngroup - 1].load(butil::memory_order_consume);
gejun's avatar
gejun committed
399
                const size_t block_index =
400
                    g->nblock.fetch_add(1, butil::memory_order_relaxed);
gejun's avatar
gejun committed
401 402
                if (block_index < RP_GROUP_NBLOCK) {
                    g->blocks[block_index].store(
403
                        new_block, butil::memory_order_release);
gejun's avatar
gejun committed
404 405 406
                    *index = (ngroup - 1) * RP_GROUP_NBLOCK + block_index;
                    return new_block;
                }
407
                g->nblock.fetch_sub(1, butil::memory_order_relaxed);
gejun's avatar
gejun committed
408 409 410 411 412 413 414 415 416 417 418 419 420
            }
        } while (add_block_group(ngroup));

        // Fail to add_block_group.
        delete new_block;
        return NULL;
    }

    // Create a BlockGroup and append it to _block_groups.
    // Shall be called infrequently because a BlockGroup is pretty big.
    static bool add_block_group(size_t old_ngroup) {
        BlockGroup* bg = NULL;
        BAIDU_SCOPED_LOCK(_block_group_mutex);
421
        const size_t ngroup = _ngroup.load(butil::memory_order_acquire);
gejun's avatar
gejun committed
422 423 424 425 426 427 428 429 430 431
        if (ngroup != old_ngroup) {
            // Other thread got lock and added group before this thread.
            return true;
        }
        if (ngroup < RP_MAX_BLOCK_NGROUP) {
            bg = new(std::nothrow) BlockGroup;
            if (NULL != bg) {
                // Release fence is paired with consume fence in address() and
                // add_block() to avoid un-constructed bg to be seen by other
                // threads.
432 433
                _block_groups[ngroup].store(bg, butil::memory_order_release);
                _ngroup.store(ngroup + 1, butil::memory_order_release);
gejun's avatar
gejun committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
            }
        }
        return bg != NULL;
    }

    inline LocalPool* get_or_new_local_pool() {
        LocalPool* lp = _local_pool;
        if (lp != NULL) {
            return lp;
        }
        lp = new(std::nothrow) LocalPool(this);
        if (NULL == lp) {
            return NULL;
        }
        BAIDU_SCOPED_LOCK(_change_thread_mutex); //avoid race with clear()
        _local_pool = lp;
450 451
        butil::thread_atexit(LocalPool::delete_local_pool, lp);
        _nlocal.fetch_add(1, butil::memory_order_relaxed);
gejun's avatar
gejun committed
452 453 454 455 456 457 458
        return lp;
    }

    void clear_from_destructor_of_local_pool() {
        // Remove tls
        _local_pool = NULL;

459
        if (_nlocal.fetch_sub(1, butil::memory_order_relaxed) != 1) {
gejun's avatar
gejun committed
460 461 462 463 464 465 466 467 468 469 470
            return;
        }

        // Can't delete global even if all threads(called ResourcePool
        // functions) quit because the memory may still be referenced by 
        // other threads. But we need to validate that all memory can
        // be deallocated correctly in tests, so wrap the function with 
        // a macro which is only defined in unittests.
#ifdef BAIDU_CLEAR_RESOURCE_POOL_AFTER_ALL_THREADS_QUIT
        BAIDU_SCOPED_LOCK(_change_thread_mutex);  // including acquire fence.
        // Do nothing if there're active threads.
471
        if (_nlocal.load(butil::memory_order_relaxed) != 0) {
gejun's avatar
gejun committed
472 473 474 475 476 477 478 479 480 481
            return;
        }
        // All threads exited and we're holding _change_thread_mutex to avoid
        // racing with new threads calling get_resource().

        // Clear global free list.
        FreeChunk dummy;
        while (pop_free_chunk(dummy));

        // Delete all memory
482
        const size_t ngroup = _ngroup.exchange(0, butil::memory_order_relaxed);
gejun's avatar
gejun committed
483
        for (size_t i = 0; i < ngroup; ++i) {
484
            BlockGroup* bg = _block_groups[i].load(butil::memory_order_relaxed);
gejun's avatar
gejun committed
485 486 487
            if (NULL == bg) {
                break;
            }
488
            size_t nblock = std::min(bg->nblock.load(butil::memory_order_relaxed),
gejun's avatar
gejun committed
489 490
                                     RP_GROUP_NBLOCK);
            for (size_t j = 0; j < nblock; ++j) {
491
                Block* b = bg->blocks[j].load(butil::memory_order_relaxed);
gejun's avatar
gejun committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
                if (NULL == b) {
                    continue;
                }
                for (size_t k = 0; k < b->nitem; ++k) {
                    T* const objs = (T*)b->items;
                    objs[k].~T();
                }
                delete b;
            }
            delete bg;
        }

        memset(_block_groups, 0, sizeof(BlockGroup*) * RP_MAX_BLOCK_NGROUP);
#endif
    }

private:
    bool pop_free_chunk(FreeChunk& c) {
gejun's avatar
gejun committed
510 511
        // Critical for the case that most return_object are called in
        // different threads of get_object.
gejun's avatar
gejun committed
512 513 514 515 516 517 518 519
        if (_free_chunks.empty()) {
            return false;
        }
        pthread_mutex_lock(&_free_chunks_mutex);
        if (_free_chunks.empty()) {
            pthread_mutex_unlock(&_free_chunks_mutex);
            return false;
        }
gejun's avatar
gejun committed
520
        DynamicFreeChunk* p = _free_chunks.back();
gejun's avatar
gejun committed
521 522
        _free_chunks.pop_back();
        pthread_mutex_unlock(&_free_chunks_mutex);
gejun's avatar
gejun committed
523 524 525
        c.nfree = p->nfree;
        memcpy(c.ids, p->ids, sizeof(*p->ids) * p->nfree);
        free(p);
gejun's avatar
gejun committed
526 527 528 529
        return true;
    }

    bool push_free_chunk(const FreeChunk& c) {
gejun's avatar
gejun committed
530 531 532
        DynamicFreeChunk* p = (DynamicFreeChunk*)malloc(
            offsetof(DynamicFreeChunk, ids) + sizeof(*c.ids) * c.nfree);
        if (!p) {
gejun's avatar
gejun committed
533 534
            return false;
        }
gejun's avatar
gejun committed
535 536
        p->nfree = c.nfree;
        memcpy(p->ids, c.ids, sizeof(*c.ids) * c.nfree);
gejun's avatar
gejun committed
537
        pthread_mutex_lock(&_free_chunks_mutex);
gejun's avatar
gejun committed
538
        _free_chunks.push_back(p);
gejun's avatar
gejun committed
539 540 541 542
        pthread_mutex_unlock(&_free_chunks_mutex);
        return true;
    }
    
543
    static butil::static_atomic<ResourcePool*> _singleton;
gejun's avatar
gejun committed
544 545
    static pthread_mutex_t _singleton_mutex;
    static BAIDU_THREAD_LOCAL LocalPool* _local_pool;
546 547
    static butil::static_atomic<long> _nlocal;
    static butil::static_atomic<size_t> _ngroup;
gejun's avatar
gejun committed
548 549
    static pthread_mutex_t _block_group_mutex;
    static pthread_mutex_t _change_thread_mutex;
550
    static butil::static_atomic<BlockGroup*> _block_groups[RP_MAX_BLOCK_NGROUP];
gejun's avatar
gejun committed
551

gejun's avatar
gejun committed
552
    std::vector<DynamicFreeChunk*> _free_chunks;
gejun's avatar
gejun committed
553 554
    pthread_mutex_t _free_chunks_mutex;

555
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
556
    static butil::static_atomic<size_t> _global_nfree;
gejun's avatar
gejun committed
557 558 559 560 561 562 563 564 565 566 567 568 569
#endif
};

// Declare template static variables:

template <typename T>
const size_t ResourcePool<T>::FREE_CHUNK_NITEM;

template <typename T>
BAIDU_THREAD_LOCAL typename ResourcePool<T>::LocalPool*
ResourcePool<T>::_local_pool = NULL;

template <typename T>
570
butil::static_atomic<ResourcePool<T>*> ResourcePool<T>::_singleton =
571
    BUTIL_STATIC_ATOMIC_INIT(NULL);
gejun's avatar
gejun committed
572 573 574 575 576

template <typename T>
pthread_mutex_t ResourcePool<T>::_singleton_mutex = PTHREAD_MUTEX_INITIALIZER;

template <typename T>
577
butil::static_atomic<long> ResourcePool<T>::_nlocal = BUTIL_STATIC_ATOMIC_INIT(0);
gejun's avatar
gejun committed
578 579

template <typename T>
580
butil::static_atomic<size_t> ResourcePool<T>::_ngroup = BUTIL_STATIC_ATOMIC_INIT(0);
gejun's avatar
gejun committed
581 582 583 584 585 586 587 588 589

template <typename T>
pthread_mutex_t ResourcePool<T>::_block_group_mutex = PTHREAD_MUTEX_INITIALIZER;

template <typename T>
pthread_mutex_t ResourcePool<T>::_change_thread_mutex =
    PTHREAD_MUTEX_INITIALIZER;

template <typename T>
590
butil::static_atomic<typename ResourcePool<T>::BlockGroup*>
gejun's avatar
gejun committed
591 592
ResourcePool<T>::_block_groups[RP_MAX_BLOCK_NGROUP] = {};

593
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
gejun's avatar
gejun committed
594
template <typename T>
595
butil::static_atomic<size_t> ResourcePool<T>::_global_nfree = BUTIL_STATIC_ATOMIC_INIT(0);
gejun's avatar
gejun committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
#endif

template <typename T>
inline bool operator==(ResourceId<T> id1, ResourceId<T> id2) {
    return id1.value == id2.value;
}

template <typename T>
inline bool operator!=(ResourceId<T> id1, ResourceId<T> id2) {
    return id1.value != id2.value;
}

// Disable comparisons between different typed ResourceId
template <typename T1, typename T2>
bool operator==(ResourceId<T1> id1, ResourceId<T2> id2);

template <typename T1, typename T2>
bool operator!=(ResourceId<T1> id1, ResourceId<T2> id2);

inline std::ostream& operator<<(std::ostream& os,
                                ResourcePoolInfo const& info) {
    return os << "local_pool_num: " << info.local_pool_num
              << "\nblock_group_num: " << info.block_group_num
              << "\nblock_num: " << info.block_num
              << "\nitem_num: " << info.item_num
              << "\nblock_item_num: " << info.block_item_num
              << "\nfree_chunk_item_num: " << info.free_chunk_item_num
              << "\ntotal_size: " << info.total_size;
624
#ifdef BUTIL_RESOURCE_POOL_NEED_FREE_ITEM_NUM
gejun's avatar
gejun committed
625 626 627 628 629
              << "\nfree_num: " << info.free_item_num
#endif
           ;
}

630
}  // namespace butil
gejun's avatar
gejun committed
631

632
#endif  // BUTIL_RESOURCE_POOL_INL_H