Clean up logging upon calls to Simulate #269

jougs · 2016-03-09T17:31:43Z

The output upon calls to Simulate has previously been spread out over multiple messages and cluttered by useless messages. This was hard to read by humans and hard to parse by machines. This PR cleans and compacts logging messages and adds the number of threads and processes to the output in order to prevent problems like seen in #238.

The old output looked like this:

Mar 09 18:22:58 Simulate [Info]: 
    Simulating 100 ms.

Mar 09 18:22:58 NodeManager::prepare_nodes_ [Info]: 
    Please wait. Preparing elements.

Mar 09 18:22:58 NodeManager::prepare_nodes_ [Info]: 
    Simulating 1000 local nodes.

Mar 09 18:22:58 SimulationManager::update [Info]: 
    Simulating using OpenMP.

Mar 09 18:22:58 SimulationManager::resume [Info]: 
    Simulation finished.
OpenMP
Mar 09 18:22:58 NodeManager::finalize_nodes() [Info]: 
     using OpenMP.

The new output for the same script looks like this:

Mar 09 18:26:55 NodeManager::prepare_nodes [Info]: 
    Preparing 1000 nodes for simulation.

Mar 09 18:26:55 SimulationManager::resume [Info]: 
    Number of local nodes: 1000
    Simulaton time (ms): 100
    Number of OpenMP threads: 2
    Number of MPI processes: 1

Mar 09 18:26:55 SimulationManager::resume [Info]: 
    Simulation finished.

If NEST was compiled without support for OpenMP, the third line of the table will read

Not using OpenMP

If NEST was compiled without support for MPI, the fourth line of the table will read

Not using MPI

While testing with 0 nodes, I found a segfault, which I then also fixed in this PR for convenience reasons.

Setting nodes_vec_network_size_ to 0 forces the nodes_vec to be resized to the current number of threads. If this is omitted, calibration reaches behind the nodes_vec and causes a segfault.

* Removed unuseful messages * Added number of threads and number of processes to output * Reformatted logging message into a table

jougs · 2016-03-09T17:32:15Z

@apeyser, @heplesser, would you please review? Thanks!

jougs · 2016-03-09T17:33:28Z

