blcr-dkms 0.8.5-2 / usr / src / blcr-0.8.5 / tests / hugetlbfs.c

/*
 * Berkeley Lab Checkpoint/Restart (BLCR) for Linux is Copyright (c)
 * 2003, The Regents of the University of California, through Lawrence
 * Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Portions may be copyrighted by others, as may be noted in specific
 * copyright notices within specific files.
 *
 * 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
 *
 * $Id: hugetlbfs.c,v 1.7 2008/08/29 21:36:53 phargrov Exp $
 *
 * Test of mmap()s on hugetlbfs across a checkpoint
 */

#define _GNU_SOURCE /* Ensures we get getline() */
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <unistd.h>
#include <signal.h>
#include <fcntl.h>
#include <string.h>
#include <errno.h>
#include <sys/mman.h>

#include "crut.h"

enum {
 MSG_PARENT_DONE = 17,
 MSG_CHILD_READY,
 MSG_PARENT_REQUEST,
 MSG_CHILD_GOOD,
 MSG_CHILD_BAD
};

static const char MSG1[] = "MSG1: Hello world!";
static const char MSG2[] = "MSG2: The quick brown fox jumps over the lazy dog.";
static const char MSG3[] = "MSG3: All good things come to those who waitpid().";

static int pagesize = -1;
#define FILESTEM "/tstfile.0"
static char *filename;

enum {
	TEST_UNLINK	= 1,
};

struct testcase {
	char *	addr;
	size_t	len;
	int	prot;
	int	flags;
	int	fd;
	struct crut_pipes checker;
	int	test_flags;
};

static void sigpipe(int signo) {
    fprintf(stderr, "%d exiting on SIGPIPE\n", getpid());
    exit(-1);
}

static void checker_child(struct testcase *t) {

    /* If shared mapping of a file, them map via a separate file descriptor */
    if ((t->fd >= 0) && (t->flags & MAP_SHARED)) {
       	int err, fd;
	
	err = fcntl(t->fd, F_GETFL);
	if (err < 0) {
	    perror("fcntl()");
	    exit(-1);
	}
	fd = open(filename, err&O_ACCMODE, 0);
	if (fd < 0) {
	    perror("open()");
	    exit(-1);
	}
	t->addr = mmap(0, t->len, t->prot, t->flags, fd, 0);
	if (t->addr == MAP_FAILED) {
	    perror("mmap()");
	    exit(-1);
	}
	(void)close(fd);
    }
    if (t->fd >= 0) (void)close(t->fd);

    crut_pipes_putchar(&t->checker, MSG_CHILD_READY);
    while (1) {
        crut_pipes_expect(&t->checker, MSG_PARENT_REQUEST);
        if (strncmp(t->addr, MSG2, sizeof(MSG2))) {
            crut_pipes_putchar(&t->checker, MSG_CHILD_BAD);
	    CRUT_FAIL("Wrong value read.  Pre-checkpoint sharing lost?");
	    exit(-1);
	}
	strcpy(t->addr, MSG3);
        crut_pipes_putchar(&t->checker, MSG_CHILD_GOOD);
    }
}

static int
mmaps_setup_common(void **testdata, void *start, int prot , int flags, int fd, int test_flags)
{
    struct testcase *t = malloc(sizeof(*t));
    size_t len = pagesize;

    t->test_flags = test_flags;
    t->len = len;
    t->prot = prot;
    t->flags = flags;
    t->fd = fd;
    t->addr = mmap(start, len, prot, flags, fd, 0);
    CRUT_DEBUG("mmap(%p, %d, 0x%x, 0x%x, %d, 0) -> %p (%d)", start, (int)len, prot, flags, fd, t->addr, errno);
    if (t->addr == MAP_FAILED) return -1;
    if (flags & MAP_SHARED) {
	(void)signal(SIGPIPE, &sigpipe);
	if (!crut_pipes_fork(&t->checker)) {
	    /* In the child */
	    checker_child(t);
	    exit(-1); /* Not reached */
	} else {
	    /* In the parent */
	    crut_pipes_expect(&t->checker, MSG_CHILD_READY);
	    CRUT_DEBUG("Child ready");
	}
    }
    strcpy(t->addr, MSG1);
    *testdata = t;
    return 0;
}

static int mmaps_setup_file_common(void **testdata, int prot, int flags, off_t offset, int test_flags)
{
    int fd, retval;
    (void)unlink(filename);
    fd = open(filename, O_CREAT|O_RDWR|O_TRUNC, S_IREAD|S_IWRITE);
    if (fd < 0) return fd;
    retval = mmaps_setup_common(testdata, 0, prot, flags, fd, test_flags);
    close(fd);
    if (test_flags & TEST_UNLINK) (void)unlink(filename);
    return retval;
}

static int mmaps_setup_rw_fs(void **testdata)
{ return mmaps_setup_file_common(testdata, PROT_READ|PROT_WRITE, MAP_SHARED, 0, 0); }

static int mmaps_setup_rw_us(void **testdata)
{ return mmaps_setup_file_common(testdata, PROT_READ|PROT_WRITE, MAP_SHARED, 0, TEST_UNLINK); }

static int check_shared(struct testcase *t)
{
    pid_t pid;

    if (strncmp(t->addr, MSG1, sizeof(MSG1))) {
	CRUT_FAIL("Wrong value read from memory");
	return -1;
    }

    if (!(t->prot & PROT_WRITE)) {
	if (mprotect(t->addr, t->len, PROT_READ|PROT_WRITE) == 0) {
	    CRUT_FAIL("Unexpected success from mprotect(READ|WRITE) of read-only file");
	    return -1;
        }
	return 0;
    }

    /* Fork a transient child to read MSG1 and write MSG2 */
    pid = fork();
    if (pid < 0) {
	CRUT_FAIL("fork() failed: %s", strerror(errno));
	return -1;
    }
    if (!pid) {
	/* Child */
        if (strncmp(t->addr, MSG1, sizeof(MSG1))) {
	    CRUT_FAIL("Wrong value read in child.  Post-checkpoint sharing lost?");
	    exit(-1);
	}
        strcpy(t->addr, MSG2);
	exit(0);
    }
    crut_waitpid_expect(pid, 0);

    /* Now ask the permanent child to read MSG2 and write MSG3 */
    crut_pipes_putchar(&t->checker, MSG_PARENT_REQUEST);
    crut_pipes_expect(&t->checker, MSG_CHILD_GOOD);
    if (strncmp(t->addr, MSG3, sizeof(MSG3))) {
	CRUT_FAIL("Wrong value read from memory.  Pre-checkpoint sharing lost?");
	return -1;
    }

    strcpy(t->addr, MSG1);
    
    return 0;
}

static int
mmaps_precheckpoint_shared(void *p)
{
    CRUT_DEBUG("Sanity check before checkpoint.");
    return check_shared(p);
}

static int
mmaps_continue_shared(void *p)
{
    CRUT_DEBUG("Continuing after checkpoint.");
    return check_shared(p);
}

static int
mmaps_restart_shared(void *p)
{
    CRUT_DEBUG("Restarting from checkpoint.");
    return check_shared(p);
}

static int
mmaps_teardown(void *p)
{
    struct testcase *t = (struct testcase *)p;

    (void)unlink(filename);

    if (t->flags & MAP_SHARED) {
        crut_pipes_putchar(&t->checker, MSG_PARENT_DONE);
	crut_waitpid_expect(t->checker.child, MSG_PARENT_DONE);
    }

    return munmap(t->addr, t->len);
}

