root/tools/testing/selftests/breakpoints/step_after_suspend_test.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (C) 2016 Google, Inc.
 */

#define _GNU_SOURCE

#include <errno.h>
#include <fcntl.h>
#include <sched.h>
#include <signal.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <sys/ptrace.h>
#include <sys/stat.h>
#include <sys/timerfd.h>
#include <sys/types.h>
#include <sys/wait.h>

#include "kselftest.h"

void child(int cpu)
{
        cpu_set_t set;

        CPU_ZERO(&set);
        CPU_SET(cpu, &set);
        if (sched_setaffinity(0, sizeof(set), &set) != 0) {
                ksft_print_msg("sched_setaffinity() failed: %s\n",
                        strerror(errno));
                _exit(1);
        }

        if (ptrace(PTRACE_TRACEME, 0, NULL, NULL) != 0) {
                ksft_print_msg("ptrace(PTRACE_TRACEME) failed: %s\n",
                        strerror(errno));
                _exit(1);
        }

        if (raise(SIGSTOP) != 0) {
                ksft_print_msg("raise(SIGSTOP) failed: %s\n", strerror(errno));
                _exit(1);
        }

        _exit(0);
}

int run_test(int cpu)
{
        int status;
        pid_t pid = fork();
        pid_t wpid;

        if (pid < 0) {
                ksft_print_msg("fork() failed: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (pid == 0)
                child(cpu);

        wpid = waitpid(pid, &status, __WALL);
        if (wpid != pid) {
                ksft_print_msg("waitpid() failed: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (!WIFSTOPPED(status)) {
                ksft_print_msg("child did not stop: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (WSTOPSIG(status) != SIGSTOP) {
                ksft_print_msg("child did not stop with SIGSTOP: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }

        if (ptrace(PTRACE_SINGLESTEP, pid, NULL, NULL) < 0) {
                if (errno == EIO) {
                        ksft_print_msg(
                                "ptrace(PTRACE_SINGLESTEP) not supported on this architecture: %s\n",
                                strerror(errno));
                        return KSFT_SKIP;
                }
                ksft_print_msg("ptrace(PTRACE_SINGLESTEP) failed: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }

        wpid = waitpid(pid, &status, __WALL);
        if (wpid != pid) {
                ksft_print_msg("waitpid() failed: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (WIFEXITED(status)) {
                ksft_print_msg("child did not single-step: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }
        if (!WIFSTOPPED(status)) {
                ksft_print_msg("child did not stop: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (WSTOPSIG(status) != SIGTRAP) {
                ksft_print_msg("child did not stop with SIGTRAP: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }

        if (ptrace(PTRACE_CONT, pid, NULL, NULL) < 0) {
                ksft_print_msg("ptrace(PTRACE_CONT) failed: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }

        wpid = waitpid(pid, &status, __WALL);
        if (wpid != pid) {
                ksft_print_msg("waitpid() failed: %s\n", strerror(errno));
                return KSFT_FAIL;
        }
        if (!WIFEXITED(status)) {
                ksft_print_msg("child did not exit after PTRACE_CONT: %s\n",
                        strerror(errno));
                return KSFT_FAIL;
        }

        return KSFT_PASS;
}

/*
 * Reads the suspend success count from sysfs.
 * Returns the count on success or exits on failure.
 */
static int get_suspend_success_count_or_fail(void)
{
        FILE *fp;
        int val;

        fp = fopen("/sys/power/suspend_stats/success", "r");
        if (!fp)
                ksft_exit_fail_msg(
                        "Failed to open suspend_stats/success: %s\n",
                        strerror(errno));

        if (fscanf(fp, "%d", &val) != 1) {
                fclose(fp);
                ksft_exit_fail_msg(
                        "Failed to read suspend success count\n");
        }

        fclose(fp);
        return val;
}

void suspend(void)
{
        int timerfd;
        int err;
        int count_before;
        int count_after;
        struct itimerspec spec = {};

        if (getuid() != 0)
                ksft_exit_skip("Please run the test as root - Exiting.\n");

        timerfd = timerfd_create(CLOCK_BOOTTIME_ALARM, 0);
        if (timerfd < 0)
                ksft_exit_fail_msg("timerfd_create() failed\n");

        spec.it_value.tv_sec = 5;
        err = timerfd_settime(timerfd, 0, &spec, NULL);
        if (err < 0)
                ksft_exit_fail_msg("timerfd_settime() failed\n");

        count_before = get_suspend_success_count_or_fail();

        system("(echo mem > /sys/power/state) 2> /dev/null");

        count_after = get_suspend_success_count_or_fail();
        if (count_after <= count_before)
                ksft_exit_fail_msg("Failed to enter Suspend state\n");

        close(timerfd);
}

int main(int argc, char **argv)
{
        int opt;
        bool do_suspend = true;
        bool succeeded = true;
        unsigned int tests = 0;
        cpu_set_t available_cpus;
        int err;
        int cpu;

        ksft_print_header();

        while ((opt = getopt(argc, argv, "n")) != -1) {
                switch (opt) {
                case 'n':
                        do_suspend = false;
                        break;
                default:
                        printf("Usage: %s [-n]\n", argv[0]);
                        printf("        -n: do not trigger a suspend/resume cycle before the test\n");
                        return -1;
                }
        }

        err = sched_getaffinity(0, sizeof(available_cpus), &available_cpus);
        if (err < 0)
                ksft_exit_fail_msg("sched_getaffinity() failed\n");

        for (cpu = 0; cpu < CPU_SETSIZE; cpu++) {
                if (!CPU_ISSET(cpu, &available_cpus))
                        continue;
                tests++;
        }

        if (do_suspend)
                suspend();

        ksft_set_plan(tests);
        for (cpu = 0; cpu < CPU_SETSIZE; cpu++) {
                int test_success;

                if (!CPU_ISSET(cpu, &available_cpus))
                        continue;

                test_success = run_test(cpu);
                switch (test_success) {
                case KSFT_PASS:
                        ksft_test_result_pass("CPU %d\n", cpu);
                        break;
                case KSFT_SKIP:
                        ksft_test_result_skip("CPU %d\n", cpu);
                        break;
                case KSFT_FAIL:
                        ksft_test_result_fail("CPU %d\n", cpu);
                        succeeded = false;
                        break;
                }
        }

        if (succeeded)
                ksft_exit_pass();
        else
                ksft_exit_fail();
}