runtests.c revision 90221f9148b67fdc90178b67f9600b7bd4e3bc7c
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * This file and its contents are supplied under the terms of the
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * Common Development and Distribution License ("CDDL"), version 1.0.
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * You may only use this file in accordance with the terms of version
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * 1.0 of the CDDL.
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * A full copy of the text of the CDDL should have accompanied this
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * source. A copy of the CDDL is also available via the Internet at
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * Copyright 2016 Joyent, Inc.
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * Validate various fcntl(2) and flock(3C) operations.
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello#define LOCKFILE_FMT "/tmp/.lockfile-%s-%ld"
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellotypedef struct lockinfo {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void assert_write_locked_by(lockinfo_t *, pid_t);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void assert_read_locked_by(lockinfo_t *, pid_t);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void assert_all_unlocked(void);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic int flock_copyfil(lockinfo_t *, lockinfo_t *);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_fcntl(lockinfo_t *lf, int cmd, struct flock *fl);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_run(lock_style_t, boolean_t, lockinfo_t *,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_cleanup_child(pid_t, int []);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_test_invalid(lockinfo_t *, int, short, short,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_test_exclusive(lock_style_t, lock_style_t,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_test_shared(lock_style_t, lock_style_t, lockinfo_t *,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic void flock_test_upgrade_downgrade(void);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic lockinfo_t flock_fileA = { "a", NULL, -1 };
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic lockinfo_t flock_fileB = { "b", NULL, -1 };
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic lockinfo_t flock_dirA = { "a", NULL, -1 };
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mellostatic lockinfo_t flock_dirB = { "b", NULL, -1 };
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_fcntl(lockinfo_t *lf, int cmd, struct flock *fl)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloassert_write_locked_by(lockinfo_t *lf, pid_t pid)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_WRLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_WRLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_WRLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_WRLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloassert_read_locked_by(lockinfo_t *lf, pid_t pid)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_RDLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_RDLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(fl.l_type, ==, F_UNLCK, short);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_copyfil(lockinfo_t *src, lockinfo_t *dst)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if ((dst->lf_fd = open(src->lf_path, O_RDWR)) == -1) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if (asprintf(&lf->lf_path, LOCKFILE_FMT, lf->lf_name, getpid()) < 0) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if ((lf->lf_fd = open(lf->lf_path, O_RDWR|O_CREAT, 0600)) == -1) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if (asprintf(&lf->lf_path, LOCKDIR_FMT, lf->lf_name, getpid()) < 0) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if ((lf->lf_fd = open(lf->lf_path, O_RDONLY)) == -1) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_run(lock_style_t style, boolean_t is_exclusive, lockinfo_t *lf,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello char *modestr = is_exclusive ? "exclusive" : "shared";
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello char *argv[5] = { acqprog, stylestr, modestr, lf->lf_path, NULL };
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Set up pipe for communicating with child */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello err(EXIT_FAILURE, "Failed to execute %s", acqprog);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello while (waitpid(pid, &childstat, 0) == -1) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello err(EXIT_FAILURE, "Failed to wait on child");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd1), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd2), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd3), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Acquiring shared locks 1, 2 and 3...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd1.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd2.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Upgrading lock 3 should fail w/ EWOULDBLOCK...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_EX|LOCK_NB), ==, -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Upgrading 3 should succeed after releasing locks 1 & 2...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd1.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd2.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_EX), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Starting up child, then downgrading lock 3 to shared...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_run(LSTYLE_FLOCK, B_FALSE, &flock_fileA, &pid, fds);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(flock_nodata(fds[0]), ==, B_TRUE, boolean_t);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Releasing child and upgrading...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_EX), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_test_invalid(lockinfo_t *lf, int cmd, short l_type, short l_whence,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("fcntl(fd, %s, { %hd, %hd, %ld, %ld, ... })...",
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_cmdname(cmd), l_type, l_whence, l_start, l_len);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(fcntl(lf->lf_fd, cmd, &fl), ==, -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_test_exclusive(lock_style_t styleA, lock_style_t styleB,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello lockinfo_t *lock1, lockinfo_t *lock2, boolean_t kill_firstborn)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_stylename(styleA), flock_stylename(styleB),
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello kill_firstborn ? "kill child" : "child exits");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Create child, and wait for it to acquire the lock */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_run(styleA, B_TRUE, lock1, &pidA, fdsA);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Create second child, which shouldn't acquire & signal */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_run(styleB, B_TRUE, lock1, &pidB, fdsB);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3_IMPL(flock_nodata(fdsB[0]), ==, B_TRUE, boolean_t);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* lock1 is blocked for reading and writing */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello assert_write_locked_by(lock1, styleA == LSTYLE_POSIX ? pidA : -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Tell pidA to exit */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Wait for pidB to signal us */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* lock1 is blocked for reading and writing */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello assert_write_locked_by(lock1, styleB == LSTYLE_POSIX ? pidB : -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Tell pidB to exit */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * Tests after child has released lock
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Melloflock_test_shared(lock_style_t styleA, lock_style_t styleB,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello lockinfo_t *lock1, lockinfo_t *lock2, boolean_t kill_firstborn)
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_stylename(styleA), flock_stylename(styleB),
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello kill_firstborn ? "kill child" : "child exits");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Create children, and wait for it to acquire the lock */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_run(styleB, B_FALSE, lock1, &pidB, fdsB);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_run(styleA, B_FALSE, lock1, &pidA, fdsA);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* testfileA is only blocked for writing */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello assert_read_locked_by(lock1, styleA == LSTYLE_POSIX ? pidA : -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Tell pidA to exit */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* testfileA is still blocked for writing by pidB */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello assert_read_locked_by(lock1, styleB == LSTYLE_POSIX ? pidB : -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Tell pidB to exit */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd1), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd2), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock_copyfil(&flock_fileA, &afd3), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Acquiring first two shared locks...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd1.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd2.lf_fd, LOCK_SH), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Acquiring an exclusive lock should fail w/ EWOULDBLOCK...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_EX|LOCK_NB), ==, -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Releasing to acquire an exclusive lock...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd1.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd2.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Acquiring an exclusive lock...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_EX), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("Acquiring a shared lock should fail w/ EWOULDBLOCK...");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd1.lf_fd, LOCK_EX|LOCK_NB), ==, -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd2.lf_fd, LOCK_EX|LOCK_NB), ==, -1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello VERIFY3S(flock(afd3.lf_fd, LOCK_UN), ==, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (first = (lock_style_t)0; first < LSTYLE_LAST; first++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (second = (lock_style_t)0; second < LSTYLE_LAST; second++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (first = (lock_style_t)0; first < LSTYLE_LAST; first++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (second = (lock_style_t)0; second < LSTYLE_LAST; second++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("# flock(3C) directory lock tests\n");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_exclusive(LSTYLE_FLOCK, LSTYLE_FLOCK,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_exclusive(LSTYLE_FLOCK, LSTYLE_FLOCK,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_shared(LSTYLE_FLOCK, LSTYLE_FLOCK,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_shared(LSTYLE_FLOCK, LSTYLE_FLOCK,
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("# Invalid fcntl(2) parameters tests\n");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (i = 0; i < sizeof (cmds) / sizeof (short); i++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_invalid(&flock_fileA, cmds[i], 200, 0, 0, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_invalid(&flock_fileA, cmds[i], -1, 0, 0, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello for (i = 3; i < sizeof (cmds) / sizeof (short); i++) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_invalid(&flock_fileA, cmds[i], F_WRLCK, 1, 0, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_invalid(&flock_fileA, cmds[i], F_WRLCK, 0, 1, 0);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_test_invalid(&flock_fileA, cmds[i], F_WRLCK, 0, 0, 1);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("# Testing that multiple OFD locks work in a process\n");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello flock_log("# Testing flock(3C) upgrade/downgrade tests\n");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello errx(EXIT_FAILURE, "Can't find program name!");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello while (*suffix != '.' && *suffix != '\0') {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello if (asprintf(&acqprog, "%s/acquire-lock%s", dirpath, suffix) < 0) {
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello "Can't generate lock acquisition program name!");
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello "Can't run lock acquisition program %s", acqprog);
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello /* Create several lockfiles for testing */
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * We run the tests in a child process so that when tests fail
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello * we can still clean up our temporary files.
90221f9148b67fdc90178b67f9600b7bd4e3bc7cCody Peter Mello err(EXIT_FAILURE, "Unable to fork to run tests");