roby 0.8.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (644) hide show
  1. checksums.yaml +7 -0
  2. data/.deep-cover.rb +3 -0
  3. data/.gitattributes +1 -0
  4. data/.gitignore +24 -0
  5. data/.simplecov +10 -0
  6. data/.travis.yml +17 -0
  7. data/.yardopts +4 -0
  8. data/Gemfile +15 -0
  9. data/README.md +11 -0
  10. data/Rakefile +47 -177
  11. data/benchmark/{alloc_misc.rb → attic/alloc_misc.rb} +2 -2
  12. data/benchmark/{discovery_latency.rb → attic/discovery_latency.rb} +19 -19
  13. data/benchmark/{garbage_collection.rb → attic/garbage_collection.rb} +9 -9
  14. data/benchmark/{genom.rb → attic/genom.rb} +0 -0
  15. data/benchmark/attic/transactions.rb +62 -0
  16. data/benchmark/plan_basic_operations.rb +28 -0
  17. data/benchmark/relations/graph.rb +63 -0
  18. data/benchmark/ruby/identity.rb +18 -0
  19. data/benchmark/ruby/set_intersect_vs_hash_merge.rb +39 -0
  20. data/benchmark/ruby/yield_vs_block.rb +35 -0
  21. data/benchmark/run +5 -0
  22. data/benchmark/synthetic_plan_modifications_with_transactions.rb +79 -0
  23. data/benchmark/transactions.rb +99 -51
  24. data/bin/roby +38 -197
  25. data/bin/roby-display +14 -0
  26. data/bin/roby-log +3 -176
  27. data/doc/guide/{src → attic}/abstraction/achieve_with.page +1 -1
  28. data/doc/guide/{src → attic}/abstraction/forwarding.page +1 -1
  29. data/doc/guide/{src → attic}/abstraction/hierarchy.page +1 -1
  30. data/doc/guide/{src → attic}/abstraction/index.page +1 -1
  31. data/doc/guide/{src → attic}/abstraction/task_models.page +1 -1
  32. data/doc/guide/{overview.rdoc → attic/cycle/api_overview.rdoc} +6 -1
  33. data/doc/guide/{src → attic}/cycle/cycle-overview.png +0 -0
  34. data/doc/guide/{src → attic}/cycle/cycle-overview.svg +0 -0
  35. data/doc/guide/attic/cycle/error_handling.page +98 -0
  36. data/doc/guide/{src → attic}/cycle/error_instantaneous_repair.png +0 -0
  37. data/doc/guide/{src → attic}/cycle/error_instantaneous_repair.svg +0 -0
  38. data/doc/guide/{src/cycle/error_handling.page → attic/cycle/error_sources.page} +46 -89
  39. data/doc/guide/{src → attic}/cycle/garbage_collection.page +1 -1
  40. data/doc/guide/{src → attic}/cycle/index.page +1 -1
  41. data/doc/guide/{src → attic}/cycle/propagation.page +11 -1
  42. data/doc/guide/{src → attic}/cycle/propagation_diamond.png +0 -0
  43. data/doc/guide/{src → attic}/cycle/propagation_diamond.svg +0 -0
  44. data/doc/guide/attic/plans/building_plans.page +89 -0
  45. data/doc/guide/attic/plans/code.page +192 -0
  46. data/doc/guide/{src/basics → attic/plans}/events.page +3 -4
  47. data/doc/guide/attic/plans/index.page +7 -0
  48. data/doc/guide/{plan_modifications.rdoc → attic/plans/plan_modifications.rdoc} +5 -3
  49. data/doc/guide/{src/basics → attic/plans}/plan_objects.page +2 -1
  50. data/doc/guide/attic/plans/querying_plans.page +5 -0
  51. data/doc/guide/{src/basics → attic/plans}/tasks.page +20 -20
  52. data/doc/guide/config.yaml +7 -4
  53. data/doc/guide/ext/extended_menu.rb +29 -0
  54. data/doc/guide/ext/init.rb +6 -0
  55. data/doc/guide/ext/rdoc_links.rb +7 -6
  56. data/doc/guide/src/advanced_concepts/history.page +5 -0
  57. data/doc/guide/src/advanced_concepts/index.page +11 -0
  58. data/doc/guide/src/advanced_concepts/recognizing_patterns.page +83 -0
  59. data/doc/guide/src/advanced_concepts/scheduling.page +87 -0
  60. data/doc/guide/src/advanced_concepts/transactions.page +5 -0
  61. data/doc/guide/src/advanced_concepts/unreachability.page +42 -0
  62. data/doc/guide/src/base.template +96 -0
  63. data/doc/guide/src/basics_shell_header.txt +5 -7
  64. data/doc/guide/src/building/action_coordination.page +96 -0
  65. data/doc/guide/src/building/actions.page +124 -0
  66. data/doc/guide/src/building/file_layout.page +71 -0
  67. data/doc/guide/src/building/index.page +50 -0
  68. data/doc/guide/src/building/patterns.page +86 -0
  69. data/doc/guide/src/building/patterns_forwarding.png +0 -0
  70. data/doc/guide/src/building/patterns_forwarding.svg +277 -0
  71. data/doc/guide/src/building/runtime.page +95 -0
  72. data/doc/guide/src/building/task_models.page +94 -0
  73. data/doc/guide/src/building/tasks.page +284 -0
  74. data/doc/guide/src/concepts/error_handling.page +100 -0
  75. data/doc/guide/src/concepts/exception_propagation.png +0 -0
  76. data/doc/guide/src/concepts/exception_propagation.svg +445 -0
  77. data/doc/guide/src/concepts/execution.page +85 -0
  78. data/doc/guide/src/concepts/execution.png +0 -0
  79. data/doc/guide/src/concepts/execution.svg +573 -0
  80. data/doc/guide/src/concepts/execution_cycle.png +0 -0
  81. data/doc/guide/src/concepts/garbage_collection.page +57 -0
  82. data/doc/guide/src/concepts/index.page +27 -0
  83. data/doc/guide/src/concepts/plans.page +101 -0
  84. data/doc/guide/src/concepts/policy.page +31 -0
  85. data/doc/guide/src/concepts/reactor.page +61 -0
  86. data/doc/guide/src/concepts/simple_plan_example.png +0 -0
  87. data/doc/guide/src/concepts/simple_plan_example.svg +376 -0
  88. data/doc/guide/src/default.template +9 -74
  89. data/doc/guide/src/event_relations/forward.page +71 -0
  90. data/doc/guide/src/event_relations/index.page +12 -0
  91. data/doc/guide/src/event_relations/scheduling_constraints.page +43 -0
  92. data/doc/guide/src/event_relations/signal.page +55 -0
  93. data/doc/guide/src/event_relations/temporal_constraints.page +77 -0
  94. data/doc/guide/src/htmldoc.metainfo +21 -8
  95. data/doc/guide/src/index.page +8 -3
  96. data/doc/guide/src/{introduction/install.page → installation/index.page} +37 -25
  97. data/doc/guide/src/installation/publications.page +14 -0
  98. data/doc/guide/src/{introduction → installation}/videos.page +14 -7
  99. data/doc/guide/src/interacting/index.page +16 -0
  100. data/doc/guide/src/interacting/run.page +33 -0
  101. data/doc/guide/src/interacting/shell.page +95 -0
  102. data/doc/guide/src/plugins/creating_plugins.page +72 -0
  103. data/doc/guide/src/plugins/index.page +27 -5
  104. data/doc/guide/src/plugins/{fault_tolerance.page → standard_plugins/fault_tolerance.page} +2 -2
  105. data/doc/guide/src/plugins/standard_plugins/index.page +11 -0
  106. data/doc/guide/src/plugins/{subsystems.page → standard_plugins/subsystems.page} +2 -2
  107. data/doc/guide/src/style_screen.css +687 -0
  108. data/doc/guide/src/task_relations/dependency.page +107 -0
  109. data/doc/guide/src/task_relations/executed_by.page +77 -0
  110. data/doc/guide/src/task_relations/index.page +12 -0
  111. data/doc/guide/src/task_relations/new_relations.page +119 -0
  112. data/doc/guide/src/task_relations/planned_by.page +46 -0
  113. data/doc/guide/src/tutorial/app.page +117 -0
  114. data/doc/guide/src/{basics → tutorial}/code_examples.page +6 -5
  115. data/doc/guide/src/{basics → tutorial}/dry.page +15 -15
  116. data/doc/guide/src/{basics → tutorial}/errors.page +43 -68
  117. data/doc/guide/src/tutorial/events.page +195 -0
  118. data/doc/guide/src/{basics → tutorial}/hierarchy.page +53 -52
  119. data/doc/guide/src/tutorial/index.page +13 -0
  120. data/doc/guide/src/tutorial/log_replay/goForward_1.png +0 -0
  121. data/doc/guide/src/tutorial/log_replay/goForward_2.png +0 -0
  122. data/doc/guide/src/tutorial/log_replay/goForward_3.png +0 -0
  123. data/doc/guide/src/{basics → tutorial}/log_replay/goForward_4.png +0 -0
  124. data/doc/guide/src/tutorial/log_replay/goForward_5.png +0 -0
  125. data/doc/guide/src/{basics → tutorial}/log_replay/hierarchy_error_1.png +0 -0
  126. data/doc/guide/src/{basics → tutorial}/log_replay/hierarchy_error_2.png +0 -0
  127. data/doc/guide/src/{basics → tutorial}/log_replay/hierarchy_error_3.png +0 -0
  128. data/doc/guide/src/tutorial/log_replay/moveto_code_error.png +0 -0
  129. data/doc/guide/src/{basics → tutorial}/log_replay/plan_repair_1.png +0 -0
  130. data/doc/guide/src/{basics → tutorial}/log_replay/plan_repair_2.png +0 -0
  131. data/doc/guide/src/{basics → tutorial}/log_replay/plan_repair_3.png +0 -0
  132. data/doc/guide/src/tutorial/log_replay/plan_repair_4.png +0 -0
  133. data/doc/guide/src/tutorial/log_replay/roby_log_main_window.png +0 -0
  134. data/doc/guide/src/{basics → tutorial}/log_replay/roby_log_relation_window.png +0 -0
  135. data/doc/guide/src/{basics → tutorial}/log_replay/roby_replay_event_representation.png +0 -0
  136. data/doc/guide/src/tutorial/relations_display.page +153 -0
  137. data/doc/guide/src/{basics → tutorial}/roby_cycle_overview.png +0 -0
  138. data/doc/guide/src/tutorial/shell.page +121 -0
  139. data/doc/guide/src/{basics → tutorial}/summary.page +1 -1
  140. data/doc/guide/src/tutorial/tasks.page +374 -0
  141. data/lib/roby.rb +102 -47
  142. data/lib/roby/actions.rb +17 -0
  143. data/lib/roby/actions/action.rb +80 -0
  144. data/lib/roby/actions/interface.rb +45 -0
  145. data/lib/roby/actions/library.rb +23 -0
  146. data/lib/roby/actions/models/action.rb +224 -0
  147. data/lib/roby/actions/models/coordination_action.rb +58 -0
  148. data/lib/roby/actions/models/interface.rb +22 -0
  149. data/lib/roby/actions/models/interface_base.rb +294 -0
  150. data/lib/roby/actions/models/library.rb +12 -0
  151. data/lib/roby/actions/models/method_action.rb +90 -0
  152. data/lib/roby/actions/task.rb +114 -0
  153. data/lib/roby/and_generator.rb +125 -0
  154. data/lib/roby/app.rb +2795 -829
  155. data/lib/roby/app/autotest_console_reporter.rb +138 -0
  156. data/lib/roby/app/base.rb +21 -0
  157. data/lib/roby/app/cucumber.rb +2 -0
  158. data/lib/roby/app/cucumber/controller.rb +439 -0
  159. data/lib/roby/app/cucumber/helpers.rb +280 -0
  160. data/lib/roby/app/cucumber/world.rb +32 -0
  161. data/lib/roby/app/debug.rb +136 -0
  162. data/lib/roby/app/gen.rb +2 -0
  163. data/lib/roby/app/rake.rb +178 -38
  164. data/lib/roby/app/robot_config.rb +9 -0
  165. data/lib/roby/app/robot_names.rb +115 -0
  166. data/lib/roby/app/run.rb +3 -2
  167. data/lib/roby/app/scripts.rb +72 -0
  168. data/lib/roby/app/scripts/autotest.rb +173 -0
  169. data/lib/roby/app/scripts/display.rb +2 -0
  170. data/lib/roby/app/scripts/restart.rb +52 -0
  171. data/lib/roby/app/scripts/results.rb +17 -8
  172. data/lib/roby/app/scripts/run.rb +155 -24
  173. data/lib/roby/app/scripts/shell.rb +147 -62
  174. data/lib/roby/app/scripts/test.rb +107 -22
  175. data/lib/roby/app/test_reporter.rb +74 -0
  176. data/lib/roby/app/test_server.rb +159 -0
  177. data/lib/roby/app/vagrant.rb +47 -0
  178. data/lib/roby/backports.rb +16 -0
  179. data/lib/roby/cli/display.rb +190 -0
  180. data/lib/roby/cli/exceptions.rb +17 -0
  181. data/lib/roby/cli/gen/actions/class.rb +5 -0
  182. data/lib/roby/cli/gen/actions/test.rb +6 -0
  183. data/lib/roby/cli/gen/app/.yardopts +6 -0
  184. data/lib/roby/cli/gen/app/README.md +28 -0
  185. data/lib/roby/cli/gen/app/Rakefile +15 -0
  186. data/{app → lib/roby/cli/gen/app}/config/app.yml +29 -39
  187. data/lib/roby/cli/gen/app/models/.gitattributes +1 -0
  188. data/{app → lib/roby/cli/gen/app/scripts}/controllers/.gitattributes +0 -0
  189. data/{app/data/.gitattributes → lib/roby/cli/gen/app/test/.gitignore} +0 -0
  190. data/lib/roby/cli/gen/class/class.rb +6 -0
  191. data/lib/roby/cli/gen/class/test.rb +7 -0
  192. data/lib/roby/cli/gen/helpers.rb +203 -0
  193. data/lib/roby/cli/gen/module/module.rb +5 -0
  194. data/lib/roby/cli/gen/module/test.rb +6 -0
  195. data/lib/roby/cli/gen/roby_app/config/init.rb +17 -0
  196. data/lib/roby/cli/gen/roby_app/config/robots/robot.rb +40 -0
  197. data/lib/roby/cli/gen/task/class.rb +44 -0
  198. data/lib/roby/cli/gen/task/test.rb +6 -0
  199. data/lib/roby/cli/gen_main.rb +120 -0
  200. data/lib/roby/cli/log.rb +276 -0
  201. data/lib/roby/cli/log/flamegraph.html +499 -0
  202. data/lib/roby/cli/log/flamegraph_renderer.rb +88 -0
  203. data/lib/roby/cli/main.rb +153 -0
  204. data/lib/roby/coordination.rb +60 -0
  205. data/lib/roby/coordination/action_script.rb +25 -0
  206. data/lib/roby/coordination/action_state_machine.rb +125 -0
  207. data/lib/roby/coordination/actions.rb +106 -0
  208. data/lib/roby/coordination/base.rb +145 -0
  209. data/lib/roby/coordination/calculus.rb +40 -0
  210. data/lib/roby/coordination/child.rb +28 -0
  211. data/lib/roby/coordination/event.rb +29 -0
  212. data/lib/roby/coordination/fault_handler.rb +25 -0
  213. data/lib/roby/coordination/fault_handling_task.rb +13 -0
  214. data/lib/roby/coordination/fault_response_table.rb +110 -0
  215. data/lib/roby/coordination/models/action_script.rb +64 -0
  216. data/lib/roby/coordination/models/action_state_machine.rb +224 -0
  217. data/lib/roby/coordination/models/actions.rb +191 -0
  218. data/lib/roby/coordination/models/arguments.rb +55 -0
  219. data/lib/roby/coordination/models/base.rb +176 -0
  220. data/lib/roby/coordination/models/capture.rb +86 -0
  221. data/lib/roby/coordination/models/child.rb +35 -0
  222. data/lib/roby/coordination/models/event.rb +41 -0
  223. data/lib/roby/coordination/models/exceptions.rb +42 -0
  224. data/lib/roby/coordination/models/fault_handler.rb +219 -0
  225. data/lib/roby/coordination/models/fault_response_table.rb +77 -0
  226. data/lib/roby/coordination/models/root.rb +22 -0
  227. data/lib/roby/coordination/models/script.rb +283 -0
  228. data/lib/roby/coordination/models/task.rb +184 -0
  229. data/lib/roby/coordination/models/task_from_action.rb +50 -0
  230. data/lib/roby/coordination/models/task_from_as_plan.rb +33 -0
  231. data/lib/roby/coordination/models/task_from_instanciation_object.rb +31 -0
  232. data/lib/roby/coordination/models/task_from_variable.rb +27 -0
  233. data/lib/roby/coordination/models/task_with_dependencies.rb +48 -0
  234. data/lib/roby/coordination/models/variable.rb +32 -0
  235. data/lib/roby/coordination/script.rb +200 -0
  236. data/lib/roby/coordination/script_instruction.rb +12 -0
  237. data/lib/roby/coordination/task.rb +45 -0
  238. data/lib/roby/coordination/task_base.rb +69 -0
  239. data/lib/roby/coordination/task_script.rb +293 -0
  240. data/lib/roby/coordination/task_state_machine.rb +308 -0
  241. data/lib/roby/decision_control.rb +33 -21
  242. data/lib/roby/distributed_object.rb +76 -0
  243. data/lib/roby/droby.rb +17 -0
  244. data/lib/roby/droby/droby_id.rb +6 -0
  245. data/lib/roby/droby/enable.rb +153 -0
  246. data/lib/roby/droby/event_logger.rb +189 -0
  247. data/lib/roby/droby/event_logging.rb +57 -0
  248. data/lib/roby/droby/exceptions.rb +14 -0
  249. data/lib/roby/droby/identifiable.rb +22 -0
  250. data/lib/roby/droby/logfile.rb +141 -0
  251. data/lib/roby/droby/logfile/client.rb +176 -0
  252. data/lib/roby/droby/logfile/file_format.md +97 -0
  253. data/lib/roby/droby/logfile/index.rb +117 -0
  254. data/lib/roby/droby/logfile/reader.rb +139 -0
  255. data/lib/roby/droby/logfile/server.rb +199 -0
  256. data/lib/roby/droby/logfile/writer.rb +114 -0
  257. data/lib/roby/droby/marshal.rb +264 -0
  258. data/lib/roby/droby/marshallable.rb +12 -0
  259. data/lib/roby/droby/null_event_logger.rb +25 -0
  260. data/lib/roby/droby/object_manager.rb +205 -0
  261. data/lib/roby/droby/peer_id.rb +6 -0
  262. data/lib/roby/droby/plan_rebuilder.rb +373 -0
  263. data/lib/roby/droby/rebuilt_plan.rb +160 -0
  264. data/lib/roby/droby/remote_droby_id.rb +6 -0
  265. data/lib/roby/droby/timepoints.rb +205 -0
  266. data/lib/roby/droby/timepoints_ctf.metadata.erb +101 -0
  267. data/lib/roby/droby/timepoints_ctf.rb +125 -0
  268. data/lib/roby/droby/v5.rb +14 -0
  269. data/lib/roby/droby/v5/builtin.rb +120 -0
  270. data/lib/roby/droby/v5/droby_class.rb +45 -0
  271. data/lib/roby/droby/v5/droby_constant.rb +81 -0
  272. data/lib/roby/droby/v5/droby_dump.rb +1026 -0
  273. data/lib/roby/droby/v5/droby_id.rb +44 -0
  274. data/lib/roby/droby/v5/droby_model.rb +82 -0
  275. data/lib/roby/droby/v5/peer_id.rb +10 -0
  276. data/lib/roby/droby/v5/remote_droby_id.rb +42 -0
  277. data/lib/roby/event.rb +79 -957
  278. data/lib/roby/event_constraints.rb +835 -0
  279. data/lib/roby/event_generator.rb +1047 -0
  280. data/lib/roby/event_structure/causal_link.rb +6 -0
  281. data/lib/roby/event_structure/forwarding.rb +6 -0
  282. data/lib/roby/event_structure/precedence.rb +7 -0
  283. data/lib/roby/event_structure/signal.rb +8 -0
  284. data/lib/roby/event_structure/temporal_constraints.rb +640 -0
  285. data/lib/roby/exceptions.rb +446 -152
  286. data/lib/roby/executable_plan.rb +549 -0
  287. data/lib/roby/execution_engine.rb +1997 -950
  288. data/lib/roby/filter_generator.rb +26 -0
  289. data/lib/roby/gui/chronicle_view.rb +225 -0
  290. data/lib/roby/gui/chronicle_widget.rb +925 -0
  291. data/lib/roby/gui/dot_id.rb +11 -0
  292. data/lib/roby/gui/exception_view.rb +44 -0
  293. data/lib/roby/gui/log_display.rb +273 -0
  294. data/lib/roby/gui/model_views.rb +2 -0
  295. data/lib/roby/gui/model_views/action_interface.rb +53 -0
  296. data/lib/roby/gui/model_views/task.rb +47 -0
  297. data/lib/roby/gui/model_views/task.rhtml +41 -0
  298. data/lib/roby/gui/object_info_view.rb +89 -0
  299. data/lib/roby/gui/plan_dot_layout.rb +427 -0
  300. data/lib/roby/gui/plan_rebuilder_widget.rb +357 -0
  301. data/lib/roby/gui/qt4_toMSecsSinceEpoch.rb +8 -0
  302. data/lib/roby/gui/relations_view.rb +278 -0
  303. data/lib/roby/gui/relations_view/relations.ui +139 -0
  304. data/lib/roby/gui/relations_view/relations_canvas.rb +1088 -0
  305. data/lib/roby/gui/relations_view/relations_config.rb +292 -0
  306. data/lib/roby/gui/relations_view/relations_view.ui +53 -0
  307. data/lib/roby/gui/scheduler_view.css +24 -0
  308. data/lib/roby/gui/scheduler_view.rb +46 -0
  309. data/lib/roby/gui/scheduler_view.rhtml +53 -0
  310. data/lib/roby/gui/stepping.rb +93 -0
  311. data/lib/roby/gui/stepping.ui +181 -0
  312. data/lib/roby/gui/styles.rb +81 -0
  313. data/lib/roby/gui/task_display_configuration.rb +42 -0
  314. data/lib/roby/gui/task_state_at.rb +38 -0
  315. data/lib/roby/hooks.rb +26 -0
  316. data/lib/roby/interface.rb +136 -469
  317. data/lib/roby/interface/async.rb +20 -0
  318. data/lib/roby/interface/async/action_monitor.rb +188 -0
  319. data/lib/roby/interface/async/interface.rb +498 -0
  320. data/lib/roby/interface/async/job_monitor.rb +213 -0
  321. data/lib/roby/interface/async/log.rb +238 -0
  322. data/lib/roby/interface/async/new_job_listener.rb +79 -0
  323. data/lib/roby/interface/async/ui_connector.rb +183 -0
  324. data/lib/roby/interface/client.rb +553 -0
  325. data/lib/roby/interface/command.rb +24 -0
  326. data/lib/roby/interface/command_argument.rb +16 -0
  327. data/lib/roby/interface/command_library.rb +92 -0
  328. data/lib/roby/interface/droby_channel.rb +174 -0
  329. data/lib/roby/interface/exceptions.rb +22 -0
  330. data/lib/roby/interface/interface.rb +655 -0
  331. data/lib/roby/interface/job.rb +47 -0
  332. data/lib/roby/interface/rest.rb +10 -0
  333. data/lib/roby/interface/rest/api.rb +29 -0
  334. data/lib/roby/interface/rest/helpers.rb +24 -0
  335. data/lib/roby/interface/rest/server.rb +212 -0
  336. data/lib/roby/interface/server.rb +154 -0
  337. data/lib/roby/interface/shell_client.rb +468 -0
  338. data/lib/roby/interface/shell_subcommand.rb +24 -0
  339. data/lib/roby/interface/subcommand_client.rb +35 -0
  340. data/lib/roby/interface/tcp.rb +168 -0
  341. data/lib/roby/models/arguments.rb +112 -0
  342. data/lib/roby/models/plan_object.rb +83 -0
  343. data/lib/roby/models/task.rb +835 -0
  344. data/lib/roby/models/task_event.rb +62 -0
  345. data/lib/roby/models/task_service.rb +78 -0
  346. data/lib/roby/or_generator.rb +88 -0
  347. data/lib/roby/plan.rb +1751 -864
  348. data/lib/roby/plan_object.rb +611 -0
  349. data/lib/roby/plan_service.rb +200 -0
  350. data/lib/roby/promise.rb +332 -0
  351. data/lib/roby/queries.rb +23 -0
  352. data/lib/roby/queries/and_matcher.rb +32 -0
  353. data/lib/roby/queries/any.rb +27 -0
  354. data/lib/roby/queries/code_error_matcher.rb +58 -0
  355. data/lib/roby/queries/event_generator_matcher.rb +9 -0
  356. data/lib/roby/queries/execution_exception_matcher.rb +165 -0
  357. data/lib/roby/queries/index.rb +165 -0
  358. data/lib/roby/queries/localized_error_matcher.rb +149 -0
  359. data/lib/roby/queries/matcher_base.rb +107 -0
  360. data/lib/roby/queries/none.rb +27 -0
  361. data/lib/roby/queries/not_matcher.rb +30 -0
  362. data/lib/roby/queries/op_matcher.rb +8 -0
  363. data/lib/roby/queries/or_matcher.rb +30 -0
  364. data/lib/roby/queries/plan_object_matcher.rb +363 -0
  365. data/lib/roby/queries/query.rb +188 -0
  366. data/lib/roby/queries/task_event_generator_matcher.rb +86 -0
  367. data/lib/roby/queries/task_matcher.rb +344 -0
  368. data/lib/roby/relations.rb +42 -678
  369. data/lib/roby/relations/bidirectional_directed_adjacency_graph.rb +492 -0
  370. data/lib/roby/relations/directed_relation_support.rb +268 -0
  371. data/lib/roby/relations/event_relation_graph.rb +19 -0
  372. data/lib/roby/relations/fork_merge_visitor.rb +154 -0
  373. data/lib/roby/relations/graph.rb +533 -0
  374. data/lib/roby/relations/models/directed_relation_support.rb +11 -0
  375. data/lib/roby/relations/models/graph.rb +75 -0
  376. data/lib/roby/relations/models/task_relation_graph.rb +18 -0
  377. data/lib/roby/relations/space.rb +380 -0
  378. data/lib/roby/relations/task_relation_graph.rb +20 -0
  379. data/lib/roby/robot.rb +85 -38
  380. data/lib/roby/schedulers/basic.rb +155 -25
  381. data/lib/roby/schedulers/null.rb +20 -0
  382. data/lib/roby/schedulers/reporting.rb +31 -0
  383. data/lib/roby/schedulers/state.rb +129 -0
  384. data/lib/roby/schedulers/temporal.rb +91 -0
  385. data/lib/roby/singletons.rb +87 -0
  386. data/lib/roby/standalone.rb +4 -2
  387. data/lib/roby/standard_errors.rb +405 -82
  388. data/lib/roby/state.rb +6 -3
  389. data/lib/roby/state/conf_model.rb +5 -0
  390. data/lib/roby/state/events.rb +181 -95
  391. data/lib/roby/state/goal_model.rb +77 -0
  392. data/lib/roby/state/open_struct.rb +591 -0
  393. data/lib/roby/state/open_struct_model.rb +68 -0
  394. data/lib/roby/state/pos.rb +45 -45
  395. data/lib/roby/state/shapes.rb +11 -11
  396. data/lib/roby/state/state_model.rb +303 -0
  397. data/lib/roby/state/task.rb +43 -0
  398. data/lib/roby/support.rb +88 -148
  399. data/lib/roby/task.rb +1361 -1750
  400. data/lib/roby/task_arguments.rb +428 -0
  401. data/lib/roby/task_event.rb +127 -0
  402. data/lib/roby/task_event_generator.rb +337 -0
  403. data/lib/roby/task_service.rb +6 -0
  404. data/lib/roby/task_structure/conflicts.rb +104 -0
  405. data/lib/roby/task_structure/dependency.rb +932 -0
  406. data/lib/roby/task_structure/error_handling.rb +118 -0
  407. data/lib/roby/task_structure/executed_by.rb +234 -0
  408. data/lib/roby/task_structure/planned_by.rb +90 -0
  409. data/lib/roby/tasks/aggregator.rb +37 -0
  410. data/lib/roby/tasks/external_process.rb +275 -0
  411. data/lib/roby/tasks/group.rb +27 -0
  412. data/lib/roby/tasks/null.rb +19 -0
  413. data/lib/roby/tasks/parallel.rb +43 -0
  414. data/lib/roby/tasks/sequence.rb +88 -0
  415. data/lib/roby/tasks/simple.rb +21 -0
  416. data/lib/roby/{thread_task.rb → tasks/thread.rb} +50 -24
  417. data/lib/roby/tasks/timeout.rb +17 -0
  418. data/lib/roby/tasks/virtual.rb +55 -0
  419. data/lib/roby/template_plan.rb +7 -0
  420. data/lib/roby/test/aruba_minitest.rb +74 -0
  421. data/lib/roby/test/assertion.rb +16 -0
  422. data/lib/roby/test/assertions.rb +490 -0
  423. data/lib/roby/test/common.rb +368 -591
  424. data/lib/roby/test/dsl.rb +149 -0
  425. data/lib/roby/test/error.rb +18 -0
  426. data/lib/roby/test/event_reporter.rb +83 -0
  427. data/lib/roby/test/execution_expectations.rb +1134 -0
  428. data/lib/roby/test/expect_execution.rb +151 -0
  429. data/lib/roby/test/minitest_helpers.rb +166 -0
  430. data/lib/roby/test/roby_app_helpers.rb +200 -0
  431. data/lib/roby/test/run_planners.rb +155 -0
  432. data/lib/roby/test/self.rb +112 -0
  433. data/lib/roby/test/spec.rb +198 -0
  434. data/lib/roby/test/tasks/empty_task.rb +4 -4
  435. data/lib/roby/test/tasks/goto.rb +28 -27
  436. data/lib/roby/test/teardown_plans.rb +100 -0
  437. data/lib/roby/test/testcase.rb +239 -307
  438. data/lib/roby/test/tools.rb +159 -155
  439. data/lib/roby/test/validate_state_machine.rb +75 -0
  440. data/lib/roby/transaction.rb +1125 -0
  441. data/lib/roby/transaction/event_generator_proxy.rb +63 -0
  442. data/lib/roby/transaction/plan_object_proxy.rb +99 -0
  443. data/lib/roby/transaction/plan_service_proxy.rb +43 -0
  444. data/lib/roby/transaction/proxying.rb +120 -0
  445. data/lib/roby/transaction/task_event_generator_proxy.rb +19 -0
  446. data/lib/roby/transaction/task_proxy.rb +135 -0
  447. data/lib/roby/until_generator.rb +30 -0
  448. data/lib/roby/version.rb +5 -0
  449. data/lib/roby/yard.rb +169 -0
  450. data/lib/yard-roby.rb +1 -0
  451. data/manifest.xml +32 -6
  452. data/roby.gemspec +59 -0
  453. metadata +788 -587
  454. data/Manifest.txt +0 -321
  455. data/NOTES +0 -4
  456. data/README.txt +0 -166
  457. data/TODO.txt +0 -146
  458. data/app/README.txt +0 -24
  459. data/app/Rakefile +0 -8
  460. data/app/config/ROBOT.rb +0 -5
  461. data/app/config/init.rb +0 -33
  462. data/app/config/roby.yml +0 -3
  463. data/app/controllers/ROBOT.rb +0 -2
  464. data/app/planners/ROBOT/main.rb +0 -6
  465. data/app/planners/main.rb +0 -5
  466. data/app/scripts/distributed +0 -3
  467. data/app/scripts/generate/bookmarks +0 -3
  468. data/app/scripts/replay +0 -3
  469. data/app/scripts/results +0 -3
  470. data/app/scripts/run +0 -3
  471. data/app/scripts/server +0 -3
  472. data/app/scripts/shell +0 -3
  473. data/app/scripts/test +0 -3
  474. data/app/tasks/.gitattributes +0 -0
  475. data/app/tasks/ROBOT/.gitattributes +0 -0
  476. data/bin/roby-shell +0 -25
  477. data/doc/guide/src/basics/app.page +0 -139
  478. data/doc/guide/src/basics/index.page +0 -11
  479. data/doc/guide/src/basics/log_replay/goForward_1.png +0 -0
  480. data/doc/guide/src/basics/log_replay/goForward_2.png +0 -0
  481. data/doc/guide/src/basics/log_replay/goForward_3.png +0 -0
  482. data/doc/guide/src/basics/log_replay/goForward_5.png +0 -0
  483. data/doc/guide/src/basics/log_replay/plan_repair_4.png +0 -0
  484. data/doc/guide/src/basics/log_replay/roby_log_main_window.png +0 -0
  485. data/doc/guide/src/basics/relations_display.page +0 -203
  486. data/doc/guide/src/basics/shell.page +0 -102
  487. data/doc/guide/src/default.css +0 -319
  488. data/doc/guide/src/introduction/index.page +0 -29
  489. data/doc/guide/src/introduction/publications.page +0 -14
  490. data/doc/guide/src/relations/dependency.page +0 -89
  491. data/doc/guide/src/relations/index.page +0 -12
  492. data/ext/droby/dump.cc +0 -175
  493. data/ext/droby/extconf.rb +0 -3
  494. data/ext/graph/algorithm.cc +0 -746
  495. data/ext/graph/extconf.rb +0 -7
  496. data/ext/graph/graph.cc +0 -575
  497. data/ext/graph/graph.hh +0 -183
  498. data/ext/graph/iterator_sequence.hh +0 -102
  499. data/ext/graph/undirected_dfs.hh +0 -226
  500. data/ext/graph/undirected_graph.hh +0 -421
  501. data/lib/roby/app/scripts/generate/bookmarks.rb +0 -162
  502. data/lib/roby/app/scripts/replay.rb +0 -31
  503. data/lib/roby/app/scripts/server.rb +0 -18
  504. data/lib/roby/basic_object.rb +0 -151
  505. data/lib/roby/config.rb +0 -14
  506. data/lib/roby/distributed.rb +0 -36
  507. data/lib/roby/distributed/base.rb +0 -448
  508. data/lib/roby/distributed/communication.rb +0 -875
  509. data/lib/roby/distributed/connection_space.rb +0 -616
  510. data/lib/roby/distributed/distributed_object.rb +0 -206
  511. data/lib/roby/distributed/drb.rb +0 -62
  512. data/lib/roby/distributed/notifications.rb +0 -531
  513. data/lib/roby/distributed/peer.rb +0 -555
  514. data/lib/roby/distributed/protocol.rb +0 -529
  515. data/lib/roby/distributed/proxy.rb +0 -343
  516. data/lib/roby/distributed/subscription.rb +0 -311
  517. data/lib/roby/distributed/transaction.rb +0 -498
  518. data/lib/roby/external_process_task.rb +0 -225
  519. data/lib/roby/graph.rb +0 -160
  520. data/lib/roby/log.rb +0 -3
  521. data/lib/roby/log/chronicle.rb +0 -303
  522. data/lib/roby/log/console.rb +0 -74
  523. data/lib/roby/log/data_stream.rb +0 -275
  524. data/lib/roby/log/dot.rb +0 -279
  525. data/lib/roby/log/event_stream.rb +0 -161
  526. data/lib/roby/log/file.rb +0 -396
  527. data/lib/roby/log/gui/basic_display.ui +0 -83
  528. data/lib/roby/log/gui/basic_display_ui.rb +0 -89
  529. data/lib/roby/log/gui/chronicle.rb +0 -26
  530. data/lib/roby/log/gui/chronicle_view.rb +0 -40
  531. data/lib/roby/log/gui/chronicle_view.ui +0 -70
  532. data/lib/roby/log/gui/chronicle_view_ui.rb +0 -90
  533. data/lib/roby/log/gui/data_displays.rb +0 -171
  534. data/lib/roby/log/gui/data_displays.ui +0 -155
  535. data/lib/roby/log/gui/data_displays_ui.rb +0 -146
  536. data/lib/roby/log/gui/notifications.rb +0 -26
  537. data/lib/roby/log/gui/relations.rb +0 -269
  538. data/lib/roby/log/gui/relations.ui +0 -123
  539. data/lib/roby/log/gui/relations_ui.rb +0 -120
  540. data/lib/roby/log/gui/relations_view.rb +0 -185
  541. data/lib/roby/log/gui/relations_view.ui +0 -149
  542. data/lib/roby/log/gui/relations_view_ui.rb +0 -144
  543. data/lib/roby/log/gui/replay.rb +0 -366
  544. data/lib/roby/log/gui/replay_controls.rb +0 -206
  545. data/lib/roby/log/gui/replay_controls.ui +0 -282
  546. data/lib/roby/log/gui/replay_controls_ui.rb +0 -249
  547. data/lib/roby/log/gui/runtime.rb +0 -130
  548. data/lib/roby/log/hooks.rb +0 -186
  549. data/lib/roby/log/logger.rb +0 -203
  550. data/lib/roby/log/notifications.rb +0 -244
  551. data/lib/roby/log/plan_rebuilder.rb +0 -468
  552. data/lib/roby/log/relations.rb +0 -1084
  553. data/lib/roby/log/server.rb +0 -547
  554. data/lib/roby/log/sqlite.rb +0 -47
  555. data/lib/roby/log/timings.rb +0 -233
  556. data/lib/roby/plan-object.rb +0 -371
  557. data/lib/roby/planning.rb +0 -13
  558. data/lib/roby/planning/loops.rb +0 -309
  559. data/lib/roby/planning/model.rb +0 -1012
  560. data/lib/roby/planning/task.rb +0 -180
  561. data/lib/roby/query.rb +0 -655
  562. data/lib/roby/relations/conflicts.rb +0 -67
  563. data/lib/roby/relations/dependency.rb +0 -358
  564. data/lib/roby/relations/ensured.rb +0 -19
  565. data/lib/roby/relations/error_handling.rb +0 -22
  566. data/lib/roby/relations/events.rb +0 -7
  567. data/lib/roby/relations/executed_by.rb +0 -208
  568. data/lib/roby/relations/influence.rb +0 -10
  569. data/lib/roby/relations/planned_by.rb +0 -63
  570. data/lib/roby/state/information.rb +0 -55
  571. data/lib/roby/state/state.rb +0 -367
  572. data/lib/roby/task-operations.rb +0 -186
  573. data/lib/roby/task_index.rb +0 -80
  574. data/lib/roby/test/distributed.rb +0 -230
  575. data/lib/roby/test/tasks/simple_task.rb +0 -23
  576. data/lib/roby/transactions.rb +0 -507
  577. data/lib/roby/transactions/proxy.rb +0 -325
  578. data/plugins/fault_injection/History.txt +0 -4
  579. data/plugins/fault_injection/README.txt +0 -34
  580. data/plugins/fault_injection/Rakefile +0 -12
  581. data/plugins/fault_injection/TODO.txt +0 -0
  582. data/plugins/fault_injection/app.rb +0 -52
  583. data/plugins/fault_injection/fault_injection.rb +0 -89
  584. data/plugins/fault_injection/test/test_fault_injection.rb +0 -78
  585. data/plugins/subsystems/README.txt +0 -37
  586. data/plugins/subsystems/Rakefile +0 -13
  587. data/plugins/subsystems/app.rb +0 -182
  588. data/plugins/subsystems/test/app/README +0 -24
  589. data/plugins/subsystems/test/app/Rakefile +0 -8
  590. data/plugins/subsystems/test/app/config/app.yml +0 -71
  591. data/plugins/subsystems/test/app/config/init.rb +0 -12
  592. data/plugins/subsystems/test/app/config/roby.yml +0 -3
  593. data/plugins/subsystems/test/app/planners/main.rb +0 -20
  594. data/plugins/subsystems/test/app/scripts/distributed +0 -3
  595. data/plugins/subsystems/test/app/scripts/replay +0 -3
  596. data/plugins/subsystems/test/app/scripts/results +0 -3
  597. data/plugins/subsystems/test/app/scripts/run +0 -3
  598. data/plugins/subsystems/test/app/scripts/server +0 -3
  599. data/plugins/subsystems/test/app/scripts/shell +0 -3
  600. data/plugins/subsystems/test/app/scripts/test +0 -3
  601. data/plugins/subsystems/test/app/tasks/services.rb +0 -15
  602. data/plugins/subsystems/test/test_subsystems.rb +0 -78
  603. data/test/distributed/test_communication.rb +0 -195
  604. data/test/distributed/test_connection.rb +0 -284
  605. data/test/distributed/test_execution.rb +0 -378
  606. data/test/distributed/test_mixed_plan.rb +0 -341
  607. data/test/distributed/test_plan_notifications.rb +0 -238
  608. data/test/distributed/test_protocol.rb +0 -525
  609. data/test/distributed/test_query.rb +0 -106
  610. data/test/distributed/test_remote_plan.rb +0 -491
  611. data/test/distributed/test_transaction.rb +0 -466
  612. data/test/mockups/external_process +0 -28
  613. data/test/mockups/tasks.rb +0 -27
  614. data/test/planning/test_loops.rb +0 -432
  615. data/test/planning/test_model.rb +0 -427
  616. data/test/planning/test_task.rb +0 -126
  617. data/test/relations/test_conflicts.rb +0 -42
  618. data/test/relations/test_dependency.rb +0 -324
  619. data/test/relations/test_ensured.rb +0 -38
  620. data/test/relations/test_executed_by.rb +0 -224
  621. data/test/relations/test_planned_by.rb +0 -56
  622. data/test/suite_core.rb +0 -29
  623. data/test/suite_distributed.rb +0 -10
  624. data/test/suite_planning.rb +0 -4
  625. data/test/suite_relations.rb +0 -8
  626. data/test/tasks/test_external_process.rb +0 -126
  627. data/test/tasks/test_thread_task.rb +0 -70
  628. data/test/test_bgl.rb +0 -528
  629. data/test/test_event.rb +0 -969
  630. data/test/test_exceptions.rb +0 -591
  631. data/test/test_execution_engine.rb +0 -987
  632. data/test/test_gui.rb +0 -20
  633. data/test/test_interface.rb +0 -43
  634. data/test/test_log.rb +0 -125
  635. data/test/test_log_server.rb +0 -133
  636. data/test/test_plan.rb +0 -418
  637. data/test/test_query.rb +0 -424
  638. data/test/test_relations.rb +0 -260
  639. data/test/test_state.rb +0 -432
  640. data/test/test_support.rb +0 -16
  641. data/test/test_task.rb +0 -1181
  642. data/test/test_testcase.rb +0 -138
  643. data/test/test_transactions.rb +0 -610
  644. data/test/test_transactions_proxy.rb +0 -216
