Merge pull request #45617 from RandomShaper/modernize_atomics

Modernize atomics (and fix `volatile`)

8 files changed, 63 insertions, 61 deletions

diff --git a/servers/audio/audio_rb_resampler.cpp b/servers/audio/audio_rb_resampler.cpp
index efdcb916ed..3c8a1469cd 100644
--- a/servers/audio/audio_rb_resampler.cpp
+++ b/servers/audio/audio_rb_resampler.cpp
@@ -131,7 +131,7 @@ bool AudioRBResampler::mix(AudioFrame *p_dest, int p_frames) {
 			src_read = read_space;
 		}
 
-		rb_read_pos = (rb_read_pos + src_read) & rb_mask;
+		rb_read_pos.set((rb_read_pos.get() + src_read) & rb_mask);
 
 		// Create fadeout effect for the end of stream (note that it can be because of slow writer)
 		if (p_frames - target_todo > 0) {
@@ -183,8 +183,8 @@ Error AudioRBResampler::setup(int p_channels, int p_src_mix_rate, int p_target_m
 	src_mix_rate = p_src_mix_rate;
 	target_mix_rate = p_target_mix_rate;
 	offset = 0;
-	rb_read_pos = 0;
-	rb_write_pos = 0;
+	rb_read_pos.set(0);
+	rb_write_pos.set(0);
 
 	//avoid maybe strange noises upon load
 	for (unsigned int i = 0; i < (rb_len * channels); i++) {
@@ -205,8 +205,8 @@ void AudioRBResampler::clear() {
 	memdelete_arr(read_buf);
 	rb = nullptr;
 	offset = 0;
-	rb_read_pos = 0;
-	rb_write_pos = 0;
+	rb_read_pos.set(0);
+	rb_write_pos.set(0);
 	read_buf = nullptr;
 }
 
@@ -214,8 +214,8 @@ AudioRBResampler::AudioRBResampler() {
 	rb = nullptr;
 	offset = 0;
 	read_buf = nullptr;
-	rb_read_pos = 0;
-	rb_write_pos = 0;
+	rb_read_pos.set(0);
+	rb_write_pos.set(0);
 
 	rb_bits = 0;
 	rb_len = 0;
diff --git a/servers/audio/audio_rb_resampler.h b/servers/audio/audio_rb_resampler.h
index 7b74e3a2a1..c0f981704b 100644
--- a/servers/audio/audio_rb_resampler.h
+++ b/servers/audio/audio_rb_resampler.h
@@ -32,6 +32,7 @@
 #define AUDIO_RB_RESAMPLER_H
 
 #include "core/os/memory.h"
+#include "core/templates/safe_refcount.h"
 #include "core/typedefs.h"
 #include "servers/audio_server.h"
 
@@ -44,8 +45,8 @@ struct AudioRBResampler {
 	uint32_t src_mix_rate;
 	uint32_t target_mix_rate;
 
-	volatile int rb_read_pos;
-	volatile int rb_write_pos;
+	SafeNumeric<int> rb_read_pos;
+	SafeNumeric<int> rb_write_pos;
 
 	int32_t offset; //contains the fractional remainder of the resampler
 	enum {
@@ -62,8 +63,8 @@ struct AudioRBResampler {
 
 public:
 	_FORCE_INLINE_ void flush() {
-		rb_read_pos = 0;
-		rb_write_pos = 0;
+		rb_read_pos.set(0);
+		rb_write_pos.set(0);
 		offset = 0;
 	}
 
@@ -78,8 +79,8 @@ public:
 	_FORCE_INLINE_ int get_writer_space() const {
 		int space, r, w;
 
-		r = rb_read_pos;
-		w = rb_write_pos;
+		r = rb_read_pos.get();
+		w = rb_write_pos.get();
 
 		if (r == w) {
 			space = rb_len - 1;
@@ -95,8 +96,8 @@ public:
 	_FORCE_INLINE_ int get_reader_space() const {
 		int space, r, w;
 
-		r = rb_read_pos;
-		w = rb_write_pos;
+		r = rb_read_pos.get();
+		w = rb_write_pos.get();
 
 		if (r == w) {
 			space = 0;
@@ -110,48 +111,52 @@ public:
 	}
 
 	_FORCE_INLINE_ bool has_data() const {
-		return rb && rb_read_pos != rb_write_pos;
+		return rb && rb_read_pos.get() != rb_write_pos.get();
 	}
 
 	_FORCE_INLINE_ float *get_write_buffer() { return read_buf; }
 	_FORCE_INLINE_ void write(uint32_t p_frames) {
 		ERR_FAIL_COND(p_frames >= rb_len);
 
+		int wp = rb_write_pos.get();
+
 		switch (channels) {
 			case 1: {
 				for (uint32_t i = 0; i < p_frames; i++) {
-					rb[rb_write_pos] = read_buf[i];
-					rb_write_pos = (rb_write_pos + 1) & rb_mask;
+					rb[wp] = read_buf[i];
+					wp = (wp + 1) & rb_mask;
 				}
 			} break;
 			case 2: {
 				for (uint32_t i = 0; i < p_frames; i++) {
-					rb[(rb_write_pos << 1) + 0] = read_buf[(i << 1) + 0];
-					rb[(rb_write_pos << 1) + 1] = read_buf[(i << 1) + 1];
-					rb_write_pos = (rb_write_pos + 1) & rb_mask;
+					rb[(wp << 1) + 0] = read_buf[(i << 1) + 0];
+					rb[(wp << 1) + 1] = read_buf[(i << 1) + 1];
+					wp = (wp + 1) & rb_mask;
 				}
 			} break;
 			case 4: {
 				for (uint32_t i = 0; i < p_frames; i++) {
-					rb[(rb_write_pos << 2) + 0] = read_buf[(i << 2) + 0];
-					rb[(rb_write_pos << 2) + 1] = read_buf[(i << 2) + 1];
-					rb[(rb_write_pos << 2) + 2] = read_buf[(i << 2) + 2];
-					rb[(rb_write_pos << 2) + 3] = read_buf[(i << 2) + 3];
-					rb_write_pos = (rb_write_pos + 1) & rb_mask;
+					rb[(wp << 2) + 0] = read_buf[(i << 2) + 0];
+					rb[(wp << 2) + 1] = read_buf[(i << 2) + 1];
+					rb[(wp << 2) + 2] = read_buf[(i << 2) + 2];
+					rb[(wp << 2) + 3] = read_buf[(i << 2) + 3];
+					wp = (wp + 1) & rb_mask;
 				}
 			} break;
 			case 6: {
 				for (uint32_t i = 0; i < p_frames; i++) {
-					rb[(rb_write_pos * 6) + 0] = read_buf[(i * 6) + 0];
-					rb[(rb_write_pos * 6) + 1] = read_buf[(i * 6) + 1];
-					rb[(rb_write_pos * 6) + 2] = read_buf[(i * 6) + 2];
-					rb[(rb_write_pos * 6) + 3] = read_buf[(i * 6) + 3];
-					rb[(rb_write_pos * 6) + 4] = read_buf[(i * 6) + 4];
-					rb[(rb_write_pos * 6) + 5] = read_buf[(i * 6) + 5];
-					rb_write_pos = (rb_write_pos + 1) & rb_mask;
+					rb[(wp * 6) + 0] = read_buf[(i * 6) + 0];
+					rb[(wp * 6) + 1] = read_buf[(i * 6) + 1];
+					rb[(wp * 6) + 2] = read_buf[(i * 6) + 2];
+					rb[(wp * 6) + 3] = read_buf[(i * 6) + 3];
+					rb[(wp * 6) + 4] = read_buf[(i * 6) + 4];
+					rb[(wp * 6) + 5] = read_buf[(i * 6) + 5];
+					wp = (wp + 1) & rb_mask;
 				}
 			} break;
 		}
+
+		rb_write_pos.set(wp);
 	}
 
 	int get_channel_count() const;
diff --git a/servers/audio/effects/audio_effect_capture.cpp b/servers/audio/effects/audio_effect_capture.cpp
index f37938eec8..37e4122e50 100644
--- a/servers/audio/effects/audio_effect_capture.cpp
+++ b/servers/audio/effects/audio_effect_capture.cpp
@@ -106,7 +106,7 @@ int AudioEffectCapture::get_frames_available() const {
 }
 
 int64_t AudioEffectCapture::get_discarded_frames() const {
-	return discarded_frames;
+	return discarded_frames.get();
 }
 
 int AudioEffectCapture::get_buffer_length_frames() const {
@@ -115,7 +115,7 @@ int AudioEffectCapture::get_buffer_length_frames() const {
 }
 
 int64_t AudioEffectCapture::get_pushed_frames() const {
-	return pushed_frames;
+	return pushed_frames.get();
 }
 
 void AudioEffectCaptureInstance::process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) {
@@ -129,9 +129,9 @@ void AudioEffectCaptureInstance::process(const AudioFrame *p_src_frames, AudioFr
 		// Add incoming audio frames to the IO ring buffer
 		int32_t ret = buffer.write(p_src_frames, p_frame_count);
 		ERR_FAIL_COND_MSG(ret != p_frame_count, "Failed to add data to effect capture ring buffer despite sufficient space.");
-		atomic_add(&base->pushed_frames, p_frame_count);
+		base->pushed_frames.add(p_frame_count);
 	} else {
-		atomic_add(&base->discarded_frames, p_frame_count);
+		base->discarded_frames.add(p_frame_count);
 	}
 }
 
diff --git a/servers/audio/effects/audio_effect_capture.h b/servers/audio/effects/audio_effect_capture.h
index b154be85de..81d4ed6b0f 100644
--- a/servers/audio/effects/audio_effect_capture.h
+++ b/servers/audio/effects/audio_effect_capture.h
@@ -55,8 +55,8 @@ class AudioEffectCapture : public AudioEffect {
 	friend class AudioEffectCaptureInstance;
 
 	RingBuffer<AudioFrame> buffer;
-	uint64_t discarded_frames = 0;
-	uint64_t pushed_frames = 0;
+	SafeNumeric<uint64_t> discarded_frames;
+	SafeNumeric<uint64_t> pushed_frames;
 	float buffer_length_seconds = 0.1f;
 	bool buffer_initialized = false;
 
diff --git a/servers/physics_2d/physics_server_2d_wrap_mt.cpp b/servers/physics_2d/physics_server_2d_wrap_mt.cpp
index c2557d8f7f..790c87cc44 100644
--- a/servers/physics_2d/physics_server_2d_wrap_mt.cpp
+++ b/servers/physics_2d/physics_server_2d_wrap_mt.cpp
@@ -33,7 +33,7 @@
 #include "core/os/os.h"
 
 void PhysicsServer2DWrapMT::thread_exit() {
-	exit = true;
+	exit.set();
 }
 
 void PhysicsServer2DWrapMT::thread_step(real_t p_delta) {
@@ -52,9 +52,9 @@ void PhysicsServer2DWrapMT::thread_loop() {
 
 	physics_2d_server->init();
 
-	exit = false;
-	step_thread_up = true;
-	while (!exit) {
+	exit.clear();
+	step_thread_up.set();
+	while (!exit.is_set()) {
 		// flush commands one by one, until exit is requested
 		command_queue.wait_and_flush_one();
 	}
@@ -98,7 +98,7 @@ void PhysicsServer2DWrapMT::init() {
 	if (create_thread) {
 		//OS::get_singleton()->release_rendering_thread();
 		thread.start(_thread_callback, this);
-		while (!step_thread_up) {
+		while (!step_thread_up.is_set()) {
 			OS::get_singleton()->delay_usec(1000);
 		}
 	} else {
@@ -120,7 +120,6 @@ PhysicsServer2DWrapMT::PhysicsServer2DWrapMT(PhysicsServer2D *p_contained, bool
 	physics_2d_server = p_contained;
 	create_thread = p_create_thread;
 	step_pending = 0;
-	step_thread_up = false;
 
 	pool_max_size = GLOBAL_GET("memory/limits/multithreaded_server/rid_pool_prealloc");
 
diff --git a/servers/physics_2d/physics_server_2d_wrap_mt.h b/servers/physics_2d/physics_server_2d_wrap_mt.h
index a6f0b1d4f1..3577f706de 100644
--- a/servers/physics_2d/physics_server_2d_wrap_mt.h
+++ b/servers/physics_2d/physics_server_2d_wrap_mt.h
@@ -34,6 +34,7 @@
 #include "core/config/project_settings.h"
 #include "core/os/thread.h"
 #include "core/templates/command_queue_mt.h"
+#include "core/templates/safe_refcount.h"
 #include "servers/physics_server_2d.h"
 
 #ifdef DEBUG_SYNC
@@ -52,9 +53,9 @@ class PhysicsServer2DWrapMT : public PhysicsServer2D {
 
 	Thread::ID server_thread;
 	Thread::ID main_thread;
-	volatile bool exit;
+	SafeFlag exit;
 	Thread thread;
-	volatile bool step_thread_up;
+	SafeFlag step_thread_up;
 	bool create_thread;
 
 	Semaphore step_sem;
diff --git a/servers/rendering/rendering_server_default.cpp b/servers/rendering/rendering_server_default.cpp
index 2e8f60d879..61d1efaf22 100644
--- a/servers/rendering/rendering_server_default.cpp
+++ b/servers/rendering/rendering_server_default.cpp
@@ -237,7 +237,7 @@ void RenderingServerDefault::init() {
 			thread.start(_thread_callback, this);
 			print_verbose("RenderingServerWrapMT: Starting render thread");
 		}
-		while (!draw_thread_up) {
+		while (!draw_thread_up.is_set()) {
 			OS::get_singleton()->delay_usec(1000);
 		}
 		print_verbose("RenderingServerWrapMT: Finished render thread");
@@ -329,17 +329,17 @@ bool RenderingServerDefault::is_low_end() const {
 }
 
 void RenderingServerDefault::_thread_exit() {
-	exit = true;
+	exit.set();
 }
 
 void RenderingServerDefault::_thread_draw(bool p_swap_buffers, double frame_step) {
-	if (!atomic_decrement(&draw_pending)) {
+	if (!draw_pending.decrement()) {
 		_draw(p_swap_buffers, frame_step);
 	}
 }
 
 void RenderingServerDefault::_thread_flush() {
-	atomic_decrement(&draw_pending);
+	draw_pending.decrement();
 }
 
 void RenderingServerDefault::_thread_callback(void *_instance) {
@@ -355,9 +355,8 @@ void RenderingServerDefault::_thread_loop() {
 
 	_init();
 
-	exit = false;
-	draw_thread_up = true;
-	while (!exit) {
+	draw_thread_up.set();
+	while (!exit.is_set()) {
 		// flush commands one by one, until exit is requested
 		command_queue.wait_and_flush_one();
 	}
@@ -371,7 +370,7 @@ void RenderingServerDefault::_thread_loop() {
 
 void RenderingServerDefault::sync() {
 	if (create_thread) {
-		atomic_increment(&draw_pending);
+		draw_pending.increment();
 		command_queue.push_and_sync(this, &RenderingServerDefault::_thread_flush);
 	} else {
 		command_queue.flush_all(); //flush all pending from other threads
@@ -380,7 +379,7 @@ void RenderingServerDefault::sync() {
 
 void RenderingServerDefault::draw(bool p_swap_buffers, double frame_step) {
 	if (create_thread) {
-		atomic_increment(&draw_pending);
+		draw_pending.increment();
 		command_queue.push(this, &RenderingServerDefault::_thread_draw, p_swap_buffers, frame_step);
 	} else {
 		_draw(p_swap_buffers, frame_step);
@@ -390,8 +389,6 @@ void RenderingServerDefault::draw(bool p_swap_buffers, double frame_step) {
 RenderingServerDefault::RenderingServerDefault(bool p_create_thread) :
 		command_queue(p_create_thread) {
 	create_thread = p_create_thread;
-	draw_pending = 0;
-	draw_thread_up = false;
 
 	if (!p_create_thread) {
 		server_thread = Thread::get_caller_id();
diff --git a/servers/rendering/rendering_server_default.h b/servers/rendering/rendering_server_default.h
index effa555ec4..73b463f6e7 100644
--- a/servers/rendering/rendering_server_default.h
+++ b/servers/rendering/rendering_server_default.h
@@ -89,12 +89,12 @@ class RenderingServerDefault : public RenderingServer {
 	void _thread_loop();
 
 	Thread::ID server_thread;
-	volatile bool exit;
+	SafeFlag exit;
 	Thread thread;
-	volatile bool draw_thread_up;
+	SafeFlag draw_thread_up;
 	bool create_thread;
 
-	uint64_t draw_pending;
+	SafeNumeric<uint64_t> draw_pending;
 	void _thread_draw(bool p_swap_buffers, double frame_step);
 	void _thread_flush();