Ceph is a distributed object, block, and file storage platform
Go to file
Feng Hualong 0ce6d03bbc Crypto: Add QAT batch mode
Now, the current code does not allow qat to exert
its acceleration advantage, but leads to poor performance
of qat. The QAT batch mode is implemented here, so that
the QAT performance can be displayed.

When we scale up the number of concurrent requests and worry about
QAT instance will be bottleneck, we can fall back to CPU.

And there add a parameter to set the times of the number of QAT
instance to wait for free instance, which can avoid QAT to be
not busy and make sure QAT full of utilization as much as possible.

max_queue_size is up to max_requests

Add optional_yield in RGWPutObj_BlockEncrypt and
RGWGetObj_BlockDecrypt. Make it with coroutine and non-coroutine mode.

Signed-off-by: Feng Hualong <hualong.feng@intel.com>
2023-03-10 17:02:42 +08:00
.github .github: update add-to-project action 2023-02-27 16:01:33 +01:00
admin doc: remove rtd main checkout 2022-11-28 08:37:24 -05:00
bin
ceph-erasure-code-corpus@2d7d78b9cc Rollback submodules changes made by accident 2023-01-30 15:16:46 +00:00
ceph-menv
ceph-object-corpus@038c72b5ac ceph-object-corpus: pick up 16.2.0-90-g50f1821b4c 2021-04-12 21:49:28 +08:00
cmake/modules Merge pull request #48729 from ivancich/wip-flight-select-add-flight 2023-01-17 18:22:54 -05:00
debian mgr/prometheus: use vendored "packaging" instead 2023-01-11 20:31:03 +08:00
doc Merge pull request #50335 from adk3798/cephadm-compatability-update 2023-03-02 07:36:46 +10:00
etc
examples Merge pull request #50202 from rzarzynski/wip-librbd-drop-cxx11-from-example 2023-02-23 18:25:14 +01:00
fusetrace
keys
man doc,man: typos found by codespell 2021-12-15 12:04:36 +01:00
mirroring doc: Remove inactive Ceph mirrors. 2022-08-19 09:47:26 +08:00
monitoring Merge pull request #48783 from rhcs-dashboard/fix-grafana-stat-panel 2023-02-08 18:34:30 +05:30
qa Merge PR #48720 into main 2023-03-01 07:54:18 +05:30
selinux selinux: prepare for anon inode controls enablement 2022-08-29 14:42:44 +02:00
share
src Crypto: Add QAT batch mode 2023-03-10 17:02:42 +08:00
sudoers.d rpm, debian: move smartmontools and nvme-cli to ceph-base 2021-08-25 13:20:23 +00:00
systemd Merge pull request #44221 from BenoitKnecht/ceph-mon-device-metrics 2022-01-10 07:56:29 -08:00
udev rbd: include RADOS namespace in krbd symlinks 2020-09-08 19:36:02 +02:00
.gitattributes doc: use union merge strategy for resolving conflicts in PendingReleaseNotes 2020-08-28 18:59:30 -07:00
.githubmap Merge PR #48473 into main 2022-12-19 16:17:15 +05:30
.gitignore osd/scrub: scrubbing schedule - minor related cleanups 2021-11-05 17:07:57 +02:00
.gitleaks.toml .gitleaks.toml: Allowlist cephadm test 2022-08-08 13:57:36 -04:00
.gitmodule_mirrors
.gitmodules remove rapidjson submodule 2022-11-30 14:59:27 -05:00
.mailmap mailmap: add Pedro Gonzalez Gomez 2022-10-17 15:59:36 +02:00
.organizationmap mailmap: add Pedro Gonzalez Gomez 2022-10-17 15:59:36 +02:00
.peoplemap .githubmap: update mail address 2021-08-17 09:57:25 +05:30
.readthedocs.yml doc: remove rtd main checkout 2022-11-28 08:37:24 -05:00
AUTHORS
ceph.spec.in rpm: use system arrow packages for fedora/centos9 2023-01-25 13:47:08 -05:00
CMakeLists.txt rgw: add conditional backtrace logging after "WARNING: blocking librados call" 2023-01-24 14:04:01 -05:00
CodingStyle mgr/dashboard: tslint to eslint migration 2022-11-14 22:56:21 +05:30
CONTRIBUTING.rst doc/rados/configuration/common.rst: expand the running multiple clusters section 2020-11-14 01:36:07 -08:00
COPYING COPYING: add entries for backport scripts 2021-01-14 17:42:56 +01:00
COPYING-GPL2
COPYING-LGPL2.1
COPYING-LGPL3
do_cmake.sh do_cmake.sh: build with python3.10 on ubuntu version >= 22.0 2022-08-23 10:09:11 -05:00
do_freebsd.sh do_freebsd.sh: set WITH_JAEGER=OFF 2022-05-17 04:42:01 -04:00
doc_deps.deb.txt admin/build-doc: s/virtualenv/python3 -m venv/ 2021-07-31 22:34:05 +08:00
install-deps.sh install-deps.sh: Fail when downloading apt repos 2023-02-06 13:50:46 -07:00
make-debs.sh make-debs.sh: remove lsb_release 2021-08-18 13:08:24 -04:00
make-dist make-dist: don't set Release tag in ceph.spec for SUSE distros 2022-10-25 09:49:50 +11:00
make-srpm.sh
mingw_conf.sh win32: add rhel option 2022-09-27 11:21:18 -04:00
PendingReleaseNotes Merge PR #48720 into main 2023-03-01 07:54:18 +05:30
pom.xml
README.aix ceph.spec.in: drop gdbm from build deps 2021-08-18 01:04:42 +08:00
README.FreeBSD
README.md Update README.md 2023-01-29 12:42:01 +05:30
README.solaris
README.windows.rst doc/cephfs: update Dokany requirement 2022-08-30 14:04:54 +00:00
run-make-check.sh build: temporarily disable WITH_RADOSGW_MOTR in make check 2022-08-11 13:50:42 -04:00
SECURITY.md SECURITY.md: update security policy 2021-05-14 19:11:02 +05:30
SubmittingPatches-backports.rst doc: change "master" to "main" in backport doc 2022-08-03 08:32:16 +00:00
SubmittingPatches-kernel.rst
SubmittingPatches.rst SubmittingPatches.rst: PRs should target "main" 2022-06-13 09:38:40 +08:00
win32_build.sh win32_build.sh: build "ceph_test*" 2023-02-17 10:42:40 +00:00
win32_deps_build.sh Merge pull request #47874 from petrutlucian94/dokany_v2 2022-10-27 18:18:36 +05:30

