some doc fix and bugfix

doujiang24 · doujiang24 · commit 3eb0be9e15f7 · 2016-08-02T18:42:28.000+08:00
diff --git a/README.markdown b/README.markdown
@@ -6105,7 +6105,7 @@ ngx.shared.DICT.get
 
 **context:** *set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;, balancer_by_lua&#42;, ssl_certificate_by_lua&#42;, ssl_session_fetch_by_lua&#42;, ssl_session_store_by_lua&#42;*
 
-Retrieving the value in the dictionary [ngx.shared.DICT](#ngxshareddict) for the key `key`. If the key does not exist or has been expired, then `nil` will be returned.
+Retrieving the value in the dictionary [ngx.shared.DICT](#ngxshareddict) for the key `key`. If the key does not exist or has expired, then `nil` will be returned.
 
 In case of errors, `nil` and a string describing the error will be returned.
 
@@ -6314,11 +6314,11 @@ ngx.shared.DICT.lpush
 ---------------------
 **syntax:** *length, err = ngx.shared.DICT:lpush(key, value)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
-Inserts the specified (numerical or string) `value` at the head of the list named `key` in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict). Returns the length of the list after the push operations.
+Inserts the specified (numerical or string) `value` at the head of the list named `key` in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict). Returns the number of elements in the list after the push operation.
 
-If `key` does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, it will return `nil` and `"wrongtype operation"`.
+If `key` does not exist, it is created as an empty list before performing the push operations. When the `key` already takes a value that is not a list, it will return `nil` and `"value not a list"`.
 
 It never overrides the (least recently used) unexpired items in the store when running out of storage in the shared memory zone. In this case, it will immediately return `nil` and the string "no memory".
 
@@ -6332,7 +6332,7 @@ ngx.shared.DICT.rpush
 ---------------------
 **syntax:** *length, err = ngx.shared.DICT:rpush(key, value)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Similar to the [lpush](#ngxshareddictlpush) method, but inserts the specified (numerical or string) `value` at the tail of the list named `key`.
 
@@ -6346,11 +6346,11 @@ ngx.shared.DICT.lpop
 --------------------
 **syntax:** *val, err = ngx.shared.DICT:lpop(key)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Removes and returns the first element of the list named `key` in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict).
 
-If `key` does not exist, it will return `nil`. When key holds a value that is not a list, it will return `nil` and `"wrongtype operation"`.
+If `key` does not exist, it will return `nil`. When the `key` already takes a value that is not a list, it will return `nil` and `"value not a list"`.
 
 This feature was first introduced in the `v0.*.*` release.
 
@@ -6362,11 +6362,11 @@ ngx.shared.DICT.rpop
 --------------------
 **syntax:** *val, err = ngx.shared.DICT:rpop(key)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Removes and returns the last element of the list named `key` in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict).
 
-If `key` does not exist, it will return `nil`. When key holds a value that is not a list, it will return `nil` and `"wrongtype operation"`.
+If `key` does not exist, it will return `nil`. When the `key` already takes a value that is not a list, it will return `nil` and `"value not a list"`.
 
 This feature was first introduced in the `v0.*.*` release.
 
@@ -6378,11 +6378,11 @@ ngx.shared.DICT.llen
 --------------------
 **syntax:** *len, err = ngx.shared.DICT:llen(key)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
 Returns the length of the list named `key` in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict).
 
-If key does not exist, it is interpreted as an empty list and 0 is returned. When key holds a value that is not a list, it will return `nil` and `"wrongtype operation"`.
+If key does not exist, it is interpreted as an empty list and 0 is returned. When the `key` already takes a value that is not a list, it will return `nil` and `"value not a list"`.
 
 This feature was first introduced in the `v0.*.*` release.
 
@@ -6394,11 +6394,11 @@ ngx.shared.DICT.expire
 ----------------------
 **syntax:** *ok, err = ngx.shared.DICT:expire(key, exptime)*
 
-**context:** *init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.**
+**context:** *init_by_lua&#42;, set_by_lua&#42;, rewrite_by_lua&#42;, access_by_lua&#42;, content_by_lua&#42;, header_filter_by_lua&#42;, body_filter_by_lua&#42;, log_by_lua&#42;, ngx.timer.&#42;*
 
