path: root/xen/include/xsm/xsm.h

/*
 *  This file contains the XSM hook definitions for Xen.
 *
 *  This work is based on the LSM implementation in Linux 2.6.13.4.
 *
 *  Author:  George Coker, <gscoker@alpha.ncsc.mil>
 *
 *  Contributors: Michael LeMay, <mdlemay@epoch.ncsc.mil>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2,
 *  as published by the Free Software Foundation.
 */

#ifndef __XSM_H__
#define __XSM_H__

#include <xen/sched.h>
#include <xen/multiboot.h>

typedef void xsm_op_t;
DEFINE_XEN_GUEST_HANDLE(xsm_op_t);

/* policy magic number (defined by XSM_MAGIC) */
typedef u32 xsm_magic_t;
#ifndef XSM_MAGIC
#define XSM_MAGIC 0x00000000
#endif

/* These annotations are used by callers and in dummy.h to document the
 * default actions of XSM hooks. They should be compiled out otherwise.
 */
enum xsm_default {
    XSM_HOOK,     /* Guests can normally access the hypercall */
    XSM_DM_PRIV,  /* Device model can perform on its target domain */
    XSM_TARGET,   /* Can perform on self or your target domain */
    XSM_PRIV,     /* Privileged - normally restricted to dom0 */
    XSM_OTHER     /* Something more complex */
};
typedef enum xsm_default xsm_default_t;

extern char *policy_buffer;
extern u32 policy_size;

typedef int (*xsm_initcall_t)(void);

extern xsm_initcall_t __xsm_initcall_start[], __xsm_initcall_end[];

#define xsm_initcall(fn) \
    static xsm_initcall_t __initcall_##fn \
    __used_section(".xsm_initcall.init") = fn

struct xsm_operations {
    void (*security_domaininfo) (struct domain *d,
                                        struct xen_domctl_getdomaininfo *info);
    int (*domain_create) (struct domain *d, u32 ssidref);
    int (*getdomaininfo) (struct domain *d);
    int (*domctl_scheduler_op) (struct domain *d, int op);
    int (*sysctl_scheduler_op) (int op);
    int (*set_target) (struct domain *d, struct domain *e);
    int (*domctl) (struct domain *d, int cmd);
    int (*sysctl) (int cmd);
    int (*readconsole) (uint32_t clear);
    int (*do_mca) (void);

    int (*evtchn_unbound) (struct domain *d, struct evtchn *chn, domid_t id2);
    int (*evtchn_interdomain) (struct domain *d1, struct evtchn *chn1,
                                        struct domain *d2, struct evtchn *chn2);
    void (*evtchn_close_post) (struct evtchn *chn);
    int (*evtchn_send) (struct domain *d, struct evtchn *chn);
    int (*evtchn_status) (struct domain *d, struct evtchn *chn);
    int (*evtchn_reset) (struct domain *d1, struct domain *d2);

    int (*grant_mapref) (struct domain *d1, struct domain *d2, uint32_t flags);
    int (*grant_unmapref) (struct domain *d1, struct domain *d2);
    int (*grant_setup) (struct domain *d1, struct domain *d2);
    int (*grant_transfer) (struct domain *d1, struct domain *d2);
    int (*grant_copy) (struct domain *d1, struct domain *d2);
    int (*grant_query_size) (struct domain *d1, struct domain *d2);

    int (*alloc_security_domain) (struct domain *d);
    void (*free_security_domain) (struct domain *d);
    int (*alloc_security_evtchn) (struct evtchn *chn);
    void (*free_security_evtchn) (struct evtchn *chn);
    char *(*show_security_evtchn) (struct domain *d, const struct evtchn *chn);

    int (*get_pod_target) (struct domain *d);
    int (*set_pod_target) (struct domain *d);
    int (*memory_exchange) (struct domain *d);
    int (*memory_adjust_reservation) (struct domain *d1, struct domain *d2);
    int (*memory_stat_reservation) (struct domain *d1, struct domain *d2);
    int (*memory_pin_page) (struct domain *d1, struct domain *d2, struct page_info *page);
    int (*add_to_physmap) (struct domain *d1, struct domain *d2);
    int (*remove_from_physmap) (struct domain *d1, struct domain *d2);
    int (*claim_pages) (struct domain *d);

    int (*console_io) (struct domain *d, int cmd);

    int (*profile) (struct domain *d, int op);

    int (*kexec) (void);
    int (*schedop_shutdown) (struct domain *d1, struct domain *d2);

