testcases/kernel/syscalls/llseek/llseek01.c

/*
 *
 *   Copyright (c) International Business Machines  Corp., 2001
 *
 *   This program is free software;  you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 *   the GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program;  if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

/*
 * Test Name: llseek01
 *
 * Test Description:
 *  Verify that, llseek() call succeeds to set the file pointer position
 *  to an offset larger than file size. Also, verify that any attempt
 *  to write to this location fails.
 *
 * Expected result:
 *  llseek() should return the offset from the beginning of the file measured
 *  in bytes. Attempt to write to the location ( > file size) should fail.
 *
 * Algorithm:
 *  Setup:
 *   Setup signal handling.
 *   Create temporary directory.
 *   Pause for SIGUSR1 if option specified.
 *
 *  Test:
 *   Loop if the proper options are given.
 *   Execute system call
 *   Check return code, if system call failed (return=-1)
 *   	Log the errno and Issue a FAIL message.
 *   Otherwise,
 *   	Verify the Functionality of system call
 *      if successful,
 *      	Issue Functionality-Pass message.
 *      Otherwise,
 *		Issue Functionality-Fail message.
 *  Cleanup:
 *   Print errno log and/or timing stats if options given
 *   Delete the temporary directory created.
 *
 * Usage:  <for command-line>
 *  llseek01 [-c n] [-f] [-i n] [-I x] [-P x] [-t]
 *     where,  -c n : Run n copies concurrently.
 *             -f   : Turn off functionality Testing.
 *	       -i n : Execute test n times.
 *	       -I x : Execute test for x seconds.
 *	       -P x : Pause for x seconds between iterations.
 *	       -t   : Turn on syscall timing.
 *
 * HISTORY
 *	07/2001 Ported by Wayne Boyer
 *
 * RESTRICTIONS:
 *  None.
 */

#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif

#include <unistd.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include <utime.h>
#include <string.h>
#include <signal.h>
#include <sys/resource.h>
#include <sys/stat.h>
#include <sys/types.h>

#include "test.h"
#include "usctest.h"

#define TEMP_FILE	"tmp_file"
#define FILE_MODE	0644

char *TCID="llseek01";		/* Test program identifier.    */
int TST_TOTAL=1;		/* Total number of test cases. */
extern int Tst_count;		/* Test Case counter for tst_* routines */
char write_buff[BUFSIZ];	/* buffer to hold data */
int fildes;			/* file handle for temp file */

struct rlimit rlp_orig;		/* resource for original file size limit */

void setup();			/* Main setup function of test */
void cleanup();			/* cleanup function for the test */


int
main(int ac, char **av)
{
	int lc;			/* loop counter */
	char *msg;		/* message returned from parse_opts */
	loff_t offset;		/* Ret value from llseek */

	/* Parse standard options given to run the test. */
	msg = parse_opts(ac, av, (option_t *) NULL, NULL);
	if (msg != (char *) NULL) {
		tst_brkm(TBROK, NULL, "OPTION PARSING ERROR - %s", msg);
		tst_exit();
	}

	/* Perform global setup for test */
	setup();

	/* Check looping state if -i option given */
	for (lc = 0; TEST_LOOPING(lc); lc++) {
		/* Reset Tst_count in case we are looping. */
		Tst_count=0;

		/*
		 * set file size limit, seek to a file using llseek.
		 */
		TEST(lseek64(fildes, (loff_t)(80 * BUFSIZ), SEEK_SET));

		/* check return code of lseek(2) */
		if (TEST_RETURN == (loff_t)-1) {
			tst_resm(TFAIL, "llseek on (%s) Failed, errno=%d : %s",
				 TEMP_FILE, TEST_ERRNO, strerror(TEST_ERRNO));
			continue;
		}

		/*
		 * Perform functional verification if test
		 * executed without (-f) option.
		 */
		if (STD_FUNCTIONAL_TEST) {
			/*
			 * Check if the return value from lseek(2)
			 * is equal to the specified offset value.
			 */
			if (TEST_RETURN != (loff_t)(80 * BUFSIZ)) {
				tst_resm(TFAIL, "llseek() returned incorrect "
					 "value %d, expected %d",
					 offset, BUFSIZ);
				continue;
			}

			/*
			 * llseek() successful.  Now attempt to write past
			 * file size limit.
			 */
			if (write(fildes, write_buff, BUFSIZ) != -1) {
				tst_brkm(TFAIL, cleanup, "write successful "
					 "after file size limit");
			}

			/* Seeking to end of last valid write */
			offset = lseek64(fildes, (loff_t)BUFSIZ, SEEK_SET);
			if (offset != (loff_t)BUFSIZ) {
				tst_brkm(TFAIL, cleanup,
					 "llseek under file size limit");
			}

			/*
			 * llseek() successful.  Now, attempt to write to
			 * file size limit.
			 */
			if (write(fildes, write_buff, BUFSIZ) != BUFSIZ) {
				tst_brkm(TFAIL, cleanup, "write failed to "
					 "write to file size limit");
			}

			/*
			 * Again, attempt to write past file size limit.
			 */
			if (write(fildes, write_buff, BUFSIZ) != -1) {
				tst_brkm(TFAIL, cleanup, "write past file "
					 "size limit successful");
			}

			tst_resm(TPASS, "Functionality of llseek() on %s "
				 "successful", TEMP_FILE);
		} else {
			tst_resm(TPASS, "call succeeded");
		}
	}	/* End for TEST_LOOPING */

	/* Call cleanup() to undo setup done for the test. */
	cleanup();

	/*NOTREACHED*/
	return 0;
}	/* End main */

