src/waffle/linux/linux_dl.c

   1 // Copyright 2012 Intel Corporation
   2 //
   3 // All rights reserved.
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are met:
   7 //
   8 // - Redistributions of source code must retain the above copyright notice, this
   9 //   list of conditions and the following disclaimer.
  10 //
  11 // - Redistributions in binary form must reproduce the above copyright notice,
  12 //   this list of conditions and the following disclaimer in the documentation
  13 //   and/or other materials provided with the distribution.
  14 //
  15 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23 // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 #include <assert.h>
  27 #include <stdbool.h>
  28 #include <stdlib.h>
  29
  30 #include <dlfcn.h>
  31
  32 #include "wcore_error.h"
  33 #include "wcore_util.h"
  34
  35 #include "linux_dl.h"
  36
  37 struct linux_dl {
  38     /// @brief For example, "libGLESv2.so.2".
  39     const char *name;
  40
  41     /// @brief The library obtained with dlopen().
  42     ///
  43     /// The library is initialized if and only if `dl != NULL`.
  44     void *dl;
  45 };
  46
  47 static const char*
  48 linux_dl_get_name(int32_t waffle_dl)
  49 {
  50     switch (waffle_dl) {
  51         case WAFFLE_DL_OPENGL:
  52 #ifdef WAFFLE_HAS_ANDROID
  53             return NULL;
  54 #else
  55             return "libGL.so.1";
  56 #endif
  57         case WAFFLE_DL_OPENGL_ES1:
  58 #ifdef WAFFLE_HAS_ANDROID
  59             return "libGLESv1_CM.so";
  60 #else
  61             return "libGLESv1_CM.so.1";
  62 #endif
  63         case WAFFLE_DL_OPENGL_ES2:
  64         case WAFFLE_DL_OPENGL_ES3:
  65             // As of 2014-04-20, Mesa statically provides the ES2 and ES3
  66             // symbols symbols in libGLESv2.so.2 and provides no ES3-only library
  67             //
  68             // Mesa did not change the library's soname when it added the ES3
  69             // symbols. The soname was and is libGLESv2.so.2 before and after
  70             // ES3.
  71 #ifdef WAFFLE_HAS_ANDROID
  72             return "libGLESv2.so";
  73 #else
  74             return "libGLESv2.so.2";
  75 #endif
  76         default:
  77             assert(false);
  78             return NULL;
  79     }
  80 }
  81
  82 struct linux_dl*
  83 linux_dl_open(int32_t waffle_dl)
  84 {
  85     struct linux_dl *self = wcore_calloc(sizeof(*self));
  86     if (self == NULL)
  87         return NULL;
  88
  89     self->name = linux_dl_get_name(waffle_dl);
  90     if (!self->name)
  91         goto error;
  92
  93     self->dl = dlopen(self->name, RTLD_LAZY);
  94     if (!self->dl) {
  95         wcore_errorf(WAFFLE_ERROR_UNKNOWN,
  96                      "dlopen(\"%s\") failed: %s", self->name, dlerror());
  97         goto error;
  98     }
  99
 100     return self;
 101
 102 error:
 103     free(self);
 104     return NULL;
 105 }
 106
 107 bool
 108 linux_dl_close(struct linux_dl *self)
 109 {
 110     int error = 0;
 111
 112     if (!self)
 113         return true;
 114
 115     if (self->dl) {
 116         error = dlclose(self->dl);
 117         if (error) {
 118             wcore_errorf(WAFFLE_ERROR_UNKNOWN,
 119                          "dlclose(libname=\"%s\") failed: %s",
 120                          self->name, dlerror());
 121         }
 122     }
 123
 124     free(self);
 125     return error == 0;
 126 }
 127
 128 void*
 129 linux_dl_sym(struct linux_dl *self, const char *symbol)
 130 {
 131     // Clear any previous error.
 132     dlerror();
 133
 134     void *sym = dlsym(self->dl, symbol);
 135
 136     const char *error = dlerror();
 137     if (error) {
 138         wcore_errorf(WAFFLE_ERROR_UNKNOWN,
 139                      "dlsym(libname=\"%s\", \"%s\") failed: %s",
 140                      self->name, symbol, error);
 141         return NULL;
 142     }
 143
 144     return sym;
 145 }