isc/tests/isctest.c

	isctest.c revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
/*
 * Copyright (C) 2011-2014, 2016  Internet Systems Consortium, Inc. ("ISC")
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

/* $Id$ */

/*! \file */

#include <config.h>

#include <time.h>

#include <isc/app.h>
#include <isc/buffer.h>
#include <isc/entropy.h>
#include <isc/hash.h>
#include <isc/mem.h>
#include <isc/os.h>
#include <isc/socket.h>
#include <isc/string.h>
#include <isc/task.h>
#include <isc/timer.h>
#include <isc/util.h>

#include "isctest.h"

isc_mem_t *mctx = NULL;
isc_entropy_t *ectx = NULL;
isc_log_t *lctx = NULL;
isc_taskmgr_t *taskmgr = NULL;
isc_timermgr_t *timermgr = NULL;
isc_socketmgr_t *socketmgr = NULL;
isc_task_t *maintask = NULL;
int ncpus;

static isc_boolean_t hash_active = ISC_FALSE;

/*
 * Logging categories: this needs to match the list in bin/named/log.c.
 */
static isc_logcategory_t categories[] = {
        { "",                0 },
        { "client",          0 },
        { "network",         0 },
        { "update",          0 },
        { "queries",         0 },
        { "unmatched",       0 },
        { "update-security", 0 },
        { "query-errors",    0 },
        { NULL,              0 }
};

static void
cleanup_managers(void) {
    if (maintask != NULL)
        isc_task_destroy(&maintask);
    if (socketmgr != NULL)
        isc_socketmgr_destroy(&socketmgr);
    if (taskmgr != NULL)
        isc_taskmgr_destroy(&taskmgr);
    if (timermgr != NULL)
        isc_timermgr_destroy(&timermgr);
}

static isc_result_t
create_managers(void) {
    isc_result_t result;
#ifdef ISC_PLATFORM_USETHREADS
    ncpus = isc_os_ncpus();
#else
    ncpus = 1;
#endif

    CHECK(isc_taskmgr_create(mctx, ncpus, 0, &taskmgr));
    CHECK(isc_task_create(taskmgr, 0, &maintask));
    isc_taskmgr_setexcltask(taskmgr, maintask);

    CHECK(isc_timermgr_create(mctx, &timermgr));
    CHECK(isc_socketmgr_create(mctx, &socketmgr));
    return (ISC_R_SUCCESS);

 cleanup:
    cleanup_managers();
    return (result);
}

isc_result_t
isc_test_begin(FILE *logfile, isc_boolean_t start_managers) {
    isc_result_t result;

    isc_mem_debugging |= ISC_MEM_DEBUGRECORD;
    CHECK(isc_mem_create(0, 0, &mctx));
    CHECK(isc_entropy_create(mctx, &ectx));

    CHECK(isc_hash_create(mctx, ectx, 255));
    hash_active = ISC_TRUE;

    if (logfile != NULL) {
        isc_logdestination_t destination;
        isc_logconfig_t *logconfig = NULL;

        CHECK(isc_log_create(mctx, &lctx, &logconfig));
        isc_log_registercategories(lctx, categories);
        isc_log_setcontext(lctx);

        destination.file.stream = logfile;
        destination.file.name = NULL;
        destination.file.versions = ISC_LOG_ROLLNEVER;
        destination.file.maximum_size = 0;
        CHECK(isc_log_createchannel(logconfig, "stderr",
                        ISC_LOG_TOFILEDESC,
                        ISC_LOG_DYNAMIC,
                        &destination, 0));
        CHECK(isc_log_usechannel(logconfig, "stderr", NULL, NULL));
    }

#ifdef ISC_PLATFORM_USETHREADS
    ncpus = isc_os_ncpus();
#else
    ncpus = 1;
#endif

    if (start_managers)
        CHECK(create_managers());

    return (ISC_R_SUCCESS);

  cleanup:
    isc_test_end();
    return (result);
}

void
isc_test_end(void) {
    if (maintask != NULL)
        isc_task_detach(&maintask);
    if (taskmgr != NULL)
        isc_taskmgr_destroy(&taskmgr);
    if (lctx != NULL)
        isc_log_destroy(&lctx);
    if (hash_active) {
        isc_hash_destroy();
        hash_active = ISC_FALSE;
    }
    if (ectx != NULL)
        isc_entropy_detach(&ectx);

    cleanup_managers();

    if (mctx != NULL)
        isc_mem_destroy(&mctx);
}

/*
 * Sleep for 'usec' microseconds.
 */
void
isc_test_nap(isc_uint32_t usec) {
#ifdef HAVE_NANOSLEEP
    struct timespec ts;

    ts.tv_sec = usec / 1000000;
    ts.tv_nsec = (usec % 1000000) * 1000;
    nanosleep(&ts, NULL);
#elif HAVE_USLEEP
    usleep(usec);
#else
    /*
     * No fractional-second sleep function is available, so we
     * round up to the nearest second and sleep instead
     */
    sleep((usec / 1000000) + 1);
#endif
}