lib/ecoli_init.h

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * Register initialization routines.
  30  */
  31
  32 #ifndef ECOLI_INIT_
  33 #define ECOLI_INIT_
  34
  35 #include <sys/queue.h>
  36
  37 #include <ecoli_log.h>
  38 #include <ecoli_node.h>
  39
  40 #define EC_INIT_REGISTER(t)                                             \
  41         static void ec_init_init_##t(void);                             \
  42         static void __attribute__((constructor, used))                  \
  43         ec_init_init_##t(void)                                          \
  44         {                                                               \
  45                  ec_init_register(&t);                                  \
  46         }
  47
  48 /**
  49  * Type of init function. Return 0 on success, -1 on error.
  50  */
  51 typedef int (ec_init_t)(void);
  52
  53 TAILQ_HEAD(ec_init_list, ec_init);
  54
  55 /**
  56  * A structure describing a test case.
  57  */
  58 struct ec_init {
  59         TAILQ_ENTRY(ec_init) next;  /**< Next in list. */
  60         ec_init_t *init;            /**< Init function. */
  61         unsigned int priority;      /**< Priority (0=first, 99=last) */
  62 };
  63
  64 /**
  65  * Register an initialization function.
  66  *
  67  * @param init
  68  *   A pointer to a ec_init structure to be registered.
  69  */
  70 void ec_init_register(struct ec_init *test);
  71
  72 /**
  73  * Initialize ecoli library
  74  *
  75  * Must be called before any other function from libecoli, except
  76  * ec_malloc_register().
  77  *
  78  * @return
  79  *   0 on success, -1 on error (errno is set).
  80  */
  81 int ec_init(void);
  82
  83 #endif