Fixed Issue #104 by improving WRENCH_* logging macros

wrench-project · Jun 19, 2019 · f745b52 · f745b52
1 parent 1e0584a
commit f745b52
Show file tree

Hide file tree

Showing 52 changed files with 87 additions and 71 deletions.
diff --git a/include/wrench/logging/TerminalOutput.h b/include/wrench/logging/TerminalOutput.h
@@ -13,19 +13,39 @@
 #include <map>
 
 #include <simgrid/s4u/Actor.hpp>
+#include <xbt/log.h>
 
 #include <iostream>
 
 namespace wrench {
 
 
-/* Wrappers around XBT_* macros */
-
-#define WRENCH_INFO(...)  wrench::TerminalOutput::beginThisProcessColor(); XBT_INFO(__VA_ARGS__) ; wrench::TerminalOutput::endThisProcessColor()
-
-#define WRENCH_DEBUG(...)  wrench::TerminalOutput::beginThisProcessColor(); XBT_DEBUG(__VA_ARGS__) ; wrench::TerminalOutput::endThisProcessColor()
+/* Wrappers around XBT_* macros, using a bit of those macro's internal magic as well
+ * to avoid generating useless (but space consuming) color ASCII codes
+ */
 
-#define WRENCH_WARN(...)  wrench::TerminalOutput::beginThisProcessColor(); XBT_WARN(__VA_ARGS__) ; wrench::TerminalOutput::endThisProcessColor()
+#define WRENCH_LOG_NEW_DEFAULT_CATEGORY(cname, desc) XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc)
+
+#define WRENCH_INFO(...)  \
+    if (_XBT_LOG_ISENABLEDV((*_simgrid_log_category__default), xbt_log_priority_info)) { \
+      wrench::TerminalOutput::beginThisProcessColor();  \
+      XBT_INFO(__VA_ARGS__) ;  \
+      wrench::TerminalOutput::endThisProcessColor(); \
+    }
+
+#define WRENCH_DEBUG(...)  \
+    if (_XBT_LOG_ISENABLEDV((*_simgrid_log_category__default), xbt_log_priority_debug)) { \
+      wrench::TerminalOutput::beginThisProcessColor();  \
+      XBT_DEBUG(__VA_ARGS__) ;  \
+      wrench::TerminalOutput::endThisProcessColor(); \
+    }
+
+#define WRENCH_WARN(...)  \
+    if (_XBT_LOG_ISENABLEDV((*_simgrid_log_category__default), xbt_log_priority_warning)) { \
+      wrench::TerminalOutput::beginThisProcessColor();  \
+      XBT_WARN(__VA_ARGS__) ;  \
+      wrench::TerminalOutput::endThisProcessColor(); \
+    }
 
     /***********************/
     /** \cond DEVELOPER    */

diff --git a/src/wrench/logging/TerminalOutput.cpp b/src/wrench/logging/TerminalOutput.cpp
@@ -10,7 +10,6 @@
 #include <string>
 #include <simgrid/s4u/Actor.hpp>
 #include <iostream>
-#include <xbt/log.h>
 #include "wrench/logging/TerminalOutput.h"
 
 namespace wrench {
@@ -44,7 +43,7 @@ namespace wrench {
      */
     void TerminalOutput::beginThisProcessColor() {
 
-        if ((not TerminalOutput::wrench_no_log) and (TerminalOutput::color_enabled)) {
+        if (TerminalOutput::color_enabled) {
             std::cerr << TerminalOutput::getThisProcessLoggingColor();
         }
     }
@@ -53,7 +52,7 @@ namespace wrench {
      * @brief Turn off colored output for the calling process
      */
     void TerminalOutput::endThisProcessColor() {
-        if ((not TerminalOutput::wrench_no_log) and (TerminalOutput::color_enabled)) {
+        if (TerminalOutput::color_enabled) {
             std::cerr << "\033[0m";
         }
     }

diff --git a/src/wrench/managers/DataMovementManager.cpp b/src/wrench/managers/DataMovementManager.cpp
@@ -23,7 +23,7 @@
 #include "wrench/workflow/Workflow.h"
 #include "wrench/managers/DataMovementManager.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(data_movement_manager, "Log category for Data Movement Manager");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(data_movement_manager, "Log category for Data Movement Manager");
 
 namespace wrench {
 

diff --git a/src/wrench/managers/EnergyMeter.cpp b/src/wrench/managers/EnergyMeter.cpp
@@ -14,7 +14,7 @@
 
 #define EPSILON 0.0001
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(energy_meter, "Log category for Energy Meter");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(energy_meter, "Log category for Energy Meter");
 
 namespace wrench {
 

diff --git a/src/wrench/managers/JobManager.cpp b/src/wrench/managers/JobManager.cpp
@@ -26,7 +26,7 @@
 #include "JobManagerMessage.h"
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(job_manager, "Log category for Job Manager");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(job_manager, "Log category for Job Manager");
 
 namespace wrench {
 

diff --git a/src/wrench/services/Service.cpp b/src/wrench/services/Service.cpp
@@ -17,7 +17,7 @@
 #include "wrench/exceptions/WorkflowExecutionException.h"
 #include "wrench/services/ServiceMessagePayload.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(service, "Log category for Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(service, "Log category for Service");
 
 
 namespace wrench {

diff --git a/src/wrench/services/compute/ComputeService.cpp b/src/wrench/services/compute/ComputeService.cpp
@@ -17,7 +17,7 @@
 #include "wrench/services/compute/ComputeServiceMessage.h"
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(compute_service, "Log category for Compute Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(compute_service, "Log category for Compute Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/bare_metal/BareMetalComputeService.cpp b/src/wrench/services/compute/bare_metal/BareMetalComputeService.cpp
@@ -34,7 +34,7 @@
 #include "wrench/services/helpers/ServiceTerminationDetector.h"
 #include "wrench/services/helpers/HostStateChangeDetector.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(baremetal_compute_service, "Log category for BareMetalComputeService");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(baremetal_compute_service, "Log category for BareMetalComputeService");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/batch/BatchComputeService.cpp b/src/wrench/services/compute/batch/BatchComputeService.cpp
@@ -39,7 +39,7 @@
 
 #endif
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(batch_service, "Log category for Batch Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(batch_service, "Log category for Batch Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/batch/BatschedNetworkListener.cpp b/src/wrench/services/compute/batch/BatschedNetworkListener.cpp
@@ -27,7 +27,7 @@
 
 #endif
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(batch_network_listener_service, "Log category for Batch Network Listener Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(batch_network_listener_service, "Log category for Batch Network Listener Service");
 
 //class context_t;
 

diff --git a/src/wrench/services/compute/batch/TraceFileLoader.cpp b/src/wrench/services/compute/batch/TraceFileLoader.cpp
@@ -8,12 +8,12 @@
  */
 
 #include <fstream>
-#include <xbt/log.h>
+#include "wrench/logging/TerminalOutput.h"
 #include <wrench-dev.h>
 #include <nlohmann/json.hpp>
 #include "wrench/util/TraceFileLoader.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(trace_file_loader, "Log category for Trace File Loader");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(trace_file_loader, "Log category for Trace File Loader");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/batch/WorkloadTraceFileReplayer.cpp b/src/wrench/services/compute/batch/WorkloadTraceFileReplayer.cpp
@@ -14,7 +14,7 @@
 #include "WorkloadTraceFileReplayer.h"
 #include "WorkloadTraceFileReplayerEventReceiver.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(workload_trace_file_replayer, "Log category for Trace File Replayer");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(workload_trace_file_replayer, "Log category for Trace File Replayer");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/batch/WorkloadTraceFileReplayerEventReceiver.cpp b/src/wrench/services/compute/batch/WorkloadTraceFileReplayerEventReceiver.cpp
@@ -12,7 +12,7 @@
 #include <wrench-dev.h>
 #include "WorkloadTraceFileReplayerEventReceiver.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(one_job_wms, "Log category for One Job WMS");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(one_job_wms, "Log category for One Job WMS");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/cloud/CloudComputeService.cpp b/src/wrench/services/compute/cloud/CloudComputeService.cpp
@@ -21,7 +21,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(cloud_service, "Log category for Cloud Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(cloud_service, "Log category for Cloud Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/htcondor/HTCondorCentralManagerService.cpp b/src/wrench/services/compute/htcondor/HTCondorCentralManagerService.cpp
@@ -18,7 +18,7 @@
 #include "wrench/services/compute/htcondor/HTCondorNegotiatorService.h"
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(HTCondorCentralManager, "Log category for HTCondorCentralManagerService");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(HTCondorCentralManager, "Log category for HTCondorCentralManagerService");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/htcondor/HTCondorNegotiatorService.cpp b/src/wrench/services/compute/htcondor/HTCondorNegotiatorService.cpp
@@ -15,7 +15,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Simulation.h"
 #include "wrench/workflow/WorkflowTask.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(htcondor_negotiator, "Log category for HTCondorNegotiator");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(htcondor_negotiator, "Log category for HTCondorNegotiator");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/htcondor/HTCondorService.cpp b/src/wrench/services/compute/htcondor/HTCondorService.cpp
@@ -13,7 +13,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 #include "wrench/simgrid_S4U_util/S4U_Simulation.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(HTCondor, "Log category for HTCondorService Scheduler");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(HTCondor, "Log category for HTCondorService Scheduler");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/standard_job_executor/StandardJobExecutor.cpp b/src/wrench/services/compute/standard_job_executor/StandardJobExecutor.cpp
@@ -33,7 +33,7 @@
 
 #include "wrench/util/PointerUtil.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(standard_job_executor, "Log category for Standard Job Executor");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(standard_job_executor, "Log category for Standard Job Executor");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/virtualized_cluster/VirtualizedClusterComputeService.cpp b/src/wrench/services/compute/virtualized_cluster/VirtualizedClusterComputeService.cpp
@@ -20,7 +20,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(virtualized_cluster_service, "Log category for Virtualized Cluster Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(virtualized_cluster_service, "Log category for Virtualized Cluster Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/work_unit_executor/ComputeThread.cpp b/src/wrench/services/compute/work_unit_executor/ComputeThread.cpp
@@ -8,13 +8,11 @@
  * (at your option) any later version.
  */
 
-#include <xbt.h>
+#include "wrench/logging/TerminalOutput.h"
 #include <wrench-dev.h>
 #include "ComputeThread.h"
 
-
-XBT_LOG_NEW_DEFAULT_CATEGORY(compute_thread, "Log category for ComputeThread");
-
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(compute_thread, "Log category for ComputeThread");
 
 namespace wrench {
 

diff --git a/src/wrench/services/compute/work_unit_executor/Workunit.cpp b/src/wrench/services/compute/work_unit_executor/Workunit.cpp
@@ -14,7 +14,7 @@
 #include "wrench/services/compute/workunit_executor/Workunit.h"
 #include <wrench-dev.h>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(workunit, "Log category for Workunit");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(workunit, "Log category for Workunit");
 
 
 namespace wrench {

diff --git a/src/wrench/services/compute/work_unit_executor/WorkunitExecutor.cpp b/src/wrench/services/compute/work_unit_executor/WorkunitExecutor.cpp
@@ -26,11 +26,11 @@
 #include "ComputeThread.h"
 #include "wrench/simulation/Simulation.h"
 
-#include <xbt.h>
+#include "wrench/logging/TerminalOutput.h"
 #include <wrench/services/compute/ComputeService.h>
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(workunit_executor, "Log category for Multicore Workunit Executor");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(workunit_executor, "Log category for Multicore Workunit Executor");
 
 //#define S4U_KILL_JOIN_WORKS
 

diff --git a/src/wrench/services/file_registry/FileRegistryService.cpp b/src/wrench/services/file_registry/FileRegistryService.cpp
@@ -22,7 +22,7 @@
 #include <wrench/services/network_proximity/NetworkProximityService.h>
 #include <algorithm>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(file_registry_service, "Log category for File Registry Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(file_registry_service, "Log category for File Registry Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/helpers/alarm/Alarm.cpp b/src/wrench/services/helpers/alarm/Alarm.cpp
@@ -14,7 +14,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Simulation.h"
 #include "wrench/workflow/execution_events/FailureCause.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(alarm_service, "Log category for Alarm Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(alarm_service, "Log category for Alarm Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/helpers/host_state_change_detector/HostStateChangeDetector.cpp b/src/wrench/services/helpers/host_state_change_detector/HostStateChangeDetector.cpp
@@ -16,7 +16,7 @@
 #include <wrench/services/helpers/HostStateChangeDetector.h>
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(host_state_change_detector, "Log category for HostStateChangeDetector");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(host_state_change_detector, "Log category for HostStateChangeDetector");
 
 
 void wrench::HostStateChangeDetector::cleanup(bool has_returned_from_main, int return_value) {

diff --git a/src/wrench/services/helpers/service_termination_detector/ServiceTerminationDetector.cpp b/src/wrench/services/helpers/service_termination_detector/ServiceTerminationDetector.cpp
@@ -13,7 +13,7 @@
 #include <wrench/simulation/Simulation.h>
 #include <wrench-dev.h>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(failure_detector, "Log category for ServiceTerminationDetector");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(failure_detector, "Log category for ServiceTerminationDetector");
 
 /**
  * @brief Constructor

diff --git a/src/wrench/services/network_proximity/NetworkProximityDaemon.cpp b/src/wrench/services/network_proximity/NetworkProximityDaemon.cpp
@@ -18,7 +18,7 @@
 #include "NetworkProximityMessage.h"
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(network_daemons_service, "Log category for Network Daemons Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(network_daemons_service, "Log category for Network Daemons Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/network_proximity/NetworkProximityService.cpp b/src/wrench/services/network_proximity/NetworkProximityService.cpp
@@ -24,7 +24,7 @@
 
 #include <boost/algorithm/string.hpp>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(network_proximity_service, "Log category for Network Proximity Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(network_proximity_service, "Log category for Network Proximity Service");
 
 namespace wrench {
 

diff --git a/src/wrench/services/storage/StorageService.cpp b/src/wrench/services/storage/StorageService.cpp
@@ -17,7 +17,7 @@
 #include "wrench/simgrid_S4U_util/S4U_Mailbox.h"
 #include "wrench/simulation/Simulation.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(storage_service, "Log category for Storage Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(storage_service, "Log category for Storage Service");
 
 
 namespace wrench {

diff --git a/src/wrench/services/storage/simple/NetworkConnection.cpp b/src/wrench/services/storage/simple/NetworkConnection.cpp
@@ -16,7 +16,7 @@
 //#include <xbt/ex.hpp>
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(simple_storage_service_data_connection, "Log category for Data Connection");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(simple_storage_service_data_connection, "Log category for Data Connection");
 
 namespace wrench {
 

diff --git a/src/wrench/services/storage/simple/NetworkConnectionManager.cpp b/src/wrench/services/storage/simple/NetworkConnectionManager.cpp
@@ -11,7 +11,7 @@
 #include <wrench/simgrid_S4U_util/S4U_PendingCommunication.h>
 #include <wrench-dev.h>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(network_connection_manager, "Log category for Network Connection Manager");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(network_connection_manager, "Log category for Network Connection Manager");
 
 
 namespace wrench {

diff --git a/src/wrench/services/storage/simple/SimpleStorageService.cpp b/src/wrench/services/storage/simple/SimpleStorageService.cpp
@@ -21,7 +21,7 @@
 #include "wrench/simulation/SimulationTimestampTypes.h"
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(simple_storage_service, "Log category for Simple Storage Service");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(simple_storage_service, "Log category for Simple Storage Service");
 
 
 namespace wrench {

diff --git a/src/wrench/simgrid_S4U_util/S4U_Daemon.cpp b/src/wrench/simgrid_S4U_util/S4U_Daemon.cpp
@@ -19,7 +19,7 @@
 #endif
 
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_daemon, "Log category for S4U_Daemon");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(s4u_daemon, "Log category for S4U_Daemon");
 
 #ifdef ACTOR_TRACKING_OUTPUT
 std::map<std::string, unsigned long> num_actors;

diff --git a/src/wrench/simgrid_S4U_util/S4U_DaemonActor.cpp b/src/wrench/simgrid_S4U_util/S4U_DaemonActor.cpp
@@ -9,9 +9,9 @@
  *
  */
 
-#include <xbt/log.h>
+#include "wrench/logging/TerminalOutput.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_daemon_actor, "Log category for S4U_DaemonActor");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(s4u_daemon_actor, "Log category for S4U_DaemonActor");
 
 namespace wrench {
 

diff --git a/src/wrench/simgrid_S4U_util/S4U_DaemonActor.h b/src/wrench/simgrid_S4U_util/S4U_DaemonActor.h
@@ -13,7 +13,7 @@
 #define WRENCH_SIM4U_DAEMONACTOR_H
 
 
-#include <xbt.h>
+#include "wrench/logging/TerminalOutput.h"
 #include <string>
 #include <vector>
 #include <iostream>

diff --git a/src/wrench/simgrid_S4U_util/S4U_Mailbox.cpp b/src/wrench/simgrid_S4U_util/S4U_Mailbox.cpp
@@ -24,7 +24,7 @@
 #include "wrench/simgrid_S4U_util/S4U_PendingCommunication.h"
 #include "wrench/simulation/SimulationMessage.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(mailbox, "Mailbox");
+WRENCH_LOG_NEW_DEFAULT_CATEGORY(mailbox, "Mailbox");
 
 
 namespace wrench {