lib/object-pool.c

   1 /*
   2  * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_LOG_TAG "OBJECT-POOL"
  24 #include <babeltrace/lib-logging-internal.h>
  25
  26 #include <stdint.h>
  27 #include <babeltrace/assert-internal.h>
  28 #include <babeltrace/assert-pre-internal.h>
  29 #include <babeltrace/object-pool-internal.h>
  30
  31 int bt_object_pool_initialize(struct bt_object_pool *pool,
  32                 bt_object_pool_new_object_func new_object_func,
  33                 bt_object_pool_destroy_object_func destroy_object_func,
  34                 void *data)
  35 {
  36         int ret = 0;
  37
  38         BT_ASSERT(new_object_func);
  39         BT_ASSERT(destroy_object_func);
  40         BT_LOGD("Initializing object pool: addr=%p, data-addr=%p",
  41                 pool, data);
  42         pool->objects = g_ptr_array_new();
  43         if (!pool->objects) {
  44                 BT_LOGE_STR("Failed to allocate a GPtrArray.");
  45                 goto error;
  46         }
  47
  48         pool->funcs.new_object = new_object_func;
  49         pool->funcs.destroy_object = destroy_object_func;
  50         pool->data = data;
  51         pool->size = 0;
  52         BT_LIB_LOGD("Initialized object pool: %!+o", pool);
  53         goto end;
  54
  55 error:
  56         if (pool) {
  57                 bt_object_pool_finalize(pool);
  58         }
  59
  60         ret = -1;
  61
  62 end:
  63         return ret;
  64 }
  65
  66 void bt_object_pool_finalize(struct bt_object_pool *pool)
  67 {
  68         uint64_t i;
  69
  70         BT_ASSERT(pool);
  71         BT_LIB_LOGD("Finalizing object pool: %!+o", pool);
  72
  73         if (pool->objects) {
  74                 for (i = 0; i < pool->size; i++) {
  75                         void *obj = pool->objects->pdata[i];
  76
  77                         if (obj) {
  78                                 pool->funcs.destroy_object(obj, pool->data);
  79                         }
  80                 }
  81
  82                 g_ptr_array_free(pool->objects, TRUE);
  83                 pool->objects = NULL;
  84         }
  85 }