@@ -1,875 +0,0 @@
1
- module Roby
2
- module Distributed
3
- # Error raised when a connection attempt failed on the given neighbour
4
- class ConnectionFailed < RuntimeError
5
- attr_reader :neighbour
6
-
7
- def initialize(neighbour)
8
- @neighbour = neighbour
9
- end
10
- end
11
-
12
- class Peer
13
- class << self
14
- private :new
15
- end
16
-
17
- # ConnectionToken objects are used to sort out concurrent
18
- # connections, i.e. cases where two peers are trying to initiate a
19
- # connection with each other at the same time.
20
- #
21
- # When this situation appears, each peer compares its own token
22
- # with the one sent by the remote peer. The greatest token wins and
23
- # is considered the initiator of the connection.
24
- #
25
- # See #initiate_connection
26
- class ConnectionToken
27
- attr_reader :time, :value
28
- def initialize
29
- @time = Time.now
30
- @value = rand
31
- end
32
- def <=>(other)
33
- result = (time <=> other.time)
34
- if result == 0
35
- value <=> other.value
36
- else
37
- result
38
- end
39
- end
40
- include Comparable
41
- end
42
-
43
- # A value indicating the current status of the connection. It can
44
- # be one of :connected, :disconnecting, :disconnected
45
- attr_reader :connection_state
46
-
47
- # Connect to +neighbour+ and return the corresponding peer. It is a
48
- # blocking method, so it is an error to call it from within the control thread
49
- def self.connect(neighbour, connection_space = Distributed.state)
50
- Roby.condition_variable(true) do |cv, mutex|
51
- peer = nil
52
- mutex.synchronize do
53
- thread = initiate_connection(connection_space, neighbour) do |peer|
54
- return peer unless thread
55
- end
56
-
57
- begin
58
- mutex.unlock
59
- thread.value
60
- rescue Exception => e
61
- connection_space.synchronize do
62
- connection_space.pending_connections.delete(neighbour.remote_id)
63
- end
64
- raise ConnectionFailed.new(neighbour), e.message
65
- ensure
66
- mutex.lock
67
- end
68
- end
69
- end
70
- end
71
-
72
- # Start connecting to +neighbour+ in an another thread and yield
73
- # the corresponding Peer object. This is safe to call if we have
74
- # already connected to +neighbour+, in which case the already
75
- # existing peer is returned.
76
- #
77
- # The Peer object is yield from within the control thread, only
78
- # when the :ready event of the peer's ConnectionTask has been
79
- # emitted
80
- #
81
- # Returns the connection thread
82
- def self.initiate_connection(connection_space, neighbour, &block)
83
- connection_space.synchronize do
84
- if peer = connection_space.peers[neighbour.remote_id]
85
- # already connected
86
- yield(peer) if block_given?
87
- return
88
- end
89
-
90
- local_token = ConnectionToken.new
91
- call = [:connect, local_token,
92
- connection_space.name,
93
- connection_space.remote_id,
94
- Distributed.format(Roby::State)]
95
- send_connection_request(connection_space, neighbour, call, local_token, &block)
96
- end
97
- end
98
-
99
- def self.abort_connection_thread(connection_space, remote_id, lock = true)
100
- if lock
101
- connection_space.synchronize do
102
- abort_connection_thread(connection_space, remote_id, false)
103
- end
104
- end
105
-
106
- connection_space.pending_connections.delete(remote_id)
107
- if peer = connection_space.peers[remote_id]
108
- begin
109
- connection_space.mutex.unlock
110
- peer.disconnected(:aborted)
111
- ensure
112
- connection_space.mutex.lock
113
- end
114
- end
115
- end
116
-
117
- def self.send_connection_thread(connection_space, neighbour, call, local_token, &block)
118
- remote_id = neighbour.remote_id
119
- Thread.current.abort_on_exception = false
120
-
121
- begin
122
- socket = TCPSocket.new(remote_id.uri, remote_id.ref)
123
- rescue Errno::ECONNRESET, Errno::ECONNREFUSED
124
- abort_connection_thread(connection_space, remote_id)
125
- return
126
- end
127
-
128
- begin
129
- socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
130
- Distributed.debug "#{call[0]}: #{neighbour} on #{socket.peer_info}"
131
-
132
- # Send the connection request
133
- call = Marshal.dump(call)
134
- socket.write [call.size].pack("N")
135
- socket.write call
136
-
137
- reply_size = socket.read(4)
138
- if !reply_size
139
- raise "peer disconnected"
140
- end
141
- reply = Marshal.load(socket.read(*reply_size.unpack("N")))
142
- rescue Errno::ECONNRESET, Errno::ENOTCONN
143
- abort_connection_thread(connection_space, remote_id)
144
- return
145
- end
146
-
147
- connection_space.synchronize do
148
- connection_space.pending_connections.delete(remote_id)
149
- m = reply.shift
150
- Roby::Distributed.debug "remote peer #{m}"
151
-
152
- # if the remote peer is also connecting, and if its
153
- # token is better than our own, m will be nil and thus
154
- # the thread will finish without doing anything
155
-
156
- case m
157
- when :connected
158
- peer = new(connection_space, socket, *reply)
159
- when :reconnected
160
- peer = connection_space.peers[remote_id]
161
- peer.reconnected(socket)
162
- when :aborted
163
- abort_connection_thread(connection_space, remote_id, false)
164
- return
165
- when :already_connecting, :already_connected
166
- peer = connection_space.peers[remote_id]
167
- end
168
-
169
- yield(peer) if peer && block_given?
170
- peer
171
- end
172
- end
173
-
174
- # Generic handling of connection/reconnection initiated by this side
175
- def self.send_connection_request(connection_space, neighbour, call, local_token, &block) # :nodoc:
176
- remote_id = neighbour.remote_id
177
- token, connecting_thread = connection_space.pending_connections[remote_id]
178
- if token
179
- # we are already connecting to the peer, check the connection token
180
- peer = begin
181
- connection_space.mutex.unlock
182
- connecting_thread.value
183
- ensure
184
- connection_space.mutex.lock
185
- end
186
-
187
- if token < local_token
188
- if !peer
189
- raise "something went wrong during connection: got nil peer with better token"
190
- end
191
- yield(peer) if block_given?
192
- return
193
- end
194
- end
195
-
196
-
197
- connecting_thread = Thread.new do
198
- send_connection_thread(connection_space, neighbour, call, local_token, &block)
199
- end
200
- connection_space.pending_connections[remote_id] = [local_token, connecting_thread]
201
- connecting_thread
202
- end
203
-
204
- # Create a Peer object for a connection attempt on the server
205
- # socket There is nothing to do here. The remote peer is supposed
206
- # to send us a #connect message, after which we can assume that the
207
- # connection is up
208
- def self.connection_request(connection_space, socket)
209
- socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
210
-
211
- # read connection info from +socket+
212
- info_size = *socket.read(4).unpack("N")
213
- m, remote_token, remote_name, remote_id, remote_state =
214
- Marshal.load(socket.read(info_size))
215
-
216
- Distributed.debug "connection attempt from #{socket}: #{m} #{remote_name} #{remote_id}"
217
-
218
- connection_space.synchronize do
219
- # Now check the connection status
220
- if old_peer = connection_space.aborted_connections.delete(remote_id)
221
- reply = [:aborted]
222
- elsif m == :connect && peer = connection_space.peers[remote_id]
223
- reply = [:already_connected]
224
- else
225
- token, connecting_thread = connection_space.pending_connections[remote_id]
226
- if token && token < remote_token
227
- if connecting_thread
228
- begin
229
- connection_space.mutex.unlock
230
- connecting_thread.join
231
- ensure
232
- connection_space.mutex.lock
233
- end
234
- end
235
- reply = [:already_connecting]
236
- elsif m == :reconnect
237
- peer = connection_space.peers[remote_id]
238
- peer.reconnected(socket)
239
- reply = [:reconnected]
240
- else
241
- peer = new(connection_space, socket, remote_name, remote_id, remote_state)
242
- reply = [:connected, connection_space.name,
243
- connection_space.remote_id,
244
- Distributed.format(Roby::State)]
245
- end
246
- end
247
-
248
- Distributed.debug "connection attempt from #{socket}: #{reply[0]}"
249
- reply = Marshal.dump(reply)
250
- socket.write [reply.size].pack("N")
251
- socket.write reply
252
- end
253
- end
254
-
255
- # Reconnect to the given peer after the socket closed
256
- def reconnect
257
- local_token = ConnectionToken.new
258
-
259
- connection_space.synchronize do
260
- call = [:reconnect, local_token, connection_space.name, connection_space.remote_id]
261
- Peer.send_connection_request(connection_space, self, call, local_token)
262
- end
263
- end
264
-
265
- # Called when we managed to reconnect to our peer. +socket+ is the new communication socket
266
- def reconnected(socket)
267
- Roby::Distributed.debug "new socket for #{self}: #{socket.peer_info}"
268
- connection_space.pending_sockets << [socket, self]
269
- @socket = socket
270
- end
271
-
272
- # Normal disconnection procedure.
273
- #
274
- # The procedure is as follows:
275
- # * we set the connection state as 'disconnecting'. This disables all
276
- # notifications for this peer (see for instance
277
- # Distributed.each_subscribed_peer)
278
- # * we queue the :disconnected message
279
- #
280
- # At this point, we are waiting for the remote peer to do the same:
281
- # send us 'disconnected'. When we receive that message, we put the
282
- # connection into the disconnected state and all transmission is
283
- # forbidden. We make the transmission thread quit then, and the
284
- # 'failed' event is emitted on the ConnectionTask task
285
- #
286
- # Note that once the connection leaves the connected state, the only
287
- # messages allowed by #queue_call are 'completed' and 'disconnected'
288
- def disconnect
289
- synchronize do
290
- Roby::Distributed.info "disconnecting from #{self}"
291
- @connection_state = :disconnecting
292
- end
293
- queue_call false, :disconnect
294
- end
295
-
296
- # +error+ has been raised while we were processing +msg+(*+args+)
297
- # This error cannot be recovered, and the connection to the peer
298
- # will be closed.
299
- #
300
- # This sends the PeerServer#fatal_error message to our peer
301
- def fatal_error(error, msg, args)
302
- synchronize do
303
- Roby::Distributed.fatal "fatal error '#{error.message}' while processing #{msg}(#{args.join(", ")})"
304
- Roby::Distributed.fatal Roby.filter_backtrace(error.backtrace).join("\n ")
305
- @connection_state = :disconnecting
306
- end
307
- queue_call false, :fatal_error, [error, msg, args]
308
- end
309
-
310
- # Called when the peer acknowledged the fact that we disconnected
311
- def disconnected(event = :failed) # :nodoc:
312
- Roby::Distributed.info "#{remote_name} disconnected (#{event})"
313
-
314
- connection_space.synchronize do
315
- Distributed.peers.delete(remote_id)
316
- end
317
-
318
- synchronize do
319
- @connection_state = :disconnected
320
-
321
- if @send_thread && @send_thread != Thread.current
322
- begin
323
- @send_queue.clear
324
- @send_queue.push nil
325
- mutex.unlock
326
- @send_thread.join
327
- ensure
328
- mutex.lock
329
- end
330
- end
331
- @send_thread = nil
332
-
333
- proxies.each_value do |obj|
334
- obj.remote_siblings.delete(self)
335
- end
336
- proxies.clear
337
- removing_proxies.clear
338
-
339
- socket.close unless socket.closed?
340
- end
341
-
342
- engine.once do
343
- task.emit(event)
344
- end
345
- end
346
-
347
- # Call to disconnect outside of the normal protocol.
348
- def disconnected!
349
- connection_space.synchronize do
350
- connection_space.aborted_connections[remote_id] = self
351
- end
352
- disconnected(:aborted)
353
- end
354
-
355
- # Returns true if the connection has been established. See also #link_alive?
356
- def connected?; connection_state == :connected end
357
- # Returns true if the we disconnected on our side but the peer did not
358
- # acknowledge it yet
359
- def disconnecting?; connection_state == :disconnecting end
360
- # Returns true if the connection with this peer has been removed
361
- def disconnected?; connection_state == :disconnected end
362
-
363
- # Mark the link as dead regardless of the last neighbour discovery. This
364
- # will be reset during the next neighbour discovery
365
- def link_dead!; @dead = true end
366
-
367
- # Disables the sending part of the communication link. It is an
368
- # accumulator: if #disable_tx is called twice, then TX will be
369
- # reenabled only when #enable_tx is also called twice.
370
- def disable_tx; @disabled_tx += 1 end
371
- # Enables the sending part of the communication link. It is an
372
- # accumulator: if #enable_tx is called twice, then TX will be
373
- # disabled only when #disable_tx is also called twice.
374
- def enable_tx; @disabled_tx -= 1 end
375
- # True if TX is currently disabled
376
- def disabled_tx?; @disabled_tx > 0 end
377
- # Disables the receiving part of the communication link. It is an
378
- # accumulator: if #disable_rx is called twice, then RX will be
379
- # reenabled only when #enable_rx is also called twice.
380
- def disable_rx; @disabled_rx += 1 end
381
- # Enables the receiving part of the communication link. It is an
382
- # accumulator: if #enable_rx is called twice, then RX will be
383
- # disabled only when #disable_rx is also called twice.
384
- def enable_rx; @disabled_rx -= 1 end
385
- # True if RX is currently disabled
386
- def disabled_rx?; @disabled_rx > 0 end
387
-
388
- # Checks if the connection is currently alive, i.e. if we can send
389
- # data on the link. This does not mean that we currently have no
390
- # interaction with the peer: it only means that we cannot currently
391
- # communicate with it.
392
- def link_alive?
393
- return false if socket.closed? || @dead || @disabled_tx > 0
394
- return false unless !remote_id || connection_space.neighbours.find { |n| n.remote_id == remote_id }
395
- true
396
- end
397
-
398
- end
399
-
400
- class PeerServer
401
- # Message received when an error occured on the remote side, if
402
- # this error cannot be recovered.
403
- def fatal_error(error, msg, args)
404
- Distributed.fatal "remote reports #{peer.local_object(error)} while processing #{msg}(#{args.join(", ")})"
405
- disconnect
406
- end
407
-
408
- # Message received when our peer is closing the connection
409
- def disconnect
410
- peer.disconnected
411
- nil
412
- end
413
- end
414
-
415
- # Error raised when a communication callback is queueing another
416
- # communication callback
417
- class RecursiveCallbacksError < RuntimeError; end
418
- # Error raised when a callback has failed.
419
- class CallbackProcessingError < RuntimeError; end
420
-
421
- CallSpec = Struct.new :is_callback,
422
- :method, :formatted_args, :original_args,
423
- :on_completion, :trace, :waiting_thread,
424
- :message_id
425
-
426
- # The specification of a call in Peer#send_queue and Peer#completion_queue. Note
427
- # that only the #is_callback, #method and #formatted_args are sent to the remote
428
- # PeerServer#demux method
429
- #
430
- # * is_callback is a boolean flag indicating if this call has been
431
- # queued while the PeerServer object was processing a remote request
432
- # * <tt>method</tt> is the method name to call on the remote PeerServer object
433
- # * <tt>formatted_args</tt> is the arguments formatted by
434
- # Distributed.format. Arguments are formatted right away, since we
435
- # want the marshalled arguments to reflect objects state at the
436
- # time of the call, not at the time they are sent
437
- # * +original_args+ is the arguments not yet formatted. They are
438
- # kept here to protect involved object from Ruby's GC until the
439
- # call is completed.
440
- # * +on_completion+ is a proc object which will be called when the
441
- # method has successfully been processed by the remote object, with
442
- # the returned value as argument$
443
- # * trace is the location (as returned by Kernel#caller) from which
444
- # the call has been queued. It is mainly used for debugging
445
- # purposes
446
- # * if +thread+ is not nil, it is the thread which is waiting for
447
- # the call to complete. If the call is aborted, the error will be
448
- # raised in the waiting thread
449
- class CallSpec
450
- alias :callback? :is_callback
451
-
452
- def to_s
453
- args = formatted_args.map do |arg|
454
- if arg.kind_of?(DRbObject) then arg.inspect
455
- else arg.to_s
456
- end
457
- end
458
- "#{method}(#{args.join(", ")})"
459
- end
460
- end
461
-
462
- # Called in PeerServer messages handlers to completely ignore the
463
- # message which is currently being processed
464
- def self.ignore!
465
- throw :ignore_this_call
466
- end
467
-
468
- class PeerServer
469
- # True the current thread is processing a remote request
470
- attr_predicate :processing?, true
471
- # True if the current thread is processing a remote request, and if it is a callback
472
- attr_predicate :processing_callback?, true
473
- # True if we have already queued a +completed+ message for the message being processed
474
- attr_predicate :queued_completion?, true
475
- # The ID of the message we are currently processing
476
- attr_accessor :current_message_id
477
-
478
- # Message received when the first half of a synchro point is
479
- # reached. See Peer#synchro_point.
480
- def synchro_point
481
- peer.transmit(:done_synchro_point)
482
- nil
483
- end
484
- # Message received when the synchro point is finished.
485
- def done_synchro_point; end
486
-
487
- # Message received to describe a group of consecutive calls that
488
- # have been completed, when all those calls return nil. This is
489
- # simply an optimization of the communication protocol, as most
490
- # remote calls return nil.
491
- #
492
- # +from_id+ is the ID of the first call of the group and +to_id+
493
- # the last. Both are included in the group.
494
- def completion_group(from_id, to_id)
495
- for id in (from_id..to_id)
496
- completed(nil, nil, id)
497
- end
498
- nil
499
- end
500
-
501
- # Message received when a given call, identified by its ID, has
502
- # been processed on the remote peer. +result+ is the value
503
- # returned by the method, +error+ an exception object (if an error
504
- # occured).
505
- def completed(result, error, id)
506
- call_spec = peer.completion_queue.pop
507
- if call_spec.message_id != id
508
- result = Exception.exception("something fishy: ID mismatch in completion queue (#{call_spec.message_id} != #{id}")
509
- error = true
510
- call_spec = nil
511
- end
512
- if error
513
- if call_spec && thread = call_spec.waiting_thread
514
- result = peer.local_object(result)
515
- thread.raise result
516
- else
517
- Roby::Distributed.fatal "fatal error in communication with #{peer}: #{result.full_message}"
518
- Roby::Distributed.fatal "disconnecting ..."
519
- if peer.connected?
520
- peer.disconnect
521
- else
522
- peer.disconnected!
523
- end
524
- end
525
-
526
- elsif call_spec
527
- peer.call_attached_block(call_spec, result)
528
- end
529
-
530
- nil
531
- end
532
-
533
- # Queue a completion message for our peer. This is usually done
534
- # automatically in #demux, but it is useful to do it manually in
535
- # certain conditions, for instance in PeerServer#execute
536
- #
537
- # In #execute, the control thread -> RX thread context switch is
538
- # not immediate. Therefore, it is possible that events are queued
539
- # by the control thread while the #completed message is not.
540
- # #completed! both queues the message *and* makes sure that #demux
541
- # won't.
542
- def completed!(result, error)
543
- if queued_completion?
544
- raise "already queued the completed message"
545
- else
546
- Distributed.debug { "done, returns #{'error ' if error}#{result || 'nil'} in completed!" }
547
- self.queued_completion = true
548
- peer.queue_call false, :completed, [result, error, current_message_id]
549
- end
550
- end
551
-
552
- # call-seq:
553
- # execute { ... }
554
- #
555
- # Executes the given block in the control thread and return when the block
556
- # has finished its execution. This method can be called only when serving
557
- # a remote call.
558
- def execute
559
- if !processing?
560
- return yield
561
- end
562
-
563
- peer.engine.execute do
564
- error = nil
565
- begin
566
- result = yield
567
- rescue Exception => error
568
- end
569
- completed!(error || result, !!error, peer.current_message_id)
570
- end
571
- end
572
- end
573
-
574
- class Peer
575
- # The main synchronization mutex to access the peer. See also
576
- # Peer#synchronize
577
- attr_reader :mutex
578
- def synchronize; @mutex.synchronize { yield } end
579
-
580
- # The transmission thread
581
- attr_reader :send_thread
582
- # The queue which holds all calls to the remote peer. Calls are
583
- # saved as CallSpec objects
584
- attr_reader :send_queue
585
- # The queue of calls that have been sent to our peer, but for which
586
- # a +completed+ message has not been received. This is a queue of
587
- # CallSpec objects
588
- attr_reader :completion_queue
589
- # The cycle data which is being gathered before queueing it into #send_queue
590
- attr_reader :current_cycle
591
-
592
- @@message_id = 0
593
-
594
- # Checks that +object+ is marshallable. If +object+ is a
595
- # collection, it will check that each of its elements is
596
- # marshallable first. This is automatically called for all
597
- # messages if DEBUG_MARSHALLING is set to true.
598
- def check_marshallable(object, stack = ValueSet.new)
599
- if !object.kind_of?(DRbObject) && object.respond_to?(:each) && !object.kind_of?(String)
600
- if stack.include?(object)
601
- Roby::Distributed.warn "recursive marshalling of #{obj}"
602
- raise "recursive marshalling"
603
- end
604
-
605
- stack << object
606
- begin
607
- object.each do |obj|
608
- marshalled = begin
609
- check_marshallable(obj, stack)
610
- rescue Exception
611
- raise TypeError, "cannot dump #{obj}(#{obj.class}): #{$!.message}"
612
- end
613
-
614
-
615
- if Marshal.load(marshalled).kind_of?(DRb::DRbUnknown)
616
- raise TypeError, "cannot load #{obj}(#{obj.class})"
617
- end
618
- end
619
- ensure
620
- stack.delete(object)
621
- end
622
- end
623
- Marshal.dump(object)
624
- end
625
-
626
- # This set of calls mark the end of a cycle. When one of these is
627
- # encountered, the calls gathered in #current_cycle are moved into
628
- # #send_queue
629
- CYCLE_END_CALLS = [:connect, :disconnect, :fatal_error, :state_update]
630
-
631
- attr_predicate :sync?, true
632
-
633
- # Add a CallSpec object in #send_queue. Do not use that method
634
- # directly, but use #transmit and #call instead.
635
- #
636
- # The message to be sent is m(*args). +on_completion+ is either
637
- # nil or a block object which should be called once the message has
638
- # been processed by our remote peer. +waiting_thread+ is a Thread
639
- # object of a thread waiting for the message to be processed.
640
- # #raise will be called on it if an error has occured during the
641
- # remote processing.
642
- #
643
- # If +is_callback+ is true, it means that the message is being
644
- # queued during the processing of another message. In that case, we
645
- # will receive the completion message only when all callbacks have
646
- # also been processed. Queueing callbacks while processing another
647
- # callback is forbidden and the communication layer raises
648
- # RecursiveCallbacksError if it happens.
649
- #
650
- # #queueing allow to queue normal messages when they would have
651
- # been marked as callbacks.
652
- def queue_call(is_callback, m, args = [], on_completion = nil, waiting_thread = nil)
653
- # Do some sanity checks
654
- if !m.respond_to?(:to_sym)
655
- raise ArgumentError, "method argument should be a symbol, was #{m.class}"
656
- end
657
-
658
- # Check the connection state
659
- if (disconnecting? && m != :disconnect && m != :fatal_error) || disconnected?
660
- raise DisconnectedError, "cannot queue #{m}(#{args.join(", ")}), we are not currently connected to #{remote_name}"
661
- end
662
-
663
- # Marshal DRoby-dumped objects now, since the object may be
664
- # modified between now and the time it is sent
665
- formatted_args = Distributed.format(args, self)
666
-
667
- if Roby::Distributed::DEBUG_MARSHALLING
668
- check_marshallable(formatted_args)
669
- end
670
-
671
- call_spec = CallSpec.new(is_callback,
672
- m, formatted_args, args,
673
- on_completion, caller(2), waiting_thread)
674
-
675
- synchronize do
676
- # No return message for 'completed' (of course)
677
- if call_spec.method != :completed
678
- @@message_id += 1
679
- call_spec.message_id = @@message_id
680
- completion_queue << call_spec
681
-
682
- elsif !current_cycle.empty? && !(args[0] || args[1])
683
- # Try to merge empty completed messages
684
- last_call = current_cycle.last
685
- last_method, last_args = last_call[1], last_call[2]
686
-
687
- case last_method
688
- when :completed
689
- if !(last_args[0] || last_args[1])
690
- Distributed.debug "merging two completion messages"
691
- current_cycle.pop
692
- call_spec.method = :completion_group
693
- call_spec.formatted_args = [last_args[2], args[2]]
694
- end
695
- when :completion_group
696
- Distributed.debug "extending a completion group"
697
- current_cycle.pop
698
- call_spec.method = :completion_group
699
- call_spec.formatted_args = [last_args[0], args[2]]
700
- end
701
- end
702
-
703
- Distributed.debug { "#{call_spec.is_callback ? 'adding callback' : 'queueing'} [#{call_spec.message_id}]#{remote_name}.#{call_spec.method}" }
704
- current_cycle << [call_spec.is_callback, call_spec.method, call_spec.formatted_args, !waiting_thread, call_spec.message_id]
705
- if sync? || CYCLE_END_CALLS.include?(m)
706
- Distributed.debug "transmitting #{@current_cycle.size} calls"
707
- send_queue << current_cycle
708
- @current_cycle = Array.new
709
- end
710
- end
711
- end
712
-
713
- # If #transmit calls are done in the block given to #queueing, they
714
- # will queue the call normally, instead of marking it as callback
715
- def queueing
716
- old_processing = local_server.processing?
717
-
718
- local_server.processing = false
719
- yield
720
-
721
- ensure
722
- local_server.processing = old_processing
723
- end
724
-
725
- # call-seq:
726
- # peer.transmit(method, arg1, arg2, ...) { |ret| ... }
727
- #
728
- # Asynchronous call to the remote host. If a block is given, it is
729
- # called in the communication thread when the call succeeds, with
730
- # the returned value as argument.
731
- def transmit(m, *args, &block)
732
- is_callback = engine.inside_control? && local_server.processing?
733
- if is_callback && local_server.processing_callback?
734
- raise RecursiveCallbacksError, "cannot queue callback #{m}(#{args.join(", ")}) while serving one"
735
- end
736
-
737
- queue_call is_callback, m, args, block
738
- end
739
-
740
- # call-seq:
741
- # peer.call(method, arg1, arg2) => result
742
- #
743
- # Calls a method synchronously and returns the value returned by
744
- # the remote server. If we disconnect before this call is
745
- # processed, raises DisconnectedError. If the remote server returns
746
- # an exception, this exception is raised in the calling thread as
747
- # well.
748
- #
749
- # Note that it is forbidden to use this method in control or
750
- # communication threads, as it would make the application deadlock
751
- def call(m, *args, &block)
752
- if !engine.outside_control? || Roby.taken_global_lock?
753
- raise "cannot use Peer#call in control thread or while taking the Roby global lock"
754
- end
755
-
756
- result = nil
757
- Roby.condition_variable(true) do |cv, mt|
758
- mt.synchronize do
759
- Distributed.debug do
760
- "calling #{remote_name}.#{m}"
761
- end
762
-
763
- callback = Proc.new do |return_value|
764
- mt.synchronize do
765
- result = return_value
766
- block.call(return_value) if block
767
- cv.broadcast
768
- end
769
- end
770
-
771
- queue_call false, m, args, callback, Thread.current
772
- cv.wait(mt)
773
- end
774
- end
775
-
776
- result
777
- end
778
-
779
- # Main loop of the thread which communicates with the remote peer
780
- def communication_loop
781
- Thread.current.priority = 2
782
- id = 0
783
- data = nil
784
- buffer = StringIO.new(" " * 8, 'w')
785
-
786
- Roby::Distributed.debug "starting communication loop to #{self}"
787
-
788
- loop do
789
- data ||= send_queue.shift
790
- return if disconnected?
791
-
792
- # Wait for the link to be alive before sending anything
793
- while !link_alive?
794
- return if disconnected?
795
- Roby::Distributed.info "#{self} is out of reach. Waiting before transmitting"
796
- connection_space.wait_next_discovery
797
- end
798
- return if disconnected?
799
-
800
- buffer.truncate(8)
801
- buffer.seek(8)
802
- Marshal.dump(data, buffer)
803
- buffer.string[0, 8] = [id += 1, buffer.size - 8].pack("NN")
804
-
805
- begin
806
- size = buffer.string.size
807
- Roby::Distributed.debug { "sending #{size}B to #{self}" }
808
- stats.tx += size
809
- socket.write(buffer.string)
810
-
811
- data = nil
812
- rescue Errno::EPIPE
813
- @dead = true
814
- # communication error, retry sending the data (or, if we are disconnected, return)
815
- end
816
- end
817
-
818
- rescue Interrupt
819
- rescue Exception
820
- Distributed.fatal do
821
- "While sending #{data.inspect}\n" +
822
- "Communication thread dies with\n#{$!.full_message}"
823
- end
824
-
825
- disconnected!
826
-
827
- ensure
828
- Distributed.info "communication thread quitting for #{self}. Rx: #{stats.rx}B, Tx: #{stats.tx}B"
829
- calls = []
830
- while !completion_queue.empty?
831
- calls << completion_queue.shift
832
- end
833
-
834
- calls.each do |call_spec|
835
- next unless call_spec
836
- if thread = call_spec.waiting_thread
837
- thread.raise DisconnectedError
838
- end
839
- end
840
-
841
- Distributed.info "communication thread quit for #{self}"
842
- end
843
-
844
- # Formats an error message because +error+ has been reported by +call+
845
- def report_remote_error(call, error)
846
- error_message = error.full_message { |msg| msg !~ /drb\/[\w+]\.rb/ }
847
- if call
848
- "#{remote_name} reports an error on #{call}:\n#{error_message}\n" +
849
- "call was initiated by\n #{call.trace.join("\n ")}"
850
- else
851
- "#{remote_name} reports an error on:\n#{error_message}"
852
- end
853
- end
854
-
855
- # Calls the completion block that has been given to #transmit when
856
- # +call+ is completed (the +on_completion+ parameter of
857
- # #queue_call). A remote call is completed when it has been
858
- # processed remotely *and* the callbacks returned by the remote
859
- # server (if any) have been processed as well. +result+ is the
860
- # value returned by the remote server.
861
- def call_attached_block(call, result)
862
- if block = call.on_completion
863
- begin
864
- Roby::Distributed.debug "calling completion block #{block} for #{call}"
865
- block.call(result)
866
- rescue Exception => e
867
- Roby.application_error(:droby_callbacks, block, e)
868
- end
869
- end
870
- end
871
-
872
- def synchro_point; call(:synchro_point) end
873
- end
874
- end
875
- end