lua plugin: Implement write callbacks.
[collectd.git] / src / lua.c
index b79e0b1..8e1534e 100644 (file)
--- a/src/lua.c
+++ b/src/lua.c
  *   Florian Forster <octo at collectd.org>
  **/
 
+/* <lua5.1/luaconf.h> defines a macro using "sprintf". Although not used here,
+ * GCC will complain about the macro definition. */
+#define DONT_POISON_SPRINTF_YET
+
 #include "collectd.h"
 #include "plugin.h"
 #include "common.h"
 #include <lua.h>
 #include <lauxlib.h>
 #include <lualib.h>
+#include "utils_lua.h"
+
+#include <pthread.h>
 
-typedef struct lua_script_s {
+#if defined(COLLECT_DEBUG) && COLLECT_DEBUG && defined(__GNUC__) && __GNUC__
+# undef sprintf
+# pragma GCC poison sprintf
+#endif
+
+struct lua_script_s;
+typedef struct lua_script_s lua_script_t;
+struct lua_script_s
+{
   char          *script_path;
   lua_State     *lua_state;
   
-  struct lua_script_s  *next;
-} lua_script_t;
+  lua_script_t  *next;
+};
 
-struct clua_read_function_s
+struct clua_callback_data_s
 {
   lua_State *lua_state;
   char *lua_function_name;
+  pthread_mutex_t lock;
+  int callback_id;
 };
-typedef struct clua_read_function_s clua_read_function_t;
+typedef struct clua_callback_data_s clua_callback_data_t;
 
 struct lua_c_functions_s
 {
@@ -57,42 +74,162 @@ typedef struct lua_c_functions_s lua_c_functions_t;
 static char           base_path[PATH_MAX + 1] = "";
 static lua_script_t  *scripts = NULL;
 
+static int clua_store_callback (lua_State *l, int idx) /* {{{ */
+{
+  static int callback_num = 0;
+  int callback_id;
+
+  /* XXX FIXME: Not thread-safe! */
+  callback_id = callback_num++;
+
+  if (idx < 0)
+    idx += lua_gettop (l) + 1;
+
+  lua_getfield (l, LUA_REGISTRYINDEX, "collectd_callbacks"); /* +1 = 1 */
+  if (!lua_istable (l, /* idx = */ -1))
+  {
+    lua_pop (l, /* nelems = */ 1); /* -1 = 0 */
+    lua_newtable (l); /* +1 = 1 */
+    lua_pushvalue (l, -1); /* +1 = 2 */
+    lua_setfield (l, LUA_REGISTRYINDEX, "collectd_callbacks"); /* -1 = 1 */
+  }
+
+  /* The table is now on top of the stack */
+  lua_pushinteger (l, (lua_Integer) callback_id); /* +1 = 2 */
+
+  /* Copy the function pointer */
+  lua_pushvalue (l, idx); /* +1 = 3 */
+  /* Lookup function if it's a string */
+  if (lua_isstring (l, /* idx = */ -1))
+    lua_gettable (l, LUA_GLOBALSINDEX); /* +-0 = 3 */
+
+  if (!lua_isfunction (l, /* idx = */ -1))
+  {
+    lua_pop (l, /* nelems = */ 3); /* -3 = 0 */
+    return (-1);
+  }
+
+  lua_settable (l, /* idx = */ -3); /* -2 = 1 */
+  lua_pop (l, /* nelems = */ 1); /* -1 = 0 */
+  return (callback_id);
+} /* }}} int clua_store_callback */
+
+static int clua_load_callback (lua_State *l, int callback_id) /* {{{ */
+{
+  lua_getfield (l, LUA_REGISTRYINDEX, "collectd_callbacks"); /* +1 */
+  if (!lua_istable (l, /* idx = */ -1))
+  {
+    lua_pop (l, /* nelems = */ 1); /* -1 */
+    return (-1);
+  }
+
+  lua_pushinteger (l, (lua_Integer) callback_id); /* + 1 */
+  lua_gettable (l, /* idx = */ -2); /* +-0 */
+
+  if (!lua_isfunction (l, -1))
+  {
+    lua_pop (l, /* nelems = */ 2); /* -2 */
+    return (-1);
+  }
+
+  /* Remove table */
+  lua_remove (l, /* idx = */ -2); /* -1 */
+  return (0);
+} /* }}} int clua_load_callback */
+
 static int clua_read (user_data_t *ud) /* {{{ */
 {
-  clua_read_function_t *rf = ud->data;
+  clua_callback_data_t *cb = ud->data;
   int status;
 
-  /* Load the function to the stack */
-  lua_pushstring (rf->lua_state, rf->lua_function_name);
-  lua_gettable (rf->lua_state, LUA_REGISTRYINDEX);
-
-  if (!lua_isfunction (rf->lua_state, /* stack pos = */ -1))
+  status = clua_load_callback (cb->lua_state, cb->callback_id);
+  if (status != 0)
   {
-    ERROR ("lua plugin: Unable to lookup the read function \"%s\".",
-        rf->lua_function_name);
-    /* pop the value again */
-    lua_settop (rf->lua_state, -2);
+    ERROR ("lua plugin: Unable to load callback \"%s\" (id %i).",
+        cb->lua_function_name, cb->callback_id);
     return (-1);
   }
+  /* +1 */
 
-  lua_call (rf->lua_state, /* nargs = */ 0, /* nresults = */ 1);
+  lua_call (cb->lua_state, /* nargs = */ 0, /* nresults = */ 1); /* +1 */
 
-  if (lua_isnumber (rf->lua_state, -1))
+  if (lua_isnumber (cb->lua_state, /* idx = */ -1))
   {
-    status = (int) lua_tonumber (rf->lua_state, -1);
+    status = (int) lua_tointeger (cb->lua_state, /* idx = */ -1);
   }
   else
   {
-    ERROR ("lua plugin: Read function \"%s\" did not return a numeric status.",
-        rf->lua_function_name);
+    ERROR ("lua plugin: Read function \"%s\" (id %i) did not return a numeric status.",
+        cb->lua_function_name, cb->callback_id);
     status = -1;
   }
-  /* pop the value */
-  lua_settop (rf->lua_state, -2);
+  /* pop return value and function */
+  lua_settop (cb->lua_state, /* idx = */ -2); /* -2 */
 
   return (status);
 } /* }}} int clua_read */
 
+static int clua_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
+    user_data_t *ud)
+{
+  clua_callback_data_t *cb = ud->data;
+  int status;
+
+  pthread_mutex_lock (&cb->lock);
+
+  status = clua_load_callback (cb->lua_state, cb->callback_id);
+  if (status != 0)
+  {
+    ERROR ("lua plugin: Unable to load callback \"%s\" (id %i).",
+        cb->lua_function_name, cb->callback_id);
+    pthread_mutex_unlock (&cb->lock);
+    return (-1);
+  }
+  /* +1 = 1 */
+
+  status = luaC_pushvaluelist (cb->lua_state, ds, vl);
+  if (status != 0)
+  {
+    lua_pop (cb->lua_state, /* nelems = */ 1); /* -1 = 0 */
+    pthread_mutex_unlock (&cb->lock);
+    ERROR ("lua plugin: luaC_pushvaluelist failed.");
+    return (-1);
+  }
+  /* +1 = 2 */
+
+  status = lua_pcall (cb->lua_state,
+      /* nargs    = */ 1,
+      /* nresults = */ 1,
+      /* errfunc  = */ 0); /* -2+1 = 1 */
+  if (status != 0)
+  {
+    const char *errmsg = lua_tostring (cb->lua_state, /* idx = */ -1);
+    if (errmsg == NULL)
+      ERROR ("lua plugin: Calling the write callback failed. "
+          "In addition, retrieving the error message failed.");
+    else
+      ERROR ("lua plugin: Calling the write callback failed:\n%s", errmsg);
+    lua_pop (cb->lua_state, /* nelems = */ 1); /* -1 = 0 */
+    pthread_mutex_unlock (&cb->lock);
+    return (-1);
+  }
+
+  if (!lua_isnumber (cb->lua_state, /* idx = */ -1))
+  {
+    ERROR ("lua plugin: Write function \"%s\" (id %i) did not return a numeric value.",
+        cb->lua_function_name, cb->callback_id);
+    status = -1;
+  }
+  else
+  {
+    status = (int) lua_tointeger (cb->lua_state, /* idx = */ -1);
+  }
+
+  lua_pop (cb->lua_state, /* nelems = */ 1); /* -1 = 0 */
+  pthread_mutex_unlock (&cb->lock);
+  return (status);
+} /* }}} int clua_write */
+
 /* Cleans up the stack, pushes the return value as a number onto the stack and
  * returns the number of values returned (1). */
 #define RETURN_LUA(l,status) do {                    \
