Change Conveyor,Planner,Block to use HeapRing
[clinton/Smoothieware.git] / src / modules / robot / Conveyor.cpp
index c10c682..0244906 100644 (file)
@@ -18,69 +18,53 @@ using namespace std;
 #include "Conveyor.h"
 #include "Planner.h"
 
+// The conveyor holds the queue of blocks, takes care of creating them, and starting the executing chain of blocks
+
 Conveyor::Conveyor(){
     this->current_block = NULL;
     this->looking_for_new_block = false;
-    flush_blocks = 0;
+    queue.resize(32);
+    gc_pending = queue.tail_i;
 }
 
-void Conveyor::on_module_loaded()
-{
+void Conveyor::on_module_loaded(){
     register_for_event(ON_IDLE);
 }
 
-void Conveyor::on_idle(void* argument)
-{
-    if (flush_blocks)
+// Delete blocks here, because they can't be deleted in interrupt context ( see Block.cpp:release )
+void Conveyor::on_idle(void* argument){
+    while (queue.tail_i != gc_pending)
     {
-        Block* block = queue.get_ref(0);
-//         printf("Block: clean %p\n", block);
-        while (block->gcodes.size())
-        {
-            Gcode* g = block->gcodes.back();
-            block->gcodes.pop_back();
-            delete g;
-        }
-        queue.delete_first();
-
-        __disable_irq();
-        flush_blocks--;
-        __enable_irq();
+        // Cleanly delete block
+        Block* block = queue.tail_ref();
+        block->gcodes.clear();
+        queue.consume_tail();
     }
 }
 
+void Conveyor::append_gcode(Gcode* gcode)
+{
+    gcode->mark_as_taken();
+    if (queue.is_empty())
+        THEKERNEL->call_event(ON_GCODE_EXECUTE, gcode);
+    else
+        queue.head_ref()->append_gcode(gcode);
+}
+
 // Append a block to the list
 Block* Conveyor::new_block(){
 
-    // Clean up the vector of commands in the block we are about to replace
-    // It is quite strange to do this here, we really should do it inside Block->pop_and_execute_gcode
-    // but that function is called inside an interrupt and thus can break everything if the interrupt was trigerred during a memory access
-
     // Take the next untaken block on the queue ( the one after the last one )
-    Block* block = this->queue.get_ref( this->queue.size() );
-//     printf("cleanup %p\n", block);
+    Block* block = this->queue.head_ref();
     // Then clean it up
-    if( block->conveyor == this ){
-        for(; block->gcodes.size(); ){
-            Gcode* g = block->gcodes.back();
-//             printf("Block:pop %p (%d refs)\n", g, g->queued);
-            block->gcodes.pop_back();
-            if (--g->queued == 0)
-                delete g;
-        }
-    }
+    block->clear();
 
-    // Create a new virgin Block in the queue
-    this->queue.push_back(Block());
-    block = this->queue.get_ref( this->queue.size()-1 );
-    while( block == NULL ){
-        block = this->queue.get_ref( this->queue.size()-1 );
-    }
-    block->is_ready = false;
     block->initial_rate = -2;
     block->final_rate = -2;
-    block->conveyor = this;
-    
+
+    // Create a new virgin Block in the queue
+    queue.produce_head();
+
     return block;
 }
 
@@ -99,7 +83,7 @@ void Conveyor::pop_and_process_new_block(int debug){
     if( this->current_block != NULL ){ this->looking_for_new_block = false; return; }
 
     // Return if queue is empty
-    if( this->queue.size() == 0 ){
+    if( queue.is_empty() ){
         this->current_block = NULL;
         // TODO : ON_QUEUE_EMPTY event
         this->looking_for_new_block = false;
@@ -107,16 +91,16 @@ void Conveyor::pop_and_process_new_block(int debug){
     }
 
     // Get a new block
-    this->current_block = this->queue.get_ref(0);
+    this->current_block = this->queue.tail_ref();
 
     // Tell all modules about it
-    this->kernel->call_event(ON_BLOCK_BEGIN, this->current_block);
+    THEKERNEL->call_event(ON_BLOCK_BEGIN, this->current_block);
 
-    // In case the module was not taken
+       // In case the module was not taken
     if( this->current_block->times_taken < 1 ){
-        Block* temp = this->current_block; 
-        this->current_block = NULL; // It seems this was missing and adding it fixes things, if something breaks, this may be a suspect 
-        temp->take(); 
+        Block* temp = this->current_block;
+        this->current_block = NULL; // It seems this was missing and adding it fixes things, if something breaks, this may be a suspect
+        temp->take();
         temp->release();
     }
 
@@ -124,9 +108,27 @@ void Conveyor::pop_and_process_new_block(int debug){
 
 }
 
+// Wait for the queue to have a given number of free blocks
 void Conveyor::wait_for_queue(int free_blocks)
 {
-    while( this->queue.size() >= this->queue.capacity()-free_blocks ){
-        this->kernel->call_event(ON_IDLE);
-    }
+    while (queue.is_full())
+        THEKERNEL->call_event(ON_IDLE);
+}
+
+// Wait for the queue to be empty
+void Conveyor::wait_for_empty_queue()
+{
+    while (!queue.is_empty())
+        THEKERNEL->call_event(ON_IDLE);
 }
+
+// Return true if the queue is empty
+bool Conveyor::is_queue_empty()
+{
+    return queue.is_empty();
+}
+
+
+// feels hacky, but apparently the way to do it
+#include "HeapRing.cpp"
+template class HeapRing<Block>;