1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include "cli_progress_bar.h"
#include <aws/common/array_list.h>
#include <aws/common/clock.h>
#include <aws/common/mutex.h>
#include <aws/common/task_scheduler.h>
#include <aws/common/thread.h>
#include <aws/common/thread_scheduler.h>
#include <inttypes.h>
struct progress_listener_group {
struct aws_allocator *allocator;
struct aws_array_list listeners;
struct aws_mutex mutex;
FILE *render_sink;
struct aws_thread_scheduler *scheduler;
bool run_in_background;
};
struct progress_listener {
struct progress_listener_group *owning_group;
struct aws_string *label;
struct aws_string *state;
struct aws_mutex mutex;
uint64_t max;
uint64_t current;
bool render_update_pending;
};
static void s_progress_listener_delete(struct progress_listener *listener) {
aws_string_destroy(listener->label);
aws_mutex_clean_up(&listener->mutex);
aws_mem_release(listener->owning_group->allocator, listener);
}
struct progress_listener_group *progress_listener_group_new(struct aws_allocator *allocator) {
struct progress_listener_group *group = aws_mem_calloc(allocator, 1, sizeof(struct progress_listener_group));
group->allocator = allocator;
aws_mutex_init(&group->mutex);
group->render_sink = stdout;
aws_array_list_init_dynamic(&group->listeners, allocator, 16, sizeof(struct progress_listener *));
struct aws_thread_options options = *aws_default_thread_options();
group->scheduler = aws_thread_scheduler_new(allocator, &options);
return group;
}
void progress_listener_group_delete(struct progress_listener_group *group) {
aws_mutex_lock(&group->mutex);
group->run_in_background = false;
aws_mutex_unlock(&group->mutex);
aws_thread_scheduler_release(group->scheduler);
size_t listeners_len = aws_array_list_length(&group->listeners);
for (size_t i = 0; i < listeners_len; ++i) {
struct progress_listener *listener;
aws_array_list_get_at(&group->listeners, (void **)&listener, i);
s_progress_listener_delete(listener);
}
aws_array_list_clean_up(&group->listeners);
aws_mutex_clean_up(&group->mutex);
aws_mem_release(group->allocator, group);
}
void progress_listener_group_render(struct progress_listener_group *group) {
aws_mutex_lock(&group->mutex);
size_t listeners_len = aws_array_list_length(&group->listeners);
size_t lines_per_render = 3;
size_t lines_render_count = 1;
if (listeners_len > 0) {
for (int i = (int)listeners_len - 1; i >= 0; i--) {
size_t line_skip = lines_per_render * lines_render_count++;
struct progress_listener *listener;
aws_array_list_get_at(&group->listeners, (void **)&listener, i);
aws_mutex_lock(&listener->mutex);
if (listener->render_update_pending) {
/* move from the bottom up to the row we need. */
fprintf(group->render_sink, "\033[%zuA", line_skip);
progress_listener_render(listener);
listener->render_update_pending = false;
/* now go back so the next tick gets the same offset to work from. */
fprintf(group->render_sink, "\033[%zuB", line_skip - lines_per_render);
}
aws_mutex_unlock(&listener->mutex);
}
}
aws_mutex_unlock(&group->mutex);
}
static void s_render_task(struct aws_task *task, void *arg, enum aws_task_status status) {
struct progress_listener_group *group = arg;
struct aws_allocator *allocator = group->allocator;
if (status == AWS_TASK_STATUS_RUN_READY) {
progress_listener_group_render(group);
bool run_again = false;
aws_mutex_lock(&group->mutex);
run_again = group->run_in_background;
aws_mutex_unlock(&group->mutex);
if (run_again) {
struct aws_task *new_task = aws_mem_calloc(group->allocator, 1, sizeof(struct aws_task));
new_task->arg = group;
new_task->fn = s_render_task;
uint64_t run_at = 0;
aws_high_res_clock_get_ticks(&run_at);
/* run at TV framerate */
run_at += (AWS_TIMESTAMP_NANOS / 25);
aws_thread_scheduler_schedule_future(group->scheduler, new_task, run_at);
}
}
aws_mem_release(allocator, task);
}
void progress_listener_group_run_background_render_thread(struct progress_listener_group *group) {
aws_mutex_lock(&group->mutex);
group->run_in_background = true;
aws_mutex_unlock(&group->mutex);
struct aws_task *task = aws_mem_calloc(group->allocator, 1, sizeof(struct aws_task));
task->arg = group;
task->fn = s_render_task;
aws_thread_scheduler_schedule_now(group->scheduler, task);
}
struct progress_listener *progress_listener_new(
struct progress_listener_group *group,
struct aws_string *label,
struct aws_string *state_name,
uint64_t max_value) {
struct progress_listener *listener = aws_mem_calloc(group->allocator, 1, sizeof(struct progress_listener));
aws_mutex_init(&listener->mutex);
listener->max = max_value;
listener->current = 0;
listener->label = aws_string_clone_or_reuse(group->allocator, label);
listener->state = aws_string_clone_or_reuse(group->allocator, state_name);
listener->owning_group = group;
listener->render_update_pending = false;
aws_mutex_lock(&group->mutex);
aws_array_list_push_back(&group->listeners, &listener);
progress_listener_render(listener);
aws_mutex_unlock(&group->mutex);
return listener;
}
void progress_listener_update_progress(struct progress_listener *listener, uint64_t progress_update) {
aws_mutex_lock(&listener->mutex);
listener->current += progress_update;
listener->render_update_pending = true;
aws_mutex_unlock(&listener->mutex);
}
void progress_listener_reset_progress(struct progress_listener *listener) {
aws_mutex_lock(&listener->mutex);
listener->current = 0;
listener->render_update_pending = true;
aws_mutex_unlock(&listener->mutex);
}
void progress_listener_update_max_value(struct progress_listener *listener, uint64_t max_value) {
aws_mutex_lock(&listener->mutex);
listener->max = max_value;
listener->render_update_pending = true;
aws_mutex_unlock(&listener->mutex);
}
void progress_listener_update_state(struct progress_listener *listener, struct aws_string *state_name) {
aws_mutex_lock(&listener->mutex);
aws_string_destroy(listener->state);
listener->state = aws_string_clone_or_reuse(listener->owning_group->allocator, state_name);
listener->render_update_pending = true;
aws_mutex_unlock(&listener->mutex);
}
void progress_listener_update_label(struct progress_listener *listener, struct aws_string *new_label) {
aws_mutex_lock(&listener->mutex);
aws_string_destroy(listener->label);
listener->label = aws_string_clone_or_reuse(listener->owning_group->allocator, new_label);
listener->render_update_pending = true;
aws_mutex_unlock(&listener->mutex);
}
void progress_listener_render(struct progress_listener *listener) {
struct progress_listener_group *group = listener->owning_group;
fprintf(group->render_sink, "\33[2K");
/* clamp it to 80 characters to avoid overflow messing up the line calculations. */
fprintf(group->render_sink, "%.100s\n", aws_string_c_str(listener->label));
fprintf(group->render_sink, "\33[2K");
size_t completion = (size_t)(((double)listener->current / (double)listener->max) * 100);
size_t ticks = 50;
size_t completed_ticks = completion / (100 / ticks);
fprintf(group->render_sink, " [");
for (size_t i = 0; i < ticks; ++i) {
if (completed_ticks > i) {
fprintf(group->render_sink, "=");
} else {
fprintf(group->render_sink, "-");
}
}
fprintf(group->render_sink, "]");
/* clamp the state to 20 characters to avoid overflowing the line and missing up the line calculations */
fprintf(
group->render_sink,
" %" PRIu64 "/%" PRIu64 "(%zu%%) %.20s\n\33[2K\n",
listener->current,
listener->max,
completion,
aws_string_c_str(listener->state));
}
|