epics-base/test/ioc/db/dbStressLock.c

/*************************************************************************\
* Copyright (c) 2014 Brookhaven Science Assoc. as operator of Brookhaven
*               National Laboratory.
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
 \*************************************************************************/

/*
 * Lockset stress test.
 *
 * The test stratagy is for N threads to contend for M records.
 * Each thread will perform one of three operations:
 * 1) Lock a single record.
 * 2) Lock several records.
 * 3) Retarget the TSEL link of a record
 *
 *  Author: Michael Davidsaver <mdavidsaver@bnl.gov>
 */

#include <stdlib.h>
#include <string.h>
#include <time.h>

#include "envDefs.h"
#include "epicsEvent.h"
#include "epicsStdlib.h"
#include "epicsSpin.h"
#include "epicsThread.h"
#include "epicsMutex.h"
#include "dbCommon.h"

#include "dbLockPvt.h"
#include "dbStaticLib.h"

#include "dbUnitTest.h"
#include "testMain.h"

#include "dbAccess.h"
#include "errlog.h"

#include "xRecord.h"

#if defined(CLOCK_REALTIME) && defined(CLOCK_MONOTONIC) && !defined(_WIN32)
# define TIME_STATS
#endif

#define testIntOk1(A, OP, B) testOk((A) OP (B), "%s (%d) %s %s (%d)", #A, A, #OP, #B, B);
#define testPtrOk1(A, OP, B) testOk((A) OP (B), "%s (%p) %s %s (%p)", #A, A, #OP, #B, B);

void dbTestIoc_registerRecordDeviceDriver(struct dbBase *);

/* number of seconds for the test to run */
static double runningtime = 18.0;

/* number of worker threads */
static unsigned int nworkers = 5;

static unsigned int nrecords;

#define MAXLOCK 20

static dbCommon **precords;

typedef struct {
    int id;
    unsigned long N[3];
#ifdef TIME_STATS
    double X[3];
    double X2[3];
#endif

    unsigned int done;
    epicsEventId donevent;

    dbCommon *prec[MAXLOCK];
} workerPriv;

/* hopefully a uniform random number in [0.0, 1.0] */
static
double getRand(void)
{
    return rand()/(double)RAND_MAX;
}

static
void doSingle(workerPriv *p)
{
    size_t recn = (size_t)(getRand()*(nrecords-1));
    dbCommon *prec = precords[recn];
    xRecord *px = (xRecord*)prec;

    dbScanLock(prec);
    px->val++;
    dbScanUnlock(prec);
}

static
void doMulti(workerPriv *p)
{
    int sum = 0;
    size_t i;
    size_t nlock = 2 + (size_t)(getRand()*(MAXLOCK-3));
    size_t nrec = (size_t)(getRand()*(nrecords-1));
    dbLocker *locker;

    assert(nlock>=2);
    assert(nlock<nrecords);

    for(i=0; i<nlock; i++, nrec=(nrec+1)%nrecords) {
        p->prec[i] = precords[nrec];
    }

    locker = dbLockerAlloc(p->prec, nlock, 0);
    if(!locker)
        testAbort("locker allocation fails");

    dbScanLockMany(locker);
    for(i=0; i<nlock; i++) {
        xRecord *px = (xRecord*)p->prec[i];
        sum += px->val;
    }
    dbScanUnlockMany(locker);

    dbLockerFree(locker);
}

static
void doreTarget(workerPriv *p)
{
    char scratchsrc[60];
    char scratchdst[MAX_STRING_SIZE];
    long ret;
    DBADDR dbaddr;
    double action = getRand();
    size_t nsrc = (size_t)(getRand()*(nrecords-1));
    size_t ntarg = (size_t)(getRand()*(nrecords-1));
    xRecord *psrc = (xRecord*)precords[nsrc];
    xRecord *ptarg = (xRecord*)precords[ntarg];

    strcpy(scratchsrc, psrc->name);
    strcat(scratchsrc, ".TSEL");

    ret = dbNameToAddr(scratchsrc, &dbaddr);
    if(ret)
        testAbort("bad record name? %ld", ret);

    if(action<=0.6) {
        scratchdst[0] = '\0';
    } else {
        strcpy(scratchdst, ptarg->name);
    }

    ret = dbPutField(&dbaddr, DBR_STRING, ptarg->name, 1);
    if(ret)
        testAbort("put fails with %ld", ret);
}

static
void worker(void *raw)
{
#ifdef TIME_STATS
    struct timespec before;
#endif
    workerPriv *priv = raw;

    testDiag("worker %d is %p", priv->id, epicsThreadGetIdSelf());

#ifdef TIME_STATS
    clock_gettime(CLOCK_MONOTONIC, &before);
#endif

    while(!priv->done) {
        double sel = getRand();
#ifdef TIME_STATS
        struct timespec after;
        double duration;
#endif

        int act;
        if(sel<0.33) {
            doSingle(priv);
            act = 0;
        } else if(sel<0.66) {
            doMulti(priv);
            act = 1;
        } else {
            doreTarget(priv);
            act = 2;
        }

#ifdef TIME_STATS
        clock_gettime(CLOCK_MONOTONIC, &after);

        duration = (double)((long)after.tv_nsec - (long)before.tv_nsec);
        duration *= 1e-9;
        duration += (double)(after.tv_sec - before.tv_sec);
#endif

        priv->N[act]++;
#ifdef TIME_STATS
        priv->X[act] += duration;
        priv->X2[act] += duration*duration;
#endif
    }

    epicsEventMustTrigger(priv->donevent);
}