@@ -150,14 +287,51 @@ static int lua_cb_log (lua_State *l) /* {{{ */
   RETURN_LUA (l, 0);
 } /* }}} int lua_cb_log */
 
+static int lua_cb_dispatch_values (lua_State *l) /* {{{ */
+{
+  value_list_t *vl;
+  int nargs = lua_gettop (l); /* number of arguments */
+  char identifier[6 * DATA_MAX_NAME_LEN];
+
+  if (nargs != 1)
+  {
+    WARNING ("lua plugin: collectd_dispatch_values() called "
+        "with an invalid number of arguments (%i).", nargs);
+    RETURN_LUA (l, -1);
+  }
+
+  if (!lua_istable (l, 1))
+  {
+    WARNING ("lua plugin: The first argument to collectd_dispatch_values() "
+        "must be a \"value list\" (i.e. a table).");
+    RETURN_LUA (l, -1);
+  }
+
+  vl = luaC_tovaluelist (l, /* idx = */ -1);
+  if (vl == NULL)
+  {
+    WARNING ("lua plugin: ltoc_value_list failed.");
+    RETURN_LUA (l, -1);
+  }
+
+  FORMAT_VL (identifier, sizeof (identifier), vl);
+
+  DEBUG ("lua plugin: collectd_dispatch_values: Received value list \"%s\", time %.3f, interval %.3f.",
+      identifier, CDTIME_T_TO_DOUBLE (vl->time), CDTIME_T_TO_DOUBLE (vl->interval));
+
+  sfree (vl->values);
+  sfree (vl);
+  RETURN_LUA (l, 0);
+} /* }}} lua_cb_dispatch_values */
+
 static int lua_cb_register_read (lua_State *l) /* {{{ */
 {
-  static int count = 0;
   int nargs = lua_gettop (l); /* number of arguments */
-  clua_read_function_t *rf;
+  clua_callback_data_t *cb;
+  user_data_t ud;
 
-  int num = count++; /* XXX FIXME: Not thread-safe! */
-  char function_name[64];
+  int callback_id;
+  char function_name[DATA_MAX_NAME_LEN] = "";
 
   if (nargs != 1)
   {
@@ -166,77 +340,111 @@ static int lua_cb_register_read (lua_State *l) /* {{{ */
     RETURN_LUA (l, -1);
   }
 
-  /* If the argument is a string, assume it's a global function and try to look
-   * it up. */
   if (lua_isstring (l, /* stack pos = */ 1))
-    lua_gettable (l, LUA_GLOBALSINDEX);
+  {
+    const char *tmp = lua_tostring (l, /* idx = */ 1);
+    ssnprintf (function_name, sizeof (function_name), "lua/%s", tmp);
+  }
 
-  if (!lua_isfunction (l, /* stack pos = */ 1))
+  callback_id = clua_store_callback (l, /* idx = */ 1);
+  if (callback_id < 0)
   {
-    WARNING ("lua plugin: The first argument of collectd_register_read() "
-        "must be a function.");
+    ERROR ("lua plugin: Storing callback function failed.");
     RETURN_LUA (l, -1);
   }
 
-  ssnprintf (function_name, sizeof (function_name), "collectd.read_func_%i", num);
+  if (function_name[0] == 0)
+    ssnprintf (function_name, sizeof (function_name), "lua/callback_%i", callback_id);
 
-  /* Push the name of the global variable */
-  lua_pushstring (l, function_name);
-  /* Push the name down to the first position */
-  lua_insert (l, 1);
-  /* Now set the global variable called "collectd". */
-  lua_settable (l, LUA_REGISTRYINDEX);
-
-  rf = malloc (sizeof (*rf));
-  if (rf == NULL)
+  cb = malloc (sizeof (*cb));
+  if (cb == NULL)
   {
     ERROR ("lua plugin: malloc failed.");
     RETURN_LUA (l, -1);
   }
-  else
-  {
-    user_data_t ud = { rf, /* free func */ NULL /* FIXME */ };
-    char cb_name[DATA_MAX_NAME_LEN];
 
-    memset (rf, 0, sizeof (*rf));
-    rf->lua_state = l;
-    rf->lua_function_name = strdup (function_name);
+  memset (cb, 0, sizeof (*cb));
+  cb->lua_state = l;
+  cb->callback_id = callback_id;
+  cb->lua_function_name = strdup (function_name);
 
-    ssnprintf (cb_name, sizeof (cb_name), "lua/read_func_%i", num);
+  ud.data = cb;
+  ud.free_func = NULL; /* FIXME */
 
-    plugin_register_complex_read (/* group = */ "lua",
-        /* name      = */ cb_name,
-        /* callback  = */ clua_read,
-        /* interval  = */ NULL,
-        /* user_data = */ &ud);
-  }
+  plugin_register_complex_read (/* group = */ "lua",
+      /* name      = */ function_name,
+      /* callback  = */ clua_read,
+      /* interval  = */ NULL,
+      /* user_data = */ &ud);
 
   DEBUG ("lua plugin: Successful call to lua_cb_register_read().");
 
   RETURN_LUA (l, 0);
 } /* }}} int lua_cb_register_read */
 
