1 Star 0 Fork 0

中成才 / reflow

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Reflow

A light-weight lock-free series/parallel combined scheduling framework for tasks. The goal is to maximize parallelism in order to minimize the execution time overall.


  • From imperative to Monad: lite.Task —— Simplified and Type-safe Task Assembly Toolset

    • Simplify the mixed assembly of 'series/parallel' tasks, and each task definition and assembly tool are marked with I/O type, using the compiler check, match errors at a glance. Examples see here.
  • From single execution to streaming: Pulse —— Step Streaming Data Processor

    • Data flows through a set of large-scale integration tasks, can always be entered in the order in which it was entered, can be 'queued' (FIFO, using a ingenious scheduling strategy that doesn't actually have queue) into each tasks, and each task can also retain the mark specially left by the previous data during processing, so as to be used for the next data processing. It doesn't matter in any subtask of any depth, and it doesn't matter if the previous data stays in a subtask much longer than the latter. Examples see here.

Overview

"The maximum improvement in system performance is determined by the parts that cannot be parallelized." —— Amdahl's law

In a large system, there is often a lot of business logic and control logic, which is the embodiment of hundreds of "jobs". The logic is intertwined and, taken as a whole, often intricate. On the other hand, if this large amount of "jobs" is not organized reasonably and effectively, the execution time overall and performance are also worrying. So how do we abstract and simplify such a complex problem?

Programs = Algorithms + Data Structures
Algorithm = Logic + Control

Inspired by this idea, we can separate the business logic from the control logic, abstract the control logic as a framework, and construct the business logic as a Task. The relationship between tasks can also be further classified into two types: dependent and non-dependent, that is, serial and parallel (dependent tasks must be executed sequentially, and non-dependent tasks can be executed in parallel). The user programmer only needs to focus on writing task one by one and leave the rest to the framework. Reflow is designed around the control logic that handles these tasks.

Reflow was developed to simplify the coding complexity of data-flow and event-processing between multiple tasks in complex business logic. Through the design of I / O that requires explicit definition of tasks, intelligent dependency management based on keyword and value-type analysis, unified operation scheduling, event feedback and error handling interface, the set goal is realized: task series / parallel combined scheduling. Data is electricity, task is component. In addition to simplifying the coding complexity, the established framework can standardize the original chaotic and intricate writing method, and coding errors can be easily detected, which will greatly enhance the readability, robustness and scalability of the program.

In Reflow basic logic, a complex business should first be broken down into a series of single-function, no-blocking, single-threaded task sets and packaged in Trait that explicitly define the attributes of the task. Dependencies are then built and committed using Dependency, and a working reflow object is finally obtained, which is started and the task flow can be executed.

Features

  • The intelligent dependency analysis algorithm based on keyword and value-type can analyze errors in task assembly stage, ensuring that there will not be keyword missing or value-type mismatch errors during task execution;
  • On-demand task loading mechanism based on priority and estimated duration. On-demand means that the task is put into the priority-bucket to wait for to be executed when it is its turn to execute. Why wait? Because the current tasks to be executed in different task-flows will be put into the same priority-bucket, the existing tasks in the bucket will be sorted according to their priorities;
  • A task-flow can be requested to browse mode first and then reinforce mode. Browse mode allows data to be loaded quickly;
  • Tasks can be nested and assembled indefinitely;
  • The execution of each task is atomic, single-threaded, and you don't have to worry about thread synchronization problem of input and output, whether the task is in serial or parallel, and whether it is in Pulse or not;
  • Event feedback can be specified to the thread. For example: UI thread;
  • If subsequent tasks do not depend on the output of a task, the output is discarded, allowing memory to be used efficiently;
  • Convenient synchronous/asynchronous mode switching:
      // Asynchronous by default
      reflow.start(input, feedback)
      // To change to sync, simply add 'sync()' to the end.
      reflow.start(input, feedback).sync()
  • Task execution progress can be strategically feed back:
      // `Progress.Strategy.Xxx` e.g.
      implicit lazy val strategy: Strategy = Strategy.Depth(3) -> Strategy.Fluent -> Strategy.Interval(600)
  • Deterministic classification of exceptions:
      // Feedback.scala
      def onFailed(trat: Trait, e: Exception): Unit = {
      e match {
        // There are two categories:
        // 1. `RuntimeException` caused by customer code quality issues such as `NullPointerException` are wrapped in `CodeException`,
        // The specific exception object can be retrieved through the `CodeException#getCause()` method.
        case c: CodeException => c.getCause
        // 2. Custom `Exception`, which is explicitly passed to the 'Task#failed(Exception)' method parameter, possible be
        // `null` (although Scala considers `null` to be low level).
        case e: Exception => e.printStackTrace()
      }
    }
  • Clever interrupt strategy;
  • Global precise tasks monitoring and management:
      Reflow.GlobalTrack.registerObserver(new GlobalTrackObserver {
          override def onUpdate(current: GlobalTrack, items: All): Unit = {
            if (!current.isSubReflow && current.scheduler.getState == State.EXECUTING) {
              println(s"++++++++++[[[current.state:${current.scheduler.getState}")
              items().foreach(println)
              println("----------]]]")
            }
          }
        })(Strategy.Interval(600), null)
  • Optimized configurable thread pool: If tasks continues scheduling to the thread pool, increase the size of threads to the configured maximum, then enqueue, idle release threads until core size;
  • Thread implementation without blocking (lock-free) efficient utilization:

    There is no code for future.get() mechanism;
    This requires no blocking in the user-defined tasks (if there is a block, you can split the task into multiple dependent but non-blocking tasks, except for network requests).

These features greatly meet the practical requirements of various projects.

1.1 Related

The main features of this framework are similar to Facebook Bolts and RxJava, can be seen as fine-grained extensions of their task-combination capabilities, but it's more intuitive to use, more rigorous, high-spec, and closely aligned with actual project needs.

This framework is implemented based on the thread-pool (java.util.concurrent.ThreadPoolExecutor) instead of the Fork-Join framework (java.util.concurrent.ForkJoinPool), and improved the former (see Worker) to conform to the basic logic of increase the size of threads to maximum first, or else enqueue, release thread when idle. The latter is suitable for computationally intensive tasks, but is not suitable for the design objectives of this framework, and is not suitable for resource-constrained devices (e.g. mobile phones, etc).

1.2 Instruction

This framework is completely written in Scala language, and all parameters support shorthand, will be automatically escaped as needed (implicit), can be used on any platform that adopts jvm-like (e.g. Android Runtime).

This framework is based on a special anti-blocking thread synchronization tool Snatcher, see the code documentation for details.

  • Note: This framework does not use java.util.concurrent.Future<V> tools to handle parallel tasks, since it is implemented based on the thread blocking model, it does not meet the design goals of this framework: lock-free.

How Reflow works

Reflow operation principle diagram

Start using Reflow

3.1 Dependencies

Please click Jitpack

3.2 Example

See below or LiteSpec, and ReflowSpec.

  • If using on Android platform, please make the following settings first.
class App extends AbsApp {
  override def onCreate(): Unit = {
    App.reflow.init()
    super.onCreate()
  }
}

object App {
  object implicits {
    // Feedback strategy for task-flow execution progress
    implicit lazy val strategy: Strategy = Strategy.Depth(3) -> Strategy.Fluent -> Strategy.Interval(600)
    implicit lazy val poster: Poster = new Poster {
      // Post feedback to the UI thread
      override def post(runner: Runnable): Unit = getApp.mainHandler.post(runner)
    }
  }

  object reflow {
    private[App] def init(): Unit = {
      Reflow.setThreadResetor(new ThreadResetor {
        override def reset(thread: Thread, runOnCurrentThread: Boolean): Unit = {
          if (runOnCurrentThread) Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND)
        }
      })
    }
  }
}
  • Below is part of LiteSpec, which is very concise and recommended:
