Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Use std::equal_range in get_search_range()
[simgrid.git] / src / mc / mc_private.h
index c19aa1f..cc31c85 100644 (file)
-/* Copyright (c) 2007-2014. The SimGrid Team.
+/* Copyright (c) 2007-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef MC_PRIVATE_H
-#define MC_PRIVATE_H
+#ifndef SIMGRID_MC_PRIVATE_H
+#define SIMGRID_MC_PRIVATE_H
+
+#include "simgrid_config.h"
 
 #include <sys/types.h>
 
-#include "simgrid_config.h"
 #include <stdio.h>
-#include <stdint.h>
-#include <stdbool.h>
 #ifndef WIN32
 #include <sys/mman.h>
 #endif
+
+#ifdef __cpluscplus
+#include <algorithm>
+#endif
+
 #include <elfutils/libdw.h>
 
+#include <simgrid/msg.h>
+#include <xbt/fifo.h>
+#include <xbt/config.h>
+#include <xbt/base.h>
+
 #include "mc/mc.h"
-#include "mc_base.h"
 #include "mc/datatypes.h"
-#include "xbt/fifo.h"
-#include "xbt/config.h"
-
-#include "xbt/function_types.h"
-#include "xbt/mmalloc.h"
-#include "../simix/smx_private.h"
-#include "../xbt/mmalloc/mmprivate.h"
-#include "xbt/automaton.h"
-#include "xbt/hash.h"
-#include <simgrid/msg.h>
-#include "xbt/strbuff.h"
-#include "xbt/parmap.h"
+#include "src/mc/mc_base.h"
 
-#include "mc_forward.h"
-#include "mc_protocol.h"
+#include "src/simix/smx_private.h"
+#include "src/xbt/mmalloc/mmprivate.h"
 
-SG_BEGIN_DECL()
+#ifdef __cplusplus
+#include "src/mc/mc_forward.hpp"
+#include "src/xbt/memory_map.hpp"
+#endif
 
-typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
+#include "src/mc/mc_protocol.h"
+
+SG_BEGIN_DECL()
 
 /********************************* MC Global **********************************/
 
-/** Initialisation of the model-checker
- *
- * @param pid     PID of the target process
- * @param socket  FD for the communication socket **in server mode** (or -1 otherwise)
- */
-void MC_init_pid(pid_t pid, int socket);
+XBT_PRIVATE void MC_init_dot_output();
 
-extern FILE *dot_output;
-extern const char* colors[13];
-extern xbt_parmap_t parmap;
+XBT_PRIVATE extern FILE *dot_output;
 
-extern int user_max_depth_reached;
+XBT_PRIVATE extern int user_max_depth_reached;
 
-int MC_deadlock_check(void);
-void MC_replay(xbt_fifo_t stack);
-void MC_replay_liveness(xbt_fifo_t stack);
-void MC_show_deadlock(smx_simcall_t req);
-void MC_show_stack_safety(xbt_fifo_t stack);
-void MC_dump_stack_safety(xbt_fifo_t stack);
-void MC_show_non_termination(void);
+XBT_PRIVATE void MC_replay(xbt_fifo_t stack);
+XBT_PRIVATE void MC_show_deadlock(smx_simcall_t req);
+XBT_PRIVATE void MC_show_stack_safety(xbt_fifo_t stack);
+XBT_PRIVATE void MC_dump_stack_safety(xbt_fifo_t stack);
+XBT_PRIVATE void MC_show_non_termination(void);
 
 /** Stack (of `mc_state_t`) representing the current position of the
  *  the MC in the exploration graph
  *
  *  It is managed by its head (`xbt_fifo_shift` and `xbt_fifo_unshift`).
  */
