Re: [PATCH 2/4] VFS: swap do_ioctl and vfs_ioctl names

[Randy Dunlap]

On Sun, 28 Oct 2007 20:40:56 -0400 Erez Zadok wrote:

> Rename old vfs_ioctl to do_ioctl, because the comment above it clearly
> indicates that it is an internal function not to be exported to modules;
> therefore it should have a more traditional do_XXX name.  The new do_ioctl
> is exported in fs.h but not to modules.
> 
> Rename the old do_ioctl to vfs_ioctl because the names vfs_XXX should
> preferably be reserved to callable VFS functions which modules may call, as
> many other vfs_XXX functions already do.  Export the new vfs_ioctl to GPL
> modules so others can use it (including Unionfs and eCryptfs).  Add DocBook
> for new vfs_ioctl.
> 
> Signed-off-by: Erez Zadok <ezk@xxxxxxxxxxxxx>
> ---
>  fs/compat_ioctl.c  |    2 +-
>  fs/ioctl.c         |   30 ++++++++++++++++++++++--------
>  include/linux/fs.h |    3 ++-
>  3 files changed, 25 insertions(+), 10 deletions(-)
> 

> diff --git a/fs/ioctl.c b/fs/ioctl.c
> index 652cacf..34e3f58 100644
> --- a/fs/ioctl.c
> +++ b/fs/ioctl.c
> @@ -16,8 +16,21 @@
>  
>  #include <asm/ioctls.h>
>  
> -static long do_ioctl(struct file *filp, unsigned int cmd,
> -		unsigned long arg)
> +/**
> + * vfs_ioctl - call filesystem specific ioctl methods
> + *

No "blank" line allowed in kernel-doc between function name and its
parameters.

> + * @filp: [in]     open file to invoke ioctl method on
> + * @cmd:  [in]     ioctl command to execute
> + * @arg:  [in/out] command-specific argument for ioctl
> + *
> + * Invokes filesystem specific ->unlock_ioctl, if one exists; otherwise
> + * invokes * filesystem specific ->ioctl method.  If neither method exists,
> + * returns -ENOTTY.
> + *
> + * Returns 0 on success, -errno on error.
> + */
> +long vfs_ioctl(struct file *filp, unsigned int cmd,
> +	       unsigned long arg)
>  {
>  	int error = -ENOTTY;
>  

> diff --git a/include/linux/fs.h b/include/linux/fs.h
> index b3ec4a4..c0c5d36 100644
> --- a/include/linux/fs.h
> +++ b/include/linux/fs.h
> @@ -1924,7 +1924,8 @@ extern int vfs_stat_fd(int dfd, char __user *, struct kstat *);
>  extern int vfs_lstat_fd(int dfd, char __user *, struct kstat *);
>  extern int vfs_fstat(unsigned int, struct kstat *);
>  
> -extern int vfs_ioctl(struct file *, unsigned int, unsigned int, unsigned long);
> +extern long vfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
> +extern int do_ioctl(struct file *, unsigned int, unsigned int, unsigned long);

Use/keep parameter names, please.  That is preferred.

>  extern void get_filesystem(struct file_system_type *fs);
>  extern void put_filesystem(struct file_system_type *fs);
> -- 
> 1.5.2.2
> 
> -
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/
> 


---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/