src/lib/eina_main.c

   1 /* EINA - EFL data type library
   2  * Copyright (C) 2008 Cedric Bail
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library;
  16  * if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <stdio.h>
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include "eina_config.h"
  26 #include "eina_private.h"
  27 #include "eina_types.h"
  28 #include "eina_main.h"
  29 #include "eina_error.h"
  30 #include "eina_log.h"
  31 #include "eina_hash.h"
  32 #include "eina_stringshare.h"
  33 #include "eina_list.h"
  34 #include "eina_matrixsparse.h"
  35 #include "eina_array.h"
  36 #include "eina_counter.h"
  37 #include "eina_benchmark.h"
  38 #include "eina_magic.h"
  39 #include "eina_rectangle.h"
  40 #include "eina_safety_checks.h"
  41
  42 /*============================================================================*
  43  *                                  Local                                     *
  44  *============================================================================*/
  45
  46 /**
  47  * @cond LOCAL
  48  */
  49
  50 static int _eina_main_count = 0;
  51 #ifdef EFL_HAVE_PTHREAD
  52 static int _eina_main_thread_count = 0;
  53 #endif
  54 static int _eina_log_dom = -1;
  55
  56 #ifdef ERR
  57 #undef ERR
  58 #endif
  59 #define ERR(...) EINA_LOG_DOM_ERR(_eina_log_dom, __VA_ARGS__)
  60
  61 #ifdef DBG
  62 #undef DBG
  63 #endif
  64 #define DBG(...) EINA_LOG_DOM_DBG(_eina_log_dom, __VA_ARGS__)
  65
  66 #ifdef EFL_HAVE_PTHREAD
  67 #include <pthread.h>
  68 static Eina_Bool _threads_activated = EINA_FALSE;
  69 static pthread_mutex_t _mutex = PTHREAD_MUTEX_INITIALIZER;
  70 #define LOCK() if(_threads_activated) pthread_mutex_lock(&_mutex);
  71 #define UNLOCK() if(_threads_activated) pthread_mutex_unlock(&_mutex);
  72 #define UNLOCK_FORCE() pthread_mutex_unlock(&_mutex);
  73 #else
  74 #define LOCK() do {} while (0)
  75 #define UNLOCK() do {} while (0)
  76 #define UNLOCK_FORCE() do {} while (0)
  77 #endif
  78
  79 /* place module init/shutdown functions here to avoid other modules
  80  * calling them by mistake.
  81  */
  82 #define S(x) extern Eina_Bool eina_##x##_init(void); extern Eina_Bool eina_##x##_shutdown(void)
  83 S(log);
  84 S(error);
  85 S(safety_checks);
  86 S(magic_string);
  87 S(iterator);
  88 S(accessor);
  89 S(array);
  90 S(module);
  91 S(mempool);
  92 S(list);
  93 S(stringshare);
  94 S(matrixsparse);
  95 S(convert);
  96 S(counter);
  97 S(benchmark);
  98 S(rectangle);
  99 #undef S
 100
 101 struct eina_desc_setup
 102 {
 103    const char *name;
 104    Eina_Bool (*init)(void);
 105    Eina_Bool (*shutdown)(void);
 106 };
 107
 108 static const struct eina_desc_setup _eina_desc_setup[] = {
 109 #define S(x) {#x, eina_##x##_init, eina_##x##_shutdown}
 110   /* log is a special case as it needs printf */
 111   S(error),
 112   S(safety_checks),
 113   S(magic_string),
 114   S(iterator),
 115   S(accessor),
 116   S(array),
 117   S(module),
 118   S(mempool),
 119   S(list),
 120   S(stringshare),
 121   S(matrixsparse),
 122   S(convert),
 123   S(counter),
 124   S(benchmark),
 125   S(rectangle)
 126 #undef S
 127 };
 128 static const size_t _eina_desc_setup_len = sizeof(_eina_desc_setup) / sizeof(_eina_desc_setup[0]);
 129
 130 static void
 131 _eina_shutdown_from_desc(const struct eina_desc_setup *itr)
 132 {
 133    for (itr--; itr >= _eina_desc_setup; itr--)
 134      {
 135         if (!itr->shutdown())
 136           ERR("Problems shutting down eina module '%s', ignored.", itr->name);
 137      }
 138
 139    eina_log_domain_unregister(_eina_log_dom);
 140    _eina_log_dom = -1;
 141    eina_log_shutdown();
 142 }
 143
 144 /**
 145  * @endcond
 146  */
 147
 148 /*============================================================================*
 149  *                                 Global                                     *
 150  *============================================================================*/
 151
 152 /*============================================================================*
 153  *                                   API                                      *
 154  *============================================================================*/
 155
 156 /**
 157  * @addtogroup Eina_Main_Group Main
 158  *
 159  * @brief These functions provide general initialisation and shut down
 160  * functions.
 161  *
 162  * @{
 163  */
 164
 165 /**
 166  * @brief Initialize the Eina library.
 167  *
 168  * @return 1 or greater on success, 0 on error.
 169  *
 170  * This function sets up all the eina modules. It returns 0 on
 171  * failure (that is, when one of the module fails to initialize),
 172  * otherwise it returns the number of times it has already been
 173  * called.
 174  *
 175  * When Eina is not used anymore, call eina_shutdown() to shut down
 176  * the Eina library.
 177  */
 178 EAPI int
 179 eina_init(void)
 180 {
 181    const struct eina_desc_setup *itr, *itr_end;
 182
 183    if (EINA_LIKELY(_eina_main_count > 0))
 184      return ++_eina_main_count;
 185
 186    if (!eina_log_init())
 187      {
 188         fprintf(stderr, "Could not initialize eina logging system.\n");
 189         return 0;
 190      }
 191    _eina_log_dom = eina_log_domain_register("eina", EINA_LOG_COLOR_DEFAULT);
 192    if (_eina_log_dom < 0)
 193      {
 194         EINA_LOG_ERR("Could not register log domain: eina");
 195         eina_log_shutdown();
 196         return 0;
 197      }
 198
 199    itr = _eina_desc_setup;
 200    itr_end = itr + _eina_desc_setup_len;
 201    for (; itr < itr_end; itr++)
 202      {
 203         if (!itr->init())
 204           {
 205              ERR("Could not initialize eina module '%s'.", itr->name);
 206              _eina_shutdown_from_desc(itr);
 207              return 0;
 208           }
 209      }
 210
 211    _eina_main_count = 1;
 212    return 1;
 213 }
 214
 215 /**
 216  * @brief Shut down the Eina library.
 217  *
 218  * @return 0 when all the modules is completely shut down, 1 or
 219  * greater otherwise.
 220  *
 221  * This function shuts down the Eina library. It returns 0 when it has
 222  * been called the same number of times than eina_init(). In that case
 223  * it shut down all the Eina modules.
 224  *
 225  * Once this function succeeds (that is, @c 0 is returned), you must
 226  * not call any of the Eina function anymore. You must call
 227  * eina_init() again to use the Eina functions again.
 228  */
 229 EAPI int
 230 eina_shutdown(void)
 231 {
 232    _eina_main_count--;
 233    if (EINA_UNLIKELY(_eina_main_count == 0))
 234      _eina_shutdown_from_desc(_eina_desc_setup + _eina_desc_setup_len);
 235    return _eina_main_count;
 236 }
 237
 238
 239 /**
 240  * @brief Initialize the mutexs of the Eina library.
 241  *
 242  * @return 1 or greater on success, 0 on error.
 243  *
 244  * This function sets up all the mutexs in all eina modules. It returns 0 on
 245  * failure (that is, when one of the module fails to initialize),
 246  * otherwise it returns the number of times it has already been
 247  * called.
 248  *
 249  * When the mutexs are not used anymore, call eina_thread_shutdown() to shut down
 250  * the mutexs.
 251  */
 252 EAPI int
 253 eina_threads_init(void)
 254 {
 255 #ifdef EFL_HAVE_PTHREAD
 256     int ret;
 257
 258     LOCK();
 259     ++_eina_main_thread_count;
 260     ret = _eina_main_thread_count;
 261
 262     if(_eina_main_thread_count > 1)
 263     {
 264         UNLOCK();
 265         return ret;
 266     }
 267
 268     eina_stringshare_threads_init();
 269     eina_log_threads_init();
 270     _threads_activated = EINA_TRUE;
 271
 272     return ret;
 273 #else
 274     return 0;
 275 #endif
 276 }
 277
 278 /**
 279  * @brief Shut down mutexs in the Eina library.
 280  *
 281  * @return 0 when all mutexs are completely shut down, 1 or
 282  * greater otherwise.
 283  *
 284  * This function shuts down the mutexs in the Eina library. It returns 0 when it has
 285  * been called the same number of times than eina_thread_init(). In that case
 286  * it shut down all the mutexs.
 287  *
 288  * Once this function succeeds (that is, @c 0 is returned), you must
 289  * not call any of the Eina function in a thread anymore. You must call
 290  * eina_thread_init() again to use the Eina functions in a thread again.
 291  */
 292 EAPI int
 293 eina_threads_shutdown(void)
 294 {
 295 #ifdef EFL_HAVE_PTHREAD
 296     int ret;
 297
 298     LOCK();
 299     ret = --_eina_main_thread_count;
 300     if(_eina_main_thread_count > 0)
 301     {
 302         UNLOCK();
 303         return ret;
 304     }
 305
 306     eina_stringshare_threads_shutdown();
 307     eina_log_threads_shutdown();
 308
 309     _threads_activated = EINA_FALSE;
 310
 311     UNLOCK_FORCE();
 312
 313     return ret;
 314 #else
 315     return 0;
 316 #endif
 317 }
 318
 319 /**
 320  * @}
 321  */