static void test_init(void)
{
    FILE *fp;
    int rc, fd;
    size_t len;
    char *line = NULL;
    char *mntpnt = NULL;
    void *addr;

    /* Find the pagesize */
    fp = fopen("/proc/meminfo", "r");
    if (!fp) {
	perror("open(/proc/meminfo)");
	exit(1);
    }
    while ((rc = getline(&line, &len, fp)) >= 0) {
	const char key[] = "Hugepagesize:";
	char *s;
	int kb;

	if (strncmp(key, line, sizeof(key) - 1)) { continue; }

	s = strchr(line, ' '); /* space after key */
	if (!s) { continue; }

	if (sscanf(s, " %d", &kb) != 1) { continue; }
	
	pagesize = 1024 * kb;
	break;
    }
    free(line); line = NULL;
    (void)fclose(fp);
    if (pagesize < 0) {
        fprintf(stderr, "Unable to determine huge pagesize, if any (test skipped).\n");
	exit(77);
    }

    /* Find the mount point */
    fp = fopen("/proc/mounts", "r");
    if (!fp) {
	perror("open(/proc/mounts)");
	exit(1);
    }
    while ((rc = getline(&line, &len, fp)) >= 0) {
	const char key[] = "hugetlbfs";
	char *s, *fstype;

	s = strchr(line, ' '); /* space after device */
	if (!s) { continue; }

	mntpnt = s + 1;
	s = strchr(mntpnt, ' '); /* space after mntpnt */
	if (!s) { continue; }

	*s = '\0';
	len = s - mntpnt;
	fstype = s + 1;

	if (strncmp(key, fstype, sizeof(key) - 1)) { continue; }
	
	mntpnt = strdup(mntpnt);
	break;
    }
    free(line); line = NULL;
    (void)fclose(fp);
    if (rc < 0) {
        fprintf(stderr, "No hugetlbfs mount point found (test skipped)\n");
	exit(77);
    }

    /* Build the filename */
    len += sizeof(FILESTEM);
    filename = malloc(len);
    strcpy(filename, mntpnt);
    strcat(filename, FILESTEM);
    free(mntpnt);

    /* Basic test that we can create and mmap the file */
    (void)unlink(filename);
    fd = open(filename, O_CREAT|O_RDWR|O_TRUNC, S_IREAD|S_IWRITE);
    if (fd < 0) {
        fprintf(stderr, "Could not create file on hugetlbfs (test skipped)\n");
	exit(77);
    }
    addr = mmap(0, pagesize,  PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
    (void)close(fd);
    if (addr == MAP_FAILED) {
        fprintf(stderr, "Could not mmap %dKB file on hugetlbfs (test skipped)\n", pagesize/1024);
	(void)unlink(filename);
	exit(77);
    }
    (void)munmap(addr, pagesize);
    (void)unlink(filename);
}

int
main(int argc, char *argv[])
{
    int ret;
    struct crut_operations rw_fs_test_ops = {
	test_scope:CR_SCOPE_TREE,
	test_name:"mmaps_rw_fs",
        test_description:"Test mmap(READ|WRITE,SHARED) of a file.",
	test_setup:mmaps_setup_rw_fs,
	test_precheckpoint:mmaps_precheckpoint_shared,
	test_continue:mmaps_continue_shared,
	test_restart:mmaps_restart_shared,
	test_teardown:mmaps_teardown,
    };

    struct crut_operations rw_us_test_ops = {
	test_scope:CR_SCOPE_TREE,
	test_name:"mmaps_rw_us",
        test_description:"Test mmap(READ|WRITE,SHARED) of an unlinked file.",
	test_setup:mmaps_setup_rw_us,
	test_precheckpoint:mmaps_precheckpoint_shared,
	test_continue:mmaps_continue_shared,
	test_restart:mmaps_restart_shared,
	test_teardown:mmaps_teardown,
    };

    /* Make sure we have a usable hugetlbfs */
    test_init();

    /* "normal" file test */
    crut_add_test(&rw_fs_test_ops);

    /* unlinked file test */
    crut_add_test(&rw_us_test_ops);
    
    ret = crut_main(argc, argv);

    return ret;
}