.cld_mode = CLM_READ
};
-/*
- * Check whether file has possible unwritten pages.
+/**
+ * dirty_cnt() - Check whether file has possible unwritten pages.
+ * @inode: inode being checked for dirtyness
*
- * \retval 1 file is mmap-ed or has dirty pages
- * 0 otherwise
+ * Return:
+ * * %1 file is mmap-ed or has dirty pages
+ * * %0 otherwise
*/
blkcnt_t dirty_cnt(struct inode *inode)
{
}
/**
- * Get an IO environment for special operations such as glimpse locks and
- * manually requested locks (ladvise lockahead)
- *
- * \param[in] inode inode the operation is being performed on
- * \param[out] envout thread specific execution environment
- * \param[out] ioout client io description
- * \param[out] refcheck reference check
+ * cl_io_get() - Get an IO environment for special operations such as glimpse
+ * locks and manually requested locks (ladvise lockahead)
+ * @inode: inode the operation is being performed on
+ * @envout: thread specific execution environment
+ * @ioout: client io description
+ * @refcheck: reference check
*
- * \retval 1 on success
- * \retval 0 not a regular file, cannot get environment
- * \retval negative negative errno on error
+ * Return:
+ * * %1 on success
+ * * %0 not a regular file, cannot get environment
+ * * %negative negative errno on error
*/
int cl_io_get(struct inode *inode, struct lu_env **envout,
struct cl_io **ioout, u16 *refcheck)
#define log2(n) ffz(~(n))
#endif
-/**
+/*
* If there is only one number of core visible to Lustre,
* async readahead will be disabled, to avoid massive over
* subscription, we use 1/2 of active cores as default max
RETURN(rc);
}
-/* Get the value of the default_easize parameter.
- *
- * \see client_obd::cl_default_mds_easize
- *
- * \param[in] sbi superblock info for this filesystem
- * \param[out] lmmsize pointer to storage location for value
+/**
+ * ll_get_default_mdsize() - Get the value of the default_easize parameter.
+ * see client_obd::cl_default_mds_easize
+ * @sbi: superblock info for this filesystem
+ * @lmmsize: pointer to storage location for value
*
- * \retval 0 on success
- * \retval negative negated errno on failure
+ * Return:
+ * * %0 on success
+ * * %negative negated errno on failure
*/
int ll_get_default_mdsize(struct ll_sb_info *sbi, int *lmmsize)
{
RETURN(rc);
}
-/*
- * Set the default_easize parameter to the given value.
- *
- * \see client_obd::cl_default_mds_easize
- *
- * \param[in] sbi superblock info for this filesystem
- * \param[in] lmmsize the size to set
+/**
+ * ll_set_default_mdsize() - Set the default_easize parameter to the given
+ * value. see client_obd::cl_default_mds_easize
+ * @sbi: superblock info for this filesystem
+ * @lmmsize: the size to set
*
- * \retval 0 on success
- * \retval negative negated errno on failure
+ * Return:
+ * * %0 on success
+ * * %negative negated errno on failure
*/
int ll_set_default_mdsize(struct ll_sb_info *sbi, int lmmsize)
{
RETURN(rc);
}
-/* Zero portion of page that is part of @inode.
+/**
+ * ll_io_zero_page() - Zero portion of page that is part of @inode.
+ * @inode: inode in operation
+ * @index: page index
+ * @offset: offset in page to start zero from
+ * @len: len to zero
+ *
* This implies, if necessary:
* - taking cl_lock on range corresponding to concerned page
* - grabbing vm page
* - proceeding to cl_page flush
* - releasing cl_lock
*
- * \param[in] inode inode
- * \param[in] index page index
- * \param[in] offset offset in page to start zero from
- * \param[in] len len to zero
- *
- * \retval 0 on success
- * \retval negative errno on failure
+ * Return:
+ * * %0 on success
+ * * %negative errno on failure
*/
static int ll_io_zero_page(struct inode *inode, pgoff_t index, pgoff_t offset,
unsigned int len)
RETURN(rc);
}
-/* Get reference file from volatile file name.
+/**
+ * volatile_ref_file() - Get reference file from volatile file name.
+ * @volatile_name: volatile file name
+ * @volatile_len: volatile file name length
+ * @ref_file: pointer to struct file of reference file
+ *
* Volatile file name may look like:
* <parent>/LUSTRE_VOLATILE_HDR:<mdt_index>:<random>:fd=<fd>
* where fd is opened descriptor of reference file.
*
- * \param[in] volatile_name volatile file name
- * \param[in] volatile_len volatile file name length
- * \param[out] ref_file pointer to struct file of reference file
- *
- * \retval 0 on success
- * \retval negative errno on failure
+ * Return:
+ * * %0 on success
+ * * %negative errno on failure
*/
int volatile_ref_file(const char *volatile_name, int volatile_len,
struct file **ref_file)
LSM_SEM_CHILD,
};
-/* Update directory depth and default LMV
+/**
+ * ll_update_dir_depth_dmv() - Update directory depth and default LMV
+ * @dir: parent directory inode
+ * @de: dentry
*
* Update directory depth to ROOT and inherit default LMV from parent if
* parent's default LMV is inheritable. The default LMV set with command
* "lfs setdirstripe -D ..." is stored on MDT, while the inherited default LMV
* is generated at runtime on client side.
- *
- * \param[in] dir parent directory inode
- * \param[in] de dentry
*/
void ll_update_dir_depth_dmv(struct inode *dir, struct dentry *de)
{
return 0;
}
-/* Cleanup the open handle that is cached on MDT-side.
+/**
+ * ll_open_cleanup() - Cleanup the open handle that is cached on MDT-side.
+ * @sb: super block for this file-system
+ * @pill: pointer to the original open request message
*
* For open case, the client side open handling thread may hit error
* after the MDT grant the open. Under such case, the client should
* holds the reference on such file/object, then it will block the
* subsequent threads that want to locate such object via FID.
*
- * \param[in] sb super block for this file-system
- * \param[in] open_req pointer to the original open request
*/
void ll_open_cleanup(struct super_block *sb, struct req_capsule *pill)
{
RETURN(0);
}
-/*
- * Get obd name by cmd, and copy out to user space
- */
+/* Get obd name by cmd, and copy out to user space */
int ll_get_obd_name(struct inode *inode, unsigned int cmd, void __user *uarg)
{
struct ll_sb_info *sbi = ll_i2sbi(inode);
}
/*
- * Parse linkea content to extract information about a given hardlink
- *
- * \param[in] ldata - Initialized linkea data
- * \param[in] linkno - Link identifier
- * \param[out] parent_fid - The entry's parent FID
- * \param[out] ln - Entry name destination buffer
+ * ll_linkea_decode() - Parse linkea content to extract information about a
+ * given hardlink
+ * @ldata: Initialized linkea data
+ * @linkno: Link identifier
+ * @parent_fid: The entry's parent FID
+ * @ln: Entry name destination buffer
*
- * \retval 0 on success
- * \retval Appropriate negative error code on failure
+ * Return:
+ * * %0 on success
+ * * Appropriate negative error code on failure
*/
static int ll_linkea_decode(struct linkea_data *ldata, unsigned int linkno,
struct lu_fid *parent_fid, struct lu_name *ln)
RETURN(0);
}
-/*
- * Get parent FID and name of an identified link. Operation is performed for
- * a given link number, letting the caller iterate over linkno to list one or
- * all links of an entry.
- *
- * \param[in] file - File descriptor against which to perform the operation
- * \param[in,out] arg - User-filled structure containing the linkno to operate
- * on and the available size. It is eventually filled with
- * the requested information or left untouched on error
+/**
+ * ll_getparent() - Get parent FID and name of an identified link.
+ * Operation is performed for a given link number, letting the caller
+ * iterate over linkno to list one or all links of an entry.
+ * @file: File descriptor against which to perform the operation
+ * @arg: User-filled structure containing the linkno to operate on and
+ * the available size. It is eventually filled with the requested information
+ * or left untouched on error
*
- * \retval - 0 on success
- * \retval - Appropriate negative error code on failure
+ * Return:
+ * * %0 on success
+ * * Appropriate negative error code on failure
*/
int ll_getparent(struct file *file, struct getparent __user *arg)
{
git://git.whamcloud.com / fs / lustre-release.git / commitdiff