Commit 0d3f7a2d authored by Jeff Layton's avatar Jeff Layton
Browse files

locks: rename file-private locks to "open file description locks" 



File-private locks have been merged into Linux for v3.15, and *now*
people are commenting that the name and macro definitions for the new
file-private locks suck.

...and I can't even disagree. The names and command macros do suck.

We're going to have to live with these for a long time, so it's
important that we be happy with the names before we're stuck with them.
The consensus on the lists so far is that they should be rechristened as
"open file description locks".

The name isn't a big deal for the kernel, but the command macros are not
visually distinct enough from the traditional POSIX lock macros. The
glibc and documentation folks are recommending that we change them to
look like F_OFD_{GETLK|SETLK|SETLKW}. That lessens the chance that a
programmer will typo one of the commands wrong, and also makes it easier
to spot this difference when reading code.

This patch makes the following changes that I think are necessary before
v3.15 ships:

1) rename the command macros to their new names. These end up in the uapi
   headers and so are part of the external-facing API. It turns out that
   glibc doesn't actually use the fcntl.h uapi header, but it's hard to
   be sure that something else won't. Changing it now is safest.

2) make the the /proc/locks output display these as type "OFDLCK"

Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Christoph Hellwig <hch@infradead.org>
Cc: Carlos O'Donell <carlos@redhat.com>
Cc: Stefan Metzmacher <metze@samba.org>
Cc: Andy Lutomirski <luto@amacapital.net>
Cc: Frank Filz <ffilzlnx@mindspring.com>
Cc: Theodore Ts'o <tytso@mit.edu>
Signed-off-by: default avatarJeff Layton <jlayton@redhat.com>
parent f1c6bb2c

arch/arm/kernel/sys_oabi-compat.c

