alternative.c

Go to the documentation of this file.

#define pr_fmt(fmt) "SMP alternatives: " fmt

#include <linux/module.h>
#include <linux/sched.h>
#include <linux/mutex.h>
#include <linux/list.h>
#include <linux/stringify.h>
#include <linux/kprobes.h>
#include <linux/mm.h>
#include <linux/vmalloc.h>
#include <linux/memory.h>
#include <linux/stop_machine.h>
#include <linux/slab.h>
#include <asm/alternative.h>
#include <asm/sections.h>
#include <asm/pgtable.h>
#include <asm/mce.h>
#include <asm/nmi.h>
#include <asm/cacheflush.h>
#include <asm/tlbflush.h>
#include <asm/io.h>
#include <asm/fixmap.h>

#define MAX_PATCH_LEN (255-1)

static int __initdata_or_module debug_alternative;

static int __init debug_alt(char *str)
{
    debug_alternative = 1;
    return 1;
}
__setup("debug-alternative", debug_alt);

static int noreplace_smp;

static int __init setup_noreplace_smp(char *str)
{
    noreplace_smp = 1;
    return 1;
}
__setup("noreplace-smp", setup_noreplace_smp);

#ifdef CONFIG_PARAVIRT
static int __initdata_or_module noreplace_paravirt = 0;

static int __init setup_noreplace_paravirt(char *str)
{
    noreplace_paravirt = 1;
    return 1;
}
__setup("noreplace-paravirt", setup_noreplace_paravirt);
#endif