MAIN(dbStressTest)
{
    DBENTRY ent;
    long status;
    unsigned int i;
    workerPriv *priv;
    char *nwork=getenv("NWORK");
    epicsTimeStamp seed;

    epicsTimeGetCurrent(&seed);

    srand(seed.nsec);

    if(nwork) {
        long val = 0;
        epicsParseLong(nwork, &val, 0, NULL);
        if(val>2)
            nworkers = val;
    }

    testPlan(80+nworkers*3);

    priv = callocMustSucceed(nworkers, sizeof(*priv), "no memory");

    testDiag("lock set stress test");

    testdbPrepare();

    testdbReadDatabase("dbTestIoc.dbd", NULL, NULL);
    dbTestIoc_registerRecordDeviceDriver(pdbbase);
    testdbReadDatabase("dbStressLock.db", NULL, NULL);

    eltc(0);
    testIocInitOk();
    eltc(1);

    /* collect an array of all records */
    dbInitEntry(pdbbase, &ent);
    for(status = dbFirstRecordType(&ent);
        !status;
        status = dbNextRecordType(&ent))
    {
        for(status = dbFirstRecord(&ent);
            !status;
            status = dbNextRecord(&ent))
        {
            if(ent.precnode->flags&DBRN_FLAGS_ISALIAS)
                continue;
            nrecords++;
        }

    }
    if(nrecords<2)
        testAbort("where are the records!");
    precords = callocMustSucceed(nrecords, sizeof(*precords), "no mem");
    for(status = dbFirstRecordType(&ent), i = 0;
        !status;
        status = dbNextRecordType(&ent))
    {
        for(status = dbFirstRecord(&ent);
            !status;
            status = dbNextRecord(&ent))
        {
            if(ent.precnode->flags&DBRN_FLAGS_ISALIAS)
                continue;
            precords[i++] = ent.precnode->precord;
        }

    }
    dbFinishEntry(&ent);

    testDiag("Running with %u workers and %u records",
             nworkers, nrecords);

    for(i=0; i<nworkers; i++) {
        priv[i].id = i;
        priv[i].donevent = epicsEventMustCreate(epicsEventEmpty);
    }

    for(i=0; i<nworkers; i++) {
        epicsThreadMustCreate("runner", epicsThreadPriorityMedium,
                              epicsThreadGetStackSize(epicsThreadStackSmall),
                              &worker, &priv[i]);
    }

    testDiag("All started.  Will run for %f sec", runningtime);

    epicsThreadSleep(runningtime);

    testDiag("Stopping");

    for(i=0; i<nworkers; i++) {
        priv[i].done = 1;
    }

    for(i=0; i<nworkers; i++) {
        epicsEventMustWait(priv[i].donevent);
        epicsEventDestroy(priv[i].donevent);
    }

    testDiag("All stopped");

    testDiag("Validate lockSet ref counts");
    dbInitEntry(pdbbase, &ent);
    for(status = dbFirstRecordType(&ent);
        !status;
        status = dbNextRecordType(&ent))
    {
        for(status = dbFirstRecord(&ent);
            !status;
            status = dbNextRecord(&ent))
        {
            dbCommon *prec = ent.precnode->precord;
            lockSet *ls;
            if(ent.precnode->flags&DBRN_FLAGS_ISALIAS)
                continue;
            ls = prec->lset->plockSet;
            testOk(ellCount(&ls->lockRecordList)==ls->refcount, "%s only lockRecords hold refs. %d == %d",
                   prec->name,ellCount(&ls->lockRecordList),ls->refcount);
            testOk1(ls->ownerlocker==NULL);
        }

    }
    dbFinishEntry(&ent);

    testDiag("Statistics");
    for(i=0; i<nworkers; i++) {
        testDiag("Worker %u", i);
        testDiag("N = %lu %lu %lu", priv[i].N[0], priv[i].N[1], priv[i].N[2]);
#ifdef TIME_STATS
        testDiag("X = %g %g %g", priv[i].X[0], priv[i].X[1], priv[i].X[2]);
        testDiag("X2= %g %g %g", priv[i].X2[0], priv[i].X2[1], priv[i].X2[2]);
#endif

        testOk1(priv[i].N[0]>0);
        testOk1(priv[i].N[1]>0);
        testOk1(priv[i].N[2]>0);
    }

    testIocShutdownOk();

    testdbCleanup();

    free(priv);
    free(precords);

    return testDone();
}