* are doing, by using the specific flag O_CIPHERTEXT.
* This flag is only compatible with O_DIRECT IOs, to make sure ciphertext
* data is wiped from page cache once IOs are finished.
+ *
+ * Return:
+ * * %0 - On success
+ * * %-ERRNO: On Failure
*/
int ll_file_open_encrypt(struct inode *inode, struct file *filp)
{
* llcrypt_match_name(), but Lustre server side is not aware of encryption.
* FID and name hash can then easily be extracted and put into the
* requests sent to servers.
+ *
+ * Return:
+ * * %0: Success (filename prepared correctly for the lookup operation)
+ * * %-ERRNO: Failure
*/
int ll_prepare_lookup(struct inode *dir, struct dentry *de,
struct llcrypt_name *fname, struct lu_fid *fid)
* present to users the encoded struct ll_digest_filename, instead of a digested
* name. FID and name hash can then easily be extracted and put into the
* requests sent to servers.
+ *
+ * Return:
+ * * %0: Success
+ * * %-ERRNO: On Failure
*/
int ll_setup_filename(struct inode *dir, const struct qstr *iname,
int lookup, struct llcrypt_name *fname,
* symlink target when the encryption key is not available, in a way that is
* compatible with the overlay function ll_setup_filename(), so that further
* readlink without the encryption key works properly.
+ *
+ * Return:
+ * * %Valid pointer: Success
+ * * %error pointer: On Failure
*/
const char *ll_get_symlink(struct inode *inode, const void *caddr,
unsigned int max_size,
* present to users the encoded struct ll_digest_filename, instead of a digested
* name. FID and name hash can then easily be extracted and put into the
* requests sent to servers.
+ *
+ * Return:
+ * * %0: Success
+ * * %-ERRNO: On Failure
*/
int ll_fname_disk_to_usr(struct inode *inode,
u32 hash, u32 minor_hash,
lli->lli_open_fd_count);
}
-/* Open a file, and (for the very first open) create objects on the OSTs at
+/**
+ * ll_file_open() - setup and handle file open
+ * @inode: inode of the file being opened
+ * @file: Open file pointer in the kernel
+ *
+ * Open a file, and (for the very first open) create objects on the OSTs at
* this time. If opened with O_LOV_DELAY_CREATE, then we don't do the object
* creation or open until ll_lov_setstripe() ioctl is called.
*
* used. We might be able to avoid races of that sort by getting lli_open_sem
* before returning in the O_LOV_DELAY_CREATE case and dropping it here
* or in ll_file_release(), but I'm not sure that is desirable/necessary.
+ *
+ * Return:
+ * * %0: Success
+ * * %-ERRNO: Failure
*/
int ll_file_open(struct inode *inode, struct file *file)
{
RETURN(ERR_PTR(rc));
}
-/*
- * Check whether a layout swap can be done between two inodes.
- *
- * \param[in] inode1 First inode to check
- * \param[in] inode2 Second inode to check
+/**
+ * ll_check_swap_layouts_validity() - Check whether a layout swap can be done
+ * between two inodes.
+ * @inode1: First inode to check
+ * @inode2: Second inode to check
*
- * \retval 0 on success, layout swap can be performed between both inodes
- * \retval negative error code if requirements are not met
+ * Return:
+ * * %0 on success, layout swap can be performed between both inodes
+ * * %negative error code if requirements are not met
*/
static int ll_check_swap_layouts_validity(struct inode *inode1,
struct inode *inode2)
RETURN(result > 0 ? result : rc);
}
-/*
+/**
+ * ll_do_fast_read() - read data directly from the page cache
+ * @iocb: kiocb from kernel
+ * @iter: user space buffers where the data will be copied
+ *
* The purpose of fast read is to overcome per I/O overhead and improve IOPS
* especially for small I/O.
*
* doesn't make the situation worse on single node but it may interleave write
* results from multiple nodes due to short read handling in ll_file_aio_read().
*
- * \param env - lu_env
- * \param iocb - kiocb from kernel
- * \param iter - user space buffers where the data will be copied
- *
- * \retval - number of bytes have been read, or error code if error occurred.
+ * Returns number of bytes have been read, or error code if error occurred.
*/
static ssize_t
ll_do_fast_read(struct kiocb *iocb, struct iov_iter *iter)
return result;
}
-/*
- * Confine read iter lest read beyond the EOF
- *
- * \param iocb [in] kernel iocb
- * \param to [in] reader iov_iter
+/**
+ * file_read_confine_iter() - Confine read iter lest read beyond the EOF
+ * @env: execution environment for this thread
+ * @iocb: kernel iocb
+ * @to: reader iov_iter
*
- * \retval <0 failure
- * \retval 0 success
- * \retval >0 @iocb->ki_pos has passed the EOF
+ * Returns:
+ * * %0 success
+ * * <0 failure
+ * * >0 @iocb->ki_pos has passed the EOF
*/
static int file_read_confine_iter(struct lu_env *env, struct kiocb *iocb,
struct iov_iter *to)
}
/**
- * Close inode open handle
- *
- * \param dentry [in] dentry which contains the inode
- * \param it [in,out] intent which contains open info and result
+ * ll_release_openhandle() - Close inode open handle
+ * @dentry: dentry which contains the inode
+ * @it: [in,out] intent which contains open info and result
*
- * \retval 0 success
- * \retval <0 failure
+ * Return:
+ * * %0: Success
+ * * <0: Failure
*/
int ll_release_openhandle(struct dentry *dentry, struct lookup_intent *it)
{
RETURN(result);
}
-/*
- * This value is computed using stripe object version on OST.
- * Version is computed using server side locking.
- *
- * @param flags if do sync on the OST side;
+/**
+ * ll_data_version() - retrieve the data version of a file
+ * @inode: inode of the file for which the data version is being queried
+ * @data_version: store the retrieved data version
+ * @flags: if do sync on the OST side;
* 0: no sync
* LL_DV_RD_FLUSH: flush dirty pages, LCK_PR on OSTs
* LL_DV_WR_FLUSH: drop all caching pages, LCK_PW on OSTs
+ *
+ * This value is computed using stripe object version on OST.
+ * Version is computed using server side locking.
+ *
+ * Return:
+ * * %0: Success
+ * * %<0: Failure
*/
int ll_data_version(struct inode *inode, __u64 *data_version, int flags)
{
static const char *const user_lockname[] = LOCK_MODE_NAMES;
-/* Used to allow the upper layers of the client to request an LDLM lock
+/**
+ * ll_file_lock_ahead() -
+ * @file: file this ladvise lock request is on
+ * @ladvise: ladvise struct describing this lock request
+ *
+ * Used to allow the upper layers of the client to request an LDLM lock
* without doing an actual read or write.
*
* Used for ladvise lockahead to manually request specific locks.
*
- * \param[in] file file this ladvise lock request is on
- * \param[in] ladvise ladvise struct describing this lock request
- *
- * \retval 0 success, no detailed result available (sync requests
- * and requests sent to the server [not handled locally]
- * cannot return detailed results)
- * \retval LLA_RESULT_{SAME,DIFFERENT} - detailed result of the lock request,
+ * Return:
+ * * %0: success, no detailed result available (sync requests
+ * and requests sent to the server [not handled locally]
+ * cannot return detailed results)
+ * * %<0: negative errno on error
+ * * LLA_RESULT_{SAME,DIFFERENT} - detailed result of the lock request,
* see definitions for details.
- * \retval negative negative errno on error
*/
int ll_file_lock_ahead(struct file *file, struct llapi_lu_ladvise *ladvise)
{
}
/**
- * Issue layout intent RPC to MDS.
- * \param inode [in] file inode
- * \param intent [in] layout intent
+ * ll_layout_intent() - Issue layout intent RPC to MDS.
+ * @inode: file inode
+ * @intent: layout intent
*
- * \retval 0 on success
- * \retval < 0 error code
+ * Return:
+ * * %0 on success
+ * * %<0 error code
*/
static int ll_layout_intent(struct inode *inode, struct layout_intent *intent)
{
}
/**
- * Issue layout intent RPC indicating where in a file an IO is about to write.
+ * ll_layout_write_intent() - Issue layout intent RPC indicating where in a file
+ * an IO is about to write.
+ * @inode: file inode.
+ * @opc: type of layout operation being requested
+ * @ext: write range with start offset of fille in bytes where an IO is
+ * about to write, and exclusive end offset in bytes.
*
- * \param[in] inode file inode.
- * \param[in] ext write range with start offset of fille in bytes where
- * an IO is about to write, and exclusive end offset in
- * bytes.
- *
- * \retval 0 on success
- * \retval < 0 error code
+ * Return:
+ * * %0 on success
+ * * <0 error code
*/
int ll_layout_write_intent(struct inode *inode, enum layout_intent_opc opc,
struct lu_extent *ext)
git://git.whamcloud.com / fs / lustre-release.git / commitdiff