-The `exptime` argument specifies expiration time (in seconds) for the inserted key-value pair. The time resolution is 0.001 seconds. If the exptime takes the value 0, then the item will never be expired.
+The `exptime` argument specifies a new expiration time (in seconds) for an existing key-value pair in the shm-based dictionary [ngx.shared.DICT](#ngxshareddict) specified by the `key` argument. The time resolution is 0.001 seconds. If the exptime takes the value 0, then the item will never expire.
 
-If key does not exist or has been expired, it will return `false` and `"not found"`. Otherwise it will return `true`.
+If key does not exist or has expired, it will return `false` and `"not found"`. Otherwise it will return `true`.
 
 This feature was first introduced in the `v0.*.*` release.
 
diff --git a/doc/HttpLuaModule.wiki b/doc/HttpLuaModule.wiki
@@ -5112,7 +5112,7 @@ This feature was first introduced in the <code>v0.3.1rc22</code> release.
 
 '''context:''' ''set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, balancer_by_lua*, ssl_certificate_by_lua*, ssl_session_fetch_by_lua*, ssl_session_store_by_lua*''
 
-Retrieving the value in the dictionary [[#ngx.shared.DICT|ngx.shared.DICT]] for the key <code>key</code>. If the key does not exist or has been expired, then <code>nil</code> will be returned.
+Retrieving the value in the dictionary [[#ngx.shared.DICT|ngx.shared.DICT]] for the key <code>key</code>. If the key does not exist or has expired, then <code>nil</code> will be returned.
 
 In case of errors, <code>nil</code> and a string describing the error will be returned.
 
@@ -5292,9 +5292,9 @@ See also [[#ngx.shared.DICT|ngx.shared.DICT]].
 
 '''context:''' ''init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*''
 
-Inserts the specified (numerical or string) <code>value</code> at the head of the list named <code>key</code> in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]]. Returns the length of the list after the push operations.
+Inserts the specified (numerical or string) <code>value</code> at the head of the list named <code>key</code> in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]]. Returns the number of elements in the list after the push operation.
 
-If <code>key</code> does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, it will return <code>nil</code> and <code>"wrongtype operation"</code>.
+If <code>key</code> does not exist, it is created as an empty list before performing the push operations. When the <code>key</code> already takes a value that is not a list, it will return <code>nil</code> and <code>"value not a list"</code>.
 
 It never overrides the (least recently used) unexpired items in the store when running out of storage in the shared memory zone. In this case, it will immediately return <code>nil</code> and the string "no memory".
 
@@ -5320,7 +5320,7 @@ See also [[#ngx.shared.DICT|ngx.shared.DICT]].
 
 Removes and returns the first element of the list named <code>key</code> in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]].
 
-If <code>key</code> does not exist, it will return <code>nil</code>. When key holds a value that is not a list, it will return <code>nil</code> and <code>"wrongtype operation"</code>.
+If <code>key</code> does not exist, it will return <code>nil</code>. When the <code>key</code> already takes a value that is not a list, it will return <code>nil</code> and <code>"value not a list"</code>.
 
 This feature was first introduced in the <code>v0.*.*</code> release.
 
@@ -5333,7 +5333,7 @@ See also [[#ngx.shared.DICT|ngx.shared.DICT]].
 
 Removes and returns the last element of the list named <code>key</code> in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]].
 
-If <code>key</code> does not exist, it will return <code>nil</code>. When key holds a value that is not a list, it will return <code>nil</code> and <code>"wrongtype operation"</code>.
+If <code>key</code> does not exist, it will return <code>nil</code>. When the <code>key</code> already takes a value that is not a list, it will return <code>nil</code> and <code>"value not a list"</code>.
 
 This feature was first introduced in the <code>v0.*.*</code> release.
 
@@ -5346,7 +5346,7 @@ See also [[#ngx.shared.DICT|ngx.shared.DICT]].
 
 Returns the length of the list named <code>key</code> in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]].
 
-If key does not exist, it is interpreted as an empty list and 0 is returned. When key holds a value that is not a list, it will return <code>nil</code> and <code>"wrongtype operation"</code>.
+If key does not exist, it is interpreted as an empty list and 0 is returned. When the <code>key</code> already takes a value that is not a list, it will return <code>nil</code> and <code>"value not a list"</code>.
 
 This feature was first introduced in the <code>v0.*.*</code> release.
 
@@ -5357,9 +5357,9 @@ See also [[#ngx.shared.DICT|ngx.shared.DICT]].
 
 '''context:''' ''init_by_lua*, set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*''
 
-The <code>exptime</code> argument specifies expiration time (in seconds) for the inserted key-value pair. The time resolution is 0.001 seconds. If the exptime takes the value 0, then the item will never be expired.
+The <code>exptime</code> argument specifies a new expiration time (in seconds) for an existing key-value pair in the shm-based dictionary [[#ngx.shared.DICT|ngx.shared.DICT]] specified by the <code>key</code> argument. The time resolution is 0.001 seconds. If the exptime takes the value 0, then the item will never expire.
 
-If key does not exist or has been expired, it will return <code>false</code> and <code>"not found"</code>. Otherwise it will return <code>true</code>.
+If key does not exist or has expired, it will return <code>false</code> and <code>"not found"</code>. Otherwise it will return <code>true</code>.
 
 This feature was first introduced in the <code>v0.*.*</code> release.
 
diff --git a/src/ngx_http_lua_shdict.c b/src/ngx_http_lua_shdict.c
@@ -52,6 +52,7 @@ static ngx_inline ngx_shm_zone_t *ngx_http_lua_shdict_get_zone(lua_State *L,
 #define NGX_HTTP_LUA_SHDICT_REPLACE     0x0002
 #define NGX_HTTP_LUA_SHDICT_SAFE_STORE  0x0004
 
+
 #define NGX_HTTP_LUA_SHDICT_LEFT        0x0001
 #define NGX_HTTP_LUA_SHDICT_RIGHT       0x0002
 
@@ -60,6 +61,7 @@ enum {
     SHDICT_USERDATA_INDEX = 1,
 };
 
+
 enum {
     SHDICT_TNIL = 0,        /* same as LUA_TNIL */
     SHDICT_TBOOLEAN = 1,    /* same as LUA_TBOOLEAN */
@@ -69,7 +71,7 @@ enum {
 };
 
 
-static ngx_queue_t *
+static ngx_inline ngx_queue_t *
 ngx_http_lua_shdict_get_list_head(ngx_http_lua_shdict_node_t *sd, u_short len)
 {
     return (ngx_queue_t *) ngx_align_ptr(((u_char *) &sd->data + len),
@@ -607,7 +609,7 @@ ngx_http_lua_shdict_get_helper(lua_State *L, int get_stale)
         ngx_shmtx_unlock(&ctx->shpool->mutex);
 
         lua_pushnil(L);
-        lua_pushliteral(L, "wrongtype operation");
+        lua_pushliteral(L, "value is a list");
         return 2;
 
     default:
@@ -1712,8 +1714,9 @@ ngx_http_lua_shdict_push_helper(lua_State *L, int flags)
 
     dd("shdict lookup returned %d", (int) rc);
 
+    /* exists but expired */
+
     if (rc == NGX_DONE) {
-        /* exists but expired */
 
         if (sd->value_type != SHDICT_TLIST) {
             /* TODO: reuse when length matched */
@@ -1761,14 +1764,17 @@ ngx_http_lua_shdict_push_helper(lua_State *L, int flags)
 
         dd("go to push_node");
         goto push_node;
+    }
+
+    /* exists and not expired */
 
-    } else if (rc == NGX_OK) {
+    if (rc == NGX_OK) {
 
         if (sd->value_type != SHDICT_TLIST) {
             ngx_shmtx_unlock(&ctx->shpool->mutex);
 
             lua_pushnil(L);
-            lua_pushliteral(L, "wrongtype operation");
+            lua_pushliteral(L, "value not a list");
             return 2;
         }
 
@@ -1993,7 +1999,7 @@ ngx_http_lua_shdict_pop_helper(lua_State *L, int flags)
         ngx_shmtx_unlock(&ctx->shpool->mutex);
 
         lua_pushnil(L);
-        lua_pushliteral(L, "wrongtype operation");
+        lua_pushliteral(L, "value not a list");
         return 2;
     }
 
@@ -2076,7 +2082,6 @@ ngx_http_lua_shdict_pop_helper(lua_State *L, int flags)
         ngx_slab_free_locked(ctx->shpool, node);
 
     } else {
-
         sd->value_len = sd->value_len - 1;
 
         ngx_queue_remove(&sd->queue);
@@ -2151,21 +2156,20 @@ ngx_http_lua_shdict_llen(lua_State *L)
     dd("shdict lookup returned %d", (int) rc);
 
     if (rc == NGX_OK) {
-
         if (sd->value_type != SHDICT_TLIST) {
             ngx_shmtx_unlock(&ctx->shpool->mutex);
 
             lua_pushnil(L);
-            lua_pushliteral(L, "wrongtype operation");
+            lua_pushliteral(L, "value not a list");
             return 2;
         }
 
         ngx_queue_remove(&sd->queue);
         ngx_queue_insert_head(&ctx->sh->queue, &sd->queue);
 
-        lua_pushnumber(L, (lua_Number) sd->value_len);
-
         ngx_shmtx_unlock(&ctx->shpool->mutex);
+
+        lua_pushnumber(L, (lua_Number) sd->value_len);
         return 1;
     }
 
diff --git a/t/133-shdict-list.t b/t/133-shdict-list.t
@@ -82,7 +82,7 @@ nil nil
 GET /test
 --- response_body
 push success
-nil wrongtype operation
+nil value is a list
 --- no_error_log
 [error]
 
@@ -181,7 +181,7 @@ GET /test
 --- response_body
 push success
 false exists
-nil wrongtype operation
+nil value is a list
 --- no_error_log
 [error]
 
@@ -247,7 +247,7 @@ GET /test
 --- response_body
 push success
 nil not a number
-nil wrongtype operation
+nil value is a list
 --- no_error_log
 [error]
 
@@ -308,7 +308,7 @@ key: foo
 GET /test
 --- response_body
 set success
-nil wrongtype operation
+nil value not a list
 bar nil
 --- no_error_log
 [error]
@@ -341,7 +341,7 @@ bar nil
 GET /test
 --- response_body
 set success
-nil wrongtype operation
+nil value not a list
 bar nil
 --- no_error_log
 [error]
@@ -374,7 +374,7 @@ bar nil
 GET /test
 --- response_body
 set success
-nil wrongtype operation
+nil value not a list
 bar nil
 --- no_error_log
 [error]
