Rename "Low priority" queue to "Normal priority"

Mostly for connotation reasons to the user. Tasks in the second queue are going to be run. High priority tasks will just be run first.
RichieSams · Jul 1, 2021 · 8ea3477 · 8ea3477
1 parent 657357b
commit 8ea3477
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 20 deletions.
diff --git a/README.asciidoc b/README.asciidoc
@@ -95,7 +95,7 @@ int main() {
 
 	// Schedule the tasks
 	ftl::TaskCounter counter(&taskScheduler);
-	taskScheduler.AddTasks(numTasks, tasks, ftl::TaskPriority::High, &counter);
+	taskScheduler.AddTasks(numTasks, tasks, ftl::TaskPriority::Normal, &counter);
 
 	// FTL creates its own copies of the tasks, so we can safely delete the memory
 	delete[] tasks;

diff --git a/benchmarks/empty/empty.cpp b/benchmarks/empty/empty.cpp
@@ -47,7 +47,7 @@ NONIUS_BENCHMARK("Empty", [](nonius::chronometer meter) {
 	meter.measure([&taskScheduler, tasks] {
 		for (unsigned i = 0; i < kNumIterations; ++i) {
 			ftl::TaskCounter counter(&taskScheduler);
-			taskScheduler.AddTasks(kNumTasks, tasks, ftl::TaskPriority::Low);
+			taskScheduler.AddTasks(kNumTasks, tasks, ftl::TaskPriority::Normal);
 
 			taskScheduler.WaitForCounter(&counter, 0);
 		}

diff --git a/benchmarks/producer_consumer/producer_consumer.cpp b/benchmarks/producer_consumer/producer_consumer.cpp
@@ -43,7 +43,7 @@ void Producer(ftl::TaskScheduler *taskScheduler, void *arg) {
 	}
 
 	ftl::TaskCounter counter(taskScheduler);
-	taskScheduler->AddTasks(kNumConsumerTasks, tasks, ftl::TaskPriority::Low, &counter);
+	taskScheduler->AddTasks(kNumConsumerTasks, tasks, ftl::TaskPriority::Normal, &counter);
 	delete[] tasks;
 
 	taskScheduler->WaitForCounter(&counter);
@@ -63,7 +63,7 @@ NONIUS_BENCHMARK("ProducerConsumer", [](nonius::chronometer meter) {
 	meter.measure([&taskScheduler, tasks] {
 		for (unsigned i = 0; i < kNumIterations; ++i) {
 			ftl::TaskCounter counter(&taskScheduler);
-			taskScheduler.AddTasks(kNumProducerTasks, tasks, ftl::TaskPriority::Low);
+			taskScheduler.AddTasks(kNumProducerTasks, tasks, ftl::TaskPriority::Normal);
 
 			taskScheduler.WaitForCounter(&counter);
 		}

diff --git a/examples/triangle_num.cpp b/examples/triangle_num.cpp
@@ -75,7 +75,7 @@ int main() {
 
 	// Schedule the tasks
 	ftl::TaskCounter counter(&taskScheduler);
-	taskScheduler.AddTasks(numTasks, tasks, ftl::TaskPriority::High, &counter);
+	taskScheduler.AddTasks(numTasks, tasks, ftl::TaskPriority::Normal, &counter);
 
 	// FTL creates its own copies of the tasks, so we can safely delete the memory
 	delete[] tasks;

diff --git a/include/ftl/task.h b/include/ftl/task.h
@@ -37,7 +37,7 @@ struct Task {
 
 enum class TaskPriority {
 	High,
-	Low,
+	Normal,
 };
 
 } // End of namespace ftl
diff --git a/source/task_scheduler.cpp b/source/task_scheduler.cpp
@@ -430,7 +430,7 @@ void TaskScheduler::AddTask(Task const task, TaskPriority priority, TaskCounter
 	const TaskBundle bundle = {task, counter};
 	if (priority == TaskPriority::High) {
 		m_tls[GetCurrentThreadIndex()].HiPriTaskQueue.Push(bundle);
-	} else if (priority == TaskPriority::Low) {
+	} else if (priority == TaskPriority::Normal) {
 		m_tls[GetCurrentThreadIndex()].LoPriTaskQueue.Push(bundle);
 	}
 
@@ -449,7 +449,7 @@ void TaskScheduler::AddTasks(unsigned const numTasks, Task const *const tasks, T
 	WaitFreeQueue<TaskBundle> *queue = nullptr;
 	if (priority == TaskPriority::High) {
 		queue = &m_tls[GetCurrentThreadIndex()].HiPriTaskQueue;
-	} else if (priority == TaskPriority::Low) {
+	} else if (priority == TaskPriority::Normal) {
 		queue = &m_tls[GetCurrentThreadIndex()].LoPriTaskQueue;
 	} else {
 		FTL_ASSERT("Unknown task priority", false);

diff --git a/tests/functional/calc_triangle_num.cpp b/tests/functional/calc_triangle_num.cpp
@@ -91,7 +91,7 @@ TEST_CASE("Triangle Number", "[functional]") {
 
 	// Schedule the tasks and wait for them to complete
 	ftl::TaskCounter counter(&taskScheduler);
-	taskScheduler.AddTasks(static_cast<unsigned>(numTasks), tasks, ftl::TaskPriority::Low, &counter);
+	taskScheduler.AddTasks(static_cast<unsigned>(numTasks), tasks, ftl::TaskPriority::Normal, &counter);
 	delete[] tasks;
 
 	taskScheduler.WaitForCounter(&counter);

diff --git a/tests/functional/producer_consumer.cpp b/tests/functional/producer_consumer.cpp
@@ -45,7 +45,7 @@ void Producer(ftl::TaskScheduler *taskScheduler, void *arg) {
 	}
 
 	ftl::TaskCounter counter(taskScheduler);
-	taskScheduler->AddTasks(kNumConsumerTasks, tasks, ftl::TaskPriority::Low, &counter);
+	taskScheduler->AddTasks(kNumConsumerTasks, tasks, ftl::TaskPriority::Normal, &counter);
 	delete[] tasks;
 
 	taskScheduler->WaitForCounter(&counter);
@@ -67,7 +67,7 @@ TEST_CASE("Producer Consumer", "[functional]") {
 	}
 
 	ftl::TaskCounter counter(&taskScheduler);
-	taskScheduler.AddTasks(kNumProducerTasks, tasks.data(), ftl::TaskPriority::Low, &counter);
+	taskScheduler.AddTasks(kNumProducerTasks, tasks.data(), ftl::TaskPriority::Normal, &counter);
 	taskScheduler.WaitForCounter(&counter);
 
 	// Test to see that all tasks finished

diff --git a/tests/utilities/event_callbacks.cpp b/tests/utilities/event_callbacks.cpp
@@ -120,7 +120,7 @@ TEST_CASE("Fiber Event Callbacks", "[utility]") {
 		};
 
 		ftl::TaskCounter waitCounter(&taskScheduler);
-		taskScheduler.AddTask(testTask, ftl::TaskPriority::Low, &waitCounter);
+		taskScheduler.AddTask(testTask, ftl::TaskPriority::Normal, &waitCounter);
 
 		taskScheduler.WaitForCounter(&waitCounter);
 

diff --git a/tests/utilities/fibtex.cpp b/tests/utilities/fibtex.cpp
@@ -73,12 +73,12 @@ TEST_CASE("Fibtex Locking Tests", "[utility]") {
 
 	constexpr size_t iterations = 20000;
 	for (size_t i = 0; i < iterations; ++i) {
-		taskScheduler.AddTask(ftl::Task{LockGuardTest, &md}, ftl::TaskPriority::Low, &c);
-		taskScheduler.AddTask(ftl::Task{LockGuardTest, &md}, ftl::TaskPriority::Low, &c);
-		taskScheduler.AddTask(ftl::Task{SpinLockGuardTest, &md}, ftl::TaskPriority::Low, &c);
-		taskScheduler.AddTask(ftl::Task{SpinLockGuardTest, &md}, ftl::TaskPriority::Low, &c);
-		taskScheduler.AddTask(ftl::Task{InfiniteSpinLockGuardTest, &md}, ftl::TaskPriority::Low, &c);
-		taskScheduler.AddTask(ftl::Task{InfiniteSpinLockGuardTest, &md}, ftl::TaskPriority::Low, &c);
+		taskScheduler.AddTask(ftl::Task{LockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
+		taskScheduler.AddTask(ftl::Task{LockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
+		taskScheduler.AddTask(ftl::Task{SpinLockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
+		taskScheduler.AddTask(ftl::Task{SpinLockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
+		taskScheduler.AddTask(ftl::Task{InfiniteSpinLockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
+		taskScheduler.AddTask(ftl::Task{InfiniteSpinLockGuardTest, &md}, ftl::TaskPriority::Normal, &c);
 
 		taskScheduler.WaitForCounter(&c);
 	}

diff --git a/tests/utilities/thread_local.cpp b/tests/utilities/thread_local.cpp
@@ -62,7 +62,7 @@ TEST_CASE("Thread Local", "[utility]") {
 	std::vector<ftl::Task> singleInitTask(taskScheduler.GetThreadCount(), ftl::Task{SimpleInit, &simpleCounter});
 
 	ftl::TaskCounter ac(&taskScheduler);
-	taskScheduler.AddTasks(static_cast<unsigned>(singleInitTask.size()), singleInitTask.data(), ftl::TaskPriority::Low, &ac);
+	taskScheduler.AddTasks(static_cast<unsigned>(singleInitTask.size()), singleInitTask.data(), ftl::TaskPriority::Normal, &ac);
 	taskScheduler.WaitForCounter(&ac);
 
 	auto singleInitVals = simpleCounter.GetAllValues();
@@ -73,7 +73,7 @@ TEST_CASE("Thread Local", "[utility]") {
 
 	std::vector<ftl::Task> sideEffectTask(10000, ftl::Task{SideEffect, &sideEffectCounter});
 
-	taskScheduler.AddTasks(static_cast<unsigned>(sideEffectTask.size()), sideEffectTask.data(), ftl::TaskPriority::Low, &ac);
+	taskScheduler.AddTasks(static_cast<unsigned>(sideEffectTask.size()), sideEffectTask.data(), ftl::TaskPriority::Normal, &ac);
 	taskScheduler.WaitForCounter(&ac);
 
 	auto sideEffect = sideEffectCounter.GetAllValues();