/*
 * This file is part of the Palacios Virtual Machine Monitor developed
 * by the V3VEE Project with funding from the United States National 
 * Science Foundation and the Department of Energy.  
 *
 * The V3VEE Project is a joint project between Northwestern University
 * and the University of New Mexico.  You can find out more at 
 * http://www.v3vee.org
 *
 * Copyright (c) 2010, Patrick Bridges <bridges@cs.unm.edu>
 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
 * All rights reserved.
 *
 * Author: Jack Lange <jarusl@cs.northwestern.edu>
 *         Patrick Bridges <bridges@cs.unm.edu>
 *
 * This is free software.  You are permitted to use,
 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
 */

#ifndef __VMM_TIME_H
#define __VMM_TIME_H

#ifdef __V3VEE__

#include <palacios/vmm_types.h>
#include <palacios/vmm_list.h>
#include <palacios/vmm_msr.h>
#include <palacios/vmm_util.h>

struct guest_info;


/* Per-VM time information */
struct v3_time {
    int flags;
    uint32_t td_num, td_denom; 
};
#define V3_TIME_SLAVE_HOST (1 << 0)
#define V3_TIME_TSC_PASSTHROUGH (1 << 1)

/* Per-core time information */
struct vm_core_time {
    uint32_t host_cpu_freq;    // in kHZ 
    uint32_t guest_cpu_freq;   // can be lower than host CPU freq!

    // Multipliers for TSC speed and performance speed
    uint32_t clock_ratio_num, clock_ratio_denom;
    uint32_t ipc_ratio_num, ipc_ratio_denom;

    uint64_t guest_cycles;
    sint64_t tsc_guest_offset; // Offset of guest TSC from guest cycles

    uint64_t last_update;      // Last time (in guest cycles) the 
                               // timers were updated

    uint64_t initial_host_time;// Host time when VMM started. 
    struct v3_msr tsc_aux;     // Auxilliary MSR for RDTSCP

    int flags;
	
    // Installed Timers slaved off of the guest monotonic TSC
    uint_t num_timers;
    struct list_head timers;

};

#define VM_TIME_SLAVE_HOST (1 << 0)
#define VM_TIME_TSC_PASSTHROUGH (1 << 1)
#define VM_TIME_TRAP_RDTSC (1 << 2)

struct v3_timer_ops {
    void (*update_timer)(struct guest_info * info, ullong_t cpu_cycles, ullong_t cpu_freq, void * priv_data);
    void (*advance_timer)(struct guest_info * info, void * private_data);
};

struct v3_timer {
    void * private_data;
    struct v3_timer_ops * ops;

    // Need to add accuracy/resolution fields later.

    struct list_head timer_link;
};



// Basic functions for handling passage of time in palacios
void v3_init_time_core(struct guest_info * core);
int v3_init_time_vm(struct v3_vm_info * vm);

void v3_deinit_time_core(struct guest_info * core);
void v3_deinit_time_vm(struct v3_vm_info * vm);

int v3_start_time(struct guest_info * core);

int v3_advance_time(struct guest_info * core, uint64_t * guest_cycles);

// Basic functions for attaching timers to the passage of time - these timers 
// should eventually specify their accuracy and resolution.
struct v3_timer * v3_add_timer(struct guest_info * info, struct v3_timer_ops * ops, void * private_data);
int v3_remove_timer(struct guest_info * info, struct v3_timer * timer);
void v3_update_timers(struct guest_info * info);

// Functions to return the different notions of time in Palacios.
static inline uint64_t v3_get_host_time(struct vm_core_time *t) {
    uint64_t tmp;
    rdtscll(tmp);
    return tmp;
}

// Returns *monotonic* guest time.
static inline uint64_t v3_get_guest_time(struct vm_core_time *t) {
    return t->guest_cycles;
}

static inline uint64_t v3_get_guest_tsc(struct vm_core_time *t) {
    return v3_get_guest_time(t) + t->tsc_guest_offset;
}

// Returns offset of guest TSC from host TSC
static inline sint64_t v3_tsc_host_offset(struct vm_core_time *time_state) {
    uint64_t host_time = v3_get_host_time(time_state);
    return (sint64_t)v3_get_guest_tsc(time_state) - (sint64_t)host_time;
}

// Functions for handling exits on the TSC when fully virtualizing 
// the timestamp counter.
#define TSC_MSR     0x10
#define TSC_AUX_MSR 0xC0000103

int v3_handle_rdtscp(struct guest_info *info);
int v3_handle_rdtsc(struct guest_info *info);




#endif // !__V3VEE__

#endif