/*
Copyright (c) 2008-2012 Red Hat, Inc. <http://www.redhat.com>
This file is part of GlusterFS.
This file is licensed to you under your choice of the GNU Lesser
General Public License, version 3 or any later version (LGPLv3 or
later), or the GNU General Public License, version 2 (GPLv2), in all
cases as published by the Free Software Foundation.
*/
#ifndef _INODE_H
#define _INODE_H
#include <stdint.h>
#include <sys/types.h>
#define LOOKUP_NEEDED 1
#define LOOKUP_NOT_NEEDED 2
#define DEFAULT_INODE_MEMPOOL_ENTRIES 32 * 1024
#define INODE_PATH_FMT "<gfid:%s>"
struct _inode_table;
typedef struct _inode_table inode_table_t;
struct _inode;
typedef struct _inode inode_t;
struct _dentry;
typedef struct _dentry dentry_t;
#include "glusterfs/list.h"
#include "glusterfs/iatt.h"
#include "glusterfs/compat-uuid.h"
#include "glusterfs/fd.h"
struct _inode_table {
pthread_mutex_t lock;
size_t hashsize; /* bucket size of inode hash and dentry hash */
char *name; /* name of the inode table, just for gf_log() */
inode_t *root; /* root directory inode, with number 1 */
xlator_t *xl; /* xlator to be called to do purge */
uint32_t lru_limit; /* maximum LRU cache size */
struct list_head *inode_hash; /* buckets for inode hash table */
struct list_head *name_hash; /* buckets for dentry hash table */
struct list_head active; /* list of inodes currently active (in an fop) */
uint32_t active_size; /* count of inodes in active list */
struct list_head lru; /* list of inodes recently used.
lru.next most recent */
uint32_t lru_size; /* count of inodes in lru list */
struct list_head purge; /* list of inodes to be purged soon */
uint32_t purge_size; /* count of inodes in purge list */
struct mem_pool *inode_pool; /* memory pool for inodes */
struct mem_pool *dentry_pool; /* memory pool for dentrys */
struct mem_pool *fd_mem_pool; /* memory pool for fd_t */
int ctxcount; /* number of slots in inode->ctx */
/* This is required for 'invalidation' when 'nlookup' would be used,
specially in case of fuse-bridge */
int32_t (*invalidator_fn)(xlator_t *, inode_t *);
xlator_t *invalidator_xl;
struct list_head invalidate; /* inodes which are in invalidation queue */
uint32_t invalidate_size; /* count of inodes in invalidation list */
};
struct _dentry {
struct list_head inode_list; /* list of dentries of inode */
struct list_head hash; /* hash table pointers */
inode_t *inode; /* inode of this directory entry */
char *name; /* name of the directory entry */
inode_t *parent; /* directory of the entry */
};
struct _inode_ctx {
union {
uint64_t key;
xlator_t *xl_key;
};
/* if value1 is 0, then field is not set.. */
union {
uint64_t value1;
void *ptr1;
};
/* if value2 is 0, then field is not set.. */
union {
uint64_t value2;
void *ptr2;
};
int ref; /* This is for debugging inode ref leaks,
basically helps in identifying the xlator
causing th ref leak, it is printed in
statedump */
};
struct _inode {
inode_table_t *table; /* the table this inode belongs to */
uuid_t gfid;
gf_lock_t lock;
gf_atomic_t nlookup;
uint32_t fd_count; /* Open fd count */
uint32_t active_fd_count; /* Active open fd count */
uint32_t ref; /* reference count on this inode */
ia_type_t ia_type; /* what kind of file */
struct list_head fd_list; /* list of open files on this inode */
struct list_head dentry_list; /* list of directory entries for this inode */
struct list_head hash; /* hash table pointers */
struct list_head list; /* active/lru/purge */
struct _inode_ctx *_ctx; /* replacement for dict_t *(inode->ctx) */
bool in_invalidate_list; /* Set if inode is in table invalidate list */
bool invalidate_sent; /* Set it if invalidator_fn is called for inode */
};
#define UUID0_STR "00000000-0000-0000-0000-000000000000"
#define GFID_STR_PFX "<gfid:" UUID0_STR ">"
#define GFID_STR_PFX_LEN (sizeof(GFID_STR_PFX) - 1)
inode_table_t *
inode_table_new(uint32_t lru_limit, xlator_t *xl);
inode_table_t *
inode_table_with_invalidator(uint32_t lru_limit, xlator_t *xl,
int32_t (*invalidator_fn)(xlator_t *, inode_t *),
xlator_t *invalidator_xl);
void
inode_table_destroy_all(glusterfs_ctx_t *ctx);
void
inode_table_destroy(inode_table_t *inode_table);
inode_t *
inode_new(inode_table_t *table);
inode_t *
inode_link(inode_t *inode, inode_t *parent, const char *name,
struct iatt *stbuf);
void
inode_unlink(inode_t *inode, inode_t *parent, const char *name);
inode_t *
inode_parent(inode_t *inode, uuid_t pargfid, const char *name);
inode_t *
inode_ref(inode_t *inode);
inode_t *
inode_unref(inode_t *inode);
int
inode_lookup(inode_t *inode);
int
inode_forget(inode_t *inode, uint64_t nlookup);
int
inode_forget_with_unref(inode_t *inode, uint64_t nlookup);
int
inode_ref_reduce_by_n(inode_t *inode, uint64_t nref);
int
inode_invalidate(inode_t *inode);
int
inode_rename(inode_table_t *table, inode_t *olddir, const char *oldname,
inode_t *newdir, const char *newname, inode_t *inode,
struct iatt *stbuf);
dentry_t *
__dentry_grep(inode_table_t *table, inode_t *parent, const char *name);
inode_t *
inode_grep(inode_table_t *table, inode_t *parent, const char *name);
int
inode_grep_for_gfid(inode_table_t *table, inode_t *parent, const char *name,
uuid_t gfid, ia_type_t *type);
inode_t *
inode_find(inode_table_t *table, uuid_t gfid);
int
inode_path(inode_t *inode, const char *name, char **bufp);
int
__inode_path(inode_t *inode, const char *name, char **bufp);
inode_t *
inode_from_path(inode_table_t *table, const char *path);
inode_t *
inode_resolve(inode_table_t *table, char *path);
/* deal with inode ctx's both values */
int
inode_ctx_set2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
int
__inode_ctx_set2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
int
inode_ctx_get2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
int
__inode_ctx_get2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
int
inode_ctx_del2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
int
inode_ctx_reset2(inode_t *inode, xlator_t *xlator, uint64_t *value1,
uint64_t *value2);
/* deal with inode ctx's 1st value */
int
inode_ctx_set0(inode_t *inode, xlator_t *xlator, uint64_t *value1);
int
__inode_ctx_set0(inode_t *inode, xlator_t *xlator, uint64_t *value1);
int
inode_ctx_get0(inode_t *inode, xlator_t *xlator, uint64_t *value1);
int
__inode_ctx_get0(inode_t *inode, xlator_t *xlator, uint64_t *value1);
int
inode_ctx_reset0(inode_t *inode, xlator_t *xlator, uint64_t *value1);
/* deal with inode ctx's 2st value */
int
inode_ctx_set1(inode_t *inode, xlator_t *xlator, uint64_t *value2);
int
__inode_ctx_set1(inode_t *inode, xlator_t *xlator, uint64_t *value2);
int
inode_ctx_get1(inode_t *inode, xlator_t *xlator, uint64_t *value2);
int
__inode_ctx_get1(inode_t *inode, xlator_t *xlator, uint64_t *value2);
int
inode_ctx_reset1(inode_t *inode, xlator_t *xlator, uint64_t *value2);
static inline int
__inode_ctx_put(inode_t *inode, xlator_t *this, uint64_t v)
{
return __inode_ctx_set0(inode, this, &v);
}
static inline int
inode_ctx_put(inode_t *inode, xlator_t *this, uint64_t v)
{
return inode_ctx_set0(inode, this, &v);
}
#define __inode_ctx_set(i, x, v_p) __inode_ctx_set0(i, x, v_p)
#define inode_ctx_set(i, x, v_p) inode_ctx_set0(i, x, v_p)
#define inode_ctx_reset(i, x, v) inode_ctx_reset0(i, x, v)
#define __inode_ctx_get(i, x, v) __inode_ctx_get0(i, x, v)
#define inode_ctx_get(i, x, v) inode_ctx_get0(i, x, v)
#define inode_ctx_del(i, x, v) inode_ctx_del2(i, x, v, 0)
#define inode_ctx_del1(i, x, v) inode_ctx_del2(i, x, 0, v)
gf_boolean_t
__is_root_gfid(uuid_t gfid);
void
__inode_table_set_lru_limit(inode_table_t *table, uint32_t lru_limit);
void
inode_table_set_lru_limit(inode_table_t *table, uint32_t lru_limit);
void
inode_ctx_merge(fd_t *fd, inode_t *inode, inode_t *linked_inode);
int
inode_is_linked(inode_t *inode);
void
inode_set_need_lookup(inode_t *inode, xlator_t *this);
gf_boolean_t
inode_needs_lookup(inode_t *inode, xlator_t *this);
int
inode_has_dentry(inode_t *inode);
size_t
inode_ctx_size(inode_t *inode);
void
inode_find_directory_name(inode_t *inode, const char **name);
#endif /* _INODE_H */