/*
 * Copyright (C) 2005-2008 by Pieter Palmers
 * Copytight (C) 2012 by Jonathan Woithe
 *
 * This file is part of FFADO
 * FFADO = Free FireWire (pro-)audio drivers for Linux
 *
 * FFADO is based upon FreeBoB.
 *
 * 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) version 3 of the License.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 *
 */
#include "config.h"

#include "SystemTimeSource.h"
#include "Time.h"

// needed for clock_nanosleep
#ifndef _GNU_SOURCE
    #define _GNU_SOURCE
#endif

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

DECLARE_GLOBAL_DEBUG_MODULE;

namespace Util {

static clockid_t clock_id = CLOCK_REALTIME;

bool
SystemTimeSource::setSource(clockid_t id)
{
    struct timespec tp;
    // Determine at runtime whether the kernel has support for the
    // requested clock source.
    if (clock_gettime(id, &tp) == 0) {
        clock_id = id;
        return true;
    }
    return false;
}

clockid_t
SystemTimeSource::getSource(void)
{
    return clock_id;
}

int
SystemTimeSource::clockGettime(struct timespec *tp)
{
    return clock_gettime(clock_id, tp);
}

void
SystemTimeSource::SleepUsecRelative(ffado_microsecs_t usecs)
{
    //usleep(usecs);
    struct timespec ts;
    ts.tv_sec = usecs / (1000000LL);
    ts.tv_nsec = (usecs % (1000000LL)) * 1000LL;

    // clock_nanosleep() is not implemented for CLOCK_MONOTONIC_RAW.
    // If the clock source is CLOCK_MONOTONIC_RAW, use CLOCK_MONOTONIC
    // as an approximation for the purposes of sleep timing.
    clockid_t clk = (clock_id==CLOCK_MONOTONIC_RAW)?CLOCK_MONOTONIC:clock_id;

    clock_nanosleep(clk, 0, &ts, NULL);
}

void
SystemTimeSource::SleepUsecAbsolute(ffado_microsecs_t wake_at_usec)
{
#if USE_ABSOLUTE_NANOSLEEP
    // If the system time is based on CLOCK_MONOTONIC_RAW we can't use
    // TIMER_ABSTIME even if it is available because wake_at_usec will be in
    // terms of CLOCK_MONOTONIC_RAW while clock_nanosleep() can at best use
    // only CLOCK_MONOTONIC.  There is, AFAIK, no guarantee that the two are
    // even remotely related.  For now, resolve this problem by only using
    // TIMER_ABSTIME when CLOCK_MONOTONIC_RAW is not in use.
    if (clock_id != CLOCK_MONOTONIC_RAW) {
        struct timespec ts;
        ts.tv_sec = wake_at_usec / (1000000LL);
        ts.tv_nsec = (wake_at_usec % (1000000LL)) * 1000LL;
        debugOutputExtreme(DEBUG_LEVEL_VERBOSE,
                       "clock_nanosleep until %" PRId64 " sec, %" PRId64 " nanosec\n",
                       (int64_t)ts.tv_sec, (int64_t)ts.tv_nsec);
        int err = clock_nanosleep(clock_id, TIMER_ABSTIME, &ts, NULL);
        if(err) {
            // maybe signal occurred, but we're going to ignore that
        }
        debugOutputExtreme(DEBUG_LEVEL_VERBOSE, "back with err=%d\n", err);
    } else
#endif
    {
        // only sleep if needed
        ffado_microsecs_t now = getCurrentTime();
        if(wake_at_usec >= now) {
            ffado_microsecs_t to_sleep = wake_at_usec - now;
            SleepUsecRelative(to_sleep);
        }
    }
}

ffado_microsecs_t
SystemTimeSource::SleepUsecRandom(ffado_microsecs_t max_usec)
{
    long int rnd = random();
    long long int tmp = (rnd*max_usec);
    tmp /= RAND_MAX;
    ffado_microsecs_t usec = tmp;
    SleepUsecRelative(usec);
    return usec;
}

ffado_microsecs_t
SystemTimeSource::getCurrentTime()
{
    return getCurrentTimeAsUsecs();
}

ffado_microsecs_t
SystemTimeSource::getCurrentTimeAsUsecs()
{
    struct timespec ts;
    clock_gettime(clock_id, &ts);
    return (ffado_microsecs_t)(ts.tv_sec * 1000000LL + ts.tv_nsec / 1000LL);
}

} // end of namespace Util