// ...
Scenario("`Serial/Parallel` Tasks mixed assembly") {
  val pars =
    (
      c2d
      +>>
      c2abc.inPar("name#c2abc", "`Serial` mix in `Parallel`")
      +>>
      (c2b >>> b2c >>> c2a >>> a2b) //.inPar("xxx") is optional.
      +>>
      c2a
    ) **> { (d, c, b, a, ctx) =>
      info(a.toString)
      info(b.toString)
      info(c.toString)
      info(d.toString)
      d
    }
  Input(new Aaa) >>> a2b >>> b2c >>> pars run() sync()

  assert(true)
}

// `Pulse`, more complex:
Scenario("Multi-level nested assembly test of `Pulse`") {
  val pars = {
    def p = (c2d +>> c2b) **> { (d, _, ctx) => ctx.progress(1, 2); d } +|- { (_, d) => d }
    @tailrec
    def loop(s: () => Serial[Ccc, Ddd], times: Int = 0, limit: Int = 10): Serial[Ccc, Ddd] =
      if (times >= limit) s()
      else {
        def p =
          (
            s() +|- { (_, d) => d }
            +>>
            s()
            +>>
            s()
          ) **> { (d, _, _, ctx) => ctx.progress(1, 2); d }
        loop(() => p, times + 1, limit)
      }
    loop(() => p, limit = 3)
  }

  @volatile var callableOut: Int = 0
  val future                     = new FutureTask[Int](() => callableOut)

  val repeatCount = 1000 // Int.MaxValue

  val pulse = (Input[Aaa] >>> a2b >>> b2c >>> pars) pulse (new reflow.Pulse.Feedback.Lite[Ddd] {
    override def onStart(serialNum: Long): Unit = {}
    // ...
  }
  // ...
  • Additional, refer to ReflowSpec, which is verbose and no longer recommended.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

一个轻量级方便使用的 lock-free 任务串/并联组合调度框架,目标是最大化并行以便把整体执行时间压缩到最小。 展开 收起
Scala 等 2 种语言
Apache-2.0
取消

发行版 (2)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Scala
1
https://gitee.com/wei.chou/reflow.git
git@gitee.com:wei.chou/reflow.git
wei.chou
reflow
reflow
master

搜索帮助