aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/thread/Task.cpp
blob: a11d23d3e6a869a492bb761a1975ad01849e48a5 (plain)
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
/**
 * Copyright (C) 2021 Saturneric
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * The source code version of this software was modified and released
 * by Saturneric<[email protected]><[email protected]> starting on May 12, 2021.
 *
 */

#include "core/thread/Task.h"

#include <boost/uuid/uuid.hpp>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <functional>
#include <string>
#include <utility>

#include "core/thread/TaskRunner.h"

const std::string GpgFrontend::Thread::Task::DEFAULT_TASK_NAME = "default-task";

GpgFrontend::Thread::Task::Task(std::string name)
    : uuid_(generate_uuid()), name_(name) {
  SPDLOG_TRACE("task {}/ created", GetFullID());
  init();
}

GpgFrontend::Thread::Task::Task(TaskRunnable runnable, std::string name,
                                DataObjectPtr data_object, bool sequency)
    : uuid_(generate_uuid()),
      name_(name),
      runnable_(std::move(runnable)),
      callback_(std::move([](int, const std::shared_ptr<DataObject> &) {})),
      callback_thread_(QThread::currentThread()),
      data_object_(data_object),
      sequency_(sequency) {
  SPDLOG_TRACE("task {} created with runnable, callback_thread_: {}",
               GetFullID(), static_cast<void *>(callback_thread_));
  init();
}

GpgFrontend::Thread::Task::Task(TaskRunnable runnable, std::string name,
                                DataObjectPtr data_object,
                                TaskCallback callback, bool sequency)
    : uuid_(generate_uuid()),
      name_(name),
      runnable_(std::move(runnable)),
      callback_(std::move(callback)),
      callback_thread_(QThread::currentThread()),
      data_object_(data_object),
      sequency_(sequency) {
  init();
  SPDLOG_TRACE(
      "task {} created with runnable and callback, callback_thread_: {}",
      GetFullID(), static_cast<void *>(callback_thread_));
}

GpgFrontend::Thread::Task::~Task() {
  SPDLOG_TRACE("task {} destroyed", GetFullID());
}

/**
 * @brief
 *
 * @return std::string
 */
std::string GpgFrontend::Thread::Task::GetFullID() const {
  return uuid_ + "/" + name_;
}

std::string GpgFrontend::Thread::Task::GetUUID() const { return uuid_; }

bool GpgFrontend::Thread::Task::GetSequency() const { return sequency_; }

void GpgFrontend::Thread::Task::HoldOnLifeCycle(bool hold_on) {
  this->run_callback_after_runnable_finished_ = !hold_on;
}

void GpgFrontend::Thread::Task::SetRTN(int rtn) { this->rtn_ = rtn; }

void GpgFrontend::Thread::Task::init() {
  // after runnable finished, running callback
  connect(this, &Task::SignalTaskRunnableEnd, this,
          &Task::slot_task_run_callback);
}

void GpgFrontend::Thread::Task::slot_task_run_callback(int rtn) {
  SPDLOG_TRACE("task runnable {} finished, rtn: {}", GetFullID(), rtn);
  // set return value
  this->SetRTN(rtn);

  try {
    if (callback_) {
      if (callback_thread_ == QThread::currentThread()) {
        SPDLOG_DEBUG("callback thread is the same thread");
        if (!QMetaObject::invokeMethod(callback_thread_,
                                       [callback = callback_, rtn = rtn_,
                                        data_object = data_object_, this]() {
                                         callback(rtn, data_object);
                                         // do cleaning work
                                         emit SignalTaskEnd();
                                       })) {
          SPDLOG_ERROR("failed to invoke callback");
        }
        // just finished, let callack thread to raise SignalTaskEnd
        return;
      } else {
        // waiting for callback to finish
        if (!QMetaObject::invokeMethod(
                callback_thread_,
                [callback = callback_, rtn = rtn_,
                 data_object = data_object_]() { callback(rtn, data_object); },
                Qt::BlockingQueuedConnection)) {
          SPDLOG_ERROR("failed to invoke callback");
        }
      }
    }
  } catch (std::exception &e) {
    SPDLOG_ERROR("exception caught: {}", e.what());
  } catch (...) {
    SPDLOG_ERROR("unknown exception caught");
  }

  // raise signal, announcing this task come to an end
  SPDLOG_DEBUG("task {}, starting calling signal SignalTaskEnd", GetFullID());
  emit SignalTaskEnd();
}

void GpgFrontend::Thread::Task::run() {
  SPDLOG_TRACE("task {} starting", GetFullID());

  // build runnable package for running
  auto runnable_package = [=, id = GetFullID()]() {
    SPDLOG_DEBUG("task {} runnable start runing", id);
    // Run() will set rtn by itself
    Run();
    // raise signal to anounce after runnable returned
    if (run_callback_after_runnable_finished_) emit SignalTaskRunnableEnd(rtn_);
  };

  if (thread() != QThread::currentThread()) {
    SPDLOG_DEBUG("task running thread is not object living thread");
    // if running sequently
    if (sequency_) {
      // running in another thread, blocking until returned
      if (!QMetaObject::invokeMethod(thread(), runnable_package,
                                     Qt::BlockingQueuedConnection)) {
        SPDLOG_ERROR("qt invoke method failed");
      }
    } else {
      // running in another thread, non-blocking
      if (!QMetaObject::invokeMethod(thread(), runnable_package)) {
        SPDLOG_ERROR("qt invoke method failed");
      }
    }
  } else {
    if (!QMetaObject::invokeMethod(this, runnable_package)) {
      SPDLOG_ERROR("qt invoke method failed");
    }
  }
}

void GpgFrontend::Thread::Task::SlotRun() { run(); }

void GpgFrontend::Thread::Task::Run() {
  if (runnable_) {
    SetRTN(runnable_(data_object_));
  } else {
    SPDLOG_WARN("no runnable in task, do callback operation");
  }
}

GpgFrontend::Thread::Task::DataObject::Destructor *
GpgFrontend::Thread::Task::DataObject::get_heap_ptr(size_t bytes_size) {
  Destructor *dstr_ptr = new Destructor();
  dstr_ptr->p_obj = malloc(bytes_size);
  return dstr_ptr;
}

GpgFrontend::Thread::Task::DataObject::~DataObject() {
  if (!data_objects_.empty())
    SPDLOG_WARN("data_objects_ is not empty",
                "address:", static_cast<void *>(this));
  while (!data_objects_.empty()) {
    free_heap_ptr(data_objects_.top());
    data_objects_.pop();
  }
}

size_t GpgFrontend::Thread::Task::DataObject::GetObjectSize() {
  return data_objects_.size();
}

void GpgFrontend::Thread::Task::DataObject::free_heap_ptr(Destructor *ptr) {
  SPDLOG_TRACE("p_obj: {} data object: {}",
               static_cast<const void *>(ptr->p_obj),
               static_cast<void *>(this));
  if (ptr->destroy != nullptr) {
    ptr->destroy(ptr->p_obj);
  }
  free(const_cast<void *>(ptr->p_obj));
  delete ptr;
}

std::string GpgFrontend::Thread::Task::generate_uuid() {
  return boost::uuids::to_string(boost::uuids::random_generator()());
}