utils/net_cache.c

This is part of the net tool which is basically command line wrapper for gencache.c functions (mainly for testing) [詳細]

ソースコードを見る。

関数
static void	print_cache_entry (const char *keystr, const char *datastr, const time_t timeout, void *dptr)
static void	delete_cache_entry (const char *keystr, const char *datastr, const time_t timeout, void *dptr)
static time_t	parse_timeout (const char *timeout_str)
	Parse text representation of timeout value
static int	net_cache_add (int argc, const char **argv)
	Add an entry to the cache.
static int	net_cache_del (int argc, const char **argv)
	Delete an entry in the cache
static int	net_cache_get (int argc, const char **argv)
	Get and display an entry from the cache
static int	net_cache_search (int argc, const char **argv)
	Search an entry/entries in the cache
static int	net_cache_list (int argc, const char **argv)
	List the contents of the cache
static int	net_cache_flush (int argc, const char **argv)
	Flush the whole cache
static int	net_cache_usage (int argc, const char **argv)
	Short help
int	net_cache (int argc, const char **argv)
	Entry point to 'net cache' subfunctionality

---

説明

This is part of the net tool which is basically command line wrapper for gencache.c functions (mainly for testing)

net_cache.c で定義されています。

---

関数

static void print_cache_entry	(	const char *	keystr,
		const char *	datastr,
		const time_t	timeout,
		void *	dptr
	)			[static]

net_cache.c の 37 行で定義されています。

参照先 asprintf()・d_printf()・localtime().

参照元 net_cache_get()・net_cache_list()・net_cache_search().

{
        char *timeout_str;
        char *alloc_str = NULL;
        time_t now_t = time(NULL);
        struct tm timeout_tm, *now_tm;
        /* localtime returns statically allocated pointer, so timeout_tm
           has to be copied somewhere else */

        now_tm = localtime(&timeout);
        if (!now_tm) {
                return;
        }
        memcpy(&timeout_tm, now_tm, sizeof(struct tm));
        now_tm = localtime(&now_t);
        if (!now_tm) {
                return;
        }

        /* form up timeout string depending whether it's today's date or not */
        if (timeout_tm.tm_year != now_tm->tm_year ||
                        timeout_tm.tm_mon != now_tm->tm_mon ||
                        timeout_tm.tm_mday != now_tm->tm_mday) {
            
                timeout_str = asctime(&timeout_tm);
                if (!timeout_str) {
                        return;
                }       
                timeout_str[strlen(timeout_str) - 1] = '\0';    /* remove tailing CR */
        } else {
                asprintf(&alloc_str, "%.2d:%.2d:%.2d", timeout_tm.tm_hour,
                         timeout_tm.tm_min, timeout_tm.tm_sec);
                if (!alloc_str) {
                        return;
                }
                timeout_str = alloc_str;
        }
        
        d_printf("Key: %s\t Timeout: %s\t Value: %s  %s\n", keystr,
                 timeout_str, datastr, timeout > now_t ? "": "(expired)");

        SAFE_FREE(alloc_str);
}

static void delete_cache_entry	(	const char *	keystr,
		const char *	datastr,
		const time_t	timeout,
		void *	dptr
	)			[static]

net_cache.c の 82 行で定義されています。

参照先 d_fprintf()・gencache_del().

参照元 net_cache_flush().

{
        if (!gencache_del(keystr))
                d_fprintf(stderr, "Couldn't delete entry! key = %s\n", keystr);
}

static time_t parse_timeout

(

const char *

timeout_str

)

[static]

Parse text representation of timeout value

引数:

timeout_str

string containing text representation of the timeout

戻り値:

numeric timeout of time_t type

net_cache.c の 96 行で定義されています。

参照先 len・timeout.

参照元 net_cache_add().

{
        char sign = '\0', *number = NULL, unit = '\0';
        int len, number_begin, number_end;
        time_t timeout;

        /* sign detection */
        if (timeout_str[0] == '!' || timeout_str[0] == '+') {
                sign = timeout_str[0];
                number_begin = 1;
        } else {
                number_begin = 0;
        }
        
        /* unit detection */
        len = strlen(timeout_str);
        switch (timeout_str[len - 1]) {
        case 's':
        case 'm':
        case 'h':
        case 'd':
        case 'w': unit = timeout_str[len - 1];
        }
        
        /* number detection */
        len = (sign) ? strlen(&timeout_str[number_begin]) : len;
        number_end = (unit) ? len - 1 : len;
        number = SMB_STRNDUP(&timeout_str[number_begin], number_end);
        
        /* calculate actual timeout value */
        timeout = (time_t)atoi(number);

        switch (unit) {
        case 'm': timeout *= 60; break;
        case 'h': timeout *= 60*60; break;
        case 'd': timeout *= 60*60*24; break;
        case 'w': timeout *= 60*60*24*7; break;  /* that's fair enough, I think :) */
        }
        
        switch (sign) {
        case '!': timeout = time(NULL) - timeout; break;
        case '+':
        default:  timeout += time(NULL); break;
        }
        
        if (number) SAFE_FREE(number);
        return timeout; 
}

static int net_cache_add	(	int	argc,
		const char **	argv
	)			[static]

Add an entry to the cache.

If it does exist, then set it.

引数:

argv

key, value and timeout are passed in command line

戻り値:

0 on success, otherwise failure

net_cache.c の 152 行で定義されています。

