Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implemented thread safety #15

Merged
merged 4 commits into from
Jan 9, 2020
Merged

Implemented thread safety #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37821ba
Fix bug calling non-virtual destructor via base class
moshiba Dec 6, 2019
adc60ea
Remove Buck build configs
moshiba Jan 9, 2020
b724ddf
Optimised update() and altered APIs regarding shutting down a pbar
moshiba Jan 9, 2020
b484f15
Guard critical variables and standard output procedures with mutex
moshiba Jan 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 0 additions & 14 deletions examples/BUCK
View file
Open in desktop

This file was deleted.

15 changes: 7 additions & 8 deletions examples/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,18 @@
int main() {
constexpr int test_size = 4;
constexpr int test_size2 = 80000;
pbar::ProgressBar* progressBar =
new pbar::ProgressBar("fiiirst", test_size);
pbar::ProgressBar pBar("fiiirst", test_size);
pbar::ProgressBar pBar2("secoond", test_size2, true);
for (int i = 0; i < test_size; i++) {
pbar::ProgressBar* progressBar2 =
new pbar::ProgressBar("secoond", test_size2, true);
pBar2.reset();
for (int j = 0; j < test_size2; j++) {
progressBar2->update();
pBar2.update();
usleep(1);
}
delete progressBar2;
progressBar->update();
pBar.update();
}
delete progressBar;
pBar2.close();
pBar.close();
std::cout << std::endl << std::endl;
std::cout << "test driver END" << std::endl;

Expand Down
20 changes: 0 additions & 20 deletions pbar/BUCK
View file
Open in desktop

This file was deleted.

118 changes: 84 additions & 34 deletions pbar/pbar.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

#include "pbar.hpp"

#include <aesc.hpp>
#include <cmath>
#include <iomanip>
#include <iostream>

#include <aesc.hpp>
#include "unistd.h"

namespace pbar {
Expand All @@ -25,22 +25,25 @@ int window_width::operator()() const { return 0; }

// static_window_width
static_window_width::static_window_width(const int width) : width(width) {}
static_window_width::~static_window_width() {}
int static_window_width::operator()() const { return this->width; }

// dynamic_window_width
dynamic_window_width::dynamic_window_width() {}
dynamic_window_width::~dynamic_window_width() {}
int dynamic_window_width::operator()() const {
ioctl(STDOUT_FILENO, TIOCGWINSZ, &(this->window_size));
return static_cast<int>(this->window_size.ws_col);
}
} // namespace window_width

ProgressBar::ProgressBar(const std::string& description, const int total,
ProgressBar::ProgressBar(const std::string& description, const long long& total,
const bool leave, const int width,
const std::chrono::nanoseconds min_interval_time,
const std::string& bar_format, const int initial_value,
const int position)
: description(description),
const std::string& bar_format,
const long long& initial_value, const int position)
: initial_value(initial_value),
description(description),
total(total),
leave(leave),
min_interval_time(min_interval_time),
Expand All @@ -51,7 +54,8 @@ ProgressBar::ProgressBar(const std::string& description, const int total,
n(initial_value),
position(position),
last_update_n(initial_value),
last_update_time(std::chrono::system_clock::now()) {
last_update_time(std::chrono::system_clock::now()),
disable(false) {
if (width > 0) {
this->window_width = new window_width::static_window_width(width);
} else {
Expand All @@ -61,28 +65,14 @@ ProgressBar::ProgressBar(const std::string& description, const int total,
this->display();
}

ProgressBar::ProgressBar(const std::string& description, const int total,
ProgressBar::ProgressBar(const std::string& description, const long long& total,
const bool leave)
: ProgressBar(description, total, leave, -1,
std::chrono::duration_cast<std::chrono::nanoseconds>(
std::chrono::milliseconds(100)),
std::chrono::milliseconds(10)),
"", 0, ProgressBar::nbars) {}

ProgressBar::~ProgressBar() {
this->display();
/* Cleanup and (depends on config) close the progressbar
*/
// TODO: think this through
if (this->leave) {
// leave this bar as it is
} else {
this->moveto(this->position);
std::cout << "\r" << aesc::cursor::EL(aesc::cursor::clear::to_end);
this->moveto(-this->position);
}
ProgressBar::nbars -= 1;
delete window_width;
}
ProgressBar::~ProgressBar() { this->close(); }

inline float ProgressBar::percentage() {
// TODO: deprecate and merge
Expand All @@ -108,7 +98,7 @@ void ProgressBar::moveto(const int n) {
*/

if (n > 0) {
// moves down
// moves down, needs NEWLINE to actually create and move to lines below
for (int i = 0; i != n; ++i) {
std::cout << "\n";
}
Expand Down Expand Up @@ -171,6 +161,8 @@ std::string ProgressBar::format_meter() {
void ProgressBar::display() {
/** Refresh display of this bar
*/
const std::lock_guard<std::mutex> guard(this->pbar_mutex);

if (this->position) {
this->moveto(this->position);
}
Expand All @@ -184,7 +176,25 @@ void ProgressBar::display() {
std::cout << std::flush;
}

const std::chrono::nanoseconds ProgressBar::delta_time(
std::chrono::time_point<std::chrono::system_clock>& now) {
return std::chrono::duration_cast<std::chrono::nanoseconds>(
now - this->last_update_time);
}

inline long ProgressBar::delta_iter() {
return static_cast<long>(this->n - this->last_update_n);
}

void ProgressBar::update(const int n) {
if (this->disable) {
return;
}

// HACK: for auto-refresh logic to work
if (n < 0) {
this->last_update_n += n;
}
this->n += n;
// BUG: TODO: consider last_print_n when n < 0

Expand All @@ -197,24 +207,64 @@ void ProgressBar::update(const int n) {
if (this->delta_time(now) > this->min_interval_time) {
this->display();

// TODO: dynamic min_interval_iter adjustments
this->min_interval_iter = delta_iters / 3;
// TODO: find better dynamic min_interval_iter adjustments, might
// want to consider interval fluctuation Uses max number of
// iterations between two updates
this->min_interval_iter =
std::max(this->min_interval_iter, delta_iters);
// TODO: how to evaluate this guess on next round

this->last_update_n = this->n;
this->last_update_time = std::move(now);
// Store old values for next call
{
std::lock_guard<std::mutex> guard(this->pbar_mutex);
// this->last_update_n = this->n;
const long long tmp = this->n.load();
this->last_update_n = tmp;

this->last_update_time = std::move(now);
}
}
}
}

const std::chrono::nanoseconds ProgressBar::delta_time(
std::chrono::time_point<std::chrono::system_clock>& now) {
return std::chrono::duration_cast<std::chrono::nanoseconds>(
now - this->last_update_time);
void ProgressBar::close() {
/* Clean up visuals, closes pbar if set not to leave it
* then resets
*/
if (this->disable) {
return;
}
// Prevent multiple closures
this->disable = true;

// Remove pbar from record
ProgressBar::nbars -= 1;
// TODO: implement internal set instead of simple counting to maintain
// multi-bar order
delete window_width;

this->display();
// TODO: write final stats

if (this->leave) {
// leave this bar as it is
} else {
// close (clean up) the pbar
const std::lock_guard<std::mutex> guard(this->pbar_mutex);

this->moveto(this->position);
std::cout << "\r" << aesc::cursor::EL(aesc::cursor::clear::to_end);
this->moveto(-this->position);
}
}

long ProgressBar::delta_iter() {
return static_cast<long>(this->n - this->last_update_n);
void ProgressBar::reset() {
/* encourages repeated use
*/
this->n = this->initial_value;
this->last_update_n = this->initial_value;
this->last_update_time = std::chrono::system_clock::now();
this->display();
}

} // namespace pbar
41 changes: 24 additions & 17 deletions pbar/pbar.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,21 @@

#include <sys/ioctl.h>

#include <atomic>
#include <chrono>
#include <mutex>
#include <ratio>
#include <sstream>
#include <string>

namespace pbar {

class Bar {
public:
Bar();
void refresh();
};

namespace window_width {
// Functor
class window_width {
public:
virtual int operator()() const;
virtual ~window_width() {}
};

class static_window_width final : public window_width {
Expand All @@ -38,6 +35,7 @@ class static_window_width final : public window_width {
public:
explicit static_window_width(const int width);
int operator()() const final override;
~static_window_width();
};

class dynamic_window_width final : public window_width {
Expand All @@ -47,26 +45,33 @@ class dynamic_window_width final : public window_width {
public:
dynamic_window_width();
int operator()() const final override;
~dynamic_window_width();
};

} // namespace window_width

class ProgressBar {
/* Not copyable, but movable
/* TODO: Not copyable, but movable
*/
private:
static int nbars; // bar count

private: // initial values, used in reset()
long long initial_value;

private:
const std::string description;
const long long total;
std::string description;
long long total;
const bool leave;
std::chrono::nanoseconds min_interval_time;
long min_interval_iter;
const std::string bar_format;
long long n;
std::string bar_format;
std::atomic<long long> n;
const int position;
long long last_update_n;
std::atomic<long long> last_update_n;
std::chrono::system_clock::time_point last_update_time;
bool disable;
std::mutex pbar_mutex;

private:
inline float percentage();
Expand All @@ -78,19 +83,21 @@ class ProgressBar {
void display();
const std::chrono::nanoseconds delta_time(
std::chrono::time_point<std::chrono::system_clock>& now);
long delta_iter();
inline long delta_iter();

public:
explicit ProgressBar(const std::string& description, const int total,
explicit ProgressBar(const std::string& description, const long long& total,
const bool leave, const int width,
const std::chrono::nanoseconds min_interval_time,
const std::string& bar_format, const int initial_value,
const int position);
explicit ProgressBar(const std::string& description, const int total,
const std::string& bar_format,
const long long& initial_value, const int position);
explicit ProgressBar(const std::string& description, const long long& total,
const bool leave = (ProgressBar::nbars ? false
: true));
~ProgressBar();
void update(const int n = 1);
void close();
void reset();
};

} // namespace pbar
Expand Down