    char *(*show_irq_sid) (int irq);
    int (*map_domain_pirq) (struct domain *d);
    int (*map_domain_irq) (struct domain *d, int irq, void *data);
    int (*unmap_domain_pirq) (struct domain *d);
    int (*unmap_domain_irq) (struct domain *d, int irq, void *data);
    int (*irq_permission) (struct domain *d, int pirq, uint8_t allow);
    int (*iomem_permission) (struct domain *d, uint64_t s, uint64_t e, uint8_t allow);
    int (*iomem_mapping) (struct domain *d, uint64_t s, uint64_t e, uint8_t allow);
    int (*pci_config_permission) (struct domain *d, uint32_t machine_bdf, uint16_t start, uint16_t end, uint8_t access);

    int (*get_device_group) (uint32_t machine_bdf);
    int (*test_assign_device) (uint32_t machine_bdf);
    int (*assign_device) (struct domain *d, uint32_t machine_bdf);
    int (*deassign_device) (struct domain *d, uint32_t machine_bdf);

    int (*resource_plug_core) (void);
    int (*resource_unplug_core) (void);
    int (*resource_plug_pci) (uint32_t machine_bdf);
    int (*resource_unplug_pci) (uint32_t machine_bdf);
    int (*resource_setup_pci) (uint32_t machine_bdf);
    int (*resource_setup_gsi) (int gsi);
    int (*resource_setup_misc) (void);

    int (*page_offline)(uint32_t cmd);
    int (*tmem_op)(void);
    int (*tmem_control)(void);

    long (*do_xsm_op) (XEN_GUEST_HANDLE_PARAM(xsm_op_t) op);

    int (*hvm_param) (struct domain *d, unsigned long op);
    int (*hvm_param_nested) (struct domain *d);

#ifdef CONFIG_X86
    int (*shadow_control) (struct domain *d, uint32_t op);
    int (*hvm_set_pci_intx_level) (struct domain *d);
    int (*hvm_set_isa_irq_level) (struct domain *d);
    int (*hvm_set_pci_link_route) (struct domain *d);
    int (*hvm_inject_msi) (struct domain *d);
    int (*mem_event_control) (struct domain *d, int mode, int op);
    int (*mem_event_op) (struct domain *d, int op);
    int (*mem_sharing_op) (struct domain *d, struct domain *cd, int op);
    int (*apic) (struct domain *d, int cmd);
    int (*memtype) (uint32_t access);
    int (*platform_op) (uint32_t cmd);
    int (*machine_memory_map) (void);
    int (*domain_memory_map) (struct domain *d);
#define XSM_MMU_UPDATE_READ      1
#define XSM_MMU_UPDATE_WRITE     2
#define XSM_MMU_NORMAL_UPDATE    4
#define XSM_MMU_MACHPHYS_UPDATE  8
    int (*mmu_update) (struct domain *d, struct domain *t,
                       struct domain *f, uint32_t flags);
    int (*mmuext_op) (struct domain *d, struct domain *f);
    int (*update_va_mapping) (struct domain *d, struct domain *f, l1_pgentry_t pte);
    int (*priv_mapping) (struct domain *d, struct domain *t);
    int (*bind_pt_irq) (struct domain *d, struct xen_domctl_bind_pt_irq *bind);
    int (*unbind_pt_irq) (struct domain *d, struct xen_domctl_bind_pt_irq *bind);
    int (*ioport_permission) (struct domain *d, uint32_t s, uint32_t e, uint8_t allow);
    int (*ioport_mapping) (struct domain *d, uint32_t s, uint32_t e, uint8_t allow);
#endif
#ifdef CONFIG_ARM
    int (*map_gmfn_foreign) (struct domain *d, struct domain *t);
#endif
};

#ifdef XSM_ENABLE

extern struct xsm_operations *xsm_ops;

#ifndef XSM_NO_WRAPPERS

static inline void xsm_security_domaininfo (struct domain *d,
                                        struct xen_domctl_getdomaininfo *info)
{
    xsm_ops->security_domaininfo(d, info);
}

static inline int xsm_domain_create (xsm_default_t def, struct domain *d, u32 ssidref)
{
    return xsm_ops->domain_create(d, ssidref);
}

static inline int xsm_getdomaininfo (xsm_default_t def, struct domain *d)
{
    return xsm_ops->getdomaininfo(d);
}

static inline int xsm_domctl_scheduler_op (xsm_default_t def, struct domain *d, int cmd)
{
    return xsm_ops->domctl_scheduler_op(d, cmd);
}

static inline int xsm_sysctl_scheduler_op (xsm_default_t def, int cmd)
{
    return xsm_ops->sysctl_scheduler_op(cmd);
}

static inline int xsm_set_target (xsm_default_t def, struct domain *d, struct domain *e)
{
    return xsm_ops->set_target(d, e);
}

