/*
 * Copyright (c) 2006 Apple Inc.  All Rights Reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdbool.h>
#include <errno.h>
#include <string.h>

// add additional headers needed here.

#include "../libmicro.h"
#include <pwd.h>

#if DEBUG
# define debug(fmt, args...)    (void) fprintf(stderr, fmt "\n" , ##args)
#else
# define debug(fmt, args...)
#endif


// Correct use case
//
//    getpwuid -E  -L -S -W -B 200 -C 10 -c 100 -u 5000-5200
//
//      libMicro default benchmark run options are "-E -L -S -W -C 200"
//
// -B is batch size: loop iteration per each benchmark run. Needs to match # of
//                   real lookups. This is total number of lookups to issue.
// -C is min sample number: how many benchmark needs to run to get proper sample
//                          1 is mimumum, but you get at least 3 benchmark run
//                          samples. Do not set to zero. Default is 200 for most
//                          runs in libMicro.
// -c is the cache hit rate for lookup. set to 10%, you need -c 10.
//                ie. -B 100 -c 50 -u 5000-5199
//                     out of 200 UIDs, I want 50% cache hit, and batch size is 100. 
// -u uid range in the form of "min-max". For example, -u 5000-5200
//

extern int gL1CacheEnabled;

/*
 *    Your state variables should live in the tsd_t struct below
 */
typedef struct {
} tsd_t;

// temporary buffer size
#define BUFSIZE 200
#define INVALID_ID  -1

static uid_t  uid_min = INVALID_ID;
static int    uid_range = 0;  // uid_max = uid_min + uid_range

// the number of record lookup to issue is covered by standard option optB
static int    optCachehit =   100;  // specify cache hit rate (% of record re-lookup)

int
benchmark_init()
{
    debug("benchmark_init");
    (void) sprintf(lm_optstr, "l:c:u:");

    lm_tsdsize = sizeof (tsd_t);
    lm_defB = 100;

    (void) sprintf(lm_usage,
                "\n     ------- getpwuid specific options (default: *)\n"
                "       [-c hitrate%% (100%%*)]\n"
                "       [-u UID range (min-max)]\n"
                "       [-l]\n"
                "\n" );
    return (0);
}

int
parse_range(uid_t *min, int *offset, char *buf)
{
    char *value, *tmp_ptr = strdup(buf);
    int range=0;
    debug("parse_range");

    value = strsep(&tmp_ptr, "-");
    *min = atoi(value);
    debug("min = %d", *min);
    if (tmp_ptr) {
        value = strsep(&tmp_ptr, "-");
        range = atoi(value);
        if (range < *min) {
            printf("max id should be larger than min id\n");
            return -1;
        }
        *offset = range - *min + 1;
        debug("range = %d", *offset);
    }
    else {
        printf("argument should be in the form of min-max\n");
        return -1;
    }

    return 0;
}

/*
 * This is where you parse your lower-case arguments.
 */
int
benchmark_optswitch(int opt, char *optarg)
{
    debug("benchmark_optswitch");

    switch (opt) {
    case 'c':    // cache hit rate. 100% means lookup the same records over and over
        optCachehit = atoi(optarg);
        debug("optCachehit = %d\n", optCachehit);
        if (optCachehit > 100 || optCachehit < 0) {
            printf("cache hit rate should be in between 0%% and 100%%");
            return (-1);
        }
        break;
            
    case 'l':
        gL1CacheEnabled = atoi(optarg);
        break;

    case 'u':    // UID range
        return parse_range( &uid_min, &uid_range, optarg);
        break;

    default:
        return -1;
    }

    return 0;
}


// Initialize all structures that will be used in benchmark()
// moved template init from benchmark_initworker -> benchmark_initrun
//  since username_list is static across threads and processes
//
int
benchmark_initrun()
{
    uid_t i, range;
    struct passwd *passwd = NULL;

    debug("\nbenchmark_initrun");

    // To satisfy cache hit rate, lookup cachehit percentage of the UIDs here 
    if (optCachehit < 100) {
    
        range = (int) ((float) uid_range * ((float) optCachehit / 100));
        for (i = uid_min; i < uid_min+range; i++)
            passwd = getpwuid( i );
    }

    return (0);
}


int
benchmark(void *tsd, result_t *res)
{
    int         i, err;
    struct passwd *passwd = NULL;

    res->re_errors = 0;

    debug("in to benchmark - optB = %i", lm_optB);
    for (i = 0; i < lm_optB; i++) {
        uid_t uid = uid_min + random() % uid_range ;

        // XXX No need to use getpwuid_r() since getpwuid() is already thread-safe
        // so it depends on what you want to exercise
        if (lm_optT > 1) {
            struct passwd pd;
            struct passwd *pwd_ptr = &pd;
            struct passwd *tmp_ptr;
            char pbuf[BUFSIZE];

            err = getpwuid_r( uid, pwd_ptr, pbuf, BUFSIZE, &tmp_ptr );
            if (err) {
                debug("error: %s", strerror(err));
                res->re_errors++;
            }
            else if (!tmp_ptr) {
                debug("not found: UID %d", uid);
                res->re_errors++;
            }
        }
        else {
            errno = 0;
            passwd = getpwuid( uid );

            if (!passwd) {
                if (errno) {
                    debug("error: %s", strerror(errno));
                    res->re_errors++;
                }
                else {
                    debug("not found: UID %d", uid);
                    res->re_errors++;
                }
            }
        }
    }
    res->re_count = i;

    return (0);
}

// We need to release all the structures we allocated in benchmark_initrun()
int
benchmark_finirun(void *tsd)
{
    // tsd_t    *ts = (tsd_t *)tsd;
    debug("benchmark_finirun ");

    return (0);
}

char *
benchmark_result()
{
    static char    result = '\0';
    debug("benchmark_result");
    return (&result);
}