Rename comm/ directories to broker/

doc/frameworks/broker.rst

@@ -1,5 +1,5 @@
 
-.. _comm-framework:
+.. _brokercomm-framework:
 
 ======================================
 Broker-Enabled Communication Framework
@@ -27,7 +27,7 @@ and then monitor connection status updates via
 :bro:see:`BrokerComm::incoming_connection_established` and
 :bro:see:`BrokerComm::incoming_connection_broken`.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/connecting-listener.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/connecting-listener.bro
 
 Bro can initiate outgoing connections by calling :bro:see:`BrokerComm::connect`
 and then monitor connection status updates via
@@ -35,7 +35,7 @@ and then monitor connection status updates via
 :bro:see:`BrokerComm::outgoing_connection_broken`, and
 :bro:see:`BrokerComm::outgoing_connection_incompatible`.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/connecting-connector.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/connecting-connector.bro
 
 Remote Printing
 ===============
@@ -46,11 +46,11 @@ prefix of interest and then create an event handler for
 :bro:see:`BrokerComm::print_handler` to handle any print messages that are
 received.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/printing-listener.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/printing-listener.bro
 
 To send remote print messages, just call :bro:see:`BrokerComm::print`.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/printing-connector.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/printing-connector.bro
 
 Notice that the subscriber only used the prefix "bro/print/", but is
 able to receive messages with full topics of "bro/print/hi",
@@ -75,7 +75,7 @@ Receiving remote events is similar to remote prints.  Just use
 :bro:see:`BrokerComm::subscribe_to_events` and possibly define any new events
 along with handlers that peers may want to send.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/events-listener.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/events-listener.bro
 
 To send events, there are two choices.  The first is to use call
 :bro:see:`BrokerComm::event` directly.  The second option is to use
@@ -83,7 +83,7 @@ To send events, there are two choices.  The first is to use call
 automatically sent to peers whenever it is called locally via the normal
 event invocation syntax.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/events-connector.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/events-connector.bro
 
 Again, the subscription model is prefix-based.
 
@@ -105,20 +105,20 @@ parameter of the message.
 Remote Logging
 ==============
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/testlog.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/testlog.bro
 
 Use :bro:see:`BrokerComm::subscribe_to_logs` to advertise interest in logs
 written by peers.  The topic names that Bro uses are implicitly of the
 form "bro/log/<stream-name>".
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/logs-listener.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/logs-listener.bro
 
 To send remote logs either use :bro:see:`Log::enable_remote_logging` or
 :bro:see:`BrokerComm::enable_remote_logs`.  The former allows any log stream
 to be sent to peers while the later toggles remote logging for
 particular streams.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/logs-connector.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/logs-connector.bro
 
 Message Format
 --------------
@@ -189,9 +189,9 @@ Data stores also support expiration on a per-key basis either using an
 absolute point in time or a relative amount of time since the entry's
 last modification time.
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/stores-listener.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/stores-listener.bro
 
-.. btest-include:: ${DOC_ROOT}/frameworks/comm/stores-connector.bro
+.. btest-include:: ${DOC_ROOT}/frameworks/broker/stores-connector.bro
 
 In the above example, if a local copy of the store contents isn't
 needed, just replace the :bro:see:`BrokerStore::create_clone` call with

doc/frameworks/index.rst

@@ -14,4 +14,4 @@ Frameworks
    notice
    signatures
    sumstats
-   comm
+   broker

scripts/base/init-bare.bro

@@ -3360,7 +3360,7 @@ const bits_per_uid: count = 96 &redef;
 
 # Load these frameworks here because they use fairly deep integration with
 # BiFs and script-land defined types.
-@load base/frameworks/comm
+@load base/frameworks/broker
 @load base/frameworks/logging
 @load base/frameworks/input
 @load base/frameworks/analyzer

src/CMakeLists.txt

@@ -162,11 +162,11 @@ add_subdirectory(logging)
 add_subdirectory(probabilistic)
 
 if ( ENABLE_BROKER )
-    add_subdirectory(comm)
+    add_subdirectory(broker)
 else ()
     # Just to satisfy coverage unit tests until new Broker-based
     # communication is enabled by default.
