libsmb/namecache.c

ソースコードを見る。

関数
BOOL	namecache_enable (void)
	Initialise namecache system.
BOOL	namecache_shutdown (void)
	Shutdown namecache.
static char *	namecache_key (const char *name, int name_type)
	Generates a key for netbios name lookups on basis of netbios name and type.
BOOL	namecache_store (const char *name, int name_type, int num_names, struct ip_service *ip_list)
	Store a name(s) in the name cache
BOOL	namecache_fetch (const char *name, int name_type, struct ip_service **ip_list, int *num_names)
	Look up a name in the cache.
BOOL	namecache_delete (const char *name, int name_type)
	Remove a namecache entry.
static void	flush_netbios_name (const char *key, const char *value, time_t timeout, void *dptr)
	Delete single namecache entry.
void	namecache_flush (void)
	Flush all names from the name cache.
static char *	namecache_status_record_key (const char *name, int name_type1, int name_type2, struct in_addr keyip)
BOOL	namecache_status_store (const char *keyname, int keyname_type, int name_type, struct in_addr keyip, const char *srvname)
BOOL	namecache_status_fetch (const char *keyname, int keyname_type, int name_type, struct in_addr keyip, char *srvname_out)

---

関数

BOOL namecache_enable

(

void

)

Initialise namecache system.

Function calls gencache initialisation function to perform necessary actions

戻り値:

true upon successful initialisation of the cache or false on failure

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

参照先 gencache_init().

参照元 main().

{
        /*
         * Check if name caching disabled by setting the name cache
         * timeout to zero.
         */ 

        if (lp_name_cache_timeout() == 0) {
                DEBUG(5, ("namecache_enable: disabling netbios name cache\n"));
                return False;
        }

        /* Init namecache by calling gencache initialisation */

        if (!gencache_init()) {
                DEBUG(2, ("namecache_enable: Couldn't initialise namecache on top of gencache.\n"));
                return False;
        }

        /* I leave it for now, though I don't think we really need this (mimir, 27.09.2002) */
        DEBUG(5, ("namecache_enable: enabling netbios namecache, timeout %d "
                  "seconds\n", lp_name_cache_timeout()));

        return True;
}

BOOL namecache_shutdown

(

void

)

Shutdown namecache.

Routine calls gencache close function to safely close gencache file.

戻り値:

true upon successful shutdown of the cache or false on failure

namecache.c の 72 行で定義されています。

参照先 gencache_shutdown().

参照元 main()・send_fs_socket().

{
        if (!gencache_shutdown()) {
                DEBUG(2, ("namecache_shutdown: Couldn't close namecache on top of gencache.\n"));
                return False;
        }
        
        DEBUG(5, ("namecache_shutdown: netbios namecache closed successfully.\n"));
        return True;
}

static char* namecache_key	(	const char *	name,
		int	name_type
	)			[static]

Generates a key for netbios name lookups on basis of netbios name and type.

The caller must free returned key string when finished.

引数:

	name	netbios name string (case insensitive)
	name_type	netbios type of the name being looked up

戻り値:

string consisted of uppercased name and appended type number

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

参照先 asprintf()・strupper_static().

参照元 namecache_delete()・namecache_fetch()・namecache_store().

{
        char *keystr;
        asprintf(&keystr, NBTKEY_FMT, strupper_static(name), name_type);

        return keystr;
}

BOOL namecache_store	(	const char *	name,
		int	name_type,
		int	num_names,
		struct ip_service *	ip_list
	)

Store a name(s) in the name cache

引数:

	name	netbios names array
	name_type	integer netbios name type
	num_names	number of names being stored
	ip_list	array of in_addr structures containing ip addresses being stored

namecache.c の 115 行で定義されています。

参照先 DEBUGLEVEL・gencache_init()・gencache_set()・ipstr_list_make()・namecache_key()・port.

参照元 dcip_to_name()・internal_resolve_name().

{
        time_t expiry;
        char *key, *value_string;
        int i;
        BOOL ret;

        /*
         * we use gecache call to avoid annoying debug messages about
         * initialised namecache again and again...
         */
        if (!gencache_init()) return False;

        if (name_type > 255) {
                return False; /* Don't store non-real name types. */
        }

        if ( DEBUGLEVEL >= 5 ) {
                DEBUG(5, ("namecache_store: storing %d address%s for %s#%02x: ",
                        num_names, num_names == 1 ? "": "es", name, name_type));

                for (i = 0; i < num_names; i++) 
                        DEBUGADD(5, ("%s:%d%s", inet_ntoa(ip_list[i].ip), 
                                ip_list[i].port, (i == (num_names - 1) ? "" : ",")));
                        
                DEBUGADD(5, ("\n"));
        }
        
        key = namecache_key(name, name_type);
        if (!key) {
                return False;
        }

        expiry = time(NULL) + lp_name_cache_timeout();

        /*
         * Generate string representation of ip addresses list
         * First, store the number of ip addresses and then
         * place each single ip
         */
        if (!ipstr_list_make(&value_string, ip_list, num_names)) {
                SAFE_FREE(key);
                SAFE_FREE(value_string);
                return False;
        }
        
        /* set the entry */
        ret = gencache_set(key, value_string, expiry);
        SAFE_FREE(key);
        SAFE_FREE(value_string);
        return ret;
}

BOOL namecache_fetch	(	const char *	name,
		int	name_type,
		struct ip_service **	ip_list,
		int *	num_names
	)

Look up a name in the cache.

