Parallel depth-first search engine More...
#include <gecode/search/par/engine.hh>
Classes | |
| class | Worker |
| Parallel depth-first search worker More... | |
| struct | SchedulerWorker |
| Per-worker adjustable parallel admission state. More... | |
Public Member Functions | |
| const Options & | opt (void) const |
| Provide access to search options. | |
| unsigned int | workers (void) const |
| Return number of workers. | |
| void | scheduler_enable (bool root_owner) |
| Enable adjustable parallel admission. | |
| void | scheduler_reset (bool root_owner) |
| Reset adjustable parallel state while all workers are blocked. | |
| bool | scheduler_admit (unsigned int worker) |
| Admit worker worker for one exploration action. | |
| bool | scheduler_paused (void) const |
| Whether the external worker request currently pauses the engine. | |
| void | scheduler_owner (unsigned int worker) |
| Record that worker worker owns search. | |
| void | scheduler_idle (unsigned int worker) |
| Record that worker worker is idle. | |
| void | scheduler_handoff (unsigned int worker, bool work_remains) |
| Hand worker worker's lease to a parked logical worker. | |
| Public Member Functions inherited from Gecode::Search::Engine | |
| virtual Statistics | statistics (void) const =0 |
| Return statistics. | |
| virtual bool | limited (void) const |
| Whether the engine stopped at a local limit (such as a CABS width limit) and cannot continue. | |
| virtual void | constrain (const Space &b) |
| Constrain future solutions to be better than b (raises exception). | |
| virtual void | reset (Space *s) |
| Reset engine to restart at space s (does nothing). | |
| virtual NoGoods & | nogoods (void) |
| Return no-goods (the no-goods are empty). | |
| Public Member Functions inherited from Gecode::Support::Terminator | |
| virtual | ~Terminator () |
| Destructor. | |
Protected Types | |
| enum class | SchedulerLogical { OWNER , PENDING , IDLE } |
| Logical worker state used by adjustable parallel admission. More... | |
Protected Member Functions | |
| unsigned int | scheduler_select (SchedulerLogical logical, unsigned int exclude) const |
| Select a no-lease worker by logical state (scheduler_mutex held). | |
| bool | scheduler_grow (void) |
| Grant leases up to the current request (scheduler_mutex held). | |
| Protected Member Functions inherited from Gecode::Search::Engine | |
| Engine (void) | |
| Construct a meta engine without worker control. | |
| Engine (const Options &o, unsigned int capacity) | |
| Construct a leaf engine and bind worker control to capacity. | |
Protected Attributes | |
| Options | _opt |
| Search options. | |
| bool | scheduler_enabled |
| Whether adjustable parallel admission is enabled. | |
| const std::atomic< bool > * | scheduler_fast_admit |
| Unchanged-capacity admission fast path. | |
| Support::Mutex | scheduler_mutex |
| Mutex for adjustable parallel admission. | |
| SchedulerWorker * | scheduler_worker |
| Per-worker adjustable parallel admission state. | |
| unsigned int | scheduler_requested |
| Current requested lease count. | |
| unsigned int | scheduler_leases |
| Current lease count. | |
| unsigned int | scheduler_cursor |
| Round-robin cursor for lease handoff. | |
| std::atomic< unsigned long long int > | scheduler_generation |
| Last request generation reconciled by the scheduler. | |
| Protected Attributes inherited from Gecode::Search::Engine | |
| WorkerControl | worker_control |
| Control retained for the lifetime of a leaf engine. | |
Commands from engine to workers and wait management | |
| enum | Cmd { C_WORK , C_WAIT , C_RESET , C_TERMINATE } |
| Commands from engine to workers. More... | |
| std::atomic< Cmd > | _cmd |
| The current command. | |
| Support::Mutex | _m_wait |
| Mutex for forcing workers to wait. | |
| Cmd | cmd (void) const |
| Return current command. | |
| void | block (void) |
| Block all workers. | |
| void | release (Cmd c) |
| Release all workers. | |
| void | wait (void) |
| Ensure that worker waits. | |
Termination control | |
| Support::Mutex | _m_term |
| Mutex for access to termination information. | |
| volatile unsigned int | _n_term_not_ack |
| Number of workers that have not yet acknowledged termination. | |
| Support::Event | _e_term_ack |
| Event for termination acknowledgment. | |
| Support::Mutex | _m_wait_terminate |
| Mutex for waiting for termination. | |
| volatile unsigned int | _n_not_terminated |
| Number of not yet terminated workers. | |
| Support::Event | _e_terminate |
| Event for termination (all threads have terminated). | |
| void | ack_terminate (void) |
| For worker to acknowledge termination command. | |
| virtual void | terminated (void) |
| For worker to register termination. | |
| void | wait_terminate (void) |
| For worker to wait until termination is legal. | |
| void | terminate (void) |
| For engine to perform thread termination. | |
Reset control | |
| Support::Mutex | _m_reset |
| Mutex for access to reset information. | |
| volatile unsigned int | _n_reset_not_ack |
| Number of workers that have not yet acknowledged reset. | |
| Support::Event | e_reset_ack_start |
| Event for reset acknowledgment started. | |
| Support::Event | e_reset_ack_stop |
| Event for reset acknowledgment stopped. | |
| Support::Mutex | m_wait_reset |
| Mutex for waiting for reset. | |
| void | ack_reset_start (void) |
| For worker to acknowledge start of reset cycle. | |
| void | ack_reset_stop (void) |
| For worker to acknowledge stop of reset cycle. | |
| void | wait_reset (void) |
| For worker to wait for all workers to reset. | |
Search control | |
| Support::Mutex | m_search |
| Mutex for search. | |
| Support::Event | e_search |
| Event for search (solution found, no more solutions, search stopped). | |
| Support::DynamicQueue< Space *, Heap > | solutions |
| Queue of solutions. | |
| volatile unsigned int | n_busy |
| Number of busy workers. | |
| std::atomic< bool > | has_stopped |
| Whether a worker had been stopped. | |
| std::atomic< unsigned long long int > | n_runs |
| Number of calls to next() that have started search. | |
| bool | signal (void) const |
| Whether search state changed such that signal is needed. | |
| void | idle (void) |
| Report that worker is idle. | |
| void | busy (void) |
| Report that worker is busy. | |
| unsigned long long int | run (void) const |
| Return the current call of next(). | |
| void | stop (unsigned long long int r) |
| Report that a worker was stopped during call r of next(). | |
| bool | work_remains (void) |
| Whether logical search work remains. | |
Engine interface | |
| Engine (const Options &o) | |
| Initialize with options o. | |
| virtual Space * | next (void) |
| Return next solution (nullptr, if none exists or search has been stopped). | |
| virtual bool | stopped (void) const |
| Check whether engine has been stopped. | |
| virtual | ~Engine (void) |
| Destructor. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Gecode::HeapAllocated | |
| static void * | operator new (size_t s) |
| Memory management. | |
| static void | operator delete (void *p) |
| Free memory allocated from heap. | |
Detailed Description
class Gecode::Search::Par::Engine< Tracer >
Parallel depth-first search engine
Member Enumeration Documentation
◆ SchedulerLogical
|
strongprotected |
Logical worker state used by adjustable parallel admission.
Construction and reset count every worker in n_busy. A pending worker must receive a lease and report idle even if it starts without a tree.
| Enumerator | |
|---|---|
| OWNER | Owns local search or has not yet reported its exhaustion. |
| PENDING | Has not yet reported its initial idle state. |
| IDLE | Has reported idle and owns no local search. |
◆ Cmd
| enum Gecode::Search::Par::Engine::Cmd |
Constructor & Destructor Documentation
◆ Engine()
|
inline |
Initialize with options o.
Definition at line 123 of file engine.hpp.
◆ ~Engine()
|
virtual |
Member Function Documentation
◆ scheduler_select()
|
protected |
Select a no-lease worker by logical state (scheduler_mutex held).
Definition at line 143 of file engine.hpp.
◆ scheduler_grow()
|
protected |
Grant leases up to the current request (scheduler_mutex held).
Definition at line 157 of file engine.hpp.
◆ opt()
|
inline |
Provide access to search options.
Definition at line 51 of file engine.hpp.
◆ workers()
|
inline |
Return number of workers.
Definition at line 56 of file engine.hpp.
◆ scheduler_enable()
| void Gecode::Search::Par::Engine< Tracer >::scheduler_enable | ( | bool | root_owner | ) |
Enable adjustable parallel admission.
Definition at line 183 of file engine.hpp.
◆ scheduler_reset()
| void Gecode::Search::Par::Engine< Tracer >::scheduler_reset | ( | bool | root_owner | ) |
Reset adjustable parallel state while all workers are blocked.
Definition at line 207 of file engine.hpp.
◆ scheduler_admit()
| bool Gecode::Search::Par::Engine< Tracer >::scheduler_admit | ( | unsigned int | worker | ) |
Admit worker worker for one exploration action.
Definition at line 230 of file engine.hpp.
◆ scheduler_paused()
|
inline |
Whether the external worker request currently pauses the engine.
Definition at line 278 of file engine.hpp.
◆ scheduler_owner()
| void Gecode::Search::Par::Engine< Tracer >::scheduler_owner | ( | unsigned int | worker | ) |
Record that worker worker owns search.
Definition at line 285 of file engine.hpp.
◆ scheduler_idle()
| void Gecode::Search::Par::Engine< Tracer >::scheduler_idle | ( | unsigned int | worker | ) |
Record that worker worker is idle.
Definition at line 295 of file engine.hpp.
◆ scheduler_handoff()
| void Gecode::Search::Par::Engine< Tracer >::scheduler_handoff | ( | unsigned int | worker, |
| bool | work_remains ) |
Hand worker worker's lease to a parked logical worker.
Definition at line 305 of file engine.hpp.
◆ cmd()
|
inline |
Return current command.
Definition at line 72 of file engine.hpp.
◆ block()
|
inline |
Block all workers.
Definition at line 77 of file engine.hpp.
◆ release()
|
inline |
Release all workers.
Definition at line 83 of file engine.hpp.
◆ wait()
|
inline |
Ensure that worker waits.
Definition at line 92 of file engine.hpp.
◆ ack_terminate()
|
inline |
For worker to acknowledge termination command.
Definition at line 427 of file engine.hpp.
◆ terminated()
|
inlinevirtual |
For worker to register termination.
Implements Gecode::Support::Terminator.
Definition at line 414 of file engine.hpp.
◆ wait_terminate()
|
inline |
For worker to wait until termination is legal.
Definition at line 436 of file engine.hpp.
◆ terminate()
|
inline |
For engine to perform thread termination.
Definition at line 443 of file engine.hpp.
◆ ack_reset_start()
|
inline |
For worker to acknowledge start of reset cycle.
Definition at line 462 of file engine.hpp.
◆ ack_reset_stop()
|
inline |
For worker to acknowledge stop of reset cycle.
Definition at line 471 of file engine.hpp.
◆ wait_reset()
|
inline |
For worker to wait for all workers to reset.
Definition at line 480 of file engine.hpp.
◆ signal()
|
inlineprotected |
Whether search state changed such that signal is needed.
Definition at line 352 of file engine.hpp.
◆ idle()
|
inline |
Report that worker is idle.
Definition at line 358 of file engine.hpp.
◆ busy()
|
inline |
Report that worker is busy.
Definition at line 369 of file engine.hpp.
◆ run()
|
inline |
Return the current call of next().
Definition at line 378 of file engine.hpp.
◆ stop()
|
inline |
Report that a worker was stopped during call r of next().
Definition at line 384 of file engine.hpp.
◆ work_remains()
|
inline |
Whether logical search work remains.
Definition at line 401 of file engine.hpp.
◆ next()
|
virtual |
Return next solution (nullptr, if none exists or search has been stopped).
Implements Gecode::Search::Engine.
Reimplemented in Gecode::Search::Par::PBS< Collect >, and Gecode::Search::Par::PBS< Gecode::Search::Par::CollectBest >.
Definition at line 523 of file engine.hpp.
◆ stopped()
|
inlinevirtual |
Check whether engine has been stopped.
Implements Gecode::Search::Engine.
Reimplemented in Gecode::Search::Par::PBS< Collect >, and Gecode::Search::Par::PBS< Gecode::Search::Par::CollectBest >.
Definition at line 61 of file engine.hpp.
Member Data Documentation
◆ _opt
|
protected |
◆ scheduler_enabled
|
protected |
◆ scheduler_fast_admit
|
protected |
◆ scheduler_mutex
|
protected |
◆ scheduler_worker
|
protected |
◆ scheduler_requested
|
protected |
◆ scheduler_leases
|
protected |
◆ scheduler_cursor
|
protected |
◆ scheduler_generation
|
protected |
◆ _cmd
|
protected |
◆ _m_wait
|
protected |
◆ _m_term
|
protected |
◆ _n_term_not_ack
|
protected |
◆ _e_term_ack
|
protected |
◆ _m_wait_terminate
|
protected |
◆ _n_not_terminated
|
protected |
◆ _e_terminate
|
protected |
◆ _m_reset
|
protected |
◆ _n_reset_not_ack
|
protected |
◆ e_reset_ack_start
|
protected |
◆ e_reset_ack_stop
|
protected |
◆ m_wait_reset
|
protected |
◆ m_search
|
protected |
◆ e_search
|
protected |
◆ solutions
|
protected |
◆ n_busy
|
protected |
◆ has_stopped
|
protected |
◆ n_runs
|
protected |
The documentation for this class was generated from the following files:
- gecode/search/par/engine.hh
- gecode/search/par/engine.hpp
