xenaccess.h

Go to the documentation of this file.

/*
 * The libxa library provides access to resources in domU machines.
 * 
 * Copyright (C) 2005 - 2007  Bryan D. Payne (bryan@thepaynes.cc)
 * 
 * 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) any later version.
 * 
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * --------------------
 * This file contains the public function definitions for the libxa
 * library.
 *
 * File: xenaccess.h
 *
 * Author(s): Bryan D. Payne (bryan@thepaynes.cc)
 */

#ifndef LIB_XEN_ACCESS_H
#define LIB_XEN_ACCESS_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /* HAVE_CONFIG_H */

#ifdef ENABLE_XEN
#include <xenctrl.h>
#endif /* ENABLE_XEN */
#include <stddef.h>
#include <stdint.h>
#include <time.h>
#include <stdio.h>
#include <sys/mman.h>
#include <errno.h>

/* uncomment this to enable debug output */
#define XA_DEBUG

#define XA_MODE_XEN 0

#define XA_MODE_FILE 1

#define XA_FILETYPE_DD 0

#define XA_SUCCESS 0

#define XA_FAILURE -1

#define XA_FAILHARD 0

#define XA_FAILSOFT 1

#define XA_OS_LINUX 0

#define XA_OS_WINDOWS 1

#define XA_XENVER_UNKNOWN 0

#define XA_XENVER_3_0_4 1

#define XA_XENVER_3_1_0 3

#define XA_XENVER_3_1_1 4

#define XA_XENVER_3_1_2 5

#define XA_XENVER_3_1_3 6

#define XA_XENVER_3_1_4 7

#define XA_XENVER_3_2_0 8

#define XA_XENVER_3_2_1 9

#define XA_XENVER_3_2_2 10

#define XA_XENVER_3_3_0 11

struct xa_cache_entry{
    time_t last_used;
    char *symbol_name;
    uint32_t virt_address;
    uint32_t mach_address;
    int pid;
    struct xa_cache_entry *next;
    struct xa_cache_entry *prev;
};
typedef struct xa_cache_entry* xa_cache_entry_t;

struct xa_pid_cache_entry{
    time_t last_used;
    int pid;
    uint32_t pgd;
    struct xa_pid_cache_entry *next;
    struct xa_pid_cache_entry *prev;
};
typedef struct xa_pid_cache_entry* xa_pid_cache_entry_t;

typedef struct xa_instance{
    uint32_t mode;          
    uint32_t error_mode;    
    char *sysmap;           
    char *image_type;       
    uint32_t page_offset;   
    uint32_t page_shift;    
    uint32_t page_size;     
    uint32_t kpgd;          
    uint32_t init_task;     
    int os_type;            
    int hvm;                
    int pae;                
    int pse;                
    uint32_t cr3;           
    xa_cache_entry_t cache_head;         
    xa_cache_entry_t cache_tail;         
    int current_cache_size;              
    xa_pid_cache_entry_t pid_cache_head; 
    xa_pid_cache_entry_t pid_cache_tail; 
    int current_pid_cache_size;          
    union{
        struct linux_instance{
            int tasks_offset;    
            int mm_offset;       
            int pid_offset;      
            int pgd_offset;      
            int addr_offset;     
        } linux_instance;
        struct windows_instance{
            uint32_t ntoskrnl;   
            int tasks_offset;    
            int pdbase_offset;   
            int pid_offset;      
            int peb_offset;      
            int iba_offset;      
            int ph_offset;       
        } windows_instance;
    } os;
    union{
#ifdef ENABLE_XEN
        struct xen{
            int xc_handle;       
            uint32_t domain_id;  
            int xen_version;     
            xc_dominfo_t info;   
            uint32_t size;       
            unsigned long *live_pfn_to_mfn_table;
            unsigned long nr_pfns;
        } xen;
#endif
        struct file{
            FILE *fhandle;       
            uint32_t size;       
        } file;
    } m;
} xa_instance_t;