-    add_subdirectory(comm-dummy)
+    add_subdirectory(broker-dummy)
 endif ()
 
 set(bro_SUBDIRS

src/EventHandler.cc

@@ -6,8 +6,8 @@
 #include "NetVar.h"
 
 #ifdef ENABLE_BROKER
-#include "comm/Manager.h"
+#include "broker/Manager.h"
-#include "comm/Data.h"
+#include "broker/Data.h"
 #endif
 
 EventHandler::EventHandler(const char* arg_name)

src/Net.cc

@@ -35,7 +35,7 @@
 #include "plugin/Manager.h"
 
 #ifdef ENABLE_BROKER
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 #endif
 
 extern "C" {

src/Stats.cc

@@ -11,7 +11,7 @@
 #include "threading/Manager.h"
 
 #ifdef ENABLE_BROKER
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 #endif
 
 int killed_by_inactivity = 0;

src/broker-dummy/CMakeLists.txt

@@ -9,5 +9,5 @@ bif_target(data.bif)
 bif_target(messaging.bif)
 bif_target(store.bif)
 
-bro_add_subdir_library(comm_dummy ${BIF_OUTPUT_CC})
+bro_add_subdir_library(broker_dummy ${BIF_OUTPUT_CC})
-add_dependencies(bro_comm_dummy generate_outputs)
+add_dependencies(bro_broker_dummy generate_outputs)

src/broker/CMakeLists.txt

@@ -24,5 +24,5 @@ bif_target(data.bif)
 bif_target(messaging.bif)
 bif_target(store.bif)
 
-bro_add_subdir_library(comm ${comm_SRCS} ${BIF_OUTPUT_CC})
+bro_add_subdir_library(brokercomm ${comm_SRCS} ${BIF_OUTPUT_CC})
-add_dependencies(bro_comm generate_outputs)
+add_dependencies(bro_brokercomm generate_outputs)

src/broker/Data.cc

@@ -1,5 +1,5 @@
 #include "Data.h"
-#include "comm/data.bif.h"
+#include "broker/data.bif.h"
 #include <caf/binary_serializer.hpp>
 #include <caf/binary_deserializer.hpp>
 

src/broker/Manager.cc

@@ -8,10 +8,10 @@
 #include "util.h"
 #include "Var.h"
 #include "Reporter.h"
-#include "comm/comm.bif.h"
+#include "broker/comm.bif.h"
-#include "comm/data.bif.h"
+#include "broker/data.bif.h"
-#include "comm/messaging.bif.h"
+#include "broker/messaging.bif.h"
-#include "comm/store.bif.h"
+#include "broker/store.bif.h"
 #include "logging/Manager.h"
 #include "DebugLogger.h"
 #include "iosource/Manager.h"

src/broker/Manager.h

@@ -7,7 +7,7 @@
 #include <string>
 #include <map>
 #include <unordered_set>
-#include "comm/Store.h"
+#include "broker/Store.h"
 #include "Reporter.h"
 #include "iosource/IOSource.h"
 #include "Val.h"

src/broker/Store.cc

@@ -1,5 +1,5 @@
 #include "Store.h"
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 
 #include <broker/store/master.hh>
 #include <broker/store/clone.hh>

src/broker/Store.h

@@ -1,8 +1,8 @@
 #ifndef BRO_COMM_STORE_H
 #define BRO_COMM_STORE_H
 
-#include "comm/store.bif.h"
+#include "broker/store.bif.h"
-#include "comm/data.bif.h"
+#include "broker/data.bif.h"
 #include "Reporter.h"
 #include "Type.h"
 #include "Val.h"

src/broker/comm.bif

@@ -2,7 +2,7 @@
 ##! General functions regarding Bro's broker communication mechanisms.
 
 %%{
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 %%}
 
 module BrokerComm;

src/broker/data.bif

@@ -2,7 +2,7 @@
 ##! Functions for inspecting and manipulating broker data.
 
 %%{
-#include "comm/Data.h"
+#include "broker/Data.h"
 %%}
 
 module BrokerComm;

src/broker/messaging.bif

@@ -2,7 +2,7 @@
 ##! Functions for peering and various messaging patterns (e.g. print/log/event).
 
 %%{
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 #include "logging/Manager.h"
 %%}
 

src/broker/store.bif

@@ -2,9 +2,9 @@
 ##! Functions to interface with broker's distributed data store.
 
 %%{
-#include "comm/Manager.h"
+#include "broker/Manager.h"
-#include "comm/Store.h"
+#include "broker/Store.h"
-#include "comm/Data.h"
+#include "broker/Data.h"
 #include "Trigger.h"
 %%}
 

src/logging/Manager.cc

@@ -17,7 +17,7 @@
 #include "logging.bif.h"
 
 #ifdef ENABLE_BROKER
-#include "comm/Manager.h"
+#include "broker/Manager.h"
 #endif
 
 using namespace logging;

src/main.cc

@@ -64,7 +64,7 @@ extern "C" void OPENSSL_add_all_algorithms_conf(void);
 #include "3rdparty/sqlite3.h"
 
 #ifdef ENABLE_BROKER
-#include <comm/Manager.h>
+#include "broker/Manager.h"
 #endif
 
 Brofiler brofiler;

testing/btest/Baseline/coverage.bare-load-baseline/canonified_loaded_scripts.log

@@ -14,8 +14,8 @@ scripts/base/init-bare.bro
   build/scripts/base/bif/reporter.bif.bro
   build/scripts/base/bif/plugins/Bro_SNMP.types.bif.bro
   build/scripts/base/bif/event.bif.bro
-  scripts/base/frameworks/comm/__load__.bro
+  scripts/base/frameworks/broker/__load__.bro
-    scripts/base/frameworks/comm/main.bro
+    scripts/base/frameworks/broker/main.bro
   scripts/base/frameworks/logging/__load__.bro
     scripts/base/frameworks/logging/main.bro
       build/scripts/base/bif/logging.bif.bro

testing/btest/Baseline/coverage.default-load-baseline/canonified_loaded_scripts.log

@@ -14,8 +14,8 @@ scripts/base/init-bare.bro
   build/scripts/base/bif/reporter.bif.bro
   build/scripts/base/bif/plugins/Bro_SNMP.types.bif.bro
   build/scripts/base/bif/event.bif.bro
-  scripts/base/frameworks/comm/__load__.bro
+  scripts/base/frameworks/broker/__load__.bro
-    scripts/base/frameworks/comm/main.bro
+    scripts/base/frameworks/broker/main.bro
   scripts/base/frameworks/logging/__load__.bro
     scripts/base/frameworks/logging/main.bro
       build/scripts/base/bif/logging.bif.bro

testing/btest/Baseline/plugins.hooks/output

@@ -192,7 +192,7 @@
 0.000000   MetaHookPost  CallFunction(Log::__create_stream, <frame>, (Weird::LOG, [columns=<no value description>, ev=Weird::log_weird])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::__create_stream, <frame>, (X509::LOG, [columns=<no value description>, ev=X509::log_x509])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::__create_stream, <frame>, (mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql])) -> <no result>
-0.000000   MetaHookPost  CallFunction(Log::__write, <frame>, (PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
+0.000000   MetaHookPost  CallFunction(Log::__write, <frame>, (PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::add_default_filter, <frame>, (Cluster::LOG)) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::add_default_filter, <frame>, (Communication::LOG)) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::add_default_filter, <frame>, (Conn::LOG)) -> <no result>
@@ -286,8 +286,8 @@
 0.000000   MetaHookPost  CallFunction(Log::create_stream, <frame>, (Weird::LOG, [columns=<no value description>, ev=Weird::log_weird])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::create_stream, <frame>, (X509::LOG, [columns=<no value description>, ev=X509::log_x509])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Log::create_stream, <frame>, (mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql])) -> <no result>
-0.000000   MetaHookPost  CallFunction(Log::default_path_func, <null>, (PacketFilter::LOG, , [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
+0.000000   MetaHookPost  CallFunction(Log::default_path_func, <null>, (PacketFilter::LOG, , [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
-0.000000   MetaHookPost  CallFunction(Log::write, <frame>, (PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
+0.000000   MetaHookPost  CallFunction(Log::write, <frame>, (PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])) -> <no result>
 0.000000   MetaHookPost  CallFunction(Notice::want_pp, <frame>, ()) -> <no result>
 0.000000   MetaHookPost  CallFunction(PacketFilter::build, <frame>, ()) -> <no result>
 0.000000   MetaHookPost  CallFunction(PacketFilter::combine_filters, <frame>, (ip or not ip, and, )) -> <no result>
@@ -478,8 +478,8 @@
 0.000000   MetaHookPost  LoadFile(base<...>/analyzer) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/analyzer.bif) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/bro.bif) -> -1
+0.000000   MetaHookPost  LoadFile(base<...>/broker) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/cluster) -> -1
-0.000000   MetaHookPost  LoadFile(base<...>/comm) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/communication) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/conn) -> -1
 0.000000   MetaHookPost  LoadFile(base<...>/conn-ids) -> -1
@@ -737,7 +737,7 @@
 0.000000   MetaHookPre   CallFunction(Log::__create_stream, <frame>, (Weird::LOG, [columns=<no value description>, ev=Weird::log_weird]))
 0.000000   MetaHookPre   CallFunction(Log::__create_stream, <frame>, (X509::LOG, [columns=<no value description>, ev=X509::log_x509]))
 0.000000   MetaHookPre   CallFunction(Log::__create_stream, <frame>, (mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql]))
-0.000000   MetaHookPre   CallFunction(Log::__write, <frame>, (PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T]))
+0.000000   MetaHookPre   CallFunction(Log::__write, <frame>, (PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T]))
 0.000000   MetaHookPre   CallFunction(Log::add_default_filter, <frame>, (Cluster::LOG))
 0.000000   MetaHookPre   CallFunction(Log::add_default_filter, <frame>, (Communication::LOG))
 0.000000   MetaHookPre   CallFunction(Log::add_default_filter, <frame>, (Conn::LOG))