static inline int xsm_domctl (xsm_default_t def, struct domain *d, int cmd)
{
    return xsm_ops->domctl(d, cmd);
}

static inline int xsm_sysctl (xsm_default_t def, int cmd)
{
    return xsm_ops->sysctl(cmd);
}

static inline int xsm_readconsole (xsm_default_t def, uint32_t clear)
{
    return xsm_ops->readconsole(clear);
}

static inline int xsm_do_mca(xsm_default_t def)
{
    return xsm_ops->do_mca();
}

static inline int xsm_evtchn_unbound (xsm_default_t def, struct domain *d1, struct evtchn *chn,
                                                                    domid_t id2)
{
    return xsm_ops->evtchn_unbound(d1, chn, id2);
}

static inline int xsm_evtchn_interdomain (xsm_default_t def, struct domain *d1,
                struct evtchn *chan1, struct domain *d2, struct evtchn *chan2)
{
    return xsm_ops->evtchn_interdomain(d1, chan1, d2, chan2);
}

static inline void xsm_evtchn_close_post (struct evtchn *chn)
{
    xsm_ops->evtchn_close_post(chn);
}

static inline int xsm_evtchn_send (xsm_default_t def, struct domain *d, struct evtchn *chn)
{
    return xsm_ops->evtchn_send(d, chn);
}

static inline int xsm_evtchn_status (xsm_default_t def, struct domain *d, struct evtchn *chn)
{
    return xsm_ops->evtchn_status(d, chn);
}

static inline int xsm_evtchn_reset (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->evtchn_reset(d1, d2);
}

static inline int xsm_grant_mapref (xsm_default_t def, struct domain *d1, struct domain *d2,
                                                                uint32_t flags)
{
    return xsm_ops->grant_mapref(d1, d2, flags);
}

static inline int xsm_grant_unmapref (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->grant_unmapref(d1, d2);
}

static inline int xsm_grant_setup (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->grant_setup(d1, d2);
}

static inline int xsm_grant_transfer (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->grant_transfer(d1, d2);
}

static inline int xsm_grant_copy (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->grant_copy(d1, d2);
}

static inline int xsm_grant_query_size (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->grant_query_size(d1, d2);
}

static inline int xsm_alloc_security_domain (struct domain *d)
{
    return xsm_ops->alloc_security_domain(d);
}

static inline void xsm_free_security_domain (struct domain *d)
{
    xsm_ops->free_security_domain(d);
}

static inline int xsm_alloc_security_evtchn (struct evtchn *chn)
{
    return xsm_ops->alloc_security_evtchn(chn);
}

static inline void xsm_free_security_evtchn (struct evtchn *chn)
{
    (void)xsm_ops->free_security_evtchn(chn);
}

static inline char *xsm_show_security_evtchn (struct domain *d, const struct evtchn *chn)
{
    return xsm_ops->show_security_evtchn(d, chn);
}

static inline int xsm_get_pod_target (xsm_default_t def, struct domain *d)
{
    return xsm_ops->get_pod_target(d);
}

static inline int xsm_set_pod_target (xsm_default_t def, struct domain *d)
{
    return xsm_ops->set_pod_target(d);
}

static inline int xsm_memory_exchange (xsm_default_t def, struct domain *d)
{
    return xsm_ops->memory_exchange(d);
}

static inline int xsm_memory_adjust_reservation (xsm_default_t def, struct domain *d1, struct
                                                                    domain *d2)
{
    return xsm_ops->memory_adjust_reservation(d1, d2);
}

static inline int xsm_memory_stat_reservation (xsm_default_t def, struct domain *d1,
                                                            struct domain *d2)
{
    return xsm_ops->memory_stat_reservation(d1, d2);
}

static inline int xsm_memory_pin_page(xsm_default_t def, struct domain *d1, struct domain *d2,
                                      struct page_info *page)
{
    return xsm_ops->memory_pin_page(d1, d2, page);
}

static inline int xsm_add_to_physmap(xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->add_to_physmap(d1, d2);
}

static inline int xsm_remove_from_physmap(xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->remove_from_physmap(d1, d2);
}

static inline int xsm_claim_pages(xsm_default_t def, struct domain *d)
{
    return xsm_ops->claim_pages(d);
}

static inline int xsm_console_io (xsm_default_t def, struct domain *d, int cmd)
{
    return xsm_ops->console_io(d, cmd);
}

static inline int xsm_profile (xsm_default_t def, struct domain *d, int op)
{
    return xsm_ops->profile(d, op);
}

static inline int xsm_kexec (xsm_default_t def)
{
    return xsm_ops->kexec();
}