-static lua_c_functions_t lua_c_functions[] =
+static int lua_cb_register_write (lua_State *l) /* {{{ */
 {
-  { "collectd_log", lua_cb_log },
-  { "collectd_register_read", lua_cb_register_read }
-};
+  int nargs = lua_gettop (l); /* number of arguments */
+  clua_callback_data_t *cb;
+  user_data_t ud;
+
+  int callback_id;
+  char function_name[DATA_MAX_NAME_LEN] = "";
+
+  if (nargs != 1)
+  {
+    WARNING ("lua plugin: collectd_register_read() called with an invalid "
+        "number of arguments (%i).", nargs);
+    RETURN_LUA (l, -1);
+  }
+
+  if (lua_isstring (l, /* stack pos = */ 1))
+  {
+    const char *tmp = lua_tostring (l, /* idx = */ 1);
+    ssnprintf (function_name, sizeof (function_name), "lua/%s", tmp);
+  }
+
+  callback_id = clua_store_callback (l, /* idx = */ 1);
+  if (callback_id < 0)
+  {
+    ERROR ("lua plugin: Storing callback function failed.");
+    RETURN_LUA (l, -1);
+  }
+
+  if (function_name[0] == 0)
+    ssnprintf (function_name, sizeof (function_name), "lua/callback_%i", callback_id);
+
+  cb = malloc (sizeof (*cb));
+  if (cb == NULL)
+  {
+    ERROR ("lua plugin: malloc failed.");
+    RETURN_LUA (l, -1);
+  }
+
+  memset (cb, 0, sizeof (*cb));
+  cb->lua_state = l;
+  cb->callback_id = callback_id;
+  cb->lua_function_name = strdup (function_name);
+  pthread_mutex_init (&cb->lock, /* attr = */ NULL);
+
+  ud.data = cb;
+  ud.free_func = NULL; /* FIXME */
+
+  plugin_register_write (/* name = */ function_name,
+      /* callback  = */ clua_write,
+      /* user_data = */ &ud);
+
+  DEBUG ("lua plugin: Successful call to lua_cb_register_write().");
 
-/* Declare the Lua libraries we wish to use.
- * Note: If you are opening and running a file containing Lua code using
- * 'lua_dofile(l, "myfile.lua") - you must delcare all the libraries used in
- * that file here also. */
-static const luaL_reg lua_load_libs[] =
+  RETURN_LUA (l, 0);
+} /* }}} int lua_cb_register_write */
+
+static lua_c_functions_t lua_c_functions[] =
 {
-  { LUA_COLIBNAME,   luaopen_base   },
-  /* { "luaopen_loadlib", luaopen_loadlib }, */
-#if COLLECT_DEBUG
-  { LUA_DBLIBNAME,   luaopen_debug  },
-#endif
-  { LUA_TABLIBNAME,  luaopen_table  },
-  { LUA_IOLIBNAME,   luaopen_io     },
-  { LUA_STRLIBNAME,  luaopen_string },
-  { LUA_MATHLIBNAME, luaopen_math   }
+  { "collectd_log", lua_cb_log },
+  { "collectd_dispatch_values", lua_cb_dispatch_values },
+  { "collectd_register_read", lua_cb_register_read },
+  { "collectd_register_write", lua_cb_register_write }
 };
 
 static void lua_script_free (lua_script_t *script) /* {{{ */
@@ -276,16 +484,8 @@ static int lua_script_init (lua_script_t *script) /* {{{ */
     return (-1);
   }
 
-  /* Open up all the Lua libraries declared above. */
-  for (i = 0; i < STATIC_ARRAY_SIZE (lua_load_libs); i++)
-  {
-    int status;
-
-    status = (*lua_load_libs[i].func) (script->lua_state);
-    if (status != 0)
-      WARNING ("lua plugin: Loading library \"%s\" failed.",
-          lua_load_libs[i].name);
-  }
+  /* Open up all the standard Lua libraries. */
+  luaL_openlibs (script->lua_state);
 
   /* Register all the functions we implement in C */
   for (i = 0; i < STATIC_ARRAY_SIZE (lua_c_functions); i++)
@@ -322,21 +522,31 @@ static int lua_script_load (const char *script_path) /* {{{ */
     return (-1);
   }
 
-  status = lua_dofile (script->lua_state, script->script_path);
+  status = luaL_loadfile (script->lua_state, script->script_path);
+  if (status != 0)
+  {
+    ERROR ("lua plugin: luaL_loadfile failed with status %i", status);
+    lua_script_free (script);
+    return (-1);
+  }
+
+  status = lua_pcall (script->lua_state,
+      /* nargs = */    0,
+      /* nresults = */ LUA_MULTRET,
+      /* errfunc = */  0);
   if (status != 0)
   {
     const char *errmsg;
 
-    switch (status)
-    {
-      case LUA_ERRSYNTAX: errmsg = "Syntax error"; break;
-      case LUA_ERRFILE:   errmsg = "File I/O error"; break;
-      case LUA_ERRMEM:    errmsg = "Memory allocation error"; break;
-      default:            errmsg = "Unexpected error";
-    }
+    errmsg = lua_tostring (script->lua_state, /* stack pos = */ -1);
 
-    ERROR ("lua plugin: Loading script \"%s\" failed: %s",
-        script->script_path, errmsg);
+    if (errmsg == NULL)
+      ERROR ("lua plugin: lua_pcall failed with status %i. "
+          "In addition, no error message could be retrieved from the stack.",
+          status);
+    else
+      ERROR ("lua plugin: Executing script \"%s\" failed:\n%s",
+          script->script_path, errmsg);
 
     lua_script_free (script);
     return (-1);