引数:

	name	netbios name to look up for
	name_type	netbios name type of
	name
	ip_list	mallocated list of IP addresses if found in the cache, NULL otherwise
	num_names	number of entries found

戻り値:

true upon successful fetch or false if name isn't found in the cache or has expired

namecache.c の 183 行で定義されています。

参照先 gencache_get()・gencache_init()・ipstr_list_parse()・namecache_key()・timeout.

参照元 internal_resolve_name().

{
        char *key, *value;
        time_t timeout;

        /* exit now if null pointers were passed as they're required further */
        if (!ip_list || !num_names) return False;

        if (!gencache_init())
                return False;

        if (name_type > 255) {
                return False; /* Don't fetch non-real name types. */
        }

        *num_names = 0;

        /* 
         * Use gencache interface - lookup the key
         */
        key = namecache_key(name, name_type);
        if (!key) {
                return False;
        }

        if (!gencache_get(key, &value, &timeout)) {
                DEBUG(5, ("no entry for %s#%02X found.\n", name, name_type));
                SAFE_FREE(key);
                return False;
        } else {
                DEBUG(5, ("name %s#%02X found.\n", name, name_type));
        }
        
        /*
         * Split up the stored value into the list of IP adresses
         */
        *num_names = ipstr_list_parse(value, ip_list);
        
        SAFE_FREE(key);
        SAFE_FREE(value);
                         
        return *num_names > 0;          /* true only if some ip has been fetched */
}

BOOL namecache_delete	(	const char *	name,
		int	name_type
	)

Remove a namecache entry.

Needed for site support.

namecache.c の 233 行で定義されています。

参照先 gencache_del()・gencache_init()・namecache_key().

参照元 ads_dc_name()・ads_find_dc()・ads_startup_int().

{
        BOOL ret;
        char *key;

        if (!gencache_init())
                return False;

        if (name_type > 255) {
                return False; /* Don't fetch non-real name types. */
        }

        key = namecache_key(name, name_type);
        if (!key) {
                return False;
        }
        ret = gencache_del(key);
        SAFE_FREE(key);
        return ret;
}

static void flush_netbios_name	(	const char *	key,
		const char *	value,
		time_t	timeout,
		void *	dptr
	)			[static]

Delete single namecache entry.

Look at the gencache_iterate definition.

namecache.c の 260 行で定義されています。

参照先 gencache_del().

参照元 namecache_flush().

{
        gencache_del(key);
        DEBUG(5, ("Deleting entry %s\n", key));
}

void namecache_flush

(

void

)

Flush all names from the name cache.

It's done by gencache_iterate()

戻り値:

True upon successful deletion or False in case of an error

namecache.c の 275 行で定義されています。

参照先 flush_netbios_name()・gencache_init()・gencache_iterate().

{
        if (!gencache_init())
                return;

        /* 
         * iterate through each NBT cache's entry and flush it
         * by flush_netbios_name function
         */
        gencache_iterate(flush_netbios_name, NULL, "NBT/*");
        DEBUG(5, ("Namecache flushed\n"));
}

static char* namecache_status_record_key	(	const char *	name,
		int	name_type1,
		int	name_type2,
		struct in_addr	keyip
	)			[static]

namecache.c の 290 行で定義されています。

参照先 asprintf()・strupper_static().

参照元 namecache_status_fetch()・namecache_status_store().

{
        char *keystr;

        asprintf(&keystr, "NBT/%s#%02X.%02X.%s",
                        strupper_static(name), name_type1, name_type2, inet_ntoa(keyip));
        return keystr;
}

BOOL namecache_status_store	(	const char *	keyname,
		int	keyname_type,
		int	name_type,
		struct in_addr	keyip,
		const char *	srvname
	)

namecache.c の 302 行で定義されています。

参照先 gencache_init()・gencache_set()・namecache_status_record_key().

参照元 name_status_find().

{
        char *key;
        time_t expiry;
        BOOL ret;

        if (!gencache_init())
                return False;

        key = namecache_status_record_key(keyname, keyname_type, name_type, keyip);
        if (!key)
                return False;

        expiry = time(NULL) + lp_name_cache_timeout();
        ret = gencache_set(key, srvname, expiry);

        if (ret)
                DEBUG(5, ("namecache_status_store: entry %s -> %s\n", key, srvname ));
        else
                DEBUG(5, ("namecache_status_store: entry %s store failed.\n", key ));

        SAFE_FREE(key);
        return ret;
}

BOOL namecache_status_fetch	(	const char *	keyname,
		int	keyname_type,
		int	name_type,
		struct in_addr	keyip,
		char *	srvname_out
	)

namecache.c の 331 行で定義されています。

参照先 gencache_get()・gencache_init()・namecache_status_record_key()・strlcpy()・timeout.

参照元 name_status_find().

{
        char *key = NULL;
        char *value = NULL;
        time_t timeout;

        if (!gencache_init())
                return False;

        key = namecache_status_record_key(keyname, keyname_type, name_type, keyip);
        if (!key)
                return False;

        if (!gencache_get(key, &value, &timeout)) {
                DEBUG(5, ("namecache_status_fetch: no entry for %s found.\n", key));
                SAFE_FREE(key);
                return False;
        } else {
                DEBUG(5, ("namecache_status_fetch: key %s -> %s\n", key, value ));
        }

        strlcpy(srvname_out, value, 16);
        SAFE_FREE(key);
        SAFE_FREE(value);
        return True;
}

---