taskflow/taskflow/core/task.hpp at master · yhcpp/taskflow · GitHub

Repository navigation

History

687 lines (549 loc) · 16 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

#pragma once

#include "graph.hpp"

/**

@file task.hpp

@brief task include file

namespace tf {

// ----------------------------------------------------------------------------

// Task Types

// ----------------------------------------------------------------------------

/**

@enum TaskType

@brief enumeration of all task types

enum class TaskType : int {

/** @brief placeholder task type */

PLACEHOLDER = 0,

/** @brief cudaFlow task type */

CUDAFLOW,

/** @brief syclFlow task type */

SYCLFLOW,

/** @brief static task type */

STATIC,

/** @brief dynamic (subflow) task type */

DYNAMIC,

/** @brief condition task type */

CONDITION,

/** @brief module task type */

MODULE,

/** @brief asynchronous task type */

ASYNC,

/** @brief undefined task type (for internal use only) */

UNDEFINED

};

/**

@brief array of all task types (used for iterating task types)

inline constexpr std::array<TaskType, 8> TASK_TYPES = {

TaskType::PLACEHOLDER,

TaskType::CUDAFLOW,

TaskType::SYCLFLOW,

TaskType::STATIC,

TaskType::DYNAMIC,

TaskType::CONDITION,

TaskType::MODULE,

TaskType::ASYNC

};

/**

@brief convert a task type to a human-readable string

inline const char* to_string(TaskType type) {

const char* val;

switch(type) {

case TaskType::PLACEHOLDER: val = "placeholder"; break;

case TaskType::CUDAFLOW: val = "cudaflow"; break;

case TaskType::SYCLFLOW: val = "syclflow"; break;

case TaskType::STATIC: val = "static"; break;

case TaskType::DYNAMIC: val = "subflow"; break;

case TaskType::CONDITION: val = "condition"; break;

case TaskType::MODULE: val = "module"; break;

case TaskType::ASYNC: val = "async"; break;

default: val = "undefined"; break;

}

return val;

}

// ----------------------------------------------------------------------------

// Task Traits

// ----------------------------------------------------------------------------

/**

@brief determines if a callable is a static task

A static task is a callable object constructible from std::function<void()>.

template <typename C>

constexpr bool is_static_task_v = std::is_invocable_r_v<void, C> &&

!std::is_invocable_r_v<int, C>;

/**

@brief determines if a callable is a dynamic task

A dynamic task is a callable object constructible from std::function<void(Subflow&)>.

template <typename C>

constexpr bool is_dynamic_task_v = std::is_invocable_r_v<void, C, Subflow&>;

/**

@brief determines if a callable is a condition task

A condition task is a callable object constructible from std::function<int()>.

template <typename C>

constexpr bool is_condition_task_v = std::is_invocable_r_v<int, C>;

/**

@brief determines if a callable is a %cudaFlow task

A cudaFlow task is a callable object constructible from

std::function<void(tf::cudaFlow&)> or std::function<void(tf::cudaFlowCapturer&)>.

template <typename C>

constexpr bool is_cudaflow_task_v = std::is_invocable_r_v<void, C, cudaFlow&> ||

std::is_invocable_r_v<void, C, cudaFlowCapturer&>;

/**

@brief determines if a callable is a %syclFlow task

A syclFlow task is a callable object constructible from

std::function<void(tf::syclFlow&)>.

template <typename C>

constexpr bool is_syclflow_task_v = std::is_invocable_r_v<void, C, syclFlow&>;

// ----------------------------------------------------------------------------

// Task

// ----------------------------------------------------------------------------

/**

@class Task

@brief handle to a node in a task dependency graph

A Task is handle to manipulate a node in a taskflow graph.

It provides a set of methods for users to access and modify the attributes of

the associated graph node without directly touching internal node data.

class Task {

friend class FlowBuilder;

friend class Taskflow;

friend class TaskView;

public:

/**

@brief constructs an empty task

Task() = default;

/**

@brief constructs the task with the copy of the other task

Task(const Task& other);

/**

@brief replaces the contents with a copy of the other task

Task& operator = (const Task&);

/**

@brief replaces the contents with a null pointer

Task& operator = (std::nullptr_t);

/**

@brief compares if two tasks are associated with the same graph node

bool operator == (const Task& rhs) const;

/**

@brief compares if two tasks are not associated with the same graph node

bool operator != (const Task& rhs) const;

/**

@brief queries the name of the task

const std::string& name() const;

/**

@brief queries the number of successors of the task

size_t num_successors() const;

/**

@brief queries the number of predecessors of the task

size_t num_dependents() const;

/**

@brief queries the number of strong dependents of the task

size_t num_strong_dependents() const;

/**

@brief queries the number of weak dependents of the task

size_t num_weak_dependents() const;

/**

@brief assigns a name to the task

@param name a @std_string acceptable string

@return @c *this

Task& name(const std::string& name);

/**

@brief assigns a callable

@tparam C callable type

@param callable callable to construct one of the static, dynamic, condition, and cudaFlow tasks

@return @c *this

template <typename C>

Task& work(C&& callable);

/**

@brief creates a module task from a taskflow

@param taskflow a taskflow object for the module

@return @c *this

Task& composed_of(Taskflow& taskflow);

/**

@brief adds precedence links from this to other tasks

@tparam Ts parameter pack

@param tasks one or multiple tasks

@return @c *this

template <typename... Ts>

Task& precede(Ts&&... tasks);

/**

@brief adds precedence links from other tasks to this

@tparam Ts parameter pack

@param tasks one or multiple tasks

@return @c *this

template <typename... Ts>

Task& succeed(Ts&&... tasks);

/**

@brief makes the task release this semaphore

Task& release(Semaphore& semaphore);

/**

@brief makes the task acquire this semaphore

Task& acquire(Semaphore& semaphore);

/**

@brief resets the task handle to null

void reset();

/**

@brief resets the associated work to a placeholder

void reset_work();

/**

@brief queries if the task handle points to a task node

bool empty() const;

/**

@brief queries if the task has a work assigned

bool has_work() const;

/**

@brief applies an visitor callable to each successor of the task

template <typename V>

void for_each_successor(V&& visitor) const;

/**

@brief applies an visitor callable to each dependents of the task

template <typename V>

void for_each_dependent(V&& visitor) const;

/**

@brief obtains a hash value of the underlying node

size_t hash_value() const;

/**

@brief returns the task type

TaskType type() const;

/**

@brief dumps the task through an output stream

void dump(std::ostream& ostream) const;

private:

Task(Node*);

Node* _node {nullptr};

};

// Constructor

inline Task::Task(Node* node) : _node {node} {

}

// Constructor

inline Task::Task(const Task& rhs) : _node {rhs._node} {

}

// Function: precede

template <typename... Ts>

Task& Task::precede(Ts&&... tasks) {

(_node->_precede(tasks._node), ...);

//_precede(std::forward<Ts>(tasks)...);

return *this;

}

// Function: succeed

template <typename... Ts>

Task& Task::succeed(Ts&&... tasks) {

(tasks._node->_precede(_node), ...);

//_succeed(std::forward<Ts>(tasks)...);

return *this;

}

// Function: composed_of

inline Task& Task::composed_of(Taskflow& tf) {

_node->_handle.emplace<Node::Module>(&tf);

return *this;

}

// Operator =

inline Task& Task::operator = (const Task& rhs) {

_node = rhs._node;

return *this;

}

// Operator =

inline Task& Task::operator = (std::nullptr_t ptr) {

_node = ptr;

return *this;

}

// Operator ==

inline bool Task::operator == (const Task& rhs) const {

return _node == rhs._node;

}

// Operator !=

inline bool Task::operator != (const Task& rhs) const {

return _node != rhs._node;

}

// Function: name

inline Task& Task::name(const std::string& name) {

_node->_name = name;

return *this;

}

// Function: acquire

inline Task& Task::acquire(Semaphore& s) {

if(!_node->_semaphores) {

//_node->_semaphores.emplace();

_node->_semaphores = std::make_unique<Node::Semaphores>();

}

_node->_semaphores->to_acquire.push_back(&s);

return *this;

}

// Function: release

inline Task& Task::release(Semaphore& s) {

if(!_node->_semaphores) {

//_node->_semaphores.emplace();

_node->_semaphores = std::make_unique<Node::Semaphores>();

}

_node->_semaphores->to_release.push_back(&s);

return *this;

}

// Procedure: reset

inline void Task::reset() {

_node = nullptr;

}

// Procedure: reset_work

inline void Task::reset_work() {

_node->_handle.emplace<std::monostate>();

}

// Function: name

inline const std::string& Task::name() const {

return _node->_name;

}

// Function: num_dependents

inline size_t Task::num_dependents() const {

return _node->num_dependents();

}

// Function: num_strong_dependents

inline size_t Task::num_strong_dependents() const {

return _node->num_strong_dependents();

}

// Function: num_weak_dependents

inline size_t Task::num_weak_dependents() const {

return _node->num_weak_dependents();

}

// Function: num_successors

inline size_t Task::num_successors() const {

return _node->num_successors();

}

// Function: empty

inline bool Task::empty() const {

return _node == nullptr;

}

// Function: has_work

inline bool Task::has_work() const {

return _node ? _node->_handle.index() != 0 : false;

}

// Function: task_type

inline TaskType Task::type() const {

switch(_node->_handle.index()) {

case Node::PLACEHOLDER: return TaskType::PLACEHOLDER;

case Node::STATIC: return TaskType::STATIC;

case Node::DYNAMIC: return TaskType::DYNAMIC;

case Node::CONDITION: return TaskType::CONDITION;

case Node::MODULE: return TaskType::MODULE;

case Node::ASYNC: return TaskType::ASYNC;

case Node::SILENT_ASYNC: return TaskType::ASYNC;

case Node::CUDAFLOW: return TaskType::CUDAFLOW;

case Node::SYCLFLOW: return TaskType::SYCLFLOW;

default: return TaskType::UNDEFINED;

}

// Function: for_each_successor

template <typename V>

void Task::for_each_successor(V&& visitor) const {

for(size_t i=0; i<_node->_successors.size(); ++i) {

visitor(Task(_node->_successors[i]));

}

// Function: for_each_dependent

template <typename V>

void Task::for_each_dependent(V&& visitor) const {

for(size_t i=0; i<_node->_dependents.size(); ++i) {

visitor(Task(_node->_dependents[i]));

}

// Function: hash_value

inline size_t Task::hash_value() const {

return std::hash<Node*>{}(_node);

}

// Procedure: dump

inline void Task::dump(std::ostream& os) const {

os << "task ";

if(name().empty()) os << _node;

else os << name();

os << " [type=" << to_string(type()) << ']';

}

// Function: work

template <typename C>

Task& Task::work(C&& c) {

if constexpr(is_static_task_v<C>) {

_node->_handle.emplace<Node::Static>(std::forward<C>(c));

}

else if constexpr(is_dynamic_task_v<C>) {

_node->_handle.emplace<Node::Dynamic>(std::forward<C>(c));

}

else if constexpr(is_condition_task_v<C>) {

_node->_handle.emplace<Node::Condition>(std::forward<C>(c));

}

else if constexpr(is_cudaflow_task_v<C>) {

_node->_handle.emplace<Node::cudaFlow>(std::forward<C>(c));

}

else {

static_assert(dependent_false_v<C>, "invalid task callable");

}

return *this;

}

// ----------------------------------------------------------------------------

// global ostream

// ----------------------------------------------------------------------------

/**

@brief overload of ostream inserter operator for cudaTask

inline std::ostream& operator << (std::ostream& os, const Task& task) {

task.dump(os);

return os;

}

// ----------------------------------------------------------------------------

/**

@class TaskView

@brief class to access task information from the observer interface

class TaskView {

friend class Executor;

public:

/**

@brief queries the name of the task

const std::string& name() const;

/**

@brief queries the number of successors of the task

size_t num_successors() const;

/**

@brief queries the number of predecessors of the task

size_t num_dependents() const;

/**

@brief queries the number of strong dependents of the task

size_t num_strong_dependents() const;

/**

@brief queries the number of weak dependents of the task

size_t num_weak_dependents() const;

/**

@brief applies an visitor callable to each successor of the task

template <typename V>

void for_each_successor(V&& visitor) const;

/**

@brief applies an visitor callable to each dependents of the task

template <typename V>

void for_each_dependent(V&& visitor) const;

/**

@brief queries the task type

TaskType type() const;

/**

@brief obtains a hash value of the underlying node

size_t hash_value() const;

private:

TaskView(const Node&);

TaskView(const TaskView&) = default;

const Node& _node;

};

// Constructor

inline TaskView::TaskView(const Node& node) : _node {node} {

}

// Function: name

inline const std::string& TaskView::name() const {

return _node._name;

}

// Function: num_dependents

inline size_t TaskView::num_dependents() const {

return _node.num_dependents();

}

// Function: num_strong_dependents

inline size_t TaskView::num_strong_dependents() const {

return _node.num_strong_dependents();

}

// Function: num_weak_dependents

inline size_t TaskView::num_weak_dependents() const {

return _node.num_weak_dependents();

}

// Function: num_successors

inline size_t TaskView::num_successors() const {

return _node.num_successors();

}

// Function: type

inline TaskType TaskView::type() const {

switch(_node._handle.index()) {

case Node::PLACEHOLDER: return TaskType::PLACEHOLDER;

case Node::STATIC: return TaskType::STATIC;

case Node::DYNAMIC: return TaskType::DYNAMIC;

case Node::CONDITION: return TaskType::CONDITION;

case Node::MODULE: return TaskType::MODULE;

case Node::ASYNC: return TaskType::ASYNC;

case Node::SILENT_ASYNC: return TaskType::ASYNC;

case Node::CUDAFLOW: return TaskType::CUDAFLOW;

case Node::SYCLFLOW: return TaskType::SYCLFLOW;

default: return TaskType::UNDEFINED;

}

// Function: hash_value

inline size_t TaskView::hash_value() const {

return std::hash<const Node*>{}(&_node);

}

// Function: for_each_successor

template <typename V>

void TaskView::for_each_successor(V&& visitor) const {

for(size_t i=0; i<_node._successors.size(); ++i) {

visitor(TaskView(_node._successors[i]));

}

// Function: for_each_dependent

template <typename V>

void TaskView::for_each_dependent(V&& visitor) const {

for(size_t i=0; i<_node._dependents.size(); ++i) {

visitor(TaskView(_node._dependents[i]));

}

} // end of namespace tf. ---------------------------------------------------

namespace std {

/**

@struct hash

@brief hash specialization for std::hash<tf::Task>

template <>

struct hash<tf::Task> {

auto operator() (const tf::Task& task) const noexcept {

return task.hash_value();

}

};

/**

@struct hash

@brief hash specialization for std::hash<tf::TaskView>

template <>

struct hash<tf::TaskView> {

auto operator() (const tf::TaskView& task_view) const noexcept {

return task_view.hash_value();

}

};

} // end of namespace std ----------------------------------------------------

taskflow/taskflow/core/task.hpp at master · yhcpp/taskflow · GitHub

Repository navigation

Expand file tree

Breadcrumbs

task.hpp

Latest commit

History

Breadcrumbs

task.hpp

File metadata and controls