+3 −3
Original line number Diff line number Diff line
@@ -203,9 +203,9 @@ asmlinkage long sys_oabi_fcntl64(unsigned int fd, unsigned int cmd, 
	int ret;



	switch (cmd) {

	case F_GETLKP:

	case F_SETLKP:

	case F_SETLKPW:

	case F_OFD_GETLK:

	case F_OFD_SETLK:

	case F_OFD_SETLKW:

	case F_GETLK64:

	case F_SETLK64:

	case F_SETLKW64:

fs/compat.c

+7 −7
Original line number Diff line number Diff line
@@ -457,9 +457,9 @@ COMPAT_SYSCALL_DEFINE3(fcntl64, unsigned int, fd, unsigned int, cmd, 
	case F_GETLK64:

	case F_SETLK64:

	case F_SETLKW64:

	case F_GETLKP:

	case F_SETLKP:

	case F_SETLKPW:

	case F_OFD_GETLK:

	case F_OFD_SETLK:

	case F_OFD_SETLKW:

		ret = get_compat_flock64(&f, compat_ptr(arg));

		if (ret != 0)

			break;
@@ -468,7 +468,7 @@ COMPAT_SYSCALL_DEFINE3(fcntl64, unsigned int, fd, unsigned int, cmd, 
		conv_cmd = convert_fcntl_cmd(cmd);

		ret = sys_fcntl(fd, conv_cmd, (unsigned long)&f);

		set_fs(old_fs);

		if ((conv_cmd == F_GETLK || conv_cmd == F_GETLKP) && ret == 0) {

		if ((conv_cmd == F_GETLK || conv_cmd == F_OFD_GETLK) && ret == 0) {

			/* need to return lock information - see above for commentary */

			if (f.l_start > COMPAT_LOFF_T_MAX)

				ret = -EOVERFLOW;
@@ -493,9 +493,9 @@ COMPAT_SYSCALL_DEFINE3(fcntl, unsigned int, fd, unsigned int, cmd, 
	case F_GETLK64:

	case F_SETLK64:

	case F_SETLKW64:

	case F_GETLKP:

	case F_SETLKP:

	case F_SETLKPW:

	case F_OFD_GETLK:

	case F_OFD_SETLK:

	case F_OFD_SETLKW:

		return -EINVAL;

	}

	return compat_sys_fcntl64(fd, cmd, arg);

fs/fcntl.c

+6 −6
Original line number Diff line number Diff line
@@ -274,15 +274,15 @@ static long do_fcntl(int fd, unsigned int cmd, unsigned long arg, 
		break;

#if BITS_PER_LONG != 32

	/* 32-bit arches must use fcntl64() */

	case F_GETLKP:

	case F_OFD_GETLK:

#endif

	case F_GETLK:

		err = fcntl_getlk(filp, cmd, (struct flock __user *) arg);

		break;

#if BITS_PER_LONG != 32

	/* 32-bit arches must use fcntl64() */

	case F_SETLKP:

	case F_SETLKPW:

	case F_OFD_SETLK:

	case F_OFD_SETLKW:

#endif

		/* Fallthrough */

	case F_SETLK:
@@ -399,13 +399,13 @@ SYSCALL_DEFINE3(fcntl64, unsigned int, fd, unsigned int, cmd, 
	

	switch (cmd) {

	case F_GETLK64:

	case F_GETLKP:

	case F_OFD_GETLK:

		err = fcntl_getlk64(f.file, cmd, (struct flock64 __user *) arg);

		break;

	case F_SETLK64:

	case F_SETLKW64:

	case F_SETLKP:

	case F_SETLKPW:

	case F_OFD_SETLK:

	case F_OFD_SETLKW:

		err = fcntl_setlk64(fd, f.file, cmd,

				(struct flock64 __user *) arg);

		break;

fs/locks.c

+7 −7
Original line number Diff line number Diff line
@@ -1941,7 +1941,7 @@ int fcntl_getlk(struct file *filp, unsigned int cmd, struct flock __user *l) 
	if (error)

		goto out;



	if (cmd == F_GETLKP) {

	if (cmd == F_OFD_GETLK) {

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2076,7 +2076,7 @@ again: 
	 * FL_FILE_PVT flag and override the owner.

	 */

	switch (cmd) {

	case F_SETLKP:

	case F_OFD_SETLK:

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2085,7 +2085,7 @@ again: 
		file_lock->fl_flags |= FL_FILE_PVT;

		file_lock->fl_owner = (fl_owner_t)filp;

		break;

	case F_SETLKPW:

	case F_OFD_SETLKW:

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2143,7 +2143,7 @@ int fcntl_getlk64(struct file *filp, unsigned int cmd, struct flock64 __user *l) 
	if (error)

		goto out;



	if (cmd == F_GETLKP) {

	if (cmd == F_OFD_GETLK) {

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2211,7 +2211,7 @@ again: 
	 * FL_FILE_PVT flag and override the owner.

	 */

	switch (cmd) {

	case F_SETLKP:

	case F_OFD_SETLK:

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2220,7 +2220,7 @@ again: 
		file_lock->fl_flags |= FL_FILE_PVT;

		file_lock->fl_owner = (fl_owner_t)filp;

		break;

	case F_SETLKPW:

	case F_OFD_SETLKW:

		error = -EINVAL;

		if (flock.l_pid != 0)

			goto out;
@@ -2413,7 +2413,7 @@ static void lock_get_status(struct seq_file *f, struct file_lock *fl, 
		if (fl->fl_flags & FL_ACCESS)

			seq_printf(f, "ACCESS");

		else if (IS_FILE_PVT(fl))

			seq_printf(f, "FLPVT ");

			seq_printf(f, "OFDLCK");

		else

			seq_printf(f, "POSIX ");

include/uapi/asm-generic/fcntl.h

+10 −10
Original line number Diff line number Diff line
@@ -133,20 +133,20 @@ 
#endif



/*

 * fd "private" POSIX locks.

 * Open File Description Locks

 *

 * Usually POSIX locks held by a process are released on *any* close and are

 * Usually record locks held by a process are released on *any* close and are

 * not inherited across a fork().

 *

 * These cmd values will set locks that conflict with normal POSIX locks, but

 * are "owned" by the opened file, not the process. This means that they are

 * inherited across fork() like BSD (flock) locks, and they are only released

 * automatically when the last reference to the the open file against which

 * they were acquired is put.

 * These cmd values will set locks that conflict with process-associated

 * record  locks, but are "owned" by the open file description, not the

 * process. This means that they are inherited across fork() like BSD (flock)

 * locks, and they are only released automatically when the last reference to

 * the the open file against which they were acquired is put.

 */

#define F_GETLKP	36

#define F_SETLKP	37

#define F_SETLKPW	38

#define F_OFD_GETLK	36

#define F_OFD_SETLK	37

#define F_OFD_SETLKW	38



#define F_OWNER_TID	0

#define F_OWNER_PID	1

CRA Git | Maintained and supported by SUSTech CRA and CCSE