Honoring cancellation request (closes pgRouting#232)

* allpairs * astar * bellman_ford * breadthFirstSearch * dagShortestPath * dijsktra * contraction * cpp_common * max_flow * spanningTree * topologicalSort * alpha_shape * components * trsp
mbakli · Jul 3, 2020 · ddfd9a2 · ddfd9a2
1 parent f4de22f
commit ddfd9a2
Show file tree

Hide file tree

Showing 21 changed files with 170 additions and 7 deletions.
diff --git a/NEWS b/NEWS
@@ -1,4 +1,12 @@
 
+pgRouting 3.0.1 Release Notes
+-------------------------------------------------------------------------------
+
+*Bug fixes*
+
+* [#1361 ](https://github.com/pgRouting/pgrouting/pull/1361)_: Add code to interrupt the execution
+
+
 pgRouting 3.0.0 Release Notes
 -------------------------------------------------------------------------------
 

diff --git a/doc/src/pgRouting-introduction.rst b/doc/src/pgRouting-introduction.rst
@@ -53,6 +53,7 @@ Cayetano Benavent,
 Gudesa Venkata Sai Akhil,
 Hang Wu,
 Maoguang Wang, Martha Vergara,
+Mohamed Bakli,
 Regina Obe, Rohith Reddy,
 Sourabh Garg,
 Virginia Vergara
@@ -87,7 +88,7 @@ Gerald Fenoy, Gudesa Venkata Sai Akhil,
 Hang Wu,
 Jay Mahadeokar, Jinfu Leng,
 Kai Behncke, Kishore Kumar, Ko Nagase,
-Manikata Kondeti, Mario Basa, Martin Wiesenhaan,  Maxim Dubinin, Maoguang Wang, Mohamed Zia, Mukul Priya,
+Manikata Kondeti, Mario Basa, Martin Wiesenhaan,  Maxim Dubinin, Maoguang Wang, Mohamed Zia, Mohamed Bakli, Mukul Priya,
 Razequl Islam,
 Regina Obe, Rohith Reddy,
 Sarthak Agarwal, Sourabh Garg, Stephen Woodbridge, Sylvain Housseman, Sylvain Pasche,

diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst
@@ -18,6 +18,7 @@ To see the full list of changes check the list of `Git commits <https://github.c
 
 .. changelog start
 
+* :ref:`changelog_3_0_1`
 * :ref:`changelog_3_0_0`
 * :ref:`changelog_2_6_3`
 * :ref:`changelog_2_6_2`
@@ -47,6 +48,15 @@ To see the full list of changes check the list of `Git commits <https://github.c
 
 .. changelog end
 
+.. _changelog_3_0_1:
+
+pgRouting 3.0.1 Release Notes
+-------------------------------------------------------------------------------
+
+.. rubric:: Bug fixes
+
+* `#1361 <https://github.com/pgRouting/pgrouting/pull/1361>`__: Add code to interrupt the execution
+
 .. _changelog_3_0_0:
 
 pgRouting 3.0.0 Release Notes

diff --git a/include/allpairs/pgr_allpairs.hpp b/include/allpairs/pgr_allpairs.hpp
@@ -44,6 +44,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 
 // TODO(vicky) don't keep it here
 #include "cpp_common/pgr_alloc.hpp"
@@ -99,6 +100,10 @@ class Pgr_allpairs {
          std::vector< std::vector<double>> matrix;
          make_matrix(graph.num_vertices(), matrix);
          inf_plus<double> combine;
+
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
+
          boost::floyd_warshall_all_pairs_shortest_paths(
                  graph.graph,
                  matrix,
@@ -116,6 +121,10 @@ class Pgr_allpairs {
          std::vector< std::vector<double>> matrix;
          make_matrix(graph.num_vertices(), matrix);
          inf_plus<double> combine;
+
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
+
          boost::floyd_warshall_all_pairs_shortest_paths(
                  graph.graph,
                  matrix,
@@ -134,6 +143,10 @@ class Pgr_allpairs {
          std::vector< std::vector<double>> matrix;
          make_matrix(graph.num_vertices(), matrix);
          inf_plus<double> combine;
+
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
+
          boost::johnson_all_pairs_shortest_paths(
                  graph.graph,
                  matrix,
@@ -152,6 +165,10 @@ class Pgr_allpairs {
          std::vector< std::vector<double>> matrix;
          make_matrix(graph.num_vertices(), matrix);
          inf_plus<double> combine;
+
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
+
          boost::johnson_all_pairs_shortest_paths(
                  graph.graph,
                  matrix,

diff --git a/include/astar/pgr_astar.hpp b/include/astar/pgr_astar.hpp
@@ -44,6 +44,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 
 namespace pgrouting {
 namespace algorithms {
@@ -293,6 +294,8 @@ class Pgr_astar {
              double factor,
              double epsilon) {
          bool found = false;
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              // Call A* named parameter interface
              boost::astar_search(
@@ -320,6 +323,8 @@ class Pgr_astar {
              double factor,
              double epsilon) {
          bool found = false;
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::astar_search(
                      graph.graph, source,

diff --git a/include/bellman_ford/pgr_bellman_ford.hpp b/include/bellman_ford/pgr_bellman_ford.hpp
@@ -42,6 +42,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include "cpp_common/pgr_messages.h"
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 
 
 
@@ -188,7 +189,8 @@ class Pgr_bellman_ford : public pgrouting::Pgr_messages {
                  V source,
                  V target) {
          log << std::string(__FUNCTION__) << "\n";
-
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              bool negative = boost::bellman_ford_shortest_paths(
                      graph.graph,
@@ -213,6 +215,8 @@ class Pgr_bellman_ford : public pgrouting::Pgr_messages {
              G &graph,
              V source) {
         log << std::string(__FUNCTION__) << "\n";
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::bellman_ford_shortest_paths(
                      graph.graph,

diff --git a/include/bellman_ford/pgr_edwardMoore.hpp b/include/bellman_ford/pgr_edwardMoore.hpp
@@ -30,6 +30,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 //******************************************
 
 namespace pgrouting {
@@ -159,6 +160,9 @@ class Pgr_edwardMoore {
         std::vector<E> &from_edge,
         std::deque<int64_t> &dq,
         int64_t &head_vertex) {
+        /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+        CHECK_FOR_INTERRUPTS();
+
         auto out_edges = boost::out_edges(head_vertex, graph.graph);
         E e;
         EO_i out_i;

diff --git a/include/breadthFirstSearch/pgr_breadthFirstSearch.hpp b/include/breadthFirstSearch/pgr_breadthFirstSearch.hpp
@@ -32,6 +32,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include <vector>
 
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 //******************************************
 
 namespace pgrouting {
@@ -63,6 +64,9 @@ class Pgr_breadthFirstSearch {
 
                 auto single_source_results = get_results(visited_order, source, depth, graph);
                 results.insert(results.end(), single_source_results.begin(), single_source_results.end());
+
+                /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+                CHECK_FOR_INTERRUPTS();
             }
         }
         return results;

diff --git a/include/contraction/pgr_deadEndContraction.hpp b/include/contraction/pgr_deadEndContraction.hpp
@@ -36,6 +36,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include <functional>
 #include <vector>
 #include "cpp_common/identifiers.hpp"
+#include "cpp_common/interruption.h"
 
 namespace pgrouting {
 namespace contraction {
@@ -100,6 +101,10 @@ class Pgr_deadend {
 
             graph[v].contracted_vertices().clear();
             boost::clear_vertex(v, graph.graph);
+
+            /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+            CHECK_FOR_INTERRUPTS();
+
             for (const auto u : local) {
                 if (is_dead_end(graph, u) && !forbiddenVertices.has(u)) {
                     deadendVertices += u;

diff --git a/include/cpp_common/interruption.h b/include/cpp_common/interruption.h
@@ -0,0 +1,39 @@
+/*PGR-GNU*****************************************************************
+
+Copyright (c) 2015 pgRouting developers
+Mail: [email protected]
+
+Copyright (c) 2020 Mohamed Bakli, Esteban Zimányi, Mahmoud Sakr
+[email protected], [email protected], [email protected]
+
+------
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ ********************************************************************PGR-GNU*/
+
+#ifndef INCLUDE_CPP_COMMON_INTERRUPTION_H_
+#define INCLUDE_CPP_COMMON_INTERRUPTION_H_
+/*
+ * Suppress the -Wpedantic warning temporarily about the postgres file
+ */
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wpedantic"
+extern "C" {
+#include <postgres.h>
+#include <miscadmin.h>
+}
+#pragma GCC diagnostic pop
+#endif  // INCLUDE_CPP_COMMON_INTERRUPTION_H_
diff --git a/include/dagShortestPath/pgr_dagShortestPath.hpp b/include/dagShortestPath/pgr_dagShortestPath.hpp
@@ -46,6 +46,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 
 template < class G >
 class Pgr_dag {
@@ -190,6 +191,8 @@ class Pgr_dag {
                  G &graph,
                  V source,
                  V target) {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dag_shortest_paths(graph.graph, source,
                      boost::predecessor_map(&predecessors[0])
@@ -216,6 +219,8 @@ class Pgr_dag {
              V source,
              const std::vector< V > &targets,
              size_t n_goals = std::numeric_limits<size_t>::max()) {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dag_shortest_paths(graph.graph, source,
                      boost::predecessor_map(&predecessors[0])

diff --git a/include/dijkstra/pgr_dijkstra.hpp b/include/dijkstra/pgr_dijkstra.hpp
@@ -48,6 +48,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 #include "cpp_common/basePath_SSEC.hpp"
 #include "cpp_common/pgr_base_graph.hpp"
+#include "cpp_common/interruption.h"
 #include "visitors/dijkstra_one_goal_visitor.hpp"
 
 #if 0
@@ -307,6 +308,8 @@ class Pgr_dijkstra {
                  G &graph,
                  V source,
                  V target) {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dijkstra_shortest_paths(graph.graph, source,
                      boost::predecessor_map(&predecessors[0])
@@ -338,6 +341,8 @@ class Pgr_dijkstra {
              G &graph,
              V source,
              double distance) {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dijkstra_shortest_paths(graph.graph, source,
                      boost::predecessor_map(&predecessors[0])
@@ -372,6 +377,8 @@ class Pgr_dijkstra {
          pgassert(distances.size() == graph.num_vertices());
          distances[source] = 0;
          std::vector<boost::default_color_type> color_map(graph.num_vertices());
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dijkstra_shortest_paths_no_init(graph.graph, source,
                      make_iterator_property_map(
@@ -669,6 +676,8 @@ class Pgr_dijkstra {
              V source,
              const std::vector< V > &targets,
              size_t n_goals = std::numeric_limits<size_t>::max()) {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          try {
              boost::dijkstra_shortest_paths(graph.graph, source,
                      boost::predecessor_map(&predecessors[0])

diff --git a/include/max_flow/pgr_maxflow.hpp b/include/max_flow/pgr_maxflow.hpp
@@ -45,7 +45,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include "c_types/pgr_flow_t.h"
 #include "c_types/pgr_edge_t.h"
 #include "c_types/general_path_element_t.h"
-
+#include "cpp_common/interruption.h"
 
 
 namespace pgrouting {
@@ -70,27 +70,35 @@ class PgrFlowGraph {
 
  public:
      int64_t push_relabel() {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          return boost::push_relabel_max_flow(
                  graph,
                  supersource,
                  supersink);
      }
 
      int64_t edmonds_karp() {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          return boost::edmonds_karp_max_flow(
                  graph,
                  supersource,
                  supersink);
      }
 
      int64_t boykov_kolmogorov() {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          return boost::boykov_kolmogorov_max_flow(
                  graph,
                  supersource,
                  supersink);
      }
 
      std::vector<General_path_element_t> edge_disjoint_paths() {
+         /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+         CHECK_FOR_INTERRUPTS();
          auto flow = boost::boykov_kolmogorov_max_flow(
                  graph,
                  supersource,

diff --git a/include/spanningTree/pgr_kruskal.hpp b/include/spanningTree/pgr_kruskal.hpp
@@ -32,6 +32,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #include <boost/graph/kruskal_min_spanning_tree.hpp>
 #include <vector>
 #include "spanningTree/pgr_mst.hpp"
+#include "cpp_common/interruption.h"
 
 namespace pgrouting {
 namespace functions {
@@ -70,7 +71,8 @@ template <class G>
 void
 Pgr_kruskal<G>::generate_mst(const G &graph) {
     this->clear();
-
+    /* abort in case of an interruption occurs (e.g. the query is being cancelled) */
+    CHECK_FOR_INTERRUPTS();
     boost::kruskal_minimum_spanning_tree(
             graph.graph,
             std::inserter(this->m_spanning_tree.edges, this->m_spanning_tree.edges.begin()),