/*
 * Copyright © 2016 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#include <linux/random.h>

#include "gt/intel_gt.h"
#include "gt/intel_gt_pm.h"
#include "gt/intel_gt_regs.h"
#include "gt/uc/intel_gsc_fw.h"

#include "i915_driver.h"
#include "i915_drv.h"
#include "i915_jiffies.h"
#include "i915_selftest.h"
#include "i915_wait_util.h"
#include "igt_flush_test.h"

struct i915_selftest i915_selftest __read_mostly = {
        .timeout_ms = 500,
};

int i915_mock_sanitycheck(void)
{
        pr_info(DRIVER_NAME ": %s() - ok!\n", __func__);
        return 0;
}

int i915_live_sanitycheck(struct drm_i915_private *i915)
{
        pr_info("%s: %s() - ok!\n", i915->drm.driver->name, __func__);
        return 0;
}

enum {
#define selftest(name, func) mock_##name,
#include "i915_mock_selftests.h"
#undef selftest
};

enum {
#define selftest(name, func) live_##name,
#include "i915_live_selftests.h"
#undef selftest
};

enum {
#define selftest(name, func) perf_##name,
#include "i915_perf_selftests.h"
#undef selftest
};

struct selftest {
        bool enabled;
        const char *name;
        union {
                int (*mock)(void);
                int (*live)(struct drm_i915_private *);
        };
};

#define selftest(n, f) [mock_##n] = { .name = #n, { .mock = f } },
static struct selftest mock_selftests[] = {
#include "i915_mock_selftests.h"
};
#undef selftest

#define selftest(n, f) [live_##n] = { .name = #n, { .live = f } },
static struct selftest live_selftests[] = {
#include "i915_live_selftests.h"
};
#undef selftest

#define selftest(n, f) [perf_##n] = { .name = #n, { .live = f } },
static struct selftest perf_selftests[] = {
#include "i915_perf_selftests.h"
};
#undef selftest

/* Embed the line number into the parameter name so that we can order tests */
#define selftest(n, func) selftest_0(n, func, param(n))
#define param(n) __PASTE(igt__, __PASTE(__LINE__, __mock_##n))
#define selftest_0(n, func, id) \
module_param_named(id, mock_selftests[mock_##n].enabled, bool, 0400);
#include "i915_mock_selftests.h"
#undef selftest_0
#undef param

#define param(n) __PASTE(igt__, __PASTE(__LINE__, __live_##n))
#define selftest_0(n, func, id) \
module_param_named(id, live_selftests[live_##n].enabled, bool, 0400);
#include "i915_live_selftests.h"
#undef selftest_0
#undef param

#define param(n) __PASTE(igt__, __PASTE(__LINE__, __perf_##n))
#define selftest_0(n, func, id) \
module_param_named(id, perf_selftests[perf_##n].enabled, bool, 0400);
#include "i915_perf_selftests.h"
#undef selftest_0
#undef param
#undef selftest

static void set_default_test_all(struct selftest *st, unsigned int count)
{
        unsigned int i;

        for (i = 0; i < count; i++)
                if (st[i].enabled)
                        return;

        for (i = 0; i < count; i++)
                st[i].enabled = true;
}

static bool
__gsc_proxy_init_progressing(struct intel_gsc_uc *gsc)
{
        return intel_gsc_uc_fw_proxy_get_status(gsc) == -EAGAIN;
}

static void
__wait_gsc_proxy_completed(struct drm_i915_private *i915)
{
        bool need_to_wait = (IS_ENABLED(CONFIG_INTEL_MEI_GSC_PROXY) &&
                             i915->media_gt &&
                             HAS_ENGINE(i915->media_gt, GSC0) &&
                             intel_uc_fw_is_loadable(&i915->media_gt->uc.gsc.fw));
        /*
         * The gsc proxy component depends on the kernel component driver load ordering
         * and in corner cases (the first time after an IFWI flash), init-completion
         * firmware flows take longer.
         */
        unsigned long timeout_ms = 8000;

        if (need_to_wait && wait_for(!__gsc_proxy_init_progressing(&i915->media_gt->uc.gsc),
                                     timeout_ms))
                pr_warn(DRIVER_NAME "Timed out waiting for gsc_proxy_completion!\n");
}

static void
__wait_gsc_huc_load_completed(struct drm_i915_private *i915)
{
        /* this only applies to DG2, so we only care about GT0 */
        struct intel_huc *huc = &to_gt(i915)->uc.huc;
        bool need_to_wait = (IS_ENABLED(CONFIG_INTEL_MEI_PXP) &&
                             intel_huc_wait_required(huc));
        /*
         * The GSC and PXP mei bringup depends on the kernel boot ordering, so
         * to account for the worst case scenario the HuC code waits for up to
         * 10s for the GSC driver to load and then another 5s for the PXP
         * component to bind before giving up, even though those steps normally
         * complete in less than a second from the i915 load. We match that
         * timeout here, but we expect to bail early due to the fence being
         * signalled even in a failure case, as it is extremely unlikely that
         * both components will use their full timeout.
         */
        unsigned long timeout_ms = 15000;

        if (need_to_wait &&
            wait_for(i915_sw_fence_done(&huc->delayed_load.fence), timeout_ms))
                pr_warn(DRIVER_NAME "Timed out waiting for huc load via GSC!\n");
}

static struct mm_struct *get_selftest_mm(int u_pid_nr)
{
        struct task_struct *task = NULL;
        struct mm_struct *mm = NULL;
        struct pid *u_pid = NULL;

        if (u_pid_nr < 1)
                return NULL;

        u_pid = find_get_pid(u_pid_nr);
        if (!u_pid) {
                pr_warn("Could not find PID: %d\n", u_pid_nr);
                return NULL;
        }

        task = get_pid_task(u_pid, PIDTYPE_PID);
        put_pid(u_pid);
        if (!task) {
                pr_warn("Could not find task for PID: %d\n", u_pid_nr);
                return NULL;
        }

        if (task->flags & PF_KTHREAD) {
                pr_warn("Task not in userspace: %d\n", u_pid_nr);
                put_task_struct(task);
                return NULL;
        }

        mm = get_task_mm(task);
        put_task_struct(task);
        if (!mm) {
                pr_warn("Could not find address space of task with PID: %d\n", u_pid_nr);
                return NULL;
        }

        return mm;
}

static int __run_selftests(const char *name,
                           struct selftest *st,
                           unsigned int count,
                           void *data)
{
        struct mm_struct *mm = NULL;
        int u_pid_nr = -1;
        int err = 0;

        if (i915_selftest.userspace_pid)
                u_pid_nr = i915_selftest.userspace_pid;

        while (!i915_selftest.random_seed)
                i915_selftest.random_seed = get_random_u32();

        i915_selftest.timeout_jiffies =
                i915_selftest.timeout_ms ?
                msecs_to_jiffies_timeout(i915_selftest.timeout_ms) :
                MAX_SCHEDULE_TIMEOUT;

        set_default_test_all(st, count);

        pr_info(DRIVER_NAME ": Performing %s selftests with st_random_seed=0x%x st_timeout=%u\n",
                name, i915_selftest.random_seed, i915_selftest.timeout_ms);

        /*
         * If we are running in a kthread on a multi NUMA system and the user passed
         * a valid PID of a userspace task, then we may borrow its address space
         * to prepare a safe environment for the mmap selftests.
         */
        if (!current->mm && u_pid_nr > 0) {
                mm = get_selftest_mm(u_pid_nr);
                if (mm) {
                        kthread_use_mm(mm);
                        if (unlikely(!current->mm)) {
                                mmput(mm);
                                mm = NULL;
                                pr_warn("Could not set mm as current->mm\n");
                        }
                }
        }

        /* Tests are listed in order in i915_*_selftests.h */
        for (; count--; st++) {
                if (!st->enabled)
                        continue;

                cond_resched();
                if (signal_pending(current)) {
                        if (mm) {
                                kthread_unuse_mm(mm);
                                mmput_async(mm);
                        }
                        return -EINTR;
                }

                pr_info(DRIVER_NAME ": Running %s\n", st->name);
                if (data)
                        err = st->live(data);
                else
                        err = st->mock();
                if (err == -EINTR && !signal_pending(current))
                        err = 0;
                if (err)
                        break;
        }

        if (WARN(err > 0 || err == -ENOTTY,
                 "%s returned %d, conflicting with selftest's magic values!\n",
                 st->name, err))
                err = -1;

        if (mm) {
                kthread_unuse_mm(mm);
                mmput_async(mm);
        }

        return err;
}

#define run_selftests(x, data) \
        __run_selftests(#x, x##_selftests, ARRAY_SIZE(x##_selftests), data)

int i915_mock_selftests(void)
{
        int err;

        if (!i915_selftest.mock)
                return 0;

        err = run_selftests(mock, NULL);
        if (err) {
                i915_selftest.mock = err;
                return 1;
        }

        if (i915_selftest.mock < 0) {
                i915_selftest.mock = -ENOTTY;
                return 1;
        }

        return 0;
}

int i915_live_selftests(struct pci_dev *pdev)
{
        struct drm_i915_private *i915 = pdev_to_i915(pdev);
        struct intel_uncore *uncore = &i915->uncore;
        int err;
        u32 pg_enable;
        intel_wakeref_t wakeref;

        if (!i915_selftest.live)
                return 0;

        /*
         * FIXME Disable render powergating, this is temporary wa and should be removed
         * after fixing real cause of forcewake timeouts.
         */
        with_intel_runtime_pm(uncore->rpm, wakeref) {
                if (IS_GFX_GT_IP_RANGE(to_gt(i915), IP_VER(12, 00), IP_VER(12, 74))) {
                        pg_enable = intel_uncore_read(uncore, GEN9_PG_ENABLE);
                        if (pg_enable & GEN9_RENDER_PG_ENABLE)
                                intel_uncore_write_fw(uncore, GEN9_PG_ENABLE,
                                                      pg_enable & ~GEN9_RENDER_PG_ENABLE);
                }
        }

        __wait_gsc_proxy_completed(i915);
        __wait_gsc_huc_load_completed(i915);

        err = run_selftests(live, i915);
        if (err) {
                i915_selftest.live = err;
                return err;
        }

        if (i915_selftest.live < 0) {
                i915_selftest.live = -ENOTTY;
                return 1;
        }

        return 0;
}

int i915_perf_selftests(struct pci_dev *pdev)
{
        struct drm_i915_private *i915 = pdev_to_i915(pdev);
        int err;

        if (!i915_selftest.perf)
                return 0;

        __wait_gsc_proxy_completed(i915);
        __wait_gsc_huc_load_completed(i915);

        err = run_selftests(perf, i915);
        if (err) {
                i915_selftest.perf = err;
                return err;
        }

        if (i915_selftest.perf < 0) {
                i915_selftest.perf = -ENOTTY;
                return 1;
        }

        return 0;
}

static bool apply_subtest_filter(const char *caller, const char *name)
{
        char *filter, *sep, *tok;
        bool result = true;

        filter = kstrdup(i915_selftest.filter, GFP_KERNEL);
        for (sep = filter; (tok = strsep(&sep, ","));) {
                bool allow = true;
                char *sl;

                if (*tok == '!') {
                        allow = false;
                        tok++;
                }

                if (*tok == '\0')
                        continue;

                sl = strchr(tok, '/');
                if (sl) {
                        *sl++ = '\0';
                        if (strcmp(tok, caller)) {
                                if (allow)
                                        result = false;
                                continue;
                        }
                        tok = sl;
                }

                if (strcmp(tok, name)) {
                        if (allow)
                                result = false;
                        continue;
                }

                result = allow;
                break;
        }
        kfree(filter);

        return result;
}

int __i915_nop_setup(void *data)
{
        return 0;
}

int __i915_nop_teardown(int err, void *data)
{
        return err;
}

int __i915_live_setup(void *data)
{
        struct drm_i915_private *i915 = data;

        /* The selftests expect an idle system */
        if (intel_gt_pm_wait_for_idle(to_gt(i915)))
                return -EIO;

        return intel_gt_terminally_wedged(to_gt(i915));
}

int __i915_live_teardown(int err, void *data)
{
        struct drm_i915_private *i915 = data;

        if (igt_flush_test(i915))
                err = -EIO;

        i915_gem_drain_freed_objects(i915);

        return err;
}

int __intel_gt_live_setup(void *data)
{
        struct intel_gt *gt = data;

        /* The selftests expect an idle system */
        if (intel_gt_pm_wait_for_idle(gt))
                return -EIO;

        return intel_gt_terminally_wedged(gt);
}

int __intel_gt_live_teardown(int err, void *data)
{
        struct intel_gt *gt = data;

        if (igt_flush_test(gt->i915))
                err = -EIO;

        i915_gem_drain_freed_objects(gt->i915);

        return err;
}

int __i915_subtests(const char *caller,
                    int (*setup)(void *data),
                    int (*teardown)(int err, void *data),
                    const struct i915_subtest *st,
                    unsigned int count,
                    void *data)
{
        int err;

        for (; count--; st++) {
                cond_resched();
                if (signal_pending(current))
                        return -EINTR;

                if (!apply_subtest_filter(caller, st->name))
                        continue;

                err = setup(data);
                if (err) {
                        pr_err(DRIVER_NAME "/%s: setup failed for %s\n",
                               caller, st->name);
                        return err;
                }

                pr_info(DRIVER_NAME ": Running %s/%s\n", caller, st->name);
                GEM_TRACE("Running %s/%s\n", caller, st->name);

                err = teardown(st->func(data), data);
                if (err && err != -EINTR) {
                        pr_err(DRIVER_NAME "/%s: %s failed with error %d\n",
                               caller, st->name, err);
                        return err;
                }
        }

        return 0;
}

bool __igt_timeout(unsigned long timeout, const char *fmt, ...)
{
        va_list va;

        if (!signal_pending(current)) {
                cond_resched();
                if (time_before(jiffies, timeout))
                        return false;
        }

        if (fmt) {
                va_start(va, fmt);
                vprintk(fmt, va);
                va_end(va);
        }

        return true;
}

void igt_hexdump(const void *buf, size_t len)
{
        const size_t rowsize = 8 * sizeof(u32);
        const void *prev = NULL;
        bool skip = false;
        size_t pos;

        for (pos = 0; pos < len; pos += rowsize) {
                char line[128];

                if (prev && !memcmp(prev, buf + pos, rowsize)) {
                        if (!skip) {
                                pr_info("*\n");
                                skip = true;
                        }
                        continue;
                }

                WARN_ON_ONCE(hex_dump_to_buffer(buf + pos, len - pos,
                                                rowsize, sizeof(u32),
                                                line, sizeof(line),
                                                false) >= sizeof(line));
                pr_info("[%04zx] %s\n", pos, line);

                prev = buf + pos;
                skip = false;
        }
}

module_param_named(st_random_seed, i915_selftest.random_seed, uint, 0400);
module_param_named(st_timeout, i915_selftest.timeout_ms, uint, 0400);
module_param_named(st_filter, i915_selftest.filter, charp, 0400);
module_param_named(st_userspace_pid, i915_selftest.userspace_pid, uint, 0400);
MODULE_PARM_DESC(st_userspace_pid, "For usage in tests that map userspace memory and require address space with controllable lifetime.");

module_param_named_unsafe(mock_selftests, i915_selftest.mock, int, 0400);
MODULE_PARM_DESC(mock_selftests, "Run selftests before loading, using mock hardware (0:disabled [default], 1:run tests then load driver, -1:run tests then leave dummy module)");

module_param_named_unsafe(live_selftests, i915_selftest.live, int, 0400);
MODULE_PARM_DESC(live_selftests, "Run selftests after driver initialisation on the live system (0:disabled [default], 1:run tests then continue, -1:run tests then exit module)");

module_param_named_unsafe(perf_selftests, i915_selftest.perf, int, 0400);
MODULE_PARM_DESC(perf_selftests, "Run performance orientated selftests after driver initialisation on the live system (0:disabled [default], 1:run tests then continue, -1:run tests then exit module)");