src/dso_utils.h

   1 /*
   2  * Copyright (C) 2012 Intel Corporation. All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial portions
  14  * of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  19  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #ifndef DSO_UTILS_H
  26 #define DSO_UTILS_H
  27
  28 #include <stdbool.h>
  29
  30 /** Generic pointer to function. */
  31 typedef void (*dso_generic_func)(void);
  32
  33 /** Library handle (opaque). */
  34 struct dso_handle;
  35
  36 /** Symbol lookup table. */
  37 struct dso_symbol {
  38     /** Symbol name */
  39     const char  *name;
  40     /** Offset into the supplied vtable where symbol is to be loaded. */
  41     unsigned int offset;
  42 };
  43
  44 /**
  45  * Opens the named shared library.
  46  *
  47  * @param[in]  path  the library name, or NULL to lookup into loaded libraries
  48  * @return the newly allocated library handle
  49  */
  50 struct dso_handle *
  51 dso_open(const char *path);
  52
  53 /** Closes and disposed any allocated data. */
  54 void
  55 dso_close(struct dso_handle *h);
  56
  57 /**
  58  * Loads symbols into the supplied vtable.
  59  *
  60  * @param[in]  handle           the DSO handle
  61  * @param[in]  vtable           the function table to fill in
  62  * @param[in]  vtable_length    the size (in bytes) of the function table
  63  * @param[in]  symbols          the NULL terminated array of symbols to lookup
  64  * @return true on success, false otherwise
  65  **/
  66 bool
  67 dso_get_symbols(
  68     struct dso_handle          *h,
  69     void                       *vtable,
  70     unsigned int                vtable_length,
  71     const struct dso_symbol    *symbols
  72 );
  73
  74 #endif /* DSO_UTILS_H */