Changeset 1559 for honeyclient/trunk

Timestamp:

04/25/08 11:17:11 (4 months ago)

Author:

kindlund

Message:

Housekeeping.

Files:

• honeyclient/trunk/lib/HoneyClient/Manager.pm (modified) (3 diffs)

honeyclient/trunk/lib/HoneyClient/Manager.pm

@@ -548 +548 @@
-
-            }
-
-            # TODO: Delete this, eventually.
-            print "\nBucket #" . $counter . ":\n" . Dumper($buckets->[$counter]) . "\n\n";
-            $args{'work_queue'}->enqueue(nfreeze($buckets->[$counter]));
-        }
@@ -581 +578 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-# Note: We can gracefully stop each worker, by sending an empty hashtable of work,
-# or by signalling the thread.
@@ -893 +676 @@
-}
-
+
+# Signal handler to help give user immediate feedback during
+# shutdown process.
+sub _shutdown {
+    my $LOG = get_logger();
+    $LOG->warn("Received termination signal.  Shutting down (please wait).");
+    exit;
+};
+$SIG{HUP}  = \&_shutdown;
+$SIG{INT}  = \&_shutdown;
+$SIG{QUIT} = \&_shutdown;
+$SIG{ABRT} = \&_shutdown;
+$SIG{TERM} = \&_shutdown;
+
+#######################################################################
+# Public Methods Implemented                                          #
+#######################################################################
+
+=pod
+
+=head1 EXPORTS
+
+=head2 run(driver_name => $driver_name, master_vm_config => $master_vm_config, work => $work)
+
+=over 4
+
+Runs the Manager code, using the specified arguments.
+
+I<Inputs>: 
+ B<$driver_name> is an optional argument, indicating the driver name to
+use when driving all cloned VMs.
+ B<$master_vm_config> is an optional argument, indicating the absolute
+path to the master VM configuration file that each clone VM should use.
+ B<$work> is an optional argument, indicating the work each cloned
+VM should process.
+
+=back
+
+=begin testing
+
+SKIP: {
+    skip "HoneyClient::Manager->run() can't be easily tested, yet.", 1;
+}
+
+=end testing
+
+=cut
+
+sub run {
+
+    # Extract arguments.
+    # Hash-based arguments are used, since HoneyClient::Util::SOAP is unable to handle
+    # hash references directly.  Thus, flat hashtables are used throughout the code
+    # for consistency.
+    my ($class, %args) = @_;
+
+    # Sanity check: If there's no database support and no work was
+    # specified, then stop.
+    my $localLinksExist = scalar(%{$args{'work'}});
+    if (!getVar(name      => "enable",
+                namespace => "HoneyClient::Manager::Database") && !$localLinksExist) {
+        $LOG->error("No URLs specified and database support is disabled.  Shutting down Manager.");
+        exit;
+    }
+
+    # Temporary variable to hold each cloned VM.
+    my $vm        = undef;
+
+    # Get a stub connection to the firewall.
+    my $stubFW = getClientHandle(namespace     => "HoneyClient::Manager::FW",
+                                 fault_handler => \&_handleFaultAndCleanup);
+
+    $LOG->info("Installing default firewall rules.");
+    $stubFW->installDefaultRules();
+
+    # If these parameters weren't defined, delete them
+    # from the specified arg hash.
+    if (!defined($args{'master_vm_config'})) {
+        delete $args{'master_vm_config'}; 
+    }
+    if (!defined($args{'driver_name'})) {
+        delete $args{'driver_name'}; 
+    }
+
+    # Create a new work queue.
+    $WORK_QUEUE = new Thread::Queue;
+    
+    # Create a new wait queue.
+    $WAIT_QUEUE = new Thread::Queue;
+
+    # Create the thread pool.
+    my @THREAD_POOL;
+
+    # Create the cloned VMs.
+    for (my $counter = 0; $counter < getVar(name => "num_simultaneous_clones"); $counter++) {
+        my $thread = threads->create(\&_worker, \%args);
+        if (!defined($thread)) {
+            $LOG->error("Unable to create worker thread! Shutting down.");
+            Carp::croak "Unable to create worker thread! Shutting down.";
+        }
+        # Push thread onto thread pool.
+        push(@THREAD_POOL, $thread);
+    }
+
+    # Register the host system with the database, if need be.
+    if (getVar(name      => "enable",
+               namespace => "HoneyClient::Manager::Database")) {
+
+        my $host = {
+            org => getVar(name => "organization"),
+            hostname => Sys::Hostname::Long::hostname_long,
+            ip => Sys::HostIP->ip,
+        };
+        HoneyClient::Manager::Database::insert_host($host);
+    }
+
+    # If supported, get a URL list from the database.
+    my $remoteLinksExist = 0;
+    my $queue_url_list = {};
+    my $tid = undef;
+    my $first_access_attempt = 1;
+    while (getVar(name      => "enable",
+                  namespace => "HoneyClient::Manager::Database")) {
+        $LOG->info("Waiting for new URLs from database.");
+        $queue_url_list = _get_urls(first_attempt => $first_access_attempt);
+        $first_access_attempt = 0;
+
+        $remoteLinksExist = scalar(%{$queue_url_list});
+        while (!$localLinksExist && !$remoteLinksExist) {
+
+            # Sleep for a bit, before trying again to contact the database.
+            sleep(getVar(name => "database_retry_delay"));
+            # XXX: Trap/ignore all errors and simply retry.
+            eval {
+                $queue_url_list = _get_urls(first_attempt => 0);
+                $remoteLinksExist = scalar(%{$queue_url_list});
+            };
+        }
+        # If we do have URLs from the database, then merge them into the agent state.
+        # Note: Priorities specified in the database take precedent over any URLs specified locally.
+        if ($remoteLinksExist) {
+            $args{'work'} = { %{$args{'work'}}, %{$queue_url_list} };
+        }
+        
+        # Drive the VMs, using the work found.
+        $LOG->info("Received new work and updating queue.");
+        _divide_work(work_queue              => $WORK_QUEUE,
+                     wait_queue              => $WAIT_QUEUE,
+                     work                    => $args{'work'},
+                     num_simultaneous_clones => getVar(name => "num_simultaneous_clones"));
+
+        # Wait until the VMs need more work.
+        while (!$WAIT_QUEUE->pending) {
+            # Poll the wait queue every 2 seconds.
+            # This time delay should be short.
+            threads->yield();
+            sleep(2);
+
+            # Make sure all worker threads are still alive.
+            for (my $counter = 0; $counter < getVar(name => "num_simultaneous_clones"); $counter++) {
+                my $thread = $THREAD_POOL[$counter];
+                if (!$thread->is_running()) {
+                    $LOG->error("Thread ID (" . $thread->tid() . "): Unexpectedly terminated.");
+                    Carp::croak "Thread ID (" . $thread->tid() . "): Unexpectedly terminated.";
+                }
+            }
+        }
+        $LOG->info("Got a signal that a thread needs more work.");
+
+        # Once finished, empty the work queue.
+        $args{'work'} = {};
+        # If we had any local links, they definately will have been processed by now.
+        $localLinksExist = 0;
+
+        # Loop forever, since we have a database connection.
+    }
+
+    # If we don't have a database connection, then just handle the work
+    # that was provided from the command line and then shut down.
+    if (scalar(%{$args{'work'}})) {
+
+        # Drive the VMs, using the work found.
+        $LOG->info("Received new work and updating queue.");
+        _divide_work(work_queue              => $WORK_QUEUE,
+                     wait_queue              => $WAIT_QUEUE,
+                     work                    => $args{'work'},
+                     num_simultaneous_clones => getVar(name => "num_simultaneous_clones"));
+
+        # Wait until all VMs are finished.
+        # We wait for each worker to signal that they are waiting for more work, before shutting down
+        # the application.
+        for (my $i = 0; $i < getVar(name => "num_simultaneous_clones"); $i++) {
+            my $tid = undef;
+            # This is a little hackish, since calling Thread::Queue->dequeue
+            # doesn't properly handle signals.
+            while (!defined($tid = $WAIT_QUEUE->dequeue_nb)) {
+                # Poll the wait queue every 2 seconds.
+                # This time delay should be short.
+                threads->yield();
+                sleep(2);
+
+                # Make sure all worker threads are still alive.
+                for (my $counter = 0; $counter < getVar(name => "num_simultaneous_clones"); $counter++) {
+                    my $thread = $THREAD_POOL[$counter];
+                    if (!$thread->is_running()) {
+                        $LOG->error("Thread ID (" . $thread->tid() . "): Unexpectedly terminated.");
+                        Carp::croak "Thread ID (" . $thread->tid() . "): Unexpectedly terminated.";
+                    }
+                }
+            }
+        }
+        # Once finished, empty the work queue.
+        $args{'work'} = {};
+    }
+    $LOG->info("All URLs exhausted. Shutting down Manager.");
+}
+
-#######################################################################
-