cache

include/util/tcache.h

@@ -13,27 +13,26 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef _TD_UTIL_CACHE_H
-#define _TD_UTIL_CACHE_H
+#ifndef _TD_UTIL_CACHE_H_
+#define _TD_UTIL_CACHE_H_
+
+#include "thash.h"
+#include "tlockfree.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include "os.h"
-#include "tlockfree.h"
-#include "thash.h"
-
-#if defined(_TD_ARM_32) 
-  #define TSDB_CACHE_PTR_KEY  TSDB_DATA_TYPE_INT
-  #define TSDB_CACHE_PTR_TYPE int32_t
+#if defined(_TD_ARM_32)
+#define TSDB_CACHE_PTR_KEY  TSDB_DATA_TYPE_INT
+#define TSDB_CACHE_PTR_TYPE int32_t
 #else
-  #define TSDB_CACHE_PTR_KEY  TSDB_DATA_TYPE_BIGINT  
-  #define TSDB_CACHE_PTR_TYPE int64_t
+#define TSDB_CACHE_PTR_KEY  TSDB_DATA_TYPE_BIGINT
+#define TSDB_CACHE_PTR_TYPE int64_t
 #endif
 
-typedef void (*__cache_free_fn_t)(void*);
-typedef void (*__cache_trav_fn_t)(void*, void*);
+typedef void (*__cache_free_fn_t)(void *);
+typedef void (*__cache_trav_fn_t)(void *, void *);
 
 typedef struct SCacheStatis {
   int64_t missCount;
@@ -45,17 +44,17 @@ typedef struct SCacheStatis {
 struct STrashElem;
 
 typedef struct SCacheDataNode {
-  uint64_t           addedTime;    // the added time when this element is added or updated into cache
-  uint64_t           lifespan;     // life duration when this element should be remove from cache
-  uint64_t           expireTime;   // expire time
+  uint64_t           addedTime;   // the added time when this element is added or updated into cache
+  uint64_t           lifespan;    // life duration when this element should be remove from cache
+  uint64_t           expireTime;  // expire time
   uint64_t           signature;
-  struct STrashElem *pTNodeHeader; // point to trash node head
-  uint16_t           keySize: 15;  // max key size: 32kb
-  bool               inTrashcan: 1;// denote if it is in trash or not
-  uint32_t           size;         // allocated size for current SCacheDataNode
+  struct STrashElem *pTNodeHeader;    // point to trash node head
+  uint16_t           keySize : 15;    // max key size: 32kb
+  bool               inTrashcan : 1;  // denote if it is in trash or not
+  uint32_t           size;            // allocated size for current SCacheDataNode
   T_REF_DECLARE()
-  char              *key;
-  char               data[];
+  char *key;
+  char  data[];
 } SCacheDataNode;
 
 typedef struct STrashElem {
@@ -73,22 +72,22 @@ typedef struct STrashElem {
  * when the node in pTrash does not be referenced, it will be release at the expired expiredTime
  */
 typedef struct {
-  int64_t         totalSize;          // total allocated buffer in this hash table, SCacheObj is not included.
-  int64_t         refreshTime;
-  STrashElem *    pTrash;
-  char*           name;
-  SCacheStatis    statistics;
-  SHashObj *      pHashTable;
+  int64_t           totalSize;  // total allocated buffer in this hash table, SCacheObj is not included.
+  int64_t           refreshTime;
+  STrashElem       *pTrash;
+  char             *name;
+  SCacheStatis      statistics;
+  SHashObj         *pHashTable;
   __cache_free_fn_t freeFp;
-  uint32_t        numOfElemsInTrash;  // number of element in trash
-  uint8_t         deleting;           // set the deleting flag to stop refreshing ASAP.
-  pthread_t       refreshWorker;
-  bool            extendLifespan;     // auto extend life span when one item is accessed.
-  int64_t         checkTick;          // tick used to record the check times of the refresh threads
+  uint32_t          numOfElemsInTrash;  // number of element in trash
+  uint8_t           deleting;           // set the deleting flag to stop refreshing ASAP.
+  pthread_t         refreshWorker;
+  bool              extendLifespan;  // auto extend life span when one item is accessed.
+  int64_t           checkTick;       // tick used to record the check times of the refresh threads
 #if defined(LINUX)
   pthread_rwlock_t lock;
 #else
-  pthread_mutex_t  lock;
+  pthread_mutex_t lock;
 #endif
 } SCacheObj;
 
@@ -101,7 +100,8 @@ typedef struct {
  * @param fn                   free resource callback function
  * @return
  */
-SCacheObj *taosCacheInit(int32_t keyType, int64_t refreshTimeInSeconds, bool extendLifespan, __cache_free_fn_t fn, const char *cacheName);
+SCacheObj *taosCacheInit(int32_t keyType, int64_t refreshTimeInSeconds, bool extendLifespan, __cache_free_fn_t fn,
+                         const char *cacheName);
 
 /**
  * add data into cache
@@ -113,7 +113,8 @@ SCacheObj *taosCacheInit(int32_t keyType, int64_t refreshTimeInSeconds, bool ext
  * @param keepTime      survival time in second
  * @return              cached element
  */
-void *taosCachePut(SCacheObj *pCacheObj, const void *key, size_t keyLen, const void *pData, size_t dataSize, int durationMS);
+void *taosCachePut(SCacheObj *pCacheObj, const void *key, size_t keyLen, const void *pData, size_t dataSize,
+                   int32_t durationMS);
 
 /**
  * get data from cache
@@ -177,7 +178,7 @@ void taosCacheCleanup(SCacheObj *pCacheObj);
  * @param fp
  * @return
  */
-void taosCacheRefresh(SCacheObj *pCacheObj, __cache_trav_fn_t fp, void* param1);
+void taosCacheRefresh(SCacheObj *pCacheObj, __cache_trav_fn_t fp, void *param1);
 
 /**
  * stop background refresh worker thread
@@ -188,4 +189,4 @@ void taosStopCacheRefreshWorker();
 }
 #endif
 
-#endif  /*_TD_UTIL_CACHE_H*/
+#endif /*_TD_UTIL_CACHE_H_*/