Ceph - a scalable distributed storage system

Please see https://ceph.com/ for current info.

Contributing Code

Most of Ceph is dual licensed under the LGPL version 2.1 or 3.0. Some miscellaneous code is under a BSD-style license or is public domain. The documentation is licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0). There are a handful of headers included here that are licensed under the GPL. Please see the file COPYING for a full inventory of licenses by file.

Code contributions must include a valid "Signed-off-by" acknowledging the license for the modified or contributed file. Please see the file SubmittingPatches.rst for details on what that means and on how to generate and submit patches.

We do not require assignment of copyright to contribute code; code is contributed under the terms of the applicable license.

Checking out the source

You can clone from github with

git clone git@github.com:ceph/ceph

or, if you are not a github user,

git clone https://github.com/ceph/ceph.git

Ceph contains many git submodules that need to be checked out with

git submodule update --init --recursive

Build Prerequisites

The list of Debian or RPM packages dependencies can be installed with:

./install-deps.sh

Building Ceph

Note that these instructions are meant for developers who are compiling the code for development and testing. To build binaries suitable for installation we recommend you build deb or rpm packages or refer to the ceph.spec.in or debian/rules to see which configuration options are specified for production builds.

Build instructions:

./do_cmake.sh
cd build
ninja

(do_cmake.sh now defaults to creating a debug build of ceph that can be up to 5x slower with some workloads. Please pass "-DCMAKE_BUILD_TYPE=RelWithDebInfo" to do_cmake.sh to create a non-debug release.

The number of jobs used by ninja is derived from the number of CPU cores of the building host if unspecified. Use the -j option to limit the job number if the build jobs are running out of memory. On average, each job takes around 2.5GiB memory.)

