summaryrefslogtreecommitdiff
path: root/ACE/tests/Message_Block_Test.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/tests/Message_Block_Test.cpp')
-rw-r--r--ACE/tests/Message_Block_Test.cpp347
1 files changed, 347 insertions, 0 deletions
diff --git a/ACE/tests/Message_Block_Test.cpp b/ACE/tests/Message_Block_Test.cpp
new file mode 100644
index 00000000000..3757c3c9f2c
--- /dev/null
+++ b/ACE/tests/Message_Block_Test.cpp
@@ -0,0 +1,347 @@
+// $Id$
+
+// ============================================================================
+//
+// = LIBRARY
+// tests
+//
+// = FILENAME
+// Message_Block_Test.cpp
+//
+// = DESCRIPTION
+// This test program is a torture test that illustrates how
+// <ACE_Message_Block> reference counting works in multi-threaded
+// code.
+//
+// = AUTHOR
+// Doug Schmidt <schmidt@cs.wustl.edu> and Nanbor Wang <nanbor@cs.wustl.edu>
+//
+// ============================================================================
+
+#include "test_config.h"
+#include "ace/OS_NS_stdio.h"
+#include "ace/OS_NS_string.h"
+#include "ace/Task.h"
+#include "ace/Malloc_T.h"
+#include "ace/Profile_Timer.h"
+#include "ace/Free_List.h"
+
+ACE_RCSID (tests,
+ Message_Block_Test,
+ "$Id$")
+
+// Number of memory allocation strategies used in this test.
+static const int ACE_ALLOC_STRATEGY_NO = 2;
+
+// Size of a memory block (multiple of ACE_MALLOC_ALIGN).
+static const int ACE_ALLOC_SIZE = 5;
+
+// Amount of memory block preallocated.
+static const size_t ACE_ALLOC_AMOUNT = 48;
+
+#if defined (ACE_HAS_THREADS)
+
+#include "ace/Lock_Adapter_T.h"
+#include "ace/Synch_Traits.h"
+
+// Number of iterations to run the test.
+static size_t n_iterations = ACE_MAX_ITERATIONS;
+
+static ACE_Lock_Adapter<ACE_SYNCH_MUTEX> lock_adapter_;
+// Serialize access to <ACE_Message_Block> reference count, which will
+// be decremented from multiple threads.
+
+class Worker_Task : public ACE_Task<ACE_MT_SYNCH>
+{
+public:
+ Worker_Task (void);
+ // Activate the task.
+
+ virtual int svc (void);
+ // Iterate <n_iterations> time printing off a message and "waiting"
+ // for all other threads to complete this iteration.
+
+ virtual int put (ACE_Message_Block *mb, ACE_Time_Value *tv = 0);
+ // Allows the producer to pass messages to the <Message_Block>.
+
+private:
+ virtual int close (u_long);
+ // Close hook.
+};
+
+int
+Worker_Task::close (u_long)
+{
+ ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("(%t) close of worker\n")));
+ return 0;
+}
+
+// Simply enqueue the Worker_Task into the end of the queue.
+
+int
+Worker_Task::put (ACE_Message_Block *mb, ACE_Time_Value *tv)
+{
+ return this->msg_queue ()->enqueue_prio (mb, tv);
+}
+
+// Iterate <n_iterations> printing off a message and "waiting" for all
+// other threads to complete this iteration.
+
+int
+Worker_Task::svc (void)
+{
+ // The <ACE_Task::svc_run()> method automatically adds us to the
+ // process-wide <ACE_Thread_Manager> when the thread begins.
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) starting svc() method\n")));
+
+ // Keep looping, reading a message out of the queue, until we get a
+ // message with a length == 0, which signals us to quit.
+
+ for (int count = 0; ; count++)
+ {
+ ACE_Message_Block *mb = 0;
+
+ int dequeue_results = this->msg_queue ()->dequeue_head (mb);
+
+ ACE_ASSERT (dequeue_results != -1);
+
+ size_t length = mb->length ();
+
+ // If there's a next() Task then "logically" copy the message by
+ // calling <duplicate> and send it on down the pipeline. Note
+ // that this doesn't actually make a copy of the message
+ // contents (i.e., the Data_Block portion), it just makes a copy
+ // of the header and reference counts the data.
+ if (this->next () != 0)
+ {
+ int duplicate_result = this->put_next (mb->duplicate ());
+ ACE_ASSERT (duplicate_result != -1);
+ }
+
+ // If there's no next() Task to send to, then we'll consume the
+ // message here.
+ else if (length > 0)
+ {
+ int current_count = ACE_OS::atoi (ACE_TEXT_CHAR_TO_TCHAR (mb->rd_ptr ()));
+ int i;
+
+ ACE_ASSERT (count == current_count);
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) enqueueing %d duplicates\n"),
+ current_count));
+
+ ACE_Message_Block *dup;
+
+ // Enqueue <current_count> duplicates with msg_priority == 1.
+ for (i = current_count; i > 0; i--)
+ {
+ ACE_ALLOCATOR_RETURN (dup,
+ mb->duplicate (),
+ -1);
+ // Set the priority to be greater than "normal"
+ // messages. Therefore, all of these messages should go
+ // to the "front" of the queue, i.e., ahead of all the
+ // other messages that are being enqueued by other
+ // threads.
+ dup->msg_priority (ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY + 1);
+
+ int enqueue_prio_result =
+ this->msg_queue ()->enqueue_prio
+ (dup,
+ // Don't block indefinitely if we flow control...
+ (ACE_Time_Value *) &ACE_Time_Value::zero);
+
+ ACE_ASSERT (enqueue_prio_result != -1);
+ }
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) dequeueing %d duplicates\n"),
+ current_count));
+
+ // Dequeue the same <current_count> duplicates.
+ for (i = current_count; i > 0; i--)
+ {
+ int deqresult = this->msg_queue ()->dequeue_head (dup);
+ ACE_ASSERT (deqresult != -1);
+ ACE_ASSERT (count == ACE_OS::atoi (ACE_TEXT_CHAR_TO_TCHAR (dup->rd_ptr ())));
+ ACE_ASSERT (ACE_OS::strcmp (mb->rd_ptr (), dup->rd_ptr ()) == 0);
+ ACE_ASSERT (dup->msg_priority () == ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY + 1);
+ dup->release ();
+ }
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) in iteration %d, length = %d, prio = %d, text = \"%*s\"\n"),
+ count,
+ length,
+ mb->msg_priority (),
+ length - 2, // remove the trailing "\n\0"
+ mb->rd_ptr ()));
+ }
+
+ // We're responsible for deallocating this.
+ mb->release ();
+
+ if (length == 0)
+ {
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) in iteration %d, queue len = %d, got NULL message, exiting\n"),
+ count, this->msg_queue ()->message_count ()));
+ break;
+ }
+ }
+
+ // Note that the ACE_Task::svc_run () method automatically removes
+ // us from the Thread_Manager when the thread exits.
+ return 0;
+}
+
+Worker_Task::Worker_Task (void)
+{
+ // Make us an Active Object.
+ if (this->activate (THR_NEW_LWP) == -1)
+ ACE_ERROR ((LM_ERROR,
+ ACE_TEXT ("%p\n"),
+ ACE_TEXT ("activate failed")));
+}
+
+static int
+produce (Worker_Task &worker_task,
+ ACE_Allocator *alloc_strategy)
+{
+ ACE_Message_Block *mb;
+
+ // Send <n_iteration> messages through the pipeline.
+ for (size_t count = 0; count < n_iterations; count++)
+ {
+ ACE_TCHAR buf[BUFSIZ];
+ ACE_OS::sprintf (buf, ACE_SIZE_T_FORMAT_SPECIFIER, count);
+
+ size_t n = (ACE_OS::strlen (buf) + 1) * sizeof (ACE_TCHAR);
+
+ // Allocate a new message.
+ ACE_NEW_RETURN (mb,
+ ACE_Message_Block (n, // size
+ ACE_Message_Block::MB_DATA, // type
+ 0, // cont
+ 0, // data
+ alloc_strategy, // allocator
+ &lock_adapter_, // locking strategy
+ ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY), // priority
+ -1);
+
+ // Copy buf into the Message_Block and update the wr_ptr ().
+ mb->copy ((char *) buf, n);
+
+ // Pass the message to the Worker_Task.
+ if (worker_task.put (mb,
+ // Don't block indefinitely if we flow control...
+ (ACE_Time_Value *) &ACE_Time_Value::zero) == -1)
+ ACE_ERROR ((LM_ERROR,
+ ACE_TEXT (" (%t) %p\n"),
+ ACE_TEXT ("put")));
+ }
+
+ // Send a shutdown message to the waiting threads and exit.
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("\n(%t) sending shutdown message\n")));
+
+ ACE_NEW_RETURN (mb,
+ ACE_Message_Block (0,
+ ACE_Message_Block::MB_DATA,
+ 0,
+ 0,
+ alloc_strategy,
+ &lock_adapter_),
+ -1);
+
+ if (worker_task.put (mb) == -1)
+ ACE_ERROR ((LM_ERROR,
+ ACE_TEXT (" (%t) %p\n"),
+ ACE_TEXT ("put")));
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("\n(%t) end producer\n")));
+ return 0;
+}
+
+typedef ACE_TCHAR MEMORY_CHUNK[ACE_MALLOC_ALIGN * ACE_ALLOC_SIZE];
+
+ACE_Cached_Allocator<MEMORY_CHUNK,
+ ACE_SYNCH_MUTEX>
+ mem_allocator (ACE_ALLOC_AMOUNT);
+struct alloc_struct_type
+{
+ ACE_Allocator *strategy_;
+ const ACE_TCHAR *name_;
+ ACE_Profile_Timer::ACE_Elapsed_Time et_;
+};
+
+alloc_struct_type alloc_struct[ACE_ALLOC_STRATEGY_NO] =
+{
+ { 0, ACE_TEXT ("Default"), {0,0,0} },
+ { &mem_allocator, ACE_TEXT ("Cached Memory"), {0,0,0} }
+};
+
+#endif /* ACE_HAS_THREADS */
+
+int
+run_main (int, ACE_TCHAR *[])
+{
+ ACE_START_TEST (ACE_TEXT ("Message_Block_Test"));
+#if defined (ACE_HAS_THREADS)
+ int n_threads = ACE_MAX_THREADS;
+
+ ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("(%t) threads = %d\n"), n_threads));
+
+ ACE_Profile_Timer ptime;
+
+ int i;
+
+ for (i = 0; i < ACE_ALLOC_STRATEGY_NO; i++)
+ {
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) Start Message_Block_Test using %s allocation strategy\n"),
+ alloc_struct[i].name_));
+
+ // Create the worker tasks.
+ Worker_Task worker_task[ACE_MAX_THREADS] ;
+
+ // Link all the tasks together into a simple pipeline.
+ for (size_t j = 1; j < ACE_MAX_THREADS; j++)
+ worker_task[j - 1].next (&worker_task[j]);
+
+ ptime.start ();
+ // Generate messages and pass them through the pipeline.
+ produce (worker_task[0], alloc_struct[i].strategy_);
+
+ // Wait for all the threads to reach their exit point.
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) waiting for worker tasks to finish...\n")));
+
+ ACE_Thread_Manager::instance ()->wait ();
+ ptime.stop ();
+ ptime.elapsed_time (alloc_struct[i].et_);
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) destroying worker tasks\n")));
+ }
+
+ for (i = 0; i < ACE_ALLOC_STRATEGY_NO; i++)
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("Elapsed time using %s allocation strategy: %f sec\n"),
+ alloc_struct[i].name_,
+ alloc_struct[i].et_.real_time));
+
+ ACE_DEBUG ((LM_DEBUG,
+ ACE_TEXT ("(%t) Exiting...\n")));
+#else
+ ACE_ERROR ((LM_INFO,
+ ACE_TEXT ("threads not supported on this platform\n")));
+#endif /* ACE_HAS_THREADS */
+ ACE_END_TEST;
+ return 0;
+}