参照先 d_fprintf()・d_printf()・gencache_set()・gencache_shutdown()・parse_timeout()・timeout.

参照元 net_cache().

{
        const char *keystr, *datastr, *timeout_str;
        time_t timeout;
        
        if (argc < 3) {
                d_printf("\nUsage: net cache add <key string> <data string> <timeout>\n");
                return -1;
        }
        
        keystr = argv[0];
        datastr = argv[1];
        timeout_str = argv[2];
        
        /* parse timeout given in command line */
        timeout = parse_timeout(timeout_str);
        if (!timeout) {
                d_fprintf(stderr, "Invalid timeout argument.\n");
                return -1;
        }
        
        if (gencache_set(keystr, datastr, timeout)) {
                d_printf("New cache entry stored successfully.\n");
                gencache_shutdown();
                return 0;
        }
        
        d_fprintf(stderr, "Entry couldn't be added. Perhaps there's already such a key.\n");
        gencache_shutdown();
        return -1;
}

static int net_cache_del	(	int	argc,
		const char **	argv
	)			[static]

Delete an entry in the cache

引数:

argv

key to delete an entry of

戻り値:

0 on success, otherwise failure

net_cache.c の 190 行で定義されています。

参照先 d_fprintf()・d_printf()・gencache_del().

参照元 net_cache().

{
        const char *keystr = argv[0];
        
        if (argc < 1) {
                d_printf("\nUsage: net cache del <key string>\n");
                return -1;
        }
        
        if(gencache_del(keystr)) {
                d_printf("Entry deleted.\n");
                return 0;
        }

        d_fprintf(stderr, "Couldn't delete specified entry\n");
        return -1;
}

static int net_cache_get	(	int	argc,
		const char **	argv
	)			[static]

Get and display an entry from the cache

引数:

argv

key to search an entry of

戻り値:

0 on success, otherwise failure

net_cache.c の 215 行で定義されています。

参照先 d_fprintf()・d_printf()・gencache_get()・print_cache_entry()・timeout.

参照元 net_cache().

{
        const char* keystr = argv[0];
        char* valuestr;
        time_t timeout;

        if (argc < 1) {
                d_printf("\nUsage: net cache get <key>\n");
                return -1;
        }
        
        if (gencache_get(keystr, &valuestr, &timeout)) {
                print_cache_entry(keystr, valuestr, timeout, NULL);
                return 0;
        }

        d_fprintf(stderr, "Failed to find entry\n");
        return -1;
}

static int net_cache_search	(	int	argc,
		const char **	argv
	)			[static]

Search an entry/entries in the cache

引数:

argv

key pattern to match the entries to

戻り値:

0 on success, otherwise failure

net_cache.c の 242 行で定義されています。

参照先 d_printf()・gencache_iterate()・print_cache_entry().

参照元 net_cache().

{
        const char* pattern;
        
        if (argc < 1) {
                d_printf("Usage: net cache search <pattern>\n");
                return -1;
        }
        
        pattern = argv[0];
        gencache_iterate(print_cache_entry, NULL, pattern);
        return 0;
}

static int net_cache_list	(	int	argc,
		const char **	argv
	)			[static]

List the contents of the cache

引数:

argv

ignored in this functionailty

戻り値:

always returns 0

net_cache.c の 263 行で定義されています。

参照先 gencache_iterate()・gencache_shutdown()・print_cache_entry().

参照元 net_cache().

{
        const char* pattern = "*";
        gencache_iterate(print_cache_entry, NULL, pattern);
        gencache_shutdown();
        return 0;
}

static int net_cache_flush	(	int	argc,
		const char **	argv
	)			[static]

Flush the whole cache

引数:

argv

ignored in this functionality

戻り値:

always returns 0

net_cache.c の 278 行で定義されています。

参照先 delete_cache_entry()・gencache_iterate()・gencache_shutdown().

参照元 net_cache().

{
        const char* pattern = "*";
        gencache_iterate(delete_cache_entry, NULL, pattern);
        gencache_shutdown();
        return 0;
}

static int net_cache_usage	(	int	argc,
		const char **	argv
	)			[static]

Short help

引数:

argv

ignored in this functionality

戻り値:

always returns -1

net_cache.c の 293 行で定義されています。

参照先 d_printf().

参照元 net_cache().

{
        d_printf("  net cache add \t add add new cache entry\n");
        d_printf("  net cache del \t delete existing cache entry by key\n");
        d_printf("  net cache flush \t delete all entries existing in the cache\n");
        d_printf("  net cache get \t get cache entry by key\n");
        d_printf("  net cache search \t search for entries in the cache, by given pattern\n");
        d_printf("  net cache list \t list all cache entries (just like search for \"*\")\n");
        return -1;
}

int net_cache	(	int	argc,
		const char **	argv
	)

Entry point to 'net cache' subfunctionality

引数:

argv

arguments passed to further called functions

戻り値:

whatever further functions return

net_cache.c の 311 行で定義されています。

参照先 net_cache_add()・net_cache_del()・net_cache_flush()・net_cache_get()・net_cache_list()・net_cache_search()・net_cache_usage()・net_run_function().

{
        struct functable func[] = {
                {"add", net_cache_add},
                {"del", net_cache_del},
                {"get", net_cache_get},
                {"search", net_cache_search},
                {"list", net_cache_list},
                {"flush", net_cache_flush},
                {NULL, NULL}
        };

        return net_run_function(argc, argv, func, net_cache_usage);
}

---