-extern xbt_fifo_t mc_stack;
+XBT_PRIVATE extern xbt_fifo_t mc_stack;
+
+#ifdef __cplusplus
+
+SG_END_DECL()
+
+namespace simgrid {
+namespace mc {
+
+struct DerefAndCompareByNbProcessesAndUsedHead {
+  template<class X, class Y>
+  bool operator()(X const& a, Y const& b)
+  {
+    return std::make_pair(a->nb_processes, a->heap_bytes_used) <
+      std::make_pair(b->nb_processes, b->heap_bytes_used);
+  }
+};
+
+/**
+ *  \brief Find a suitable subrange of candidate duplicates for a given state
+ *  \param list dynamic array of states/pairs with candidate duplicates of the current state;
+ *  \param ref current state/pair;
+ *  \param min (output) index of the beginning of the the subrange
+ *  \param max (output) index of the enf of the subrange
+ *
+ *  Given a suitably ordered array of states/pairs, this function extracts a subrange
+ *  (with index *min <= i <= *max) with candidate duplicates of the given state/pair.
+ *  This function uses only fast discriminating criterions and does not use the
+ *  full state/pair comparison algorithms.
+ *
+ *  The states/pairs in list MUST be ordered using a (given) weak order
+ *  (based on nb_processes and heap_bytes_used).
+ *  The subrange is the subrange of "equivalence" of the given state/pair.
+ */
+// TODO, it would make sense to use std::set instead
+// U = some pointer of T (T*, unique_ptr<T>, shared_ptr<T>)
+template<class U, class T>
+int get_search_interval(
+  U* list, std::size_t count, T *ref, int *min, int *max)
+{
+  auto res = std::equal_range(
+    list, list + count, ref, DerefAndCompareByNbProcessesAndUsedHead());
+
+  // Not found, but we have the insertion point:
+  if (res.first == res.second)
+    return res.first - list;
+
+  // Found, we have the whole matching range:
+  else {
+    *min = res.first - list;
+    *max = (res.second - 1) - list;
+    return -1;
+  }
+}
+
+}
+}
 
-int get_search_interval(xbt_dynar_t list, void *ref, int *min, int *max);
+#endif
 
+SG_BEGIN_DECL()
 
 /****************************** Statistics ************************************/
 
@@ -85,74 +135,36 @@ typedef struct mc_stats {
   unsigned long executed_transitions;
 } s_mc_stats_t, *mc_stats_t;
 
-extern mc_stats_t mc_stats;
+XBT_PRIVATE extern mc_stats_t mc_stats;
 
-void MC_print_statistics(mc_stats_t stats);
+XBT_PRIVATE void MC_print_statistics(mc_stats_t stats);
 
 /********************************** Snapshot comparison **********************************/
 
-typedef struct s_mc_comparison_times{
-  double nb_processes_comparison_time;
-  double bytes_used_comparison_time;
-  double stacks_sizes_comparison_time;
-  double global_variables_comparison_time;
-  double heap_comparison_time;
-  double stacks_comparison_time;
-}s_mc_comparison_times_t, *mc_comparison_times_t;
-
-extern __thread mc_comparison_times_t mc_comp_times;
-extern __thread double mc_snapshot_comparison_time;
-
-int snapshot_compare(void *state1, void *state2);
-void print_comparison_times(void);
-
 //#define MC_DEBUG 1
 #define MC_VERBOSE 1
 
-/********************************** Variables with DWARF **********************************/
-
-void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
-
 /********************************** Miscellaneous **********************************/
 
-typedef struct s_local_variable{
-  dw_frame_t subprogram;
-  unsigned long ip;
-  char *name;
-  dw_type_t type;
-  void *address;
-  int region;
-}s_local_variable_t, *local_variable_t;
+XBT_PRIVATE void MC_report_assertion_error(void);
+XBT_PRIVATE void MC_report_crash(int status);
 
-/* *********** Sets *********** */
+SG_END_DECL()
 
-typedef struct s_mc_address_set *mc_address_set_t;
+#ifdef __cplusplus
 
-mc_address_set_t mc_address_set_new(void);
-void mc_address_set_free(mc_address_set_t* p);
-void mc_address_add(mc_address_set_t p, const void* value);
-bool mc_address_test(mc_address_set_t p, const void* value);
+namespace simgrid {
+namespace mc {
 
-/* *********** Hash *********** */
+XBT_PRIVATE void find_object_address(
+  std::vector<simgrid::xbt::VmMap> const& maps, simgrid::mc::ObjectInformation* result);
 
-/** \brief Hash the current state
- *  \param num_state number of states
- *  \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
- *  \result resulting hash
- * */
-uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
+XBT_PRIVATE
+int snapshot_compare(int num1, simgrid::mc::Snapshot* s1, int num2, simgrid::mc::Snapshot* s2);
 
-/** @brief Dump the stacks of the application processes
- *
- *   This functions is currently not used but it is quite convenient
- *   to call from the debugger.
- *
- *   Does not work when an application thread is running.
- */
-void MC_dump_stacks(FILE* file);
-
-void MC_report_assertion_error(void);
+}
+}
 
-SG_END_DECL()
+#endif
 
 #endif