libostd/src/win32/process.cc

/* Process handling implementation bits.
 * For Windows systems only, other implementations are stored elsewhere.
 *
 * This file is part of libostd. See COPYING.md for futher information.
 */

#include "ostd/platform.hh"

#ifndef OSTD_PLATFORM_WIN32
#  error "Incorrect platform"
#endif

#include <cstddef>
#include <cstdlib>
#include <cerrno>
#include <system_error>
#include <string>
#include <memory>
#include <new>

#include <fcntl.h>
#include <windows.h>

#include "ostd/algprithm.hh"
#include "ostd/process.hh"
#include "ostd/format.hh"

#include "ostd/filesystem.hh"

namespace fs = ostd::filesystem;

namespace ostd {
namespace detail {

OSTD_EXPORT void split_args_impl(
    string_range const &str, void (*func)(string_range, void *), void *data
) {
    if (!str.size()) {
        return;
    }
    std::unique_ptr<wchar_t[]> wstr{new wchar_t[str.size() + 1]};
    memset(wstr.get(), 0, (str.size() + 1) * sizeof(wchar_t));

    if (!MultiByteToWideChar(
        CP_UTF8, 0, str.data(), str.size(), wstr.get(), str.size() + 1
    )) {
        throw word_error{"unicode conversion failed"};
    }

    int argc = 0;
    wchar_t **pwargs = CommandLineToArgvW(wstr.get(), &argc);

    if (!pwargs) {
        throw word_error{"command line parsing failed"};
    }

    /* if anything throws, make sure stuff gets freed */
    struct wchar_guard {
        void operator()(wchar_t **p) const {
            LocalFree(p);
        }
    };
    std::unique_ptr<wchar_t *, wchar_guard> wguard{pwargs};

    for (int i = 0; i < argc; ++i) {
        wchar_t *arg = pwargs[i];
        std::size_t arglen = wcslen(arg);

        std::size_t req = 0;
        if (!(req = WideCharToMultiByte(
            CP_UTF8, 0, arg, arglen + 1, nullptr, 0, nullptr, nullptr
        ))) {
            throw word_error{"unicode conversion failed"};
        }

        std::unique_ptr<char[]> buf{new char[req]};
        if (!WideCharToMultiByte(
            CP_UTF8, 0, arg, arglen + 1, buf.get(), req, nullptr, nullptr
        )) {
            throw word_error{"unicode conversion failed"};
        }

        func(string_range{buf.get(), buf.get() + req - 1}, data);
    }
}

} /* namespace detail */

struct pipe {
    HANDLE p_r = nullptr, p_w = nullptr;

    ~pipe() {
        if (p_r) {
            CloseHandle(p_r);
        }
        if (p_w) {
            CloseHandle(p_w);
        }
    }

    void open(subprocess_stream use, SECURITY_ATTRIBUTES &sa, bool read) {
        if (use != subprocess_stream::PIPE) {
            return;
        }
        if (!CreatePipe(&p_r, &p_w, &sa, 0)) {
            throw subprocess_error{"could not open pipe"};
        }
        if (!SetHandleInformation(read ? p_r : p_w, HANDLE_FLAG_INHERIT, 0)) {
            throw subprocess_error{"could not set pipe parameters"};
        }
    }