static inline int xsm_schedop_shutdown (xsm_default_t def, struct domain *d1, struct domain *d2)
{
    return xsm_ops->schedop_shutdown(d1, d2);
}

static inline char *xsm_show_irq_sid (int irq)
{
    return xsm_ops->show_irq_sid(irq);
}

static inline int xsm_map_domain_pirq (xsm_default_t def, struct domain *d)
{
    return xsm_ops->map_domain_pirq(d);
}

static inline int xsm_map_domain_irq (xsm_default_t def, struct domain *d, int irq, void *data)
{
    return xsm_ops->map_domain_irq(d, irq, data);
}

static inline int xsm_unmap_domain_pirq (xsm_default_t def, struct domain *d)
{
    return xsm_ops->unmap_domain_pirq(d);
}

static inline int xsm_unmap_domain_irq (xsm_default_t def, struct domain *d, int irq, void *data)
{
    return xsm_ops->unmap_domain_irq(d, irq, data);
}

static inline int xsm_irq_permission (xsm_default_t def, struct domain *d, int pirq, uint8_t allow)
{
    return xsm_ops->irq_permission(d, pirq, allow);
}

static inline int xsm_iomem_permission (xsm_default_t def, struct domain *d, uint64_t s, uint64_t e, uint8_t allow)
{
    return xsm_ops->iomem_permission(d, s, e, allow);
}

static inline int xsm_iomem_mapping (xsm_default_t def, struct domain *d, uint64_t s, uint64_t e, uint8_t allow)
{
    return xsm_ops->iomem_mapping(d, s, e, allow);
}

static inline int xsm_pci_config_permission (xsm_default_t def, struct domain *d, uint32_t machine_bdf, uint16_t start, uint16_t end, uint8_t access)
{
    return xsm_ops->pci_config_permission(d, machine_bdf, start, end, access);
}

static inline int xsm_get_device_group(xsm_default_t def, uint32_t machine_bdf)
{
    return xsm_ops->get_device_group(machine_bdf);
}

static inline int xsm_test_assign_device(xsm_default_t def, uint32_t machine_bdf)
{
    return xsm_ops->test_assign_device(machine_bdf);
}

static inline int xsm_assign_device(xsm_default_t def, struct domain *d, uint32_t machine_bdf)
{
    return xsm_ops->assign_device(d, machine_bdf);
}

static inline int xsm_deassign_device(xsm_default_t def, struct domain *d, uint32_t machine_bdf)
{
    return xsm_ops->deassign_device(d, machine_bdf);
}

static inline int xsm_resource_plug_pci (xsm_default_t def, uint32_t machine_bdf)
{
    return xsm_ops->resource_plug_pci(machine_bdf);
}

static inline int xsm_resource_unplug_pci (xsm_default_t def, uint32_t machine_bdf)
{
    return xsm_ops->resource_unplug_pci(machine_bdf);
}

static inline int xsm_resource_plug_core (xsm_default_t def)
{
    return xsm_ops->resource_plug_core();
}

static inline int xsm_resource_unplug_core (xsm_default_t def)
{
    return xsm_ops->resource_unplug_core();
}

static inline int xsm_resource_setup_pci (xsm_default_t def, uint32_t machine_bdf)
{
    return xsm_ops->resource_setup_pci(machine_bdf);
}

static inline int xsm_resource_setup_gsi (xsm_default_t def, int gsi)
{
    return xsm_ops->resource_setup_gsi(gsi);
}

static inline int xsm_resource_setup_misc (xsm_default_t def)
{
    return xsm_ops->resource_setup_misc();
}

static inline int xsm_page_offline(xsm_default_t def, uint32_t cmd)
{
    return xsm_ops->page_offline(cmd);
}

static inline int xsm_tmem_op(xsm_default_t def)
{
    return xsm_ops->tmem_op();
}

static inline int xsm_tmem_control(xsm_default_t def)
{
    return xsm_ops->tmem_control();
}

static inline long xsm_do_xsm_op (XEN_GUEST_HANDLE_PARAM(xsm_op_t) op)
{
    return xsm_ops->do_xsm_op(op);
}

static inline int xsm_hvm_param (xsm_default_t def, struct domain *d, unsigned long op)
{
    return xsm_ops->hvm_param(d, op);
}

static inline int xsm_hvm_param_nested (xsm_default_t def, struct domain *d)
{
    return xsm_ops->hvm_param_nested(d);
}

#ifdef CONFIG_X86
static inline int xsm_shadow_control (xsm_default_t def, struct domain *d, uint32_t op)
{
    return xsm_ops->shadow_control(d, op);
}

static inline int xsm_hvm_set_pci_intx_level (xsm_default_t def, struct domain *d)
{
    return xsm_ops->hvm_set_pci_intx_level(d);
}

static inline int xsm_hvm_set_isa_irq_level (xsm_default_t def, struct domain *d)
{
    return xsm_ops->hvm_set_isa_irq_level(d);
}

static inline int xsm_hvm_set_pci_link_route (xsm_default_t def, struct domain *d)
{
    return xsm_ops->hvm_set_pci_link_route(d);
}

static inline int xsm_hvm_inject_msi (xsm_default_t def, struct domain *d)
{
    return xsm_ops->hvm_inject_msi(d);
}

static inline int xsm_mem_event_control (xsm_default_t def, struct domain *d, int mode, int op)
{
    return xsm_ops->mem_event_control(d, mode, op);
}

static inline int xsm_mem_event_op (xsm_default_t def, struct domain *d, int op)
{
    return xsm_ops->mem_event_op(d, op);
}

static inline int xsm_mem_sharing_op (xsm_default_t def, struct domain *d, struct domain *cd, int op)
{
    return xsm_ops->mem_sharing_op(d, cd, op);
}

static inline int xsm_apic (xsm_default_t def, struct domain *d, int cmd)
{
    return xsm_ops->apic(d, cmd);
}

static inline int xsm_memtype (xsm_default_t def, uint32_t access)
{
    return xsm_ops->memtype(access);
}

static inline int xsm_platform_op (xsm_default_t def, uint32_t op)
{
    return xsm_ops->platform_op(op);
}

static inline int xsm_machine_memory_map(xsm_default_t def)
{
    return xsm_ops->machine_memory_map();
}

static inline int xsm_domain_memory_map(xsm_default_t def, struct domain *d)
{
    return xsm_ops->domain_memory_map(d);
}

static inline int xsm_mmu_update (xsm_default_t def, struct domain *d, struct domain *t,
                                  struct domain *f, uint32_t flags)
{
    return xsm_ops->mmu_update(d, t, f, flags);
}

static inline int xsm_mmuext_op (xsm_default_t def, struct domain *d, struct domain *f)
{
    return xsm_ops->mmuext_op(d, f);
}

static inline int xsm_update_va_mapping(xsm_default_t def, struct domain *d, struct domain *f,
                                                            l1_pgentry_t pte)
{
    return xsm_ops->update_va_mapping(d, f, pte);
}

static inline int xsm_priv_mapping(xsm_default_t def, struct domain *d, struct domain *t)
{
    return xsm_ops->priv_mapping(d, t);
}

static inline int xsm_bind_pt_irq(xsm_default_t def, struct domain *d,
                                                struct xen_domctl_bind_pt_irq *bind)
{
    return xsm_ops->bind_pt_irq(d, bind);
}

static inline int xsm_unbind_pt_irq(xsm_default_t def, struct domain *d,
                                                struct xen_domctl_bind_pt_irq *bind)
{
    return xsm_ops->unbind_pt_irq(d, bind);
}

static inline int xsm_ioport_permission (xsm_default_t def, struct domain *d, uint32_t s, uint32_t e, uint8_t allow)
{
    return xsm_ops->ioport_permission(d, s, e, allow);
}

static inline int xsm_ioport_mapping (xsm_default_t def, struct domain *d, uint32_t s, uint32_t e, uint8_t allow)
{
    return xsm_ops->ioport_mapping(d, s, e, allow);
}
#endif /* CONFIG_X86 */

#ifdef CONFIG_ARM
static inline int xsm_map_gmfn_foreign (struct domain *d, struct domain *t)
{
    return xsm_ops->map_gmfn_foreign(d, t);
}
#endif /* CONFIG_ARM */

#endif /* XSM_NO_WRAPPERS */

extern int xsm_init(unsigned long *module_map, const multiboot_info_t *mbi,
                    void *(*bootstrap_map)(const module_t *));
extern int xsm_policy_init(unsigned long *module_map,
                           const multiboot_info_t *mbi,
                           void *(*bootstrap_map)(const module_t *));
extern int register_xsm(struct xsm_operations *ops);
extern int unregister_xsm(struct xsm_operations *ops);

extern struct xsm_operations dummy_xsm_ops;
extern void xsm_fixup_ops(struct xsm_operations *ops);

#else /* XSM_ENABLE */

#include <xsm/dummy.h>

static inline int xsm_init (unsigned long *module_map,
                            const multiboot_info_t *mbi,
                            void *(*bootstrap_map)(const module_t *))
{
    return 0;
}
#endif /* XSM_ENABLE */

#endif /* __XSM_H */