@@ -831,8 +831,8 @@
 0.000000   MetaHookPre   CallFunction(Log::create_stream, <frame>, (Weird::LOG, [columns=<no value description>, ev=Weird::log_weird]))
 0.000000   MetaHookPre   CallFunction(Log::create_stream, <frame>, (X509::LOG, [columns=<no value description>, ev=X509::log_x509]))
 0.000000   MetaHookPre   CallFunction(Log::create_stream, <frame>, (mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql]))
-0.000000   MetaHookPre   CallFunction(Log::default_path_func, <null>, (PacketFilter::LOG, , [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T]))
+0.000000   MetaHookPre   CallFunction(Log::default_path_func, <null>, (PacketFilter::LOG, , [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T]))
-0.000000   MetaHookPre   CallFunction(Log::write, <frame>, (PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T]))
+0.000000   MetaHookPre   CallFunction(Log::write, <frame>, (PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T]))
 0.000000   MetaHookPre   CallFunction(Notice::want_pp, <frame>, ())
 0.000000   MetaHookPre   CallFunction(PacketFilter::build, <frame>, ())
 0.000000   MetaHookPre   CallFunction(PacketFilter::combine_filters, <frame>, (ip or not ip, and, ))
@@ -1023,8 +1023,8 @@
 0.000000   MetaHookPre   LoadFile(base<...>/analyzer)
 0.000000   MetaHookPre   LoadFile(base<...>/analyzer.bif)
 0.000000   MetaHookPre   LoadFile(base<...>/bro.bif)