    void fdopen(file_stream &s, bool read) {
        int fd = _open_osfhandle(
            reinterpret_cast<intptr_t>(read ? p_r : p_w),
            read ? _O_RDONLY : 0
        );
        if (fd < 0) {
            throw subprocess_error{"could not open redirected stream"};
        }
        if (read) {
            p_r = nullptr;
        } else {
            p_w = nullptr;
        }
        auto p = _fdopen(fd, read ? "r" : "w");
        if (!p) {
            _close(fd);
            throw subprocess_error{"could not open redirected stream"};
        }
        s.open(p, [](FILE *f) {
            std::fclose(f);
        });
    }
};

/* because there is no way to have CreateProcess do a lookup in standard
 * paths AND specify a custom separate argv[0], we need to implement the
 * path resolution ourselves; fortunately the standard filesystem API
 * makes this kind of easy, but it's still a lot of code I'd rather
 * not write... oh well
 */
static std::unique_ptr<wchar_t[]> resolve_file(std::unique_ptr<wchar_t[]> cmd) {
    /* a reused buffer, TODO: allow longer paths */
    wchar_t buf[1024];

    auto is_maybe_exec = [](fs::path const &p) {
        auto st = fs::status(p);
        return (fs::is_regular_file(st) || fs::is_symlink(st));
    };

    auto get_unique = [](fs::path const &p) {
        auto const &s = p.native();
        std::unique_ptr<wchar_t[]> ret{new wchar_t[s.size() + 1]};
        std::wstring::traits_type::copy(ret.get(), s.data(), s.size() + 1);
        return ret;
    };

    fs::path p{cmd.get()};
    /* deal with some easy cases */
    if ((p.filename() != p) || (p == L".") || (p == L"..")) {
        return cmd;
    }
    /* no extension appends .exe as is done normally */
    if (!p.has_extension()) {
        p.replace_extension(L".exe");
    }
    /* the directory from which the app loaded */
    if (GetModuleFileNameW(nullptr, buf, sizeof(buf))) {
        fs::path rp{buf};
        rp.replace_filename(p);
        if (is_maybe_exec(rp)) {
            return get_unique(rp);
        }
    }
    /* the current directory */
    {
        auto rp = fs::path{L"."} / p;
        if (is_maybe_exec(rp)) {
            return get_unique(rp);
        }
    }
    /* the system directory */
    if (GetSystemDirectoryW(buf, sizeof(buf))) {
        auto rp = fs::path{buf} / p;
        if (is_maybe_exec(rp)) {
            return get_unique(rp);
        }
    }
    /* the windows directory */
    if (GetWindowsDirectoryW(buf, sizeof(buf))) {
        auto rp = fs::path{buf} / p;
        if (is_maybe_exec(rp)) {
            return get_unique(rp);
        }
    }
    /* the PATH envvar */
    std::size_t req = GetEnvironmentVariableW(L"PATH", buf, sizeof(buf));
    if (req) {
        wchar_t *envp = buf;
        std::vector<wchar_t> dynbuf;
        if (req > sizeof(buf)) {
            dynbuf.reserve(req);
            for (;;) {
                req = GetEnvironmentVariableW(
                    L"PATH", dynbuf.data(), dynbuf.capacity()
                );
                if (!req) {
                    return cmd;
                }
                if (req > dynbuf.capacity()) {
                    dynbuf.reserve(req);
                } else {
                    envp = dynbuf.data();
                    break;
                }
            }
        }
        for (;;) {
            auto sp = wcschr(envp, L';');
            fs::path rp;
            if (!sp) {
                rp = fs::path{envp} / p;
            } else if (sp == envp) {
                envp = sp + 1;
                continue;
            } else {
                rp = fs::path{envp, sp} / p;
                envp = sp + 1;
            }
            if (is_maybe_exec(rp)) {
                return get_unique(rp);
            }
        }
    }
    /* nothing found */
    return cmd;
}

/* windows follows a dumb set of rules for parsing command line params;
 * a single \ is normally interpreted literally, unless it precedes a ",
 * in which case it acts as an escape character for the quotation mark;
 * if multiple backslashes precedes the quotation mark, each pair is
 * treated as a single backslash
 *
 * we need to replicate this awful behavior here, hence the extra code
 */
static std::unique_ptr<wchar_t[]> concat_args(
    string_range cmd, bool (*func)(string_range &, void *), void *datap,
    std::unique_ptr<wchar_t[]> &cmdpath
) {
    std::string ret;

    string_range p;
    if (!func(p, datap)) {
        throw subprocess_error{"no arguments given"};
    }
    if (!cmd.size()) {
        cmd = p;
        if (!cmd.size()) {
            throw subprocess_error{"no command given"};
        }
    }

    /* convert and optionally resolve PATH and other lookup locations */
    {
        std::unique_ptr<wchar_t[]> wcmd{new wchar_t[cmd.size() + 1]};
        auto req = MultiByteToWideChar(
            CP_UTF8, 0, cmd.data(), cmd.size(), wcmd.get(), cmd.size() + 1
        );
        if (!req) {
            throw subprocess_error{"unicode conversion failed"};
        }
        wcmd.get()[req] = '\0';
        if (!use_path) {
            cmdpath = std::move(wcmd);
        } else {
            cmdpath = resolve_file(std::move(wcmd));
        }
    }

    /* concat the args */
    for (bool has = true; has; has = func(p, datap)) {
        if (!ret.empty()) {
            ret += ' ';
        }
        ret += '\"';
        for (;;) {
            auto found = ostd::find_one_of(p, string_range{"\"\\"});
            if (found.empty()) {
                ret.append(p.iter_begin(), p.iter_end());
                break;
            }
            auto sl = p.slice(0, p.size() - found.size());
            ret.append(sl.iter_begin(), sl.iter_end());
            if (found.front() == '\"') {
                /* not preceded by \, so it's safe */
                ret += "\\\"";
                found.pop_front();
            } else {
                /* handle any sequence of \ optionally followed by a " */
                std::size_t nsl = 0;
                while (found.front() == '\\') {
                    ++nsl;
                    found.pop_front();
                }
                if (!found.empty() && (found.front() == '\"')) {
                    /* double all the backslashes plus one for the " */
                    ret.append(nsl * 2 + 1, '\\');
                    ret += '\"';
                } else {
                    /* double if the backslashes were at the end of the arg */
                    ret.append(nsl * (found.empty() + 1), '\\');
                }
            }
            p = found;
        }
        ret += '\"';
    }

    /* convert to UTF-16 */
    std::unique_ptr<wchar_t[]> cmdline{new wchar_t[ret.size() + 1]};
    if (!MultiByteToWideChar(
        CP_UTF8, 0, ret.data(), ret.size() + 1, cmdline.get(), ret.size() + 1
    )) {
        throw subprocess_error{"unicode conversion failed"};
    }

    return cmdline;
}

OSTD_EXPORT void subprocess::open_impl(
    bool use_path, string_range cmd,
    bool (*func)(string_range &, void *), void *datap,
    bool (*efunc)(string_range &, void *), void *edatap
) {
    if (use_in == subprocess_stream::STDOUT) {
        throw subprocess_error{"could not redirect stdin to stdout"};
    }

    /* make sure child processes exit with parent */
    struct jobject {
        jobject() {
            handle = CreateJobObject(nullptr, nullptr);
            if (!handle) {
                throw subprocess_error{"could not create job object"};
            }
            JOBJECT_EXTENDED_LIMIT_INFORMATION jeli;
            memset(&jeli, 0, sizeof(jeli));

            jeli.BasicLimitInformation.LimitFlags =
                JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE;

            if (!SetInformationJobObject(
                handle, JobObjectExtendedLimitInformation, &jeli, sizeof(jeli)
            )) {
                CloseHandle(handle);
                throw subprocess_error{"could not set job object flags"};
            }
        }
        ~jobject() {
            /* this will cause assigned children to terminate */
            CloseHandle(handle);
        }
        HANDLE handle = nullptr;
    };
    /* initialization of local statics is thread safe, throwing
     * an exception makes it re-initialize on the next call of this
     */
    static jobject job;

    /* pipes */

    SECURITY_ATTRIBUTES sa;
    sa.nLength = sizeof(SECURITY_ATTRIBUTES);
    sa.bInheritHandle = true;
    sa.lpSecurityDescriptor = nullptr;

    pipe pipe_in, pipe_out, pipe_err;

    pipe_in.open(use_in, sa, false);
    pipe_out.open(use_out, sa, true);
    pipe_err.open(use_err, sa, true);

    /* process creation */

    PROCESS_INFORMATION pi;
    STARTUPINFOW si;

    memset(&pi, 0, sizeof(pi));
    memset(&si, 0, sizeof(si));

    si.cb = sizeof(STARTUPINFOW);

    if (use_in == subprocess_stream::PIPE) {
        si.hStdInput = pipe_in.p_r;
        pipe_in.fdopen(in, false);
    } else {
        si.hStdInput = GetStdHandle(STD_INPUT_HANDLE);
        if (si.hStdInput == INVALID_HANDLE_VALUE) {
            throw subprocess_error{"could not get standard input handle"};
        }
    }
    if (use_out == subprocess_stream::PIPE) {
        si.hStdOutput = pipe_out.p_w;
        pipe_out.fdopen(out, true);
    } else {
        si.hStdOutput = GetStdHandle(STD_OUTPUT_HANDLE);
        if (si.hStdOutput == INVALID_HANDLE_VALUE) {
            throw subprocess_error{"could not get standard output handle"};
        }
    }
    if (use_err == subprocess_stream::PIPE) {
        si.hStdError = pipe_err.p_w;
        pipe_err.fdopen(err, true);
    } else if (use_err == subprocess_stream::STDOUT) {
        si.hStdError = si.hStdOutput;
    } else {
        si.hStdError = GetStdHandle(STD_ERROR_HANDLE);
        if (si.hStdError == INVALID_HANDLE_VALUE) {
            throw subprocess_error{"could not get standard error handle"};
        }
    }
    si.dwFlags |= STARTF_USESTDHANDLES;

    std::unique_ptr<wchar_t[]> cmdpath;
    auto cmdline = concat_args(cmd, func, datap, cmdpath);

    std::wstring envstr;
    if (edatap) {
        for (string_range r; efunc(r, edatap);) {
            std::unique_ptr<wchar_t[]> wr{new wchar_t[r.size() + 1]};
            auto req = MultiByteToWideChar(
                CP_UTF8, 0, r.data(), r.size(), wr.get(), wr.size() + 1
            );
            if (!req) {
                throw subprocess_error{"unicode conversion failed"};
            }
            wr.get()[req] = L'\0';
            /* include terminating zero */
            envstr.append(wr.get(), req + 1);
        }
    } else {
        struct env_guard {
            wchar_t *envp = nullptr;
            env_guard() {
                envp = GetEnvironmentStringsW();
                if (!envp) {
                    throw subprocess_error{"could not get environment block"};
                }
            }
            ~env_guard() {
                FreeEnvironmentStrings(envp);
            }
        } envs;
        wchar_t *endp = envs.envp;
        while (*endp) {
            endp += wcslen(endp) + 1;
        }
        envstr.append(envs.envp, std::size_t(endp - envs.envp));
    }

    /* owned by CreateProcess, do not close explicitly */
    pipe_in.p_r = nullptr;
    pipe_out.p_w = nullptr;
    pipe_err.p_w = nullptr;

    /* we use CREATE_SUSPENDED so that the process doesn't
     * actually start when job assignment ends up failing...
     */
    auto success = CreateProcessW(
        cmdpath.get(),
        cmdline.get(),
        nullptr,          /* process security attributes */
        nullptr,          /* primary thread security attributes */
        true,             /* inherit handles */
        CREATE_SUSPENDED | CREATE_UNICODE_ENVIRONMENT, /* creation flags */
        envstr.data(),    /* use parent env */
        nullptr,          /* use parent cwd */
        &si,
        &pi
    );

    if (!success) {
        throw subprocess_error{"could not execute subprocess"};
    }

    auto term_throw = [](PROCESS_INFORMATION &pi, char const *msg) {
        TerminateProcess(pi.hProcess, 0);
        CloseHandle(pi.hProcess);
        CloseHandle(pi.hThread);
        throw subprocess_error{msg};
    };

    success = AssignProcessToJobObject(job.handle, pi.hProcess);
    if (!success) {
        term_throw(pi, "could not assign child to job");
    }

    if (ResumeThread(pi.hThread) == DWORD(-1)) {
        term_throw(pi, "could not resume child thread");
    }

    /* does not terminate process, but we don't need it anymore */
    CloseHandle(pi.hThread);
    p_current = static_cast<void *>(pi.hProcess);
}

OSTD_EXPORT void subprocess::reset() {
    CloseHandle(static_cast<HANDLE>(std::exchange(p_current, nullptr)));
}

OSTD_EXPORT int subprocess::close() {
    if (!p_current) {
        throw subprocess_error{"no child process"};
    }
    HANDLE proc = static_cast<HANDLE>(p_current);

    if (WaitForSingleObject(proc, INFINITE) == WAIT_FAILED) {
        reset();
        throw subprocess_error{"child process wait failed"};
    }

    DWORD ec = 0;
    if (!GetExitCodeProcess(proc, &ec)) {
        reset();
        throw subprocess_error{"could not retrieve exit code"};
    }

    reset();
    return int(ec);
}

OSTD_EXPORT void subprocess::move_data(subprocess &i) {
    std::swap(p_current, i.p_current);
}

OSTD_EXPORT void subprocess::swap_data(subprocess &i) {
    move_data(i);
}

} /* namespace ostd */