Skip to content

baidu/babylon

Repository files navigation

Babylon

CI Coverage Status

Babylon是一个用于支持C++高性能服务端开发的基础库,从内存和并行管理角度提供了大量的基础组件。广泛应用在对性能有严苛要求的场景,典型例如搜索推荐引擎,自动驾驶车载计算等场景

核心功能

  • 高效的应用级内存池机制
  • 组件式并行计算框架
    • 基于无锁DAG推导的高性能自动组件并行框架
    • 依照执行流天然生成数据流管理方案,复杂计算图场景下提供安全的数据竞争管理
    • 微流水线并行机制,提供上限更好的并行化能力
  • 并行开发基础组件
    • wait-free级别的并发安全容器(vector/queue/hash_table/...)
    • 可遍历的线程缓存开发框架
    • 可扩展支持线程/协程的同步原语(future/mutex/...)
  • 应用/框架搭建基础工具
    • IOC组件开发框架
    • C++对象序列化框架
    • 零拷贝/零分配异步日志框架

编译并使用

支持平台和编译器

  • OS: Linux
  • CPU: x86-64/aarch64
  • COMPILER: gcc-9/gcc-10/gcc-12/clang-10/clang-14

Bazel

Babylon使用Bazel进行构建并使用bzlmod进行依赖管理,考虑到目前Bazel生态整体处于bzlmod的转换周期,Babylon也依然兼容workspace依赖管理模式

bzlmod

  • 增加仓库注册表
# in .bazelrc
# babylon自身发布在独立注册表
common --registry=https://baidu.github.io/babylon/registry
# babylon依赖的boost发布在bazelboost项目的注册表,当然如果有其他源可以提供boost的注册表也可以替换
# 只要同样能够提供boost.preprocessor和boost.spirit模块寻址即可
common --registry=https://raw.githubusercontent.com/bazelboost/registry/main
  • 增加依赖项
# in MODULE.bazel
bazel_dep(name = 'babylon', version = '1.1.5')
  • 添加依赖的子模块到编译目标,全部可用子模块可以参照模块功能文档,或者BUILD文件
# in BUILD
cc_library(
  ...
  deps = [
    ...
    '@babylon//:any',
    '@babylon//:concurrent',
  ],
)
  • 也可以直接添加All in One依赖目标@babylon//:babylon
  • example/depend-use-bzlmod可以找到一个如何通过bzlmod依赖的简单样例

workspace

  • 增加babylon依赖项
# in WORKSPACE
http_archive(
  name = 'com_baidu_babylon',
  urls = ['https://github.com/baidu/babylon/archive/refs/tags/v1.1.5.tar.gz'],
  strip_prefix = 'babylon-1.1.5',
  sha256 = 'a8d37251972a522b4c6f4d28ac6bf536444ff0e0c0e47eebff37aa75ca2a65a6',
)
  • 增加传递依赖项,内容拷贝自babylon代码库的WORKSPACE,并和项目自身依赖项合并
# in WORKSPACE
... // 增加babylon的WORKSPACE内的依赖项,注意和项目已有依赖去重合并
  • 添加依赖的子模块到编译目标,全部可用子模块可以参照模块功能文档,或者BUILD文件
# in BUILD
cc_library(
  ...
  deps = [
    ...
    '@com_baidu_babylon//:any',
    '@com_baidu_babylon//:concurrent',
  ],
)
  • 也可以直接添加All in One依赖目标@com_baidu_babylon//:babylon
  • example/depend-use-workspace可以找到一个如何通过workspace依赖的简单样例

CMake

Babylon也支持使用CMake进行构建,并支持通过find_packageadd_subdirectoryFetchContent进行依赖引入

FetchContent

  • 增加依赖项到目标项目
# in CMakeList.txt
set(BUILD_DEPS ON)

include(FetchContent)
FetchContent_Declare(
  babylon
  URL "https://github.com/baidu/babylon/archive/refs/tags/v1.1.5.tar.gz"
  URL_HASH SHA256=a8d37251972a522b4c6f4d28ac6bf536444ff0e0c0e47eebff37aa75ca2a65a6
)
FetchContent_MakeAvailable(babylon)
  • 添加依赖到编译目标,CMake编译目前只提供All in One依赖目标babylon::babylon
# in CMakeList.txt
target_link_libraries(your_target babylon::babylon)
  • 编译目标项目
    • cmake -Bbuild
    • cmake --build build -j$(nproc)
  • example/depend-use-cmake-fetch可以找到一个如何通过CMake FetchContent依赖的简单样例

find_package

  • 编译并安装boost abseil-cpp protobuf或者直接使用apt等包管理工具安装对应平台的预编译包
  • 编译并安装babylon
    • cmake -Bbuild -DCMAKE_INSTALL_PREFIX=/your/install/path -DCMAKE_PREFIX_PATH=/your/install/path
    • cmake --build build -j$(nproc)
    • cmake --install build
  • 增加依赖项到目标项目
# in CMakeList.txt
find_package(babylon REQUIRED)
  • 添加依赖到编译目标,CMake编译目前只提供All in One依赖目标babylon::babylon
# in CMakeList.txt
target_link_libraries(your_target babylon::babylon)
  • 编译目标项目
    • cmake -Bbuild -DCMAKE_PREFIX_PATH=/your/install/path
    • cmake --build build -j$(nproc)
  • example/depend-use-cmake-find可以找到一个如何通过CMake find_package依赖的简单样例

add_subdirectory

  • 下载boost abseil-cpp protobuf``babylon源码
  • 增加依赖项到目标项目
# in CMakeList.txt
set(BOOST_INCLUDE_LIBRARIES preprocessor spirit)
add_subdirectory(boost EXCLUDE_FROM_ALL)
set(ABSL_ENABLE_INSTALL ON)
add_subdirectory(abseil-cpp)
set(protobuf_BUILD_TESTS OFF)
add_subdirectory(protobuf)
add_subdirectory(babylon)
  • 添加依赖到编译目标,CMake编译目前只提供All in One依赖目标babylon::babylon
# in CMakeList.txt
target_link_libraries(your_target babylon::babylon)
  • 编译目标项目
    • cmake -Bbuild
    • cmake --build build -j$(nproc)
  • example/depend-use-cmake-subdir可以找到一个如何通过CMake sub_directory依赖的简单样例

模块功能文档

整体设计思路

如何贡献

如果你遇到问题或需要新功能,欢迎创建issue。

如果你可以解决某个issue, 欢迎发送PR。

发送PR前请确认有对应的单测代码。