mirror of
git://sourceware.org/git/libabigail.git
synced 2024-12-19 00:14:33 +00:00
8d670d6dde
* include/abg-workers.h: Document the workers namespace, the task, queue and queue::task_done_notify types. * src/abg-workers.cc: Move the documentation of the thread_pool module inside the abigail::worker namespace, so that references to task and queue types (which are also in the abigail::worker namespace) can be resolved in the apidoc. Signed-off-by: Dodji Seketeli <dodji@redhat.com>
116 lines
3.3 KiB
C++
116 lines
3.3 KiB
C++
// -*- Mode: C++ -*-
|
|
//
|
|
// Copyright (C) 2013-2016 Red Hat, Inc.
|
|
//
|
|
// This file is part of the GNU Application Binary Interface Generic
|
|
// Analysis and Instrumentation Library (libabigail). This library is
|
|
// free software; you can redistribute it and/or modify it under the
|
|
// terms of the GNU Lesser General Public License as published by the
|
|
// Free Software Foundation; either version 3, or (at your option) any
|
|
// later version.
|
|
|
|
// This library is distributed in the hope that it will be useful, but
|
|
// WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// General Lesser Public License for more details.
|
|
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this program; see the file COPYING-LGPLV3. If
|
|
// not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// Author: Dodji Seketeli
|
|
|
|
/// @file
|
|
///
|
|
/// This file declares an interface for the worker threads (or thread
|
|
/// pool) design pattern. It aims at performing a set of tasks in
|
|
/// parallel, using the multi-threading capabilities of the underlying
|
|
/// processor(s).
|
|
///
|
|
|
|
#ifndef __ABG_WORKERS_H__
|
|
#define __ABG_WORKERS_H__
|
|
|
|
#include <tr1/memory>
|
|
#include <vector>
|
|
|
|
using std::tr1::shared_ptr;
|
|
|
|
namespace abigail
|
|
{
|
|
|
|
/// The namespace of the worker threads (or thread pool)
|
|
/// implementation of libabigail. This was modelled after the article
|
|
/// https://en.wikipedia.org/wiki/Thread_pool.
|
|
namespace workers
|
|
{
|
|
|
|
class task;
|
|
typedef shared_ptr<task> task_sptr;
|
|
|
|
size_t get_number_of_threads();
|
|
|
|
/// This represents a task to be performed.
|
|
///
|
|
/// Each instance of this type represents a task that can be performed
|
|
/// concurrently to other instance of the same type.
|
|
///
|
|
/// An instance of @ref task is meant to be performed by a worker
|
|
/// (thread). A set of tasks can be stored in a @ref queue.
|
|
class task
|
|
{
|
|
public:
|
|
task();
|
|
virtual void
|
|
perform() = 0;
|
|
|
|
virtual ~task();
|
|
}; // end class task.
|
|
|
|
/// This represents a queue of tasks to be performed.
|
|
///
|
|
/// Tasks are performed by a number of worker threads.
|
|
///
|
|
/// When a task is inserted into a @ref queue, the task is said to be
|
|
/// "scheduled for execution".
|
|
///
|
|
/// This is because there are worker threads waiting for tasks to be
|
|
/// added to the queue. When a task is added to the queue, a worker
|
|
/// thread picks it up, executes it, notifies interested listeners
|
|
/// when the @ref task's execution is completed, and waits for another
|
|
/// task to be added to the queue.
|
|
///
|
|
/// Of course, several worker threads can execute tasks concurrently.
|
|
class queue
|
|
{
|
|
public:
|
|
struct priv;
|
|
typedef shared_ptr<priv> priv_sptr;
|
|
|
|
private:
|
|
priv_sptr p_;
|
|
|
|
public:
|
|
struct task_done_notify;
|
|
queue();
|
|
queue(unsigned number_of_workers);
|
|
queue(unsigned number_of_workers,
|
|
const task_done_notify& notifier);
|
|
size_t get_size() const;
|
|
bool schedule_task(const task_sptr&);
|
|
void wait_for_workers_to_complete();
|
|
const std::vector<task_sptr>& get_completed_tasks() const;
|
|
~queue();
|
|
}; // end class queue
|
|
|
|
/// This functor is to notify listeners that a given task scheduled
|
|
/// for execution has been fully executed.
|
|
struct queue::task_done_notify
|
|
{
|
|
virtual void
|
|
operator()(const task_sptr& task_done);
|
|
};
|
|
} // end namespace workers
|
|
} // end namespace abigail
|
|
#endif // __ABG_WORKERS_H__
|