schedule: make print() const
[model-checker.git] / schedule.cc
index 40f9894ebb9a7be5a8ecc918fe56038471c64020..69e3d88803bcc06d15ee2fed115330b1397662f5 100644 (file)
@@ -3,12 +3,26 @@
 #include "common.h"
 #include "model.h"
 
+/** Constructor */
+Scheduler::Scheduler() :
+       current(NULL)
+{
+}
+
+/**
+ * Add a Thread to the scheduler's ready list.
+ * @param t The Thread to add
+ */
 void Scheduler::add_thread(Thread *t)
 {
        DEBUG("thread %d\n", t->get_id());
        readyList.push_back(t);
 }
 
+/**
+ * Remove a given Thread from the scheduler.
+ * @param t The Thread to remove
+ */
 void Scheduler::remove_thread(Thread *t)
 {
        if (current == t)
@@ -17,7 +31,11 @@ void Scheduler::remove_thread(Thread *t)
                readyList.remove(t);
 }
 
-Thread * Scheduler::next_thread(void)
+/**
+ * Remove one Thread from the scheduler. This implementation performs FIFO.
+ * @return The next Thread to run
+ */
+Thread * Scheduler::next_thread()
 {
        Thread *t = model->schedule_next_thread();
 
@@ -37,12 +55,19 @@ Thread * Scheduler::next_thread(void)
        return t;
 }
 
-Thread * Scheduler::get_current_thread(void)
+/**
+ * @return The currently-running Thread
+ */
+Thread * Scheduler::get_current_thread() const
 {
        return current;
 }
 
-void Scheduler::print()
+/**
+ * Print debugging information about the current state of the scheduler. Only
+ * prints something if debugging is enabled.
+ */
+void Scheduler::print() const
 {
        if (current)
                DEBUG("Current thread: %d\n", current->get_id());
@@ -50,7 +75,7 @@ void Scheduler::print()
                DEBUG("No current thread\n");
        DEBUG("Num. threads in ready list: %zu\n", readyList.size());
 
-       std::list<Thread *, MyAlloc< Thread * > >::iterator it;
+       std::list<Thread *, MyAlloc< Thread * > >::const_iterator it;
        for (it = readyList.begin(); it != readyList.end(); it++)
                DEBUG("In ready list: thread %d\n", (*it)->get_id());
 }