aboutsummaryrefslogtreecommitdiff
path: root/plugin/src/plugin.c
blob: e2aae1ff1c4db64ae6386dd9bb10193fb003745b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
#include "plugin.h"

#include "cstring.h"
#include "list.h"
#include "log/log.h" // TODO: Use the error library instead. Move it to clib.

#include <assert.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>

#include <errno.h>
#include <linux/limits.h>
#include <poll.h>
#include <sys/inotify.h>
#include <unistd.h>

// Watching for IN_CREATE leads the plugin engine to try to reload a plugin's
// shared library before the compiler has fully written to it.
static const int WATCH_MASK = IN_CLOSE_WRITE;

/// Plugin state.
///
/// Each Plugin object points to a shared library and holds a state object.
///
/// The same shared library can be loaded multiple times, resulting in multiple
/// Plugin instances, each with its own internal state.
typedef struct Plugin {
  void* handle;      // First member so that Plugin can be cast to handle.
  void* state;       // Plugin's internal state.
  bool  reloaded;    // Whether the plugin has been reloaded, state needs to be
                     // re-created.
  PluginEngine* eng; // So that the public API can do stuff with just a Plugin*.
  mstring       filename;
} Plugin;

DEF_LIST(Plugin, Plugin);

/// Plugin engine.
typedef struct PluginEngine {
  int         inotify_instance;
  int         dir_watch; // inotify watch on the plugins directory.
  Plugin_list plugins;
  mstring     plugins_dir;
} PluginEngine;

// -----------------------------------------------------------------------------
// Plugin.
// -----------------------------------------------------------------------------

static mstring plugin_lib_name(const Plugin* plugin) {
  return mstring_concat(
      mstring_make("lib"), mstring_concat_cstr(plugin->filename, ".so"));
}

static mstring plugin_lib_path(const Plugin* plugin) {
  return mstring_concat(plugin->eng->plugins_dir, plugin_lib_name(plugin));
}

static bool load_library(Plugin* plugin) {
  assert(plugin);
  assert(plugin->eng);

  // Handle reloading a previously-loaded library.
  if (plugin->handle) {
    dlclose(plugin->handle);
    plugin->handle = 0;
  }

  const mstring lib = plugin_lib_path(plugin);

  // If the plugin fails to load, make sure to keep the plugin's old handle to
  // handle the error gracefully. This handles reload failures, specifically.
  void* handle = 0;
  if ((handle = dlopen(mstring_cstr(&lib), RTLD_NOW))) {
    LOGD("Plugin [%s] loaded successfully", mstring_cstr(&plugin->filename));
    plugin->handle = handle;
    return true;
  } else {
    LOGE("dlopen() failed: %s", dlerror());
  }

  return false;
}

static void delete_plugin_state(Plugin* plugin) {
  if (plugin->state) {
    free(plugin->state);
    plugin->state = 0;
  }
}

void set_plugin_state(Plugin* plugin, void* state) {
  assert(plugin);
  delete_plugin_state(plugin);
  plugin->state = state;
}

void* get_plugin_state(Plugin* plugin) {
  assert(plugin);
  return plugin->state;
}

static void destroy_plugin(Plugin* plugin) {
  if (plugin) {
    if (plugin->handle) {
      dlclose(plugin->handle);
      plugin->handle = 0;
    }
    delete_plugin_state(plugin);
  }
}

Plugin* load_plugin(PluginEngine* eng, const char* filename) {
  assert(eng);
  assert(filename);

  Plugin plugin = (Plugin){.eng = eng, .filename = mstring_make(filename)};

  if (!load_library(&plugin)) {
    return 0;
  }

  list_add(eng->plugins, plugin);
  return &eng->plugins.head->val;
}

void delete_plugin(Plugin** pPlugin) {
  assert(pPlugin);
  Plugin* plugin = *pPlugin;
  if (plugin) {
    assert(plugin->eng);
    destroy_plugin(plugin);
    list_remove_ptr(plugin->eng->plugins, plugin);
    *pPlugin = 0;
  }
}

bool plugin_reloaded(Plugin* plugin) {
  assert(plugin);
  const bool reloaded = plugin->reloaded;
  plugin->reloaded    = false;
  return reloaded;
}

// -----------------------------------------------------------------------------
// Plugin Engine.
// -----------------------------------------------------------------------------

PluginEngine* new_plugin_engine(const PluginEngineDesc* desc) {
  PluginEngine* eng = 0;

  if (!(eng = calloc(1, sizeof(PluginEngine)))) {
    goto cleanup;
  }
  eng->plugins     = make_list(Plugin);
  eng->plugins_dir = mstring_concat_cstr(mstring_make(desc->plugins_dir), "/");

  LOGD("Watch plugins directory: %s", mstring_cstr(&eng->plugins_dir));

  if ((eng->inotify_instance = inotify_init()) == -1) {
    LOGE("Failed to create inotify instance");
    goto cleanup;
  }
  if ((eng->dir_watch = inotify_add_watch(
           eng->inotify_instance, mstring_cstr(&eng->plugins_dir),
           WATCH_MASK)) == -1) {
    LOGE("Failed to watch directory: %s", mstring_cstr(&eng->plugins_dir));
    goto cleanup;
  }

  return eng;

cleanup:
  delete_plugin_engine(&eng);
  return 0;
}

void delete_plugin_engine(PluginEngine** pEng) {
  assert(pEng);
  PluginEngine* eng = *pEng;
  if (eng) {
    list_foreach_mut(eng->plugins, plugin, { destroy_plugin(&plugin); });
    del_list(eng->plugins);
    if (eng->dir_watch != -1) {
      inotify_rm_watch(eng->dir_watch, eng->inotify_instance);
      close(eng->dir_watch);
      eng->dir_watch = 0;
    }
    if (eng->inotify_instance != -1) {
      close(eng->inotify_instance);
    }
    free(eng);
    *pEng = 0;
  }
}

void plugin_engine_update(PluginEngine* eng) {
  assert(eng);

  struct pollfd pollfds[1] = {
      {eng->inotify_instance, POLLIN, 0}
  };

  int ret = 0;
  while ((ret = poll(pollfds, 1, 0)) != 0) {
    if (ret > 0) {
      const struct pollfd* pfd = &pollfds[0];
      if (pfd->revents & POLLIN) {
        // inotify instances don't like to be partially read, and the events,
        // when watching a directory, have a variable-length file name.
        uint8_t buf[sizeof(struct inotify_event) + NAME_MAX + 1] = {0};
        ssize_t length = read(eng->inotify_instance, &buf, sizeof(buf));
        if (length == -1) {
          LOGE(
              "read() on inotify instance failed with error [%d]: %s", errno,
              strerror(errno));
          break;
        }
        const uint8_t* next = buf;
        const uint8_t* end  = buf + sizeof(buf);
        while (next < end) {
          const struct inotify_event* event = (const struct inotify_event*)next;
          if (event->mask & WATCH_MASK) {
            if (event->wd == eng->dir_watch) {
              if (event->len > 0) {
                // Name does not include directory, e.g., libfoo.so
                const mstring file = mstring_make(event->name);
                list_foreach_mut(eng->plugins, plugin, {
                  if (mstring_eq(file, plugin_lib_name(&plugin))) {
                    if (load_library(&plugin)) {
                      plugin.reloaded = true;
                    }
                    break;
                  }
                });
              }
            }
          }
          next += sizeof(struct inotify_event) + event->len;
        }
      }
      if ((pfd->revents & POLLERR) || (pfd->revents & POLLHUP) ||
          (pfd->revents & POLLNVAL)) {
        LOGE("inotify instance is in a bad state");
        break;
      }
    } else if (ret == -1) {
      LOGE("poll() failed with error [%d]: %s", errno, strerror(errno));
      break;
    }
  }
}