nestkernel/simulation_manager.cpp

 nest::SimulationManager::prepare_simulation_()
 {
-  if ( to_do_ == 0 )
-    return;
-


This could never be reached, as the calling function already has a check for t != 0

Then it should have an assert and a comment on the invariant

apeyser · 2016-03-10T08:49:56Z

nestkernel/simulation_manager.cpp

@@ -298,7 +298,7 @@ nest::SimulationManager::simulate( Time const& t )
  to_do_ += t.get_steps();
  to_do_total_ = to_do_;

-  prepare_simulation_();
+  size_t num_active_nodes = prepare_simulation_();


This is a const, correct?

… returns

jougs · 2016-03-10T10:44:03Z

I've added an assert and constness as suggested by @apeyser and disabled clang-format for some lines as suggested by @tammoippen. Many thanks for the thorough review.

heplesser · 2016-03-10T14:32:40Z

nestkernel/nest.cpp

-  Time t = Time::ms( time );
-
-  kernel().simulation_manager.simulate( t );
+  kernel().simulation_manager.simulate( Time::ms( time ) );


Merging may lead to a conflict with #265, but that should be easy to handle.

heplesser · 2016-03-10T14:36:15Z

@jougs Great and 👍 once you have moved the const, see my and @apeyser's comments in the code.

heplesser · 2016-03-11T10:02:48Z

@jougs The conflict is due to my merging #265, where I added parameter checking to simulate() in nest.cpp. I think that should be rather easy to sort out.

jougs · 2016-03-11T10:26:32Z

@heplesser: I've merged in your changes and removed the const-ness for prepare_nodes()

heplesser · 2016-03-11T10:36:00Z

@jougs 👍 from me once CI is green, but I think @apeyser would appreciate a const on line 301 in simulation_manager.cpp, see his comment above.

…ocal variable

tammoippen · 2016-03-21T13:49:58Z

nestkernel/node_manager.cpp

-#endif
+#else // clang-format off
+  for ( index t = 0; t < kernel().vp_manager.get_num_threads(); ++t )
+  {


This for-loop start should be indented one more level.

No, it shouldn't. Depending on the definition of _OPENMP, the compiler either sees

#pragma omp parallel {

or

for (...) {

The for statement in line in (new) line 727 is not inside the #pragma omp parallel block, but replaces it conditionally. So the indentation level of the opening curly brace in line 724 and (new) line 728 have to match.

As clang-format does apparently not take conditional compilation into account, I had to disable it to get the correct indentation.

tammoippen · 2016-03-21T13:53:52Z

Maybe we should also include the MPI rank in the status message or limit the status message to rank 0?

jougs · 2016-03-21T14:06:37Z

Only printing on rank 0 seems strange to me, as the number of local nodes might differ and this message might be very useful for debugging.

But I agree that rank information would be useful. However, I think it would be better if that was added globally to the LOG function to have it included in all output. I can open a corresponding PR if you think that's a good idea.

tammoippen · 2016-03-24T09:31:45Z

Missed the indentation. 👍 for this PR. (merging)

I think, both rank and thread would be useful information for LOG - in another PR.

jougs added 2 commits March 9, 2016 17:16

Fixed segfault when simulating 0 nodes.

74badc6

Setting nodes_vec_network_size_ to 0 forces the nodes_vec to be resized to the current number of threads. If this is omitted, calibration reaches behind the nodes_vec and causes a segfault.

Cleaned up logging for calls to Simulate

2d3c316

* Removed unuseful messages * Added number of threads and number of processes to output * Reformatted logging message into a table

jougs reviewed Mar 9, 2016
View reviewed changes

jougs mentioned this pull request Mar 9, 2016

No speedup from mpi parallelization (SLI and PyNEST) #238

Closed

apeyser reviewed Mar 10, 2016
View reviewed changes

jougs added 3 commits March 10, 2016 11:31

Disable clang-format to keep custom indentation

3a21ea9

Add assert to ensure to_do_ is not 0 when calling prepare_simulation_()

eca908e

Added const qualifier for num_active_nodes variable and corresponding…

9203512

… returns

Re-added the word "local" that got lost during the transition

c34c5e8

heplesser reviewed Mar 10, 2016
View reviewed changes

janhahne mentioned this pull request Mar 10, 2016

Improvement of iterative solution framework #273

Merged

jougs added 2 commits March 11, 2016 11:23

Merge branch 'master' into logging_cleanup

26b4cb6

Removed const-ness in return value

2eb15cd

Removed const from return values and arguments and added one to the l…

b9d37c9

…ocal variable

tammoippen reviewed Mar 21, 2016
View reviewed changes

tammoippen merged commit 78d7d07 into nest:master Mar 24, 2016

jougs deleted the logging_cleanup branch August 31, 2023 13:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up logging upon calls to Simulate #269

Clean up logging upon calls to Simulate #269

jougs commented Mar 9, 2016

jougs commented Mar 9, 2016

jougs Mar 9, 2016

apeyser Mar 10, 2016

apeyser Mar 10, 2016

jougs commented Mar 10, 2016

heplesser Mar 10, 2016

heplesser commented Mar 10, 2016

heplesser commented Mar 11, 2016

jougs commented Mar 11, 2016

heplesser commented Mar 11, 2016

tammoippen Mar 21, 2016

jougs Mar 21, 2016

tammoippen commented Mar 21, 2016

jougs commented Mar 21, 2016

tammoippen commented Mar 24, 2016

Clean up logging upon calls to Simulate #269

Clean up logging upon calls to Simulate #269

Conversation

jougs commented Mar 9, 2016

jougs commented Mar 9, 2016

jougs Mar 9, 2016

Choose a reason for hiding this comment

apeyser Mar 10, 2016

Choose a reason for hiding this comment

apeyser Mar 10, 2016

Choose a reason for hiding this comment

jougs commented Mar 10, 2016

heplesser Mar 10, 2016

Choose a reason for hiding this comment

heplesser commented Mar 10, 2016

heplesser commented Mar 11, 2016

jougs commented Mar 11, 2016

heplesser commented Mar 11, 2016

tammoippen Mar 21, 2016

Choose a reason for hiding this comment

jougs Mar 21, 2016

Choose a reason for hiding this comment

tammoippen commented Mar 21, 2016

jougs commented Mar 21, 2016

tammoippen commented Mar 24, 2016