eOn 3.2.0
Long-timescale dynamics: aKMC, NEB, parallel replica
☾
Toggle main menu visibility
Loading...
Searching...
No Matches
PotRegistry.h
Go to the documentation of this file.
1
/*
2
** This file is part of eOn.
3
**
4
** SPDX-License-Identifier: BSD-3-Clause
5
**
6
** Copyright (c) 2010--present, eOn Development Team
7
** All rights reserved.
8
**
9
** Repo:
10
** https://github.com/TheochemUI/eOn
11
*/
12
#pragma once
13
14
#include "
BaseStructures.h
"
15
#include <array>
16
#include <atomic>
17
#include <chrono>
18
#include <memory>
19
#include <mutex>
20
#include <string>
21
#include <vector>
22
23
namespace
eonc
{
24
27
struct
RegistryLifetime
{
28
std::atomic<bool>
alive
{
true
};
29
};
30
31
// ---------------------------------------------------------------------------
32
// IPotRegistry: injectable ABI. Production uses PotRegistry::get().
33
// ---------------------------------------------------------------------------
34
class
IPotRegistry
{
35
public
:
36
using
Clock
= std::chrono::system_clock;
37
using
TimePoint
= Clock::time_point;
38
39
virtual
~IPotRegistry
() {
40
if
(
lifetime_
)
41
lifetime_
->alive.store(
false
, std::memory_order_release);
42
}
43
44
[[nodiscard]] std::shared_ptr<RegistryLifetime>
lifetime
()
const
{
45
return
lifetime_
;
46
}
47
[[nodiscard]]
virtual
uint64_t
on_created
(
PotType
t)
noexcept
= 0;
48
virtual
void
on_destroyed
(uint64_t
id
,
PotType
t,
size_t
force_calls,
49
TimePoint
created_at) = 0;
50
virtual
void
on_force_call
(
PotType
t)
noexcept
= 0;
51
52
IPotRegistry
(
const
IPotRegistry
&) =
delete
;
53
IPotRegistry
&
operator=
(
const
IPotRegistry
&) =
delete
;
54
55
protected
:
56
IPotRegistry
() =
default
;
57
58
std::shared_ptr<RegistryLifetime>
lifetime_
{
59
std::make_shared<RegistryLifetime>()};
60
};
61
62
class
PotRegistry
:
public
IPotRegistry
{
63
public
:
64
using
Clock
=
IPotRegistry::Clock
;
65
using
TimePoint
=
IPotRegistry::TimePoint
;
66
67
struct
InstanceRecord
{
68
uint64_t
id
;
69
PotType
type
;
70
TimePoint
created_at
;
71
TimePoint
destroyed_at
;
72
size_t
force_calls
;
73
};
74
75
private
:
76
struct
TypeStats
{
77
std::atomic<size_t>
force_calls
{0};
78
std::atomic<size_t>
created
{0};
79
std::atomic<size_t>
alive
{0};
80
};
81
std::array<TypeStats, magic_enum::enum_count<PotType>()>
m_type_stats
{};
82
83
std::mutex
m_records_mutex
;
84
std::vector<InstanceRecord>
m_records
;
85
86
std::atomic<uint64_t>
m_next_id
{1};
87
88
public
:
89
PotRegistry
() =
default
;
90
~PotRegistry
()
override
{
91
// Members are still intact. Mark the registry dead before they go,
92
// so a Potential destroyed from here does not lock a dead mutex.
93
if
(
lifetime_
)
94
lifetime_
->alive.store(
false
, std::memory_order_release);
95
}
96
100
static
PotRegistry
&
get
() noexcept;
101
void
reset
();
102
103
// Lifecycle events
104
[[nodiscard]] uint64_t
on_created
(
PotType
t) noexcept override;
105
void
on_destroyed
(uint64_t
id
,
PotType
t,
size_t
force_calls,
106
TimePoint
created_at) override;
107
void
on_force_call
(
PotType
t) noexcept override;
108
109
// Per-type queries
110
[[nodiscard]]
size_t
type_force_calls
(
PotType
t) const noexcept;
111
[[nodiscard]]
size_t
total_force_calls
() const noexcept;
112
[[nodiscard]]
size_t
type_alive
(
PotType
t) const noexcept;
113
114
// JSON output
115
void
write_summary
(const std::
string
&path =
"_potcalls.json"
) const;
116
};
117
118
}
// namespace eonc
BaseStructures.h
eonc::IPotRegistry::IPotRegistry
IPotRegistry(const IPotRegistry &)=delete
eonc::IPotRegistry::lifetime
std::shared_ptr< RegistryLifetime > lifetime() const
Definition
PotRegistry.h:44
eonc::IPotRegistry::operator=
IPotRegistry & operator=(const IPotRegistry &)=delete
eonc::IPotRegistry::on_destroyed
virtual void on_destroyed(uint64_t id, PotType t, size_t force_calls, TimePoint created_at)=0
eonc::IPotRegistry::lifetime_
std::shared_ptr< RegistryLifetime > lifetime_
Definition
PotRegistry.h:58
eonc::IPotRegistry::IPotRegistry
IPotRegistry()=default
eonc::IPotRegistry::TimePoint
Clock::time_point TimePoint
Definition
PotRegistry.h:37
eonc::IPotRegistry::on_force_call
virtual void on_force_call(PotType t) noexcept=0
eonc::IPotRegistry::Clock
std::chrono::system_clock Clock
Definition
PotRegistry.h:36
eonc::IPotRegistry::~IPotRegistry
virtual ~IPotRegistry()
Definition
PotRegistry.h:39
eonc::IPotRegistry::on_created
virtual uint64_t on_created(PotType t) noexcept=0
eonc::PotRegistry
Definition
PotRegistry.h:62
eonc::PotRegistry::m_next_id
std::atomic< uint64_t > m_next_id
Definition
PotRegistry.h:86
eonc::PotRegistry::m_type_stats
std::array< TypeStats, magic_enum::enum_count< PotType >()> m_type_stats
Definition
PotRegistry.h:81
eonc::PotRegistry::PotRegistry
PotRegistry()=default
eonc::PotRegistry::~PotRegistry
~PotRegistry() override
Definition
PotRegistry.h:90
eonc::PotRegistry::on_force_call
void on_force_call(PotType t) noexcept override
Definition
PotRegistry.cpp:89
eonc::PotRegistry::get
static PotRegistry & get() noexcept
Process-lifetime singleton.
Definition
PotRegistry.cpp:51
eonc::PotRegistry::type_force_calls
size_t type_force_calls(PotType t) const noexcept
Definition
PotRegistry.cpp:94
eonc::PotRegistry::reset
void reset()
Definition
PotRegistry.cpp:61
eonc::PotRegistry::total_force_calls
size_t total_force_calls() const noexcept
Definition
PotRegistry.cpp:99
eonc::PotRegistry::m_records_mutex
std::mutex m_records_mutex
Definition
PotRegistry.h:83
eonc::PotRegistry::type_alive
size_t type_alive(PotType t) const noexcept
Definition
PotRegistry.cpp:107
eonc::PotRegistry::on_created
uint64_t on_created(PotType t) noexcept override
Definition
PotRegistry.cpp:72
eonc::PotRegistry::write_summary
void write_summary(const std::string &path="_potcalls.json") const
Definition
PotRegistry.cpp:112
eonc::PotRegistry::m_records
std::vector< InstanceRecord > m_records
Definition
PotRegistry.h:84
eonc::PotRegistry::Clock
IPotRegistry::Clock Clock
Definition
PotRegistry.h:64
eonc::PotRegistry::on_destroyed
void on_destroyed(uint64_t id, PotType t, size_t force_calls, TimePoint created_at) override
Definition
PotRegistry.cpp:79
eonc::PotRegistry::TimePoint
IPotRegistry::TimePoint TimePoint
Definition
PotRegistry.h:65
eonc
RAII resource manager for the ARTn C library with global synchronization.
Definition
ARTnSaddleSearch.cpp:23
eonc::PotType
PotType
Definition
BaseStructures.h:36
eonc::PotRegistry::InstanceRecord
Definition
PotRegistry.h:67
eonc::PotRegistry::InstanceRecord::id
uint64_t id
Definition
PotRegistry.h:68
eonc::PotRegistry::InstanceRecord::destroyed_at
TimePoint destroyed_at
Definition
PotRegistry.h:71
eonc::PotRegistry::InstanceRecord::created_at
TimePoint created_at
Definition
PotRegistry.h:70
eonc::PotRegistry::InstanceRecord::force_calls
size_t force_calls
Definition
PotRegistry.h:72
eonc::PotRegistry::InstanceRecord::type
PotType type
Definition
PotRegistry.h:69
eonc::PotRegistry::TypeStats
Definition
PotRegistry.h:76
eonc::PotRegistry::TypeStats::created
std::atomic< size_t > created
Definition
PotRegistry.h:78
eonc::PotRegistry::TypeStats::force_calls
std::atomic< size_t > force_calls
Definition
PotRegistry.h:77
eonc::PotRegistry::TypeStats::alive
std::atomic< size_t > alive
Definition
PotRegistry.h:79
eonc::RegistryLifetime
Outlives the registry object.
Definition
PotRegistry.h:27
eonc::RegistryLifetime::alive
std::atomic< bool > alive
Definition
PotRegistry.h:28
include
eon
PotRegistry.h
Generated by
1.17.0
Generated by
Doxygen 1.17.0
Analytics by
Antics
provided by
TurtleTech ehf