#define DPRINTK(fmt, ...)               \
do {                            \
    if (debug_alternative)              \
        printk(KERN_DEBUG fmt, ##__VA_ARGS__);  \
} while (0)

/*
 * Each GENERIC_NOPX is of X bytes, and defined as an array of bytes
 * that correspond to that nop. Getting from one nop to the next, we
 * add to the array the offset that is equal to the sum of all sizes of
 * nops preceding the one we are after.
 *
 * Note: The GENERIC_NOP5_ATOMIC is at the end, as it breaks the
 * nice symmetry of sizes of the previous nops.
 */
#if defined(GENERIC_NOP1) && !defined(CONFIG_X86_64)
static const unsigned char intelnops[] =
{
    GENERIC_NOP1,
    GENERIC_NOP2,
    GENERIC_NOP3,
    GENERIC_NOP4,
    GENERIC_NOP5,
    GENERIC_NOP6,
    GENERIC_NOP7,
    GENERIC_NOP8,
    GENERIC_NOP5_ATOMIC
};
static const unsigned char * const intel_nops[ASM_NOP_MAX+2] =
{
    NULL,
    intelnops,
    intelnops + 1,
    intelnops + 1 + 2,
    intelnops + 1 + 2 + 3,
    intelnops + 1 + 2 + 3 + 4,
    intelnops + 1 + 2 + 3 + 4 + 5,
    intelnops + 1 + 2 + 3 + 4 + 5 + 6,
    intelnops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
    intelnops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
};
#endif

#ifdef K8_NOP1
static const unsigned char k8nops[] =
{
    K8_NOP1,
    K8_NOP2,
    K8_NOP3,
    K8_NOP4,
    K8_NOP5,
    K8_NOP6,
    K8_NOP7,
    K8_NOP8,
    K8_NOP5_ATOMIC
};
static const unsigned char * const k8_nops[ASM_NOP_MAX+2] =
{
    NULL,
    k8nops,
    k8nops + 1,
    k8nops + 1 + 2,
    k8nops + 1 + 2 + 3,
    k8nops + 1 + 2 + 3 + 4,
    k8nops + 1 + 2 + 3 + 4 + 5,
    k8nops + 1 + 2 + 3 + 4 + 5 + 6,
    k8nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
    k8nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
};
#endif

#if defined(K7_NOP1) && !defined(CONFIG_X86_64)
static const unsigned char k7nops[] =
{
    K7_NOP1,
    K7_NOP2,
    K7_NOP3,
    K7_NOP4,
    K7_NOP5,
    K7_NOP6,
    K7_NOP7,
    K7_NOP8,
    K7_NOP5_ATOMIC
};
static const unsigned char * const k7_nops[ASM_NOP_MAX+2] =
{
    NULL,
    k7nops,
    k7nops + 1,
    k7nops + 1 + 2,
    k7nops + 1 + 2 + 3,
    k7nops + 1 + 2 + 3 + 4,
    k7nops + 1 + 2 + 3 + 4 + 5,
    k7nops + 1 + 2 + 3 + 4 + 5 + 6,
    k7nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
    k7nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
};
#endif

#ifdef P6_NOP1
static const unsigned char p6nops[] =
{
    P6_NOP1,
    P6_NOP2,
    P6_NOP3,
    P6_NOP4,
    P6_NOP5,
    P6_NOP6,
    P6_NOP7,
    P6_NOP8,
    P6_NOP5_ATOMIC
};
static const unsigned char * const p6_nops[ASM_NOP_MAX+2] =
{
    NULL,
    p6nops,
    p6nops + 1,
    p6nops + 1 + 2,
    p6nops + 1 + 2 + 3,
    p6nops + 1 + 2 + 3 + 4,
    p6nops + 1 + 2 + 3 + 4 + 5,
    p6nops + 1 + 2 + 3 + 4 + 5 + 6,
    p6nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
    p6nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
};
#endif

/* Initialize these to a safe default */
#ifdef CONFIG_X86_64
const unsigned char * const *ideal_nops = p6_nops;
#else
const unsigned char * const *ideal_nops = intel_nops;
#endif

void __init arch_init_ideal_nops(void)
{
    switch (boot_cpu_data.x86_vendor) {
    case X86_VENDOR_INTEL:
        /*
         * Due to a decoder implementation quirk, some
         * specific Intel CPUs actually perform better with
         * the "k8_nops" than with the SDM-recommended NOPs.
         */
        if (boot_cpu_data.x86 == 6 &&
            boot_cpu_data.x86_model >= 0x0f &&
            boot_cpu_data.x86_model != 0x1c &&
            boot_cpu_data.x86_model != 0x26 &&
            boot_cpu_data.x86_model != 0x27 &&
            boot_cpu_data.x86_model < 0x30) {
            ideal_nops = k8_nops;
        } else if (boot_cpu_has(X86_FEATURE_NOPL)) {
               ideal_nops = p6_nops;
        } else {
#ifdef CONFIG_X86_64
            ideal_nops = k8_nops;
#else
            ideal_nops = intel_nops;
#endif
        }
        break;
    default:
#ifdef CONFIG_X86_64
        ideal_nops = k8_nops;
#else
        if (boot_cpu_has(X86_FEATURE_K8))
            ideal_nops = k8_nops;
        else if (boot_cpu_has(X86_FEATURE_K7))
            ideal_nops = k7_nops;
        else
            ideal_nops = intel_nops;
#endif
    }
}

/* Use this to add nops to a buffer, then text_poke the whole buffer. */
static void __init_or_module add_nops(void *insns, unsigned int len)
{
    while (len > 0) {
        unsigned int noplen = len;
        if (noplen > ASM_NOP_MAX)
            noplen = ASM_NOP_MAX;
        memcpy(insns, ideal_nops[noplen], noplen);
        insns += noplen;
        len -= noplen;
    }
}

extern struct alt_instr __alt_instructions[], __alt_instructions_end[];
extern s32 __smp_locks[], __smp_locks_end[];
void *text_poke_early(void *addr, const void *opcode, size_t len);

/* Replace instructions with better alternatives for this CPU type.
   This runs before SMP is initialized to avoid SMP problems with
   self modifying code. This implies that asymmetric systems where
   APs have less capabilities than the boot processor are not handled.
   Tough. Make sure you disable such features by hand. */

void __init_or_module apply_alternatives(struct alt_instr *start,
                     struct alt_instr *end)
{
    struct alt_instr *a;
    u8 *instr, *replacement;
    u8 insnbuf[MAX_PATCH_LEN];

    DPRINTK("%s: alt table %p -> %p\n", __func__, start, end);
    /*
     * The scan order should be from start to end. A later scanned
     * alternative code can overwrite a previous scanned alternative code.
     * Some kernel functions (e.g. memcpy, memset, etc) use this order to
     * patch code.
     *
     * So be careful if you want to change the scan order to any other
     * order.
     */
    for (a = start; a < end; a++) {
        instr = (u8 *)&a->instr_offset + a->instr_offset;
        replacement = (u8 *)&a->repl_offset + a->repl_offset;
        BUG_ON(a->replacementlen > a->instrlen);
        BUG_ON(a->instrlen > sizeof(insnbuf));
        BUG_ON(a->cpuid >= NCAPINTS*32);
        if (!boot_cpu_has(a->cpuid))
            continue;

        memcpy(insnbuf, replacement, a->replacementlen);

        /* 0xe8 is a relative jump; fix the offset. */
        if (*insnbuf == 0xe8 && a->replacementlen == 5)
            *(s32 *)(insnbuf + 1) += replacement - instr;

        add_nops(insnbuf + a->replacementlen,
             a->instrlen - a->replacementlen);

        text_poke_early(instr, insnbuf, a->instrlen);
    }
}

#ifdef CONFIG_SMP

static void alternatives_smp_lock(const s32 *start, const s32 *end,
                  u8 *text, u8 *text_end)
{
    const s32 *poff;

    mutex_lock(&text_mutex);
    for (poff = start; poff < end; poff++) {
        u8 *ptr = (u8 *)poff + *poff;

        if (!*poff || ptr < text || ptr >= text_end)
            continue;
        /* turn DS segment override prefix into lock prefix */
        if (*ptr == 0x3e)
            text_poke(ptr, ((unsigned char []){0xf0}), 1);
    }
    mutex_unlock(&text_mutex);
}

static void alternatives_smp_unlock(const s32 *start, const s32 *end,
                    u8 *text, u8 *text_end)
{
    const s32 *poff;

    mutex_lock(&text_mutex);
    for (poff = start; poff < end; poff++) {
        u8 *ptr = (u8 *)poff + *poff;

        if (!*poff || ptr < text || ptr >= text_end)
            continue;
        /* turn lock prefix into DS segment override prefix */
        if (*ptr == 0xf0)
            text_poke(ptr, ((unsigned char []){0x3E}), 1);
    }
    mutex_unlock(&text_mutex);
}

struct smp_alt_module {
    /* what is this ??? */
    struct module   *mod;
    char        *name;

    /* ptrs to lock prefixes */
    const s32   *locks;
    const s32   *locks_end;

    /* .text segment, needed to avoid patching init code ;) */
    u8      *text;
    u8      *text_end;

    struct list_head next;
};
static LIST_HEAD(smp_alt_modules);
static DEFINE_MUTEX(smp_alt);
static bool uniproc_patched = false;    /* protected by smp_alt */

void __init_or_module alternatives_smp_module_add(struct module *mod,
                          char *name,
                          void *locks, void *locks_end,
                          void *text,  void *text_end)
{
    struct smp_alt_module *smp;

    mutex_lock(&smp_alt);
    if (!uniproc_patched)
        goto unlock;

    if (num_possible_cpus() == 1)
        /* Don't bother remembering, we'll never have to undo it. */
        goto smp_unlock;

    smp = kzalloc(sizeof(*smp), GFP_KERNEL);
    if (NULL == smp)
        /* we'll run the (safe but slow) SMP code then ... */
        goto unlock;

    smp->mod    = mod;
    smp->name   = name;
    smp->locks  = locks;
    smp->locks_end  = locks_end;
    smp->text   = text;
    smp->text_end   = text_end;
    DPRINTK("%s: locks %p -> %p, text %p -> %p, name %s\n",
        __func__, smp->locks, smp->locks_end,
        smp->text, smp->text_end, smp->name);

    list_add_tail(&smp->next, &smp_alt_modules);
smp_unlock:
    alternatives_smp_unlock(locks, locks_end, text, text_end);
unlock:
    mutex_unlock(&smp_alt);
}

void __init_or_module alternatives_smp_module_del(struct module *mod)
{
    struct smp_alt_module *item;

    mutex_lock(&smp_alt);
    list_for_each_entry(item, &smp_alt_modules, next) {
        if (mod != item->mod)
            continue;
        list_del(&item->next);
        kfree(item);
        break;
    }
    mutex_unlock(&smp_alt);
}

void alternatives_enable_smp(void)
{
    struct smp_alt_module *mod;

#ifdef CONFIG_LOCKDEP
    /*
     * Older binutils section handling bug prevented
     * alternatives-replacement from working reliably.
     *
     * If this still occurs then you should see a hang
     * or crash shortly after this line:
     */
    pr_info("lockdep: fixing up alternatives\n");
#endif

    /* Why bother if there are no other CPUs? */
    BUG_ON(num_possible_cpus() == 1);

    mutex_lock(&smp_alt);

    if (uniproc_patched) {
        pr_info("switching to SMP code\n");
        BUG_ON(num_online_cpus() != 1);
        clear_cpu_cap(&boot_cpu_data, X86_FEATURE_UP);
        clear_cpu_cap(&cpu_data(0), X86_FEATURE_UP);
        list_for_each_entry(mod, &smp_alt_modules, next)
            alternatives_smp_lock(mod->locks, mod->locks_end,
                          mod->text, mod->text_end);
        uniproc_patched = false;
    }
    mutex_unlock(&smp_alt);
}

/* Return 1 if the address range is reserved for smp-alternatives */
int alternatives_text_reserved(void *start, void *end)
{
    struct smp_alt_module *mod;
    const s32 *poff;
    u8 *text_start = start;
    u8 *text_end = end;

    list_for_each_entry(mod, &smp_alt_modules, next) {
        if (mod->text > text_end || mod->text_end < text_start)
            continue;
        for (poff = mod->locks; poff < mod->locks_end; poff++) {
            const u8 *ptr = (const u8 *)poff + *poff;

            if (text_start <= ptr && text_end > ptr)
                return 1;
        }
    }

    return 0;
}
#endif

#ifdef CONFIG_PARAVIRT
void __init_or_module apply_paravirt(struct paravirt_patch_site *start,
                     struct paravirt_patch_site *end)
{
    struct paravirt_patch_site *p;
    char insnbuf[MAX_PATCH_LEN];

    if (noreplace_paravirt)
        return;

    for (p = start; p < end; p++) {
        unsigned int used;

        BUG_ON(p->len > MAX_PATCH_LEN);
        /* prep the buffer with the original instructions */
        memcpy(insnbuf, p->instr, p->len);
        used = pv_init_ops.patch(p->instrtype, p->clobbers, insnbuf,
                     (unsigned long)p->instr, p->len);

        BUG_ON(used > p->len);

        /* Pad the rest with nops */
        add_nops(insnbuf + used, p->len - used);
        text_poke_early(p->instr, insnbuf, p->len);
    }
}
extern struct paravirt_patch_site __start_parainstructions[],
    __stop_parainstructions[];
#endif  /* CONFIG_PARAVIRT */

void __init alternative_instructions(void)
{
    /* The patching is not fully atomic, so try to avoid local interruptions
       that might execute the to be patched code.
       Other CPUs are not running. */
    stop_nmi();

    /*
     * Don't stop machine check exceptions while patching.
     * MCEs only happen when something got corrupted and in this
     * case we must do something about the corruption.
     * Ignoring it is worse than a unlikely patching race.
     * Also machine checks tend to be broadcast and if one CPU
     * goes into machine check the others follow quickly, so we don't
     * expect a machine check to cause undue problems during to code
     * patching.
     */

    apply_alternatives(__alt_instructions, __alt_instructions_end);

#ifdef CONFIG_SMP
    /* Patch to UP if other cpus not imminent. */
    if (!noreplace_smp && (num_present_cpus() == 1 || setup_max_cpus <= 1)) {
        uniproc_patched = true;
        alternatives_smp_module_add(NULL, "core kernel",
                        __smp_locks, __smp_locks_end,
                        _text, _etext);
    }

    if (!uniproc_patched || num_possible_cpus() == 1)
        free_init_pages("SMP alternatives",
                (unsigned long)__smp_locks,
                (unsigned long)__smp_locks_end);
#endif

    apply_paravirt(__parainstructions, __parainstructions_end);

    restart_nmi();
}

void *__init_or_module text_poke_early(void *addr, const void *opcode,
                          size_t len)
{
    unsigned long flags;
    local_irq_save(flags);
    memcpy(addr, opcode, len);
    sync_core();
    local_irq_restore(flags);
    /* Could also do a CLFLUSH here to speed up CPU recovery; but
       that causes hangs on some VIA CPUs. */
    return addr;
}

void *__kprobes text_poke(void *addr, const void *opcode, size_t len)
{
    unsigned long flags;
    char *vaddr;
    struct page *pages[2];
    int i;

    if (!core_kernel_text((unsigned long)addr)) {
        pages[0] = vmalloc_to_page(addr);
        pages[1] = vmalloc_to_page(addr + PAGE_SIZE);
    } else {
        pages[0] = virt_to_page(addr);
        WARN_ON(!PageReserved(pages[0]));
        pages[1] = virt_to_page(addr + PAGE_SIZE);
    }
    BUG_ON(!pages[0]);
    local_irq_save(flags);
    set_fixmap(FIX_TEXT_POKE0, page_to_phys(pages[0]));
    if (pages[1])
        set_fixmap(FIX_TEXT_POKE1, page_to_phys(pages[1]));
    vaddr = (char *)fix_to_virt(FIX_TEXT_POKE0);
    memcpy(&vaddr[(unsigned long)addr & ~PAGE_MASK], opcode, len);
    clear_fixmap(FIX_TEXT_POKE0);
    if (pages[1])
        clear_fixmap(FIX_TEXT_POKE1);
    local_flush_tlb();
    sync_core();
    /* Could also do a CLFLUSH here to speed up CPU recovery; but
       that causes hangs on some VIA CPUs. */
    for (i = 0; i < len; i++)
        BUG_ON(((char *)addr)[i] != ((char *)opcode)[i]);
    local_irq_restore(flags);
    return addr;
}

/*
 * Cross-modifying kernel text with stop_machine().
 * This code originally comes from immediate value.
 */
static atomic_t stop_machine_first;
static int wrote_text;

struct text_poke_params {
    struct text_poke_param *params;
    int nparams;
};

static int __kprobes stop_machine_text_poke(void *data)
{
    struct text_poke_params *tpp = data;
    struct text_poke_param *p;
    int i;

    if (atomic_xchg(&stop_machine_first, 0)) {
        for (i = 0; i < tpp->nparams; i++) {
            p = &tpp->params[i];
            text_poke(p->addr, p->opcode, p->len);
        }
        smp_wmb();  /* Make sure other cpus see that this has run */
        wrote_text = 1;
    } else {
        while (!wrote_text)
            cpu_relax();
        smp_mb();   /* Load wrote_text before following execution */
    }

    for (i = 0; i < tpp->nparams; i++) {
        p = &tpp->params[i];
        flush_icache_range((unsigned long)p->addr,
                   (unsigned long)p->addr + p->len);
    }
    /*
     * Intel Archiecture Software Developer's Manual section 7.1.3 specifies
     * that a core serializing instruction such as "cpuid" should be
     * executed on _each_ core before the new instruction is made visible.
     */
    sync_core();
    return 0;
}

void *__kprobes text_poke_smp(void *addr, const void *opcode, size_t len)
{
    struct text_poke_params tpp;
    struct text_poke_param p;

    p.addr = addr;
    p.opcode = opcode;
    p.len = len;
    tpp.params = &p;
    tpp.nparams = 1;
    atomic_set(&stop_machine_first, 1);
    wrote_text = 0;
    /* Use __stop_machine() because the caller already got online_cpus. */
    __stop_machine(stop_machine_text_poke, (void *)&tpp, cpu_online_mask);
    return addr;
}

void __kprobes text_poke_smp_batch(struct text_poke_param *params, int n)
{
    struct text_poke_params tpp = {.params = params, .nparams = n};

    atomic_set(&stop_machine_first, 1);
    wrote_text = 0;
    __stop_machine(stop_machine_text_poke, (void *)&tpp, cpu_online_mask);
}