/*
 * setup() - performs all ONE TIME setup for this test.
 *           Setup signal handler to ignore SIGXFSZ signal.
 *           Create a temporary directory and change directory to it.
 *           Create a test file under temporary directory.
 *           Set the file size limit using setrlimit.
 */
void
setup()
{
	struct sigaction act;		/* struct. to hold signal */
	struct rlimit rlp; 		/* resource for file size limit */

	/* capture signals */
	tst_sig(NOFORK, DEF_HANDLER, cleanup);

	/* Pause if that option was specified */
	TEST_PAUSE;

	/* Ignore the signal received aganist file size limit. */
	act.sa_handler = SIG_IGN;
	if (sigaction(SIGXFSZ, &act, NULL) == -1) {
		tst_brkm(TFAIL, NULL, "sigaction() Failed to ignore SIGXFSZ");
		tst_exit();
	}

	/* make a temp directory and cd to it */
	tst_tmpdir();

	/* Store the original rlimit */
	if (getrlimit(RLIMIT_FSIZE, &rlp_orig) == -1) {
		tst_brkm(TBROK, cleanup,
			 "Cannot get max. file size using getrlimit");
	}

	/* Set limit low, argument is # bytes */
	rlp.rlim_cur = rlp.rlim_max = 2 * BUFSIZ;

	if (setrlimit(RLIMIT_FSIZE, &rlp) == -1) {
		tst_brkm(TBROK, cleanup,
			 "Cannot set max. file size using setrlimit");
	}

	/* Creat/open a temporary file under above directory */
	if ((fildes = open(TEMP_FILE, O_RDWR | O_CREAT, FILE_MODE)) == -1) {
		tst_brkm(TBROK, cleanup,
			 "open(%s, O_RDWR|O_CREAT, 0644) Failed, errno=%d :%s",
			 TEMP_FILE, errno, strerror(errno));
	}

	/* Write data into temporary file */
	if (write(fildes, write_buff, BUFSIZ) != BUFSIZ) {
		tst_brkm(TBROK, cleanup, "write(2) on %s Failed, errno=%d : %s",
			 TEMP_FILE, errno, strerror(errno));
	}
}

/*
 * cleanup() - performs all ONE TIME cleanup for this test at
 *             completion or premature exit.
 *             Close the temporary file.
 *             Remove the test directory and testfile created in the setup.
 */
void
cleanup()
{
	/*
	 * print timing stats if that option was specified.
	 * print errno log if that option was specified.
	 */
	TEST_CLEANUP;

	/* Close the temporary file created */
	if (close(fildes) < 0) {
		tst_brkm(TFAIL, NULL, "close(%s) Failed, errno=%d : %s:",
			 TEMP_FILE, errno, strerror(errno));
	}

	/* Remove tmp dir and all files in it */
	tst_rmdir();

	/* Reset the file size limit */
	if (setrlimit(RLIMIT_FSIZE, &rlp_orig) == -1) {
		tst_brkm(TBROK, NULL,
			 "Cannot reset max. file size using setrlimit");
	}

	/* exit with return code appropriate for results */
	tst_exit();
}