VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/win/RTSystemShutdown-win.cpp@ 103795

Last change on this file since 103795 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.1 KB
Line 
1/* $Id: RTSystemShutdown-win.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * IPRT - RTSystemShutdown, Windows.
4 */
5
6/*
7 * Copyright (C) 2012-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#include <iprt/system.h>
42#include "internal/iprt.h"
43
44#include <iprt/assert.h>
45#include <iprt/err.h>
46#include <iprt/string.h>
47#include <iprt/utf16.h>
48
49#include <iprt/win/windows.h>
50
51
52RTDECL(int) RTSystemShutdown(RTMSINTERVAL cMsDelay, uint32_t fFlags, const char *pszLogMsg)
53{
54 AssertPtrReturn(pszLogMsg, VERR_INVALID_POINTER);
55 AssertReturn(!(fFlags & ~RTSYSTEM_SHUTDOWN_VALID_MASK), VERR_INVALID_PARAMETER);
56
57 /*
58 * Before we start, try grant the necessary privileges.
59 */
60 DWORD dwErr;
61 HANDLE hToken = NULL;
62 if (OpenThreadToken(GetCurrentThread(), TOKEN_ADJUST_PRIVILEGES, TRUE /*OpenAsSelf*/, &hToken))
63 dwErr = NO_ERROR;
64 else
65 {
66 dwErr = GetLastError();
67 if (dwErr == ERROR_NO_TOKEN)
68 {
69 if (OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES, &hToken))
70 dwErr = NO_ERROR;
71 else
72 dwErr = GetLastError();
73 }
74 }
75 if (dwErr == NO_ERROR)
76 {
77 union
78 {
79 TOKEN_PRIVILEGES TokenPriv;
80 char ab[sizeof(TOKEN_PRIVILEGES) + sizeof(LUID_AND_ATTRIBUTES)];
81 } u;
82 u.TokenPriv.PrivilegeCount = 1;
83 u.TokenPriv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
84 if (LookupPrivilegeValue(NULL /*localhost*/, SE_SHUTDOWN_NAME, &u.TokenPriv.Privileges[0].Luid))
85 {
86 if (!AdjustTokenPrivileges(hToken,
87 FALSE /*DisableAllPrivileges*/,
88 &u.TokenPriv,
89 RT_UOFFSETOF(TOKEN_PRIVILEGES, Privileges[1]),
90 NULL,
91 NULL) )
92 dwErr = GetLastError();
93 }
94 else
95 dwErr = GetLastError();
96 CloseHandle(hToken);
97 }
98
99 /*
100 * Do some parameter conversion.
101 */
102 PRTUTF16 pwszLogMsg;
103 int rc = RTStrToUtf16(pszLogMsg, &pwszLogMsg);
104 if (RT_FAILURE(rc))
105 return rc;
106 DWORD cSecsTimeout = (cMsDelay + 499) / 1000;
107
108 /*
109 * If we're told to power off the system, we should try use InitiateShutdownW (6.0+)
110 * or ExitWindowsEx (3.50) rather than InitiateSystemShutdownW, because these other
111 * APIs allows us to explicitly specify that we want to power off.
112 *
113 * Note! For NT version 4, 3.51, and 3.50 the system may instaed reboot since the
114 * x86 HALs typically didn't know how to perform a power off.
115 */
116 bool fDone = false;
117 if ( (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_POWER_OFF
118 || (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_POWER_OFF_HALT)
119 {
120 /* This API has the grace period thing. */
121 decltype(InitiateShutdownW) *pfnInitiateShutdownW;
122 pfnInitiateShutdownW = (decltype(InitiateShutdownW) *)GetProcAddress(GetModuleHandleW(L"ADVAPI32.DLL"), "InitiateShutdownW");
123 if (pfnInitiateShutdownW)
124 {
125 DWORD fShutdownFlags = SHUTDOWN_POWEROFF;
126 if (fFlags & RTSYSTEM_SHUTDOWN_FORCE)
127 fShutdownFlags |= SHUTDOWN_FORCE_OTHERS | SHUTDOWN_FORCE_SELF;
128 DWORD fReason = SHTDN_REASON_MAJOR_OTHER | (fFlags & RTSYSTEM_SHUTDOWN_PLANNED ? SHTDN_REASON_FLAG_PLANNED : 0);
129 dwErr = pfnInitiateShutdownW(NULL /*pwszMachineName*/, pwszLogMsg, cSecsTimeout, fShutdownFlags, fReason);
130 if (dwErr == ERROR_INVALID_PARAMETER)
131 {
132 fReason &= ~SHTDN_REASON_FLAG_PLANNED; /* just in case... */
133 dwErr = pfnInitiateShutdownW(NULL /*pwszMachineName*/, pwszLogMsg, cSecsTimeout, fShutdownFlags, fReason);
134 }
135 if (dwErr == ERROR_SUCCESS)
136 {
137 rc = VINF_SUCCESS;
138 fDone = true;
139 }
140 }
141
142 if (!fDone)
143 {
144 /* No grace period here, too bad. */
145 decltype(ExitWindowsEx) *pfnExitWindowsEx;
146 pfnExitWindowsEx = (decltype(ExitWindowsEx) *)GetProcAddress(GetModuleHandleW(L"USER32.DLL"), "ExitWindowsEx");
147 if (pfnExitWindowsEx)
148 {
149 DWORD fExitWindows = EWX_POWEROFF | EWX_SHUTDOWN;
150 if (fFlags & RTSYSTEM_SHUTDOWN_FORCE)
151 fExitWindows |= EWX_FORCE | EWX_FORCEIFHUNG;
152
153 if (pfnExitWindowsEx(fExitWindows, SHTDN_REASON_MAJOR_OTHER))
154 fDone = true;
155 else if (pfnExitWindowsEx(fExitWindows & ~EWX_FORCEIFHUNG, SHTDN_REASON_MAJOR_OTHER))
156 fDone = true;
157 }
158 }
159 }
160
161 /*
162 * Fall back on the oldest API.
163 */
164 if (!fDone)
165 {
166 BOOL fRebootAfterShutdown = (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_REBOOT
167 ? TRUE : FALSE;
168 BOOL fForceAppsClosed = fFlags & RTSYSTEM_SHUTDOWN_FORCE ? TRUE : FALSE;
169 if (InitiateSystemShutdownW(NULL /*pwszMachineName = NULL = localhost*/,
170 pwszLogMsg,
171 cSecsTimeout,
172 fForceAppsClosed,
173 fRebootAfterShutdown))
174 rc = (fFlags & RTSYSTEM_SHUTDOWN_ACTION_MASK) == RTSYSTEM_SHUTDOWN_HALT ? VINF_SYS_MAY_POWER_OFF : VINF_SUCCESS;
175 else
176 rc = RTErrConvertFromWin32(dwErr);
177 }
178
179 RTUtf16Free(pwszLogMsg);
180 return rc;
181}
182RT_EXPORT_SYMBOL(RTSystemShutdown);
183
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette