cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync/* $Id$ */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync/** @file
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * Set the NT timer frequency.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync/*
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * Copyright (C) 2007-2014 Oracle Corporation
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync *
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * available from http://www.virtualbox.org. This file is free software;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * General Public License (GPL) as published by the Free Software
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync *
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * The contents of this file may alternatively be used under the terms
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * of the Common Development and Distribution License Version 1.0
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * VirtualBox OSE distribution, in which case the provisions of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * CDDL are applicable instead of those of the GPL.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync *
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * You may elect to license modified versions of this file under the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * terms and conditions of either the GPL or the CDDL or both.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync/*******************************************************************************
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync* Header Files *
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync*******************************************************************************/
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#define _WIN32_WINNT 0x0500
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <Windows.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/initterm.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/getopt.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/message.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/stream.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/string.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/thread.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync#include <iprt/err.h>
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncRT_C_DECLS_BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync/* from sysinternals. */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncNTSYSAPI LONG NTAPI NtSetTimerResolution(IN ULONG DesiredResolution, IN BOOLEAN SetResolution, OUT PULONG CurrentResolution);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncNTSYSAPI LONG NTAPI NtQueryTimerResolution(OUT PULONG MinimumResolution, OUT PULONG MaximumResolution, OUT PULONG CurrentResolution);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncRT_C_DECLS_END
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncint main(int argc, char **argv)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync{
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync int rc = RTR3InitExe(argc, &argv, 0);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (RT_FAILURE(rc))
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync return RTMsgInitFailure(rc);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync /*
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * Parse arguments.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync bool fVerbose = true;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync uint32_t u32NewRes = 0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync uint32_t cSecsSleep = UINT32_MAX;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync static const RTGETOPTDEF s_aOptions[] =
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync { "--resolution", 'r', RTGETOPT_REQ_UINT32 },
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync { "--sleep", 's', RTGETOPT_REQ_UINT32 },
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync { "--quiet", 'q', RTGETOPT_REQ_NOTHING },
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync };
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTGETOPTUNION ValueUnion;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTGETOPTSTATE GetState;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync while ((rc = RTGetOpt(&GetState, &ValueUnion)))
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync switch (rc)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync case 'r':
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync u32NewRes = ValueUnion.u32;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (u32NewRes > 16*10000 /* 16 ms */ || u32NewRes < 1000 /* 100 microsec */)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync "syntax error: the new timer resolution (%RU32) is out of range\n",
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync u32NewRes);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync break;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync case 's':
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync cSecsSleep = ValueUnion.u32;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync break;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync case 'q':
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync fVerbose = false;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync break;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync case 'v':
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync fVerbose = true;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync break;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync case 'h':
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTPrintf("Usage: ntsetfreq [-q|--quiet] [-v|--verbose] [-r|--resolution <100ns>] [-s|--sleep <1s>]\n");
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync return RTEXITCODE_SUCCESS;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync default:
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync return RTGetOptPrintError(rc, &ValueUnion);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync /*
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync * Query the current resolution.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync */
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync ULONG Cur = ~0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync ULONG Min = ~0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync ULONG Max = ~0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync LONG Status;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (fVerbose || !u32NewRes)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Status = NtQueryTimerResolution(&Min, &Max, &Cur);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (Status >= 0)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTMsgInfo("cur: %u (%u.%02u Hz) min: %u (%u.%02u Hz) max: %u (%u.%02u Hz)\n",
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Cur, 10000000 / Cur, (10000000 / (Cur * 100)) % 100,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Min, 10000000 / Min, (10000000 / (Min * 100)) % 100,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Max, 10000000 / Max, (10000000 / (Max * 100)) % 100);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync else
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTMsgError("NTQueryTimerResolution failed with status %#x\n", Status);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (u32NewRes)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Status = NtSetTimerResolution(u32NewRes, TRUE, &Cur);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (Status < 0)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTMsgError("NTSetTimerResolution(%RU32,,) failed with status %#x\n", u32NewRes, Status);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync else if (fVerbose)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Cur = Min = Max = ~0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Status = NtQueryTimerResolution(&Min, &Max, &Cur);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (Status >= 0)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTMsgInfo("new: %u (%u.%02u Hz) requested %RU32 (%u.%02u Hz)\n",
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Cur, 10000000 / Cur, (10000000 / (Cur * 100)) % 100,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync u32NewRes, 10000000 / u32NewRes, (10000000 / (u32NewRes * 100)) % 100);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync else
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTMsgError("NTSetTimerResolution succeeded but the NTQueryTimerResolution call failed with status %#x (ignored)\n", Status);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync Status = 0;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (u32NewRes && Status >= 0)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync {
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync if (cSecsSleep == UINT32_MAX)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync for (;;)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTThreadSleep(RT_INDEFINITE_WAIT);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync else
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync while (cSecsSleep-- > 0)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RTThreadSleep(1000);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync }
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync return Status >= 0 ? 0 : 1;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync}
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync