synchronized with lua-nginx-module #189ba24 (log function location on failed timers).

Thanks Zexuan Luo for the upstream patch.

Author: thibaultcha

src/subsys/ngx_subsys_lua_timer.c.tt2

@@ -16,6 +16,9 @@
 #include "ngx_[% subsys %]_lua_probe.h"
 
 
+#define NGX_[% SUBSYS %]_LUA_TIMER_ERRBUF_SIZE  128
+
+
 typedef struct {
     void        **main_conf;
     void        **srv_conf;
@@ -565,29 +568,36 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
     lua_State                       *L;
     ngx_int_t                        rc;
     ngx_connection_t                *c = NULL;
-    [% req_type %]                  *r = NULL;
-    ngx_[% subsys %]_lua_ctx_t      *ctx;
-    ngx_[% req_subsys %]_cleanup_t  *cln;
     ngx_pool_cleanup_t              *pcln;
 
+    [% req_type %]                          *r = NULL;
+    ngx_[% req_subsys %]_cleanup_t          *cln;
+    ngx_[% subsys %]_lua_ctx_t              *ctx;
     ngx_[% subsys %]_lua_timer_ctx_t         tctx;
     ngx_[% subsys %]_lua_main_conf_t        *lmcf;
 
 [% IF http_subsys %]
     ngx_http_core_loc_conf_t          *clcf;
+
 [% ELSIF stream_subsys %]
     ngx_stream_core_srv_conf_t        *clcf;
-[% END %]
-[% IF stream_subsys %]
     ngx_stream_session_t              *s;
 [% END %]
 
+    lua_Debug                ar;
+    u_char                  *p;
+    u_char                   errbuf[NGX_[% SUBSYS %]_LUA_TIMER_ERRBUF_SIZE];
+    const char              *source;
+    const char              *errmsg;
+
     ngx_log_debug0(NGX_LOG_DEBUG_[% SUBSYS %], ngx_cycle->log, 0,
                    "[% log_prefix %]lua ngx.timer expired");
 
     ngx_memcpy(&tctx, ev->data, sizeof(ngx_[% subsys %]_lua_timer_ctx_t));
     ngx_free(ev);
 
+    ngx_[% subsys %]_lua_assert(tctx.co_ref && tctx.co);
+
     lmcf = tctx.lmcf;
 
     lmcf->pending_timers--;
@@ -602,22 +612,22 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
     }
 
     if (lmcf->running_timers >= lmcf->max_running_timers) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
+        p = ngx_snprintf(errbuf, NGX_[% SUBSYS %]_LUA_TIMER_ERRBUF_SIZE - 1,
 [% IF http_subsys %]
-                      "%i lua_max_running_timers are not enough",
+                         "%i lua_max_running_timers are not enough",
 
 [% ELSIF stream_subsys %]
-                      "stream lua: %i lua_max_running_timers are not enough",
+                         "stream lua: %i lua_max_running_timers are not enough",
 [% END %]
-                      lmcf->max_running_timers);
+                         lmcf->max_running_timers);
+        *p = '\0';
+        errmsg = (const char *) errbuf;
         goto failed;
     }
 
     c = ngx_[% subsys %]_lua_create_fake_connection(tctx.pool);
     if (c == NULL) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                      "[% log_prefix %]failed to create fake connection to "
-                      "run timer (co: %p)", tctx.co);
+        errmsg = "could not create fake connection";
         goto failed;
     }
 
@@ -630,18 +640,14 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
 [% IF stream_subsys %]
     s = ngx_stream_lua_create_fake_session(c);
     if (s == NULL) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                      "stream lua failed to create fake session to run timer "
-                      "(co: %p)", tctx.co);
+        errmsg = "could not create fake session";
         goto failed;
     }
 
 [% ELSIF http_subsys %]
     r = ngx_http_lua_create_fake_request(c);
     if (r == NULL) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                      "failed to create fake request to run timer (co: %p)",
-                      tctx.co);
+        errmsg = "could not create fake request";
         goto failed;
     }
 [% END %]
@@ -683,9 +689,7 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
     ctx = ngx_stream_lua_create_ctx(s);
 [% END %]
     if (ctx == NULL) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                      "[% log_prefix %]failed to create ctx to run timer "
-                      "(co: %p)", tctx.co);
+        errmsg = "could not create ctx";
         goto failed;
     }
 
@@ -698,9 +702,7 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
 
         pcln = ngx_pool_cleanup_add(r->pool, 0);
         if (pcln == NULL) {
-            ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                          "[% log_prefix %]failed to add vm cleanup to run "
-                          "timer (co: %p)", tctx.co);
+            errmsg = "could not add vm cleanup";
             goto failed;
         }
 
@@ -714,9 +716,7 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
 
     cln = ngx_[% req_subsys %]_cleanup_add(r, 0);
     if (cln == NULL) {
-        ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
-                      "[% log_prefix %]failed to add request cleanup to run "
-                      "timer (co: %p)", tctx.co);
+        errmsg = "could not add request cleanup";
         goto failed;
     }
 
@@ -773,14 +773,26 @@ ngx_[% subsys %]_lua_timer_handler(ngx_event_t *ev)
 
 failed:
 
-    if (tctx.co_ref && tctx.co) {
-        lua_pushlightuserdata(tctx.co, ngx_[% subsys %]_lua_lightudata_mask(
-                              coroutines_key));
-        lua_rawget(tctx.co, LUA_REGISTRYINDEX);
-        luaL_unref(tctx.co, -1, tctx.co_ref);
-        lua_settop(tctx.co, 0);
+    /* co stack: func [args] */
+    lua_getinfo(tctx.co, ">Sf", &ar);
+
+    source = ar.source;
+
+    if (source == NULL) {
+        source = "(unknown)";
     }
 
+    ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, 0,
+                  "[% log_prefix %]lua failed to run timer with function "
+                  "defined at %s:%d: %s",
+                  source, ar.linedefined, errmsg);
+
+    lua_pushlightuserdata(tctx.co, ngx_[% subsys %]_lua_lightudata_mask(
+                          coroutines_key));
+    lua_rawget(tctx.co, LUA_REGISTRYINDEX);
+    luaL_unref(tctx.co, -1, tctx.co_ref);
+    lua_settop(tctx.co, 0);
+
     if (tctx.vm_state) {
         ngx_[% subsys %]_lua_cleanup_vm(tctx.vm_state);
     }