summaryrefslogtreecommitdiffstats
path: root/libdimension/future-internal.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2014-08-19 17:10:03 -0400
committerTavian Barnes <tavianator@tavianator.com>2015-10-25 11:03:56 -0400
commit7b09710392d35fb55b52031d447a542d99fc6b4b (patch)
tree270eb927ee8c52ceeb99926ebf4843704775a610 /libdimension/future-internal.h
parent200c86b91ea7063d35be3bffc11c5da53c054653 (diff)
downloaddimension-7b09710392d35fb55b52031d447a542d99fc6b4b.tar.xz
Modularize the libdimension codebase.
Diffstat (limited to 'libdimension/future-internal.h')
-rw-r--r--libdimension/future-internal.h71
1 files changed, 0 insertions, 71 deletions
diff --git a/libdimension/future-internal.h b/libdimension/future-internal.h
deleted file mode 100644
index 7ca318a..0000000
--- a/libdimension/future-internal.h
+++ /dev/null
@@ -1,71 +0,0 @@
-/*************************************************************************
- * Copyright (C) 2010-2014 Tavian Barnes <tavianator@tavianator.com> *
- * *
- * This file is part of The Dimension Library. *
- * *
- * The Dimension 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 of the *
- * License, or (at your option) any later version. *
- * *
- * The Dimension 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 *
- * Lesser General Public License for more details. *
- * *
- * You should have received a copy of the GNU Lesser General Public *
- * License along with this program. If not, see *
- * <http://www.gnu.org/licenses/>. *
- *************************************************************************/
-
-/**
- * @file
- * Future object implementation.
- */
-
-#include <pthread.h>
-
-/// Allocate a new future object.
-DMNSN_INTERNAL dmnsn_future *dmnsn_new_future(void);
-
-/// Set the total number of loop iterations.
-DMNSN_INTERNAL void dmnsn_future_set_total(dmnsn_future *future, size_t total);
-/// Increment the progress of a background task.
-DMNSN_INTERNAL void dmnsn_future_increment(dmnsn_future *future);
-/// Instantly complete the background teask.
-DMNSN_INTERNAL void dmnsn_future_finish(dmnsn_future *future);
-/// Set the number of worker threads.
-DMNSN_INTERNAL void dmnsn_future_set_nthreads(dmnsn_future *future,
- unsigned int nthreads);
-/// Notify completion of a worker thread.
-DMNSN_INTERNAL void dmnsn_future_finish_thread(dmnsn_future *future);
-
-struct dmnsn_future {
- size_t progress; ///< Completed loop iterations.
- size_t total; ///< Total expected loop iterations.
-
- /// The worker thread.
- pthread_t thread;
-
- /// Mutex to guard progress and total.
- pthread_mutex_t mutex;
-
- /// Condition variable for waiting for a particular amount of progress.
- pthread_cond_t cond;
-
- /// Minimum waited-on value.
- double min_wait;
-
- /// Number of threads working on the future's background task.
- unsigned int nthreads;
- /// Number of threads not yet paused.
- unsigned int nrunning;
- /// Count of threads holding the future paused.
- unsigned int npaused;
- /// Condition variable for waiting for nrunning == 0.
- pthread_cond_t none_running_cond;
- /// Condition variable for waiting for nrunning == nthreads.
- pthread_cond_t all_running_cond;
- /// Condition variable for waiting for npaused == 0.
- pthread_cond_t resume_cond;
-};