summaryrefslogtreecommitdiffstats
path: root/src/VBox/Runtime/r3/win/RTSystemShutdown-win.cpp
blob: 369950f93666ee40fe02cd5549cc37ac0872f7ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/* $Id: RTSystemShutdown-win.cpp $ */
/** @file
 * IPRT - RTSystemShutdown, Windows.
 */

/*
 * Copyright (C) 2012-2019 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 *
 * The contents of this file may alternatively be used under the terms
 * of the Common Development and Distribution License Version 1.0
 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
 * VirtualBox OSE distribution, in which case the provisions of the
 * CDDL are applicable instead of those of the GPL.
 *
 * You may elect to license modified versions of this file under the
 * terms and conditions of either the GPL or the CDDL or both.
 */


/*********************************************************************************************************************************
*   Header Files                                                                                                                 *
*********************************************************************************************************************************/
#include <iprt/system.h>
#include "internal/iprt.h"

#include <iprt/assert.h>
#include <iprt/err.h>
#include <iprt/string.h>
#include <iprt/utf16.h>

#include <iprt/win/windows.h>


RTDECL(int) RTSystemShutdown(RTMSINTERVAL cMsDelay, uint32_t fFlags, const char *pszLogMsg)
{
    AssertPtrReturn(pszLogMsg, VERR_INVALID_POINTER);
    AssertReturn(!(fFlags & ~RTSYSTEM_SHUTDOWN_VALID_MASK), VERR_INVALID_PARAMETER);

    /*
     * Before we start, try grant the necessary privileges.
     */
    DWORD  dwErr;
    HANDLE hToken = NULL;
    if (OpenThreadToken(GetCurrentThread(), TOKEN_ADJUST_PRIVILEGES, TRUE /*OpenAsSelf*/, &hToken))
        dwErr = NO_ERROR;
    else
    {
        dwErr  = GetLastError();
        if (dwErr == ERROR_NO_TOKEN)
        {
            if (OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES, &hToken))
                dwErr = NO_ERROR;
            else
                dwErr = GetLastError();
        }
    }
    if (dwErr == NO_ERROR)
    {
        union
        {
            TOKEN_PRIVILEGES TokenPriv;
            char ab[sizeof(TOKEN_PRIVILEGES) + sizeof(LUID_AND_ATTRIBUTES)];
        } u;
        u.TokenPriv.PrivilegeCount = 1;
        u.TokenPriv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
        if (LookupPrivilegeValue(NULL /*localhost*/, SE_SHUTDOWN_NAME, &u.TokenPriv.Privileges[0].Luid))
        {
            if (!AdjustTokenPrivileges(hToken,
                                       FALSE /*DisableAllPrivileges*/,
                                       &u.TokenPriv,
                                       RT_UOFFSETOF(TOKEN_PRIVILEGES, Privileges[1]),
                                       NULL,
                                       NULL) )
                dwErr = GetLastError();
        }
        else
            dwErr = GetLastError();
        CloseHandle(hToken);
    }

    /*
     * Do some parameter conversion.
     */
    PRTUTF16 pwszLogMsg;
    int rc = RTStrToUtf16(pszLogMsg, &pwszLogMsg);
    if (RT_FAILURE(rc))
        return rc;
    DWORD cSecsTimeout = (cMsDelay + 499) / 1000;

    /*
     * If we're told to power off the system, we should try use InitiateShutdownW (6.0+)
     * or ExitWindowsEx (3.50) rather than InitiateSystemShutdownW, because these other
     * APIs allows us to explicitly specify that we want to power off.
     *
     * Note! For NT version 4, 3.51, and 3.50 the system may instaed reboot since the
     *       x86 HALs typically didn't know how to perform a power off.
     */
    bool fDone = false;
    if (   (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_POWER_OFF
        || (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_POWER_OFF_HALT)
    {
        /* This API has the grace period thing. */
        decltype(InitiateShutdownW) *pfnInitiateShutdownW;
        pfnInitiateShutdownW = (decltype(InitiateShutdownW) *)GetProcAddress(GetModuleHandleW(L"ADVAPI32.DLL"), "InitiateShutdownW");
        if (pfnInitiateShutdownW)
        {
            DWORD fShutdownFlags = SHUTDOWN_POWEROFF;
            if (fFlags & RTSYSTEM_SHUTDOWN_FORCE)
                fShutdownFlags |= SHUTDOWN_FORCE_OTHERS | SHUTDOWN_FORCE_SELF;
            DWORD fReason = SHTDN_REASON_MAJOR_OTHER | (fFlags & RTSYSTEM_SHUTDOWN_PLANNED ? SHTDN_REASON_FLAG_PLANNED : 0);
            dwErr = pfnInitiateShutdownW(NULL /*pwszMachineName*/, pwszLogMsg, cSecsTimeout, fShutdownFlags, fReason);
            if (dwErr == ERROR_INVALID_PARAMETER)
            {
                fReason &= ~SHTDN_REASON_FLAG_PLANNED; /* just in case... */
                dwErr = pfnInitiateShutdownW(NULL /*pwszMachineName*/, pwszLogMsg, cSecsTimeout, fShutdownFlags, fReason);
            }
            if (dwErr == ERROR_SUCCESS)
            {
                rc = VINF_SUCCESS;
                fDone = true;
            }
        }

        if (!fDone)
        {
            /* No grace period here, too bad. */
            decltype(ExitWindowsEx) *pfnExitWindowsEx;
            pfnExitWindowsEx = (decltype(ExitWindowsEx) *)GetProcAddress(GetModuleHandleW(L"USER32.DLL"), "ExitWindowsEx");
            if (pfnExitWindowsEx)
            {
                DWORD fExitWindows = EWX_POWEROFF | EWX_SHUTDOWN;
                if (fFlags & RTSYSTEM_SHUTDOWN_FORCE)
                    fExitWindows |= EWX_FORCE | EWX_FORCEIFHUNG;

                if (pfnExitWindowsEx(fExitWindows, SHTDN_REASON_MAJOR_OTHER))
                    fDone = true;
                else if (pfnExitWindowsEx(fExitWindows & ~EWX_FORCEIFHUNG, SHTDN_REASON_MAJOR_OTHER))
                    fDone = true;
            }
        }
    }

    /*
     * Fall back on the oldest API.
     */
    if (!fDone)
    {
        BOOL fRebootAfterShutdown = (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_REBOOT
                                   ? TRUE : FALSE;
        BOOL fForceAppsClosed     = fFlags & RTSYSTEM_SHUTDOWN_FORCE ? TRUE : FALSE;
        if (InitiateSystemShutdownW(NULL /*pwszMachineName = NULL = localhost*/,
                                    pwszLogMsg,
                                    cSecsTimeout,
                                    fForceAppsClosed,
                                    fRebootAfterShutdown))
            rc = (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_HALT ? VINF_SYS_MAY_POWER_OFF : VINF_SUCCESS;
        else
            rc = RTErrConvertFromWin32(dwErr);
    }

    RTUtf16Free(pwszLogMsg);
    return rc;
}
RT_EXPORT_SYMBOL(RTSystemShutdown);