typedef struct xa_linux_taskaddr{
    unsigned long start_code;  
    unsigned long end_code;    
    unsigned long start_data;  
    unsigned long end_data;    
    unsigned long start_brk;   
    unsigned long brk;         
    unsigned long start_stack; 
    unsigned long arg_stack;   
    unsigned long arg_end;     
    unsigned long env_start;   
    unsigned long env_end;     
} xa_linux_taskaddr_t;

typedef struct xa_windows_peb{
    uint32_t ImageBaseAddress; 
    uint32_t ProcessHeap;      
} xa_windows_peb_t;

/*--------------------------------------------------------
 * Initialization and Destruction functions from xa_core.c
 */

int xa_init_vm_name_strict (char *domain_name, xa_instance_t *instance);

int xa_init_vm_name_lax (char *domain_name, xa_instance_t *instance);

int xa_init_vm_id_strict (uint32_t domain_id, xa_instance_t *instance);

int xa_init_vm_id_lax (uint32_t domain_id, xa_instance_t *instance);

int xa_init_file_strict
    (char *filename, char *image_type, xa_instance_t *instance);

int xa_init_file_lax
    (char *filename, char *image_type, xa_instance_t *instance);

int xa_destroy (xa_instance_t *instance);

/*-----------------------------------------
 * Memory access functions from xa_memory.c
 */

void *xa_access_pa (
        xa_instance_t *instance, uint32_t phys_address,
        uint32_t *offset, int prot);

void *xa_access_ma (
        xa_instance_t *instance, uint32_t mach_address,
        uint32_t *offset, int prot);

void *xa_access_kernel_sym (
        xa_instance_t *instance, char *symbol, uint32_t *offset, int prot);

void *xa_access_kernel_va (
        xa_instance_t *instance, uint32_t virt_address,
        uint32_t *offset, int prot);

void *xa_access_kernel_va_range (
    xa_instance_t* instance, uint32_t virt_address,
    uint32_t size, uint32_t* offset, int prot);

void *xa_access_user_va (
        xa_instance_t *instance, uint32_t virt_address,
        uint32_t *offset, int pid, int prot);

void *xa_access_user_va_range (
    xa_instance_t* instance, uint32_t virt_address,
    uint32_t size, uint32_t* offset, int pid, int prot);

uint32_t xa_translate_kv2p(xa_instance_t *instance, uint32_t virt_address);

/*---------------------------------------
 * Memory access functions from xa_util.c
 */

int xa_read_long_sym (xa_instance_t *instance, char *sym, uint32_t *value);

int xa_read_long_long_sym (xa_instance_t *instance, char *sym, uint64_t *value);

int xa_read_long_virt (
        xa_instance_t *instance, uint32_t vaddr, int pid, uint32_t *value);

int xa_read_long_long_virt (
        xa_instance_t *instance, uint32_t vaddr, int pid, uint64_t *value);

int xa_read_long_phys (
        xa_instance_t *instance, uint32_t paddr, uint32_t *value);

int xa_read_long_long_phys (
        xa_instance_t *instance, uint32_t paddr, uint64_t *value);

int xa_read_long_mach (
        xa_instance_t *instance, uint32_t maddr, uint32_t *value);

int xa_read_long_long_mach (
        xa_instance_t *instance, uint32_t maddr, uint64_t *value);

int xa_symbol_to_address (xa_instance_t *instance, char *sym, uint32_t *vaddr);

/*-----------------------------
 * Linux-specific functionality
 */

int xa_linux_get_taskaddr (
        xa_instance_t *instance, int pid, xa_linux_taskaddr_t *taskaddr);

/*-----------------------------
 * Windows-specific functionality
 */

int xa_windows_get_peb (
        xa_instance_t *instance, int pid, xa_windows_peb_t *peb);


#endif /* LIB_XEN_ACCESS_H */

---