Changeset 39721 in vbox

Timestamp:

Jan 7, 2012 9:36:46 PM (13 years ago)

Author:

vboxsync

Message:

RTSystemShutdown: stub.

Location:

trunk

Files:

• include/iprt/err.h (modified) (1 diff)
• include/iprt/system.h (modified) (1 diff)
• src/VBox/Runtime/Makefile.kmk (modified) (7 diffs)
• src/VBox/Runtime/generic/RTSystemShutdown-generic.cpp (added)

trunk/include/iprt/err.h

@@ -1685 +1685 @@
 /** @} */
 
+/** @name Logger status codes
+ * @{ */
+/** Power off is not supported by the hardware or the OS. */
+#define VERR_SYS_CANNOT_POWER_OFF                   (-22400)
+/** @} */
+
 /* SED-END */
 

trunk/include/iprt/system.h

@@ -195 +195 @@
 RTDECL(int) RTSystemQueryDmiString(RTSYSDMISTR enmString, char *pszBuf, size_t cbBuf);
 
+/** @name Flags for RTSystemReboot and RTSystemShutdown.
+ * @{ */
+/** Reboot the system after shutdown. */
+#define RTSYSTEM_SHUTDOWN_REBOOT            UINT32_C(0)
+/** Reboot the system after shutdown. */
+#define RTSYSTEM_SHUTDOWN_HALT              UINT32_C(1)
+/** Power off the system after shutdown.
+ * This may be equvivalent to a RTSYSTEM_SHUTDOWN_HALT on systems where we
+ * cannot figure out whether the hardware/OS implements the actual powering
+ * off.  If we can figure out that it's not supported, an
+ * VERR_SYS_CANNOT_POWER_OFF error is raised. */
+#define RTSYSTEM_SHUTDOWN_POWER_OFF         UINT32_C(2)
+/** Power off the system after shutdown, or halt it if that's not possible. */
+#define RTSYSTEM_SHUTDOWN_POWER_OFF_HALT    UINT32_C(3)
+/** The shutdown action mask. */
+#define RTSYSTEM_SHUTDOWN_ACTION_MASK       UINT32_C(3)
+/** Unplanned shutdown/reboot. */
+#define RTSYSTEM_SHUTDOWN_UNPLANNED         UINT32_C(0)
+/** Planned shutdown/reboot. */
+#define RTSYSTEM_SHUTDOWN_PLANNED           RT_BIT_32(2)
+/** Force the system to shutdown/reboot regardless of objecting application
+ *  or other stuff.  This flag might not be realized on all systems. */
+#define RTSYSTEM_SHUTDOWN_FORCE             RT_BIT_32(3)
+/** Parameter validation mask. */
+#define RTSYSTEM_SHUTDOWN_VALID_MASK        UINT32_C(0x0000000f)
 /** @} */
 
+/**
+ * Shuts down the system.
+ *
+ * @returns IPRT status code on failure, on success it may or may not return
+ *          depending on the OS.
+ * @param   cMsDelay            The delay before the actual reboot.  If this is
+ *                              not supported by the OS, an immediate reboot
+ *                              will be performed.
+ * @param   fFlags              Shutdown flags, see RTSYSTEM_SHUTDOWN_XXX.
+ * @param   pszLogMsg           Message for the log and users about why we're
+ *                              shutting down.
+ */
+RTDECL(int) RTSystemShutdown(RTMSINTERVAL cMsDelay, uint32_t fFlags, const char *pszLogMsg);
+
+/** @} */
+
 RT_C_DECLS_END
 

trunk/src/VBox/Runtime/Makefile.kmk

@@ -541 +541 @@
         generic/RTProcDaemonize-generic.cpp \
         generic/RTProcIsRunningByName-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTThreadGetNativeState-generic.cpp \
         nt/RTErrConvertFromNtStatus.cpp \
@@ -590 +591 @@
         generic/RTSemEventMultiWait-2-ex-generic.cpp \
         generic/RTSemEventMultiWaitNoResume-2-ex-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTTimeLocalNow-generic.cpp \
         generic/RTTimerCreate-generic.cpp \
@@ -673 +675 @@
         generic/RTRandAdvCreateSystemTruer-generic.cpp \
         generic/RTSystemQueryDmiString-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTTimeLocalNow-generic.cpp \
         generic/RTTimerCreate-generic.cpp \
@@ -747 +750 @@
         generic/RTSemEventMultiWaitNoResume-2-ex-generic.cpp \
         generic/semrw-$(if-expr defined(VBOX_WITH_LOCKLESS_SEMRW),lockless-,)generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/timer-generic.cpp \
         generic/utf16locale-generic.cpp \
@@ -803 +807 @@
         generic/RTSemEventMultiWaitNoResume-2-ex-generic.cpp \
         generic/RTSystemQueryDmiString-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTThreadGetAffinity-stub-generic.cpp \
         generic/RTThreadSetAffinity-stub-generic.cpp \
@@ -869 +874 @@
         generic/RTSemEventMultiWait-2-ex-generic.cpp \
         generic/RTSemEventMultiWaitNoResume-2-ex-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTThreadSetAffinityToCpu-generic.cpp \
         generic/RTTimeLocalNow-generic.cpp \
@@ -957 +963 @@
         generic/RTSystemQueryOSInfo-generic.cpp \
         generic/RTSystemQueryDmiString-generic.cpp \
+        generic/RTSystemShutdown-generic.cpp \
         generic/RTThreadGetAffinity-stub-generic.cpp \
         generic/RTThreadSetAffinity-stub-generic.cpp \