ial.h

Go to the documentation of this file.

/*******************************************************************************/
/*  © Université de Lille, The Pip Development Team (2015-2021)                */
/*                                                                             */
/*  This software is a computer program whose purpose is to run a minimal,     */
/*  hypervisor relying on proven properties such as memory isolation.          */
/*                                                                             */
/*  This software is governed by the CeCILL license under French law and       */
/*  abiding by the rules of distribution of free software.  You can  use,      */
/*  modify and/ or redistribute the software under the terms of the CeCILL     */
/*  license as circulated by CEA, CNRS and INRIA at the following URL          */
/*  "http://www.cecill.info".                                                  */
/*                                                                             */
/*  As a counterpart to the access to the source code and  rights to copy,     */
/*  modify and redistribute granted by the license, users are provided only    */
/*  with a limited warranty  and the software's author,  the holder of the     */
/*  economic rights,  and the successive licensors  have only  limited         */
/*  liability.                                                                 */
/*                                                                             */
/*  In this respect, the user's attention is drawn to the risks associated     */
/*  with loading,  using,  modifying and/or developing or reproducing the      */
/*  software by the user in light of its specific status of free software,     */
/*  that may mean  that it is complicated to manipulate,  and  that  also      */
/*  therefore means  that it is reserved for developers  and  experienced      */
/*  professionals having in-depth computer knowledge. Users are therefore      */
/*  encouraged to load and test the software's suitability as regards their    */
/*  requirements in conditions enabling the security of their systems and/or   */
/*  data to be ensured and,  more generally, to use and operate it in the      */
/*  same conditions as regards security.                                       */
/*                                                                             */
/*  The fact that you are presently reading this means that you have had       */
/*  knowledge of the CeCILL license and that you accept its terms.             */
/*******************************************************************************/

#ifndef __IAL__
#define __IAL__

#include <stdint.h>

typedef enum user_ctx_role_e {
    /* saved when an interruption occurs*/
    INT_CTX = 0,
    /* saved when partition triggers fault*/
    ISR_CTX = 1,
    /* saved in parent when notifying a child */
    NOTIF_CHILD_CTX = 2,
    /* saved in child when notifying the parent */
    NOTIF_PARENT_CTX = 3,
    /* the invalid index */
    INVALID_CTX = 4,
} user_ctx_role_t;

// These are deprecated and are about to be removed
void initInterrupts(); 
void panic(); 

// The TRUE interface
void enableInterrupts(); 
void disableInterrupts(); 
void dispatch2 (uint32_t partition, uint32_t vint, uint32_t data1, uint32_t data2, uint32_t caller); 
void resume (uint32_t descriptor, uint32_t pipflags); 

// FIXME: move this away
#include <x86int.h>
void
dispatchGlue (uint32_t descriptor, uint32_t vint, uint32_t notify,
              uint32_t data1, uint32_t data2
#ifndef X86SMP
              , gate_ctx_t *ctx);
#else
                );
#endif

void
yieldGlue (uint32_t calleePartDescVAddr, uint32_t userTargetInterrupt, uint32_t userCallerContextSaveIndex, uint32_t flagsOnWake, uint32_t flagsOnYield
#ifndef X86SMP
              , gate_ctx_t *ctx);
#else
                );
#endif

struct partition_id {
    uint32_t partition;
    uint32_t id;
};

struct hardware_def {
    const char* name;
    uintptr_t   paddr_base;
    uintptr_t   vaddr_base;
    uintptr_t   limit;
};

typedef struct partition_id pip_pid;

#endif