+0.000000   MetaHookPre   LoadFile(base<...>/broker)
 0.000000   MetaHookPre   LoadFile(base<...>/cluster)
-0.000000   MetaHookPre   LoadFile(base<...>/comm)
 0.000000   MetaHookPre   LoadFile(base<...>/communication)
 0.000000   MetaHookPre   LoadFile(base<...>/conn)
 0.000000   MetaHookPre   LoadFile(base<...>/conn-ids)
@@ -1281,7 +1281,7 @@
 0.000000 | HookCallFunction Log::__create_stream(Weird::LOG, [columns=<no value description>, ev=Weird::log_weird])
 0.000000 | HookCallFunction Log::__create_stream(X509::LOG, [columns=<no value description>, ev=X509::log_x509])
 0.000000 | HookCallFunction Log::__create_stream(mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql])
-0.000000 | HookCallFunction Log::__write(PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])
+0.000000 | HookCallFunction Log::__write(PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])
 0.000000 | HookCallFunction Log::add_default_filter(Cluster::LOG)
 0.000000 | HookCallFunction Log::add_default_filter(Communication::LOG)
 0.000000 | HookCallFunction Log::add_default_filter(Conn::LOG)
@@ -1375,8 +1375,8 @@
 0.000000 | HookCallFunction Log::create_stream(Weird::LOG, [columns=<no value description>, ev=Weird::log_weird])
 0.000000 | HookCallFunction Log::create_stream(X509::LOG, [columns=<no value description>, ev=X509::log_x509])
 0.000000 | HookCallFunction Log::create_stream(mysql::LOG, [columns=<no value description>, ev=MySQL::log_mysql])
-0.000000 | HookCallFunction Log::default_path_func(PacketFilter::LOG, , [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])
+0.000000 | HookCallFunction Log::default_path_func(PacketFilter::LOG, , [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])
-0.000000 | HookCallFunction Log::write(PacketFilter::LOG, [ts=1425348860.085231, node=bro, filter=ip or not ip, init=T, success=T])
+0.000000 | HookCallFunction Log::write(PacketFilter::LOG, [ts=1425596289.27327, node=bro, filter=ip or not ip, init=T, success=T])
 0.000000 | HookCallFunction Notice::want_pp()
 0.000000 | HookCallFunction PacketFilter::build()
 0.000000 | HookCallFunction PacketFilter::combine_filters(ip or not ip, and, )

testing/btest/btest.cfg

@@ -1,5 +1,5 @@
 [btest]
-TestDirs    = doc bifs language core scripts istate coverage signatures plugins comm
+TestDirs    = doc bifs language core scripts istate coverage signatures plugins broker
 TmpDir      = %(testbase)s/.tmp
 BaselineDir = %(testbase)s/Baseline
 IgnoreDirs  = .svn CVS .tmp