This assumes you make your build dir a subdirectory of the ceph.git checkout. If you put it elsewhere, just point CEPH_GIT_DIR to the correct path to the checkout. Any additional CMake args can be specified by setting ARGS before invoking do_cmake. See cmake options for more details. Eg.

ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh

To build only certain targets use:

ninja [target name]

To install:

ninja install

CMake Options

If you run the cmake command by hand, there are many options you can set with "-D". For example, the option to build the RADOS Gateway is defaulted to ON. To build without the RADOS Gateway:

cmake -DWITH_RADOSGW=OFF [path to top-level ceph directory]

Another example below is building with debugging and alternate locations for a couple of external dependencies:

cmake -DLEVELDB_PREFIX="/opt/hyperleveldb" \
-DCMAKE_INSTALL_PREFIX=/opt/ceph -DCMAKE_C_FLAGS="-Og -g3 -gdwarf-4" \
..

Ceph has several bundled dependencies such as Boost, RocksDB and Arrow. By default, cmake will build these bundled dependencies from source instead of using libraries that are already installed on the system. You can opt-in to using these system libraries, provided they meet the minimum version required by Ceph, with cmake options like WITH_SYSTEM_BOOST:

cmake -DWITH_SYSTEM_BOOST=ON [...]

To view an exhaustive list of -D options, you can invoke cmake with:

cmake -LH

If you often pipe ninja to less and would like to maintain the diagnostic colors for errors and warnings (and if your compiler supports it), you can invoke cmake with:

cmake -DDIAGNOSTICS_COLOR=always ...

Then you'll get the diagnostic colors when you execute:

ninja | less -R

Other available values for 'DIAGNOSTICS_COLOR' are 'auto' (default) and 'never'.

Building a source tarball

To build a complete source tarball with everything needed to build from source and/or build a (deb or rpm) package, run

./make-dist

This will create a tarball like ceph-$version.tar.bz2 from git. (Ensure that any changes you want to include in your working directory are committed to git.)

Running a test cluster

To run a functional test cluster,

cd build
ninja vstart        # builds just enough to run vstart
../src/vstart.sh --debug --new -x --localhost --bluestore
./bin/ceph -s

Almost all of the usual commands are available in the bin/ directory. For example,

./bin/rados -p rbd bench 30 write
./bin/rbd create foo --size 1000

To shut down the test cluster,

../src/stop.sh

To start or stop individual daemons, the sysvinit script can be used:

./bin/init-ceph restart osd.0
./bin/init-ceph stop

Running unit tests

To build and run all tests (in parallel using all processors), use ctest:

cd build
ninja
ctest -j$(nproc)

(Note: Many targets built from src/test are not run using ctest. Targets starting with "unittest" are run in ninja check and thus can be run with ctest. Targets starting with "ceph_test" can not, and should be run by hand.)

When failures occur, look in build/Testing/Temporary for logs.

To build and run all tests and their dependencies without other unnecessary targets in Ceph:

cd build
ninja check -j$(nproc)

To run an individual test manually, run ctest with -R (regex matching):

ctest -R [regex matching test name(s)]

(Note: ctest does not build the test it's running or the dependencies needed to run it)

To run an individual test manually and see all the tests output, run ctest with the -V (verbose) flag:

ctest -V -R [regex matching test name(s)]

To run tests manually and run the jobs in parallel, run ctest with the -j flag:

ctest -j [number of jobs]

There are many other flags you can give ctest for better control over manual test execution. To view these options run:

man ctest

Building the Documentation

Prerequisites

The list of package dependencies for building the documentation can be found in doc_deps.deb.txt:

sudo apt-get install `cat doc_deps.deb.txt`

Building the Documentation

To build the documentation, ensure that you are in the top-level /ceph directory, and execute the build script. For example:

admin/build-doc

Reporting Issues

To report an issue and view existing issues, please visit https://tracker.ceph.com/projects/ceph.