jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2020, Liav A. <liavalb@hotmail.co.il>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/FixedArray.h>
30#include <AK/Optional.h>
31#include <AK/OwnPtr.h>
32#include <AK/Types.h>
33#include <AK/WeakPtr.h>
34#include <Kernel/UnixTypes.h>
35
36namespace Kernel {
37
38#define OPTIMAL_TICKS_PER_SECOND_RATE 1000
39
40class HardwareTimer;
41class TimeManagement {
42public:
43 static bool initialized();
44 static void initialize();
45 static TimeManagement& the();
46
47 time_t epoch_time() const;
48 void set_epoch_time(time_t);
49 time_t seconds_since_boot() const;
50 time_t ticks_per_second() const;
51 time_t ticks_this_second() const;
52 time_t boot_time() const;
53
54 bool is_system_timer(const HardwareTimer&) const;
55
56 static void update_time(const RegisterState&);
57 void increment_time_since_boot(const RegisterState&);
58
59 static void update_scheduler_ticks(const RegisterState& regs);
60 void update_ticks(const RegisterState&);
61
62 static void stale_function(const RegisterState&);
63 static bool is_hpet_periodic_mode_allowed();
64
65private:
66 explicit TimeManagement(bool probe_non_legacy_hardware_timers);
67 bool probe_and_set_legacy_hardware_timers();
68 bool probe_and_set_non_legacy_hardware_timers();
69 Vector<size_t> scan_and_initialize_periodic_timers();
70 Vector<size_t> scan_for_non_periodic_timers();
71 FixedArray<RefPtr<HardwareTimer>> m_hardware_timers { 2 };
72
73 u32 m_ticks_this_second { 0 };
74 u32 m_seconds_since_boot { 0 };
75 time_t m_epoch_time { 0 };
76 RefPtr<HardwareTimer> m_system_timer;
77 RefPtr<HardwareTimer> m_time_keeper_timer;
78 Function<void(RegisterState&)> m_scheduler_ticking { update_time };
79 Function<void(RegisterState&)> m_stale_method { stale_function };
80};
81
82}