diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 000000000..e11f87dbf --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 5cdcdb4e44bb7fbbec8a93fbb5db20d4 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.builds/alpine.yml b/.builds/alpine.yml deleted file mode 100644 index dbad71676..000000000 --- a/.builds/alpine.yml +++ /dev/null @@ -1,30 +0,0 @@ -image: alpine/latest -packages: - - bison - - cmake - - flex - - g++ - - libatomic - - libevent-dev - - libstdc++ - - memcached -sources: - - https://github.com/awesomized/libmemcached -secrets: - - a223d068-8d3f-4bab-a623-ed6e2887820a - - d7dfe587-b433-481b-8725-d7ccd82e59fb -environment: - ENABLE_HASH_HSIEH: "ON" - ENABLE_MEMASLAP: "ON" - VERBOSE: "ON" -tasks: - - prepare: | - ./libmemcached/.builds/scripts/prepare - - configure: | - maybe cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -S libmemcached -B debug - - build: | - maybe cmake --build debug -j2 - - test: | - maybe cmake --build debug -j2 --target test - - install: | - maybe cmake --install debug --prefix /tmp diff --git a/.builds/freebsd.yml b/.builds/freebsd.yml deleted file mode 100644 index 1f603497e..000000000 --- a/.builds/freebsd.yml +++ /dev/null @@ -1,47 +0,0 @@ -image: freebsd/latest -packages: - - autotools - - bison - - cmake - - curl - - cyrus-sasl - - flex - - libevent - - pkgconf - - py311-sphinx - - py311-m2r - - rsync - - tbb -sources: - - https://github.com/awesomized/libmemcached -secrets: - - a223d068-8d3f-4bab-a623-ed6e2887820a - - d7dfe587-b433-481b-8725-d7ccd82e59fb -environment: - ENABLE_HASH_HSIEH: "ON" - ENABLE_MEMASLAP: "ON" - ENABLE_SASL: "ON" - VERBOSE: "ON" - MEMCACHED_BINARY: "/home/build/memcached/work/stage/usr/local/bin/memcached" -tasks: - - prepare: | - ./libmemcached/.builds/scripts/prepare - - memcached: | - ln -s /usr/ports/Mk . - ln -s /usr/ports/Templates . - cp -R /usr/ports/databases/memcached . - cd memcached - echo bin/memcached > pkg-plist - maybe make all install PREFIX=/home/build \ - INSTALL_AS_USER=1 NO_PKG_REGISTER=1 PKG_REGISTER=/usr/bin/true \ - SASLPWDB_CONFIGURE_ENABLE=sasl-pwdb \ - OPTIONS_SET="SASL SASLPWDB" \ - OPTIONS_DEFINE="SASL SASLPWDB" - - configure: | - maybe cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -S libmemcached -B debug - - build: | - maybe cmake --build debug -j2 - - test: | - maybe cmake --build debug -j2 --target test - - install: | - maybe cmake --install debug --prefix /tmp diff --git a/.builds/openbsd.yml b/.builds/openbsd.yml deleted file mode 100644 index aaad527f7..000000000 --- a/.builds/openbsd.yml +++ /dev/null @@ -1,35 +0,0 @@ -image: openbsd/latest -packages: - - bison - - cmake - - curl-- - - libevent - - memcached-- - - pkgconf - - pigz - - py3-sphinx - - py3-m2r - - rsync-- - - sudo-- - - tbb -sources: - - https://github.com/awesomized/libmemcached -secrets: - - a223d068-8d3f-4bab-a623-ed6e2887820a - - d7dfe587-b433-481b-8725-d7ccd82e59fb -environment: - ENABLE_HASH_HSIEH: "ON" - ENABLE_MEMASLAP: "OFF" - VERBOSE: "ON" - MEMCACHED_BINARY: "memcached" -tasks: - - prepare: | - ./libmemcached/.builds/scripts/prepare - - configure: | - maybe cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -S libmemcached -B debug - - build: | - maybe cmake --build debug -j2 - - test: | - maybe cmake --build debug -j2 --target test - - install: | - maybe cmake --install debug --prefix /tmp diff --git a/.builds/scripts/maybe b/.builds/scripts/maybe deleted file mode 100755 index eae3cd744..000000000 --- a/.builds/scripts/maybe +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env bash -"$@" -ERROR=$? - -if test $ERROR -ne 0 -then - # notify-gitter failure - exit $ERROR -fi diff --git a/.builds/scripts/notify-gitter b/.builds/scripts/notify-gitter deleted file mode 100755 index 22bf064cb..000000000 --- a/.builds/scripts/notify-gitter +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env bash -set -eu - -test -f ~/.gitter || exit 0 - -GITTER=$(cat ~/.gitter) -STATUS=$1 - -REPO=awesomized/libmemcached -REF=$(GIT_DIR=libmemcached/.git git describe --abbrev --always) -REF_URL=https://github.com/${REPO}/commits/${REF} - -BUILD_URL=${JOB_URL} -BUILD_TAG=$(uname -o 2>/dev/null || uname -s) -if expr "$BUILD_TAG" : ".*Linux" >/dev/null -then - BUILD_TAG=$(source /etc/os-release; echo $PRETTY_NAME) -fi -BUILD_CXX=$(c++ --version | head -1) -if expr "${BUILD_CXX}" : "${BUILD_TAG}" >/dev/null -then - BUILD_ENV="${BUILD_CXX}" -else - BUILD_ENV="${BUILD_TAG}/${BUILD_CXX}" -fi - -case "$STATUS" in -success) - LEVEL=info - ;; -*) - LEVEL=error - ;; -esac -MESSAGE="Sourcehut [${REPO}](${REF_URL}) (${REF}) [${STATUS}](${BUILD_URL}) (${BUILD_ENV})" - -curl -sS "${GITTER}" --data-urlencode "level=${LEVEL}" --data-urlencode "message=${MESSAGE}" - diff --git a/.builds/scripts/prepare b/.builds/scripts/prepare deleted file mode 100755 index 5ddc015e3..000000000 --- a/.builds/scripts/prepare +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env bash -echo 'PATH="$PATH:~/libmemcached/.builds/scripts"' >>~/.buildenv diff --git a/.clang-format b/.clang-format deleted file mode 100644 index 7b77b814e..000000000 --- a/.clang-format +++ /dev/null @@ -1,128 +0,0 @@ -AccessModifierOffset: -2 -AlignAfterOpenBracket: Align -AlignConsecutiveAssignments: false -#AlignConsecutiveBitFields: false (in v11) -AlignConsecutiveDeclarations: false -AlignConsecutiveMacros: true -AlignEscapedNewlines: DontAlign -# AlignOperands: AlignAfterOperator (in v11) -AlignOperands: false -AlignTrailingComments: true -AllowAllArgumentsOnNextLine: true -AllowAllConstructorInitializersOnNextLine: true -AllowAllParametersOfDeclarationOnNextLine: true -AllowShortBlocksOnASingleLine: Never -AllowShortCaseLabelsOnASingleLine: false -#AllowShortEnumsOnASingleLine: true (in v11) -AllowShortFunctionsOnASingleLine: Empty -AllowShortIfStatementsOnASingleLine: Never -AllowShortLambdasOnASingleLine: All -AllowShortLoopsOnASingleLine: true -AlwaysBreakAfterReturnType: None -AlwaysBreakBeforeMultilineStrings: false -AlwaysBreakTemplateDeclarations: Yes -BinPackArguments: true -BinPackParameters: true -#BitFieldColonSpacing: None (in v12) -BraceWrapping: - AfterCaseLabel: false - AfterClass: false - AfterControlStatement: MultiLine - AfterEnum: false - AfterExternBlock: false - AfterFunction: false - AfterNamespace: false - AfterObjCDeclaration: false - AfterStruct: false - AfterUnion: false - BeforeCatch: false - BeforeElse: false -# BeforeLambdaBody: false (in v11) -# BeforeWhile: false (in v11) - IndentBraces: false - SplitEmptyFunction: true - SplitEmptyNamespace: true - SplitEmptyRecord: true -BreakBeforeBinaryOperators: NonAssignment -BreakBeforeBraces: Custom -BreakBeforeInheritanceComma: true -BreakBeforeTernaryOperators: true -BreakConstructorInitializers: BeforeComma -BreakConstructorInitializersBeforeComma: true -BreakInheritanceList: BeforeComma -BreakStringLiterals: true -ColumnLimit: 100 -#CommentPragmas: '^ ...' -CompactNamespaces: false -ConstructorInitializerAllOnOneLineOrOnePerLine: false -ConstructorInitializerIndentWidth: 0 -ContinuationIndentWidth: 4 -Cpp11BracedListStyle: true -DeriveLineEnding: true -DerivePointerAlignment: false -DisableFormat: false -#ExperimentalAutoDetectBinPacking: false -FixNamespaceComments: true -ForEachMacros: - - foreach - - BOOST_FOREACH -IncludeBlocks: Preserve -IncludeCategories: - - Regex: '^"lib(hashkit|(memcached(|protocol|util)))(-.*)?/' - Priority: 3 - - Regex: '^(<|")test/)' - Priority: 2 - - Regex: '.*' - Priority: 1 -IncludeIsMainSourceRegex: '' -IndentCaseLabels: false -IndentGotoLabels: false -#IndentExternBlock: false (in v11) -IndentPPDirectives: AfterHash -IndentWidth: 2 -IndentWrappedFunctionNames: false -#InsertTrailingCommas: Wrapped (in v11) -KeepEmptyLinesAtTheStartOfBlocks: false -Language: Cpp -MacroBlockBegin: '' -MacroBlockEnd: '' -MaxEmptyLinesToKeep: 1 -NamespaceIndentation: None -#PenaltyBreakAssignment: 2 -#PenaltyBreakBeforeFirstCallParameter: 19 -#PenaltyBreakComment: 300 -#PenaltyBreakFirstLessLess: 120 -#PenaltyBreakString: 1000 -#PenaltyBreakTemplateDeclaration: 10 -#PenaltyExcessCharacter: 1000000 -#PenaltyReturnTypeOnItsOwnLine: 60 -PointerAlignment: Right -ReflowComments: true -SortIncludes: false -SortUsingDeclarations: true -SpaceAfterCStyleCast: true -SpaceAfterLogicalNot: false -SpaceAfterTemplateKeyword: false -#SpaceAroundPointerQualifiers: Both (in v12) -SpaceBeforeAssignmentOperators: true -SpaceBeforeCpp11BracedList: false -SpaceBeforeCtorInitializerColon: true -SpaceBeforeInheritanceColon: true -SpaceBeforeParens: ControlStatements -SpaceBeforeRangeBasedForLoopColon: true -SpaceBeforeSquareBrackets: false -SpaceInEmptyBlock: false -SpaceInEmptyParentheses: false -SpacesBeforeTrailingComments: 1 -SpacesInAngles: false -SpacesInConditionalStatement: false -SpacesInContainerLiterals: false -SpacesInCStyleCastParentheses: false -SpacesInParentheses: false -SpacesInSquareBrackets: false -Standard: Latest -#StatementMacros: -# - -TabWidth: 2 -UseCRLF: false -UseTab: Never diff --git a/.cppcheck/.gitignore b/.cppcheck/.gitignore deleted file mode 100644 index d6b7ef32c..000000000 --- a/.cppcheck/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index f16e80116..000000000 --- a/.editorconfig +++ /dev/null @@ -1,27 +0,0 @@ -root = true - -[*] -charset = utf-8 -end_of_line = lf -insert_final_newline = true -trim_trailing_whitespace = true - -[*.{C,c,cc,cpp,cxx,H,h,hh,hpp,hxx}] -indent_style = space -indent_size = 2 - -[*.{yml,yaml,gen}] -indent_style = space -indent_size = 2 - -[*.{rst,md}] -trim_trailing_whitespace = false -indent_style = space -indent_size = 4 - -[{CMakeLists.txt,CmakeConfig.txt,CMakeVersions.txt,*.cmake}] -indent_style = space -indent_size = 4 - -[{Makefile,*.mk}] -indent_style = tab diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 274345ed8..000000000 --- a/.gitattributes +++ /dev/null @@ -1,3 +0,0 @@ -/ChangeLog* merge=touch -/docs/sources/ChangeLog* merge=touch -/docs/sources/issues.rst merge=touch diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 18ba5c291..000000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,8 +0,0 @@ -version: 2 - -updates: - - package-ecosystem: github-actions - directory: "/" - schedule: - interval: weekly - open-pull-requests-limit: 5 \ No newline at end of file diff --git a/.github/notify-gitter.sh b/.github/notify-gitter.sh deleted file mode 100755 index 036e932c3..000000000 --- a/.github/notify-gitter.sh +++ /dev/null @@ -1,23 +0,0 @@ -#!/usr/bin/env bash -REPO=${GITHUB_REPOSITORY} - -REF=$(basename ${GITHUB_REF}) -REF_URL=https://github.com/${REPO}/commits/${REF} - -BUILD_URL=https://github.com/${REPO}/actions/runs/${GITHUB_RUN_ID} -BUILD_ENV=${ImageOS}/${CC:-${CC_VND}-${CC_VER}} - -case "$1" in -1|true|success) - level=info - status=success - ;; -*) - level=error - status=failure - ;; -esac -message="Github [${REPO}](${REF_URL}) (${REF}) [${status}](${BUILD_URL}) (${BUILD_ENV})" - -curl -sS "${GITTER}" --data-urlencode "level=${level}" --data-urlencode "message=${message}" - diff --git a/.github/workflows/cmake-build-ci.gen b/.github/workflows/cmake-build-ci.gen deleted file mode 100755 index b3c9f83d5..000000000 --- a/.github/workflows/cmake-build-ci.gen +++ /dev/null @@ -1,495 +0,0 @@ -#!/usr/bin/env php - "Linux", - - "Linux" => "ubuntu-24.04", "ubuntu-24.04" => "gnu", - "Windows" => "windows-2022", "windows-2022" => "msvc", - "macOS" => "macos-15", "macos-15" => "clang", - - "gnu" => [ - "CC" => "gcc", - "CXX" => "g++", - ], - "clang" => [ - "CC" => "clang", - "CXX" => "clang++", - ], - "msvc" => [ - "CMAKE_GENERATOR" => "Visual Studio" - ], - "mingw" => [ - "CMAKE_GENERATOR" => "MinGW Makefiles" - ] -]; -const MAP = [ - "Linux" => [ - 'env.OS_VER' => [ - "ubuntu-22.04" => [ - 'env.CC_VND' => [ - "gnu" => [ - 'env.CC_VER' => [ - "new" => "-12", - "cur" => "-11", - "old" => "-10", - ] - ], - "clang" => [ - 'env.CC_VER' => [ - "new" => "-15", - "cur" => "-14", - "old" => "-13", - ] - ] - ] - ], - "ubuntu-24.04" => [ - 'env.CC_VND' => [ - "gnu" => [ - 'env.CC_VER' => [ - "new" => "-14", - "cur" => "-13", - ] - ], - "clang" => [ - 'env.CC_VER' => [ - "new" => "-18", - "cur" => "-17", - "old" => "-16" - ] - ] - ] - ], - ], - ], - "Windows" => [ - 'env.OS_VER' => [ - "windows-2022" => [ - 'env.CC_VND' => [ - "msvc" => [ - "env.CC_VER" => [ - "cur" => " 17 2022" - ] - ], - "mingw" => [ - "env.CC_VER" => [ - "cur" => "" - ] - ] - ] - ], - "windows-2025" => [ - 'env.CC_VND' => [ - "msvc" => [ - "env.CC_VER" => [ - "cur" => " 17 2022" - ] - ], - "mingw" => [ - "env.CC_VER" => [ - "cur" => "" - ] - ] - ] - ], - ] - ], - "macOS" => [] -]; -const ENV = [ - "ubuntu-22.04" => [ - "clang" => [ - "new" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-15-dev libc++abi-15-dev" - ], - "cur" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-14-dev libc++abi-14-dev" - ], - "old" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-13-dev libc++abi-13-dev" - ], - ] - ], - "ubuntu-24.04" => [ - "clang" => [ - "new" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-18-dev libc++abi-18-dev" - ], - "cur" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-17-dev libc++abi-17-dev" - ], - "old" => [ - "CXXFLAGS" => "-stdlib=libc++", - "INSTALL_CXX" => "libc++-16-dev libc++abi-16-dev" - ], - ] - ], -]; - -function set_addpath($os_vnd, $paths) { - foreach ((array) $paths as $path) if ($os_vnd == "Windows") { -?> - echo "" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - - echo 'PATH="$PATH:"' >> ${GITHUB_ENV} - - echo '=' | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - echo ="" >> ${GITHUB_ENV} - - - name: Prepare environment (Windows) - run: | - echo "c:\msys64\usr\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - echo "c:\msys64\mingw64\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - $os_vers) { - foreach ($os_vers as $os_ver => $cc_vnds_) { - if (!$splat_map && DEF[DEF["os"]] != $os_ver) continue; - foreach ($cc_vnds_ as $cc_vnd_is => $cc_vnds) { - foreach ($cc_vnds as $cc_vnd => $cc_vers_) { - if (!$splat_map && DEF[DEF[DEF["os"]]] != $cc_vnd) continue; - foreach ($cc_vers_ as $cc_ver_is => $cc_vers) { - foreach ($cc_vers as $cc_ver => $ver) { - if (!$splat_map && "cur" != $cc_ver) continue; -?> - - name: Prepare environment () - if: () - run: | - $val) { - step_setenv($os_vnd, $env, $val . $ver); - } - if (isset(ENV[$os_ver][$cc_vnd][$cc_ver])) { - foreach (ENV[$os_ver][$cc_vnd][$cc_ver] as $env => $val) { - step_setenv($os_vnd, $env, $val); - } - } - } - } - } - } - } - } - } -} - -function steps_getdeps($os_vnd) { -?> - - name: Install dependencies () - if: runner.os == '' - - run: | - sudo apt-get update -y - sudo apt-get install -my \ - libevent-dev \ - libsasl2-dev \ - libtbb-dev \ - python3-sphinx \ - ${INSTALL_MEMCACHED} \ - ${INSTALL_CC} ${INSTALL_CXX} - sudo systemctl stop memcached || true - - run: | - brew install bison flex libevent pkg-config rsync sphinx-doc ${INSTALL_MEMCACHED} - brew services stop memcached || true - echo MEMCACHED_BINARY="/usr/local/bin/memcached" >> ${GITHUB_ENV} - - uses: msys2/setup-msys2@v2 - with: - release: false - path-type: inherit - install: >- - bison - flex - rsync - openssh - pacboy: >- - nsis:p - - - name: Build memcached - if: runner.os != 'Windows' - run: | - if test -d memcached - then - cd memcached - ./autogen.sh - cp configure{,.old} && sed -e 's/-Werror//g' configure - ./configure CFLAGS="-O2 -pipe -fcommon" \ - --prefix=${MEMCACHED_PREFIX} \ - --enable-sasl \ - --enable-sasl-pwdb \ - --disable-coverage \ - --disable-dependency-tracking \ - --disable-docs \ - --disable-extstore \ - --disable-option-checking \ - ; - make -j4 - make install - cd .. - echo MEMCACHED_BINARY="${MEMCACHED_PREFIX}/bin/memcached" >> ${GITHUB_ENV} - fi - - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts - - OS_VND: # - OS_VER: # - CC_VND: # - CC_VER: cur - -name: cmake-build-ci -on: - workflow_dispatch: - release: - types: [published] - push: - paths: - - ".github/workflows/cmake-build-ci*" - - "CMake*" - - "CPack*" - - "contrib/**" - - "include/**" - - "src/**" - - "test/**" - branches-ignore: - - gh-pages - pull_request: - branches: - - master - - v1.x -env: - # defaults - INSTALL_MEMCACHED: memcached - ENABLE_SASL: "OFF" # ^ almost no memcached distribution package has built in sasl support - ENABLE_HASH_HSIEH: "ON" - ENABLE_DTRACE: "OFF" - OS_VND: # - OS_VER: # - CC_VND: # - CC_VER: cur - -jobs: - - # sanitizer - debug-sanitizer: - name: debug sanitizer - runs-on: # - strategy: - matrix: - sanitizer: ['address;undefined', 'thread'] - env: - CMAKE_BUILD_TYPE: "Debug" - BUILD_TESTING: "ON" - VERBOSE: "ON" - ENABLE_SANITIZERS: ${{ matrix.sanitizer }} - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - - -# memcached - debug-memcached: - name: debug memcached - runs-on: # - continue-on-error: true - strategy: - matrix: - memcached: - - 'master' - - '1.6.38' # Debian 13, FreeBSD 14 -# - '1.6.37' # Ubuntu 25.04 - - '1.6.24' # Ubuntu 24.04 -# - '1.6.23' # Enterprise Linux 10 - - '1.6.18' # Debian 12 - - '1.6.14' # Ubuntu 22.04, Amazon Linux 2023 - - '1.6.9' # Debian 11, Enterprise Linux 9 - - '1.5.22' # Last 1.5 release - env: - CMAKE_BUILD_TYPE: "Debug" - BUILD_TESTING: "ON" - VERBOSE: "ON" - INSTALL_MEMCACHED: "" - MEMCACHED_PREFIX: "/tmp" - ENABLE_SASL: "ON" - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - - uses: actions/checkout@v5 - with: - repository: memcached/memcached - path: memcached - ref: ${{ matrix.memcached }} - fetch-depth: ${{ matrix.memcached != 'master' }} - - - # mac release builds - mac: - name: release - strategy: - fail-fast: false - matrix: - os_ver: [macos-13, macos-14, macos-15] - runs-on: ${{ matrix.os_ver }} - env: - CMAKE_BUILD_TYPE: "Release" - BUILD_DOCS_MANGZ: "ON" - - permissions: - contents: read - continue-on-error: true - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - - - # windows release builds - windows: - name: release - strategy: - fail-fast: false - matrix: - os_ver: [windows-2022, windows-2025] - cc_vnd: [msvc, mingw] - cc_ver: [cur] - runs-on: ${{ matrix.os_ver }} - continue-on-error: true - env: - CMAKE_BUILD_TYPE: "Release" - OS_VND: Windows - OS_VER: ${{ matrix.os_ver }} - CC_VND: ${{ matrix.cc_vnd }} - CC_VER: ${{ matrix.cc_ver }} - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - - - # linux release builds - release: - strategy: - fail-fast: false - matrix: - os_ver: [ubuntu-22.04, ubuntu-24.04] - cc_vnd: [gnu, clang] - cc_ver: [new, cur, old] - runs-on: ${{ matrix.os_ver }} - continue-on-error: ${{ matrix.cc_vnd == 'clang' }} - env: - CMAKE_BUILD_TYPE: "Release" - BUILD_DOCS_MANGZ: "ON" - OS_VND: Linux - OS_VER: ${{ matrix.os_ver }} - CC_VND: ${{ matrix.cc_vnd }} - CC_VER: ${{ matrix.cc_ver }} - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - diff --git a/.github/workflows/cmake-build-ci.yml b/.github/workflows/cmake-build-ci.yml deleted file mode 100644 index 8fc7599f7..000000000 --- a/.github/workflows/cmake-build-ci.yml +++ /dev/null @@ -1,513 +0,0 @@ -# Generated file; do not edit! -name: cmake-build-ci -on: - workflow_dispatch: - release: - types: [published] - push: - paths: - - ".github/workflows/cmake-build-ci*" - - "CMake*" - - "CPack*" - - "contrib/**" - - "include/**" - - "src/**" - - "test/**" - branches-ignore: - - gh-pages - pull_request: - branches: - - master - - v1.x -env: - # defaults - INSTALL_MEMCACHED: memcached - ENABLE_SASL: "OFF" # ^ almost no memcached distribution package has built in sasl support - ENABLE_HASH_HSIEH: "ON" - ENABLE_DTRACE: "OFF" - OS_VND: Linux # - OS_VER: ubuntu-24.04 # - CC_VND: gnu # - CC_VER: cur - -jobs: - - # sanitizer - debug-sanitizer: - name: debug sanitizer - runs-on: ubuntu-24.04 # - strategy: - matrix: - sanitizer: ['address;undefined', 'thread'] - env: - CMAKE_BUILD_TYPE: "Debug" - BUILD_TESTING: "ON" - VERBOSE: "ON" - ENABLE_SANITIZERS: ${{ matrix.sanitizer }} - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - - name: Prepare environment (for cur gnu on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='gnu') && (env.CC_VER=='cur') - run: | - echo CC="gcc-13" >> ${GITHUB_ENV} - echo CXX="g++-13" >> ${GITHUB_ENV} - - name: Install dependencies (Linux) - if: runner.os == 'Linux' - run: | - sudo apt-get update -y - sudo apt-get install -my \ - libevent-dev \ - libsasl2-dev \ - libtbb-dev \ - python3-sphinx \ - ${INSTALL_MEMCACHED} \ - ${INSTALL_CC} ${INSTALL_CXX} - sudo systemctl stop memcached || true - - name: Build memcached - if: runner.os != 'Windows' - run: | - if test -d memcached - then - cd memcached - ./autogen.sh - cp configure{,.old} && sed -e 's/-Werror//g' configure - ./configure CFLAGS="-O2 -pipe -fcommon" \ - --prefix=${MEMCACHED_PREFIX} \ - --enable-sasl \ - --enable-sasl-pwdb \ - --disable-coverage \ - --disable-dependency-tracking \ - --disable-docs \ - --disable-extstore \ - --disable-option-checking \ - ; - make -j4 - make install - cd .. - echo MEMCACHED_BINARY="${MEMCACHED_PREFIX}/bin/memcached" >> ${GITHUB_ENV} - fi - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts - -# memcached - debug-memcached: - name: debug memcached - runs-on: ubuntu-24.04 # - continue-on-error: true - strategy: - matrix: - memcached: - - 'master' - - '1.6.38' # Debian 13, FreeBSD 14 -# - '1.6.37' # Ubuntu 25.04 - - '1.6.24' # Ubuntu 24.04 -# - '1.6.23' # Enterprise Linux 10 - - '1.6.18' # Debian 12 - - '1.6.14' # Ubuntu 22.04, Amazon Linux 2023 - - '1.6.9' # Debian 11, Enterprise Linux 9 - - '1.5.22' # Last 1.5 release - env: - CMAKE_BUILD_TYPE: "Debug" - BUILD_TESTING: "ON" - VERBOSE: "ON" - INSTALL_MEMCACHED: "" - MEMCACHED_PREFIX: "/tmp" - ENABLE_SASL: "ON" - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - - uses: actions/checkout@v5 - with: - repository: memcached/memcached - path: memcached - ref: ${{ matrix.memcached }} - fetch-depth: ${{ matrix.memcached != 'master' }} - - name: Prepare environment (for cur gnu on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='gnu') && (env.CC_VER=='cur') - run: | - echo CC="gcc-13" >> ${GITHUB_ENV} - echo CXX="g++-13" >> ${GITHUB_ENV} - - name: Install dependencies (Linux) - if: runner.os == 'Linux' - run: | - sudo apt-get update -y - sudo apt-get install -my \ - libevent-dev \ - libsasl2-dev \ - libtbb-dev \ - python3-sphinx \ - ${INSTALL_MEMCACHED} \ - ${INSTALL_CC} ${INSTALL_CXX} - sudo systemctl stop memcached || true - - name: Build memcached - if: runner.os != 'Windows' - run: | - if test -d memcached - then - cd memcached - ./autogen.sh - cp configure{,.old} && sed -e 's/-Werror//g' configure - ./configure CFLAGS="-O2 -pipe -fcommon" \ - --prefix=${MEMCACHED_PREFIX} \ - --enable-sasl \ - --enable-sasl-pwdb \ - --disable-coverage \ - --disable-dependency-tracking \ - --disable-docs \ - --disable-extstore \ - --disable-option-checking \ - ; - make -j4 - make install - cd .. - echo MEMCACHED_BINARY="${MEMCACHED_PREFIX}/bin/memcached" >> ${GITHUB_ENV} - fi - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts - - # mac release builds - mac: - name: release - strategy: - fail-fast: false - matrix: - os_ver: [macos-13, macos-14, macos-15] - runs-on: ${{ matrix.os_ver }} - env: - CMAKE_BUILD_TYPE: "Release" - BUILD_DOCS_MANGZ: "ON" - OS_VND: macOS # - OS_VER: macos-15 # - CC_VND: clang # - CC_VER: cur - permissions: - contents: read - continue-on-error: true - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - - name: Install dependencies (macOS) - if: runner.os == 'macOS' - run: | - brew install bison flex libevent pkg-config rsync sphinx-doc ${INSTALL_MEMCACHED} - brew services stop memcached || true - echo MEMCACHED_BINARY="/usr/local/bin/memcached" >> ${GITHUB_ENV} - - name: Build memcached - if: runner.os != 'Windows' - run: | - if test -d memcached - then - cd memcached - ./autogen.sh - cp configure{,.old} && sed -e 's/-Werror//g' configure - ./configure CFLAGS="-O2 -pipe -fcommon" \ - --prefix=${MEMCACHED_PREFIX} \ - --enable-sasl \ - --enable-sasl-pwdb \ - --disable-coverage \ - --disable-dependency-tracking \ - --disable-docs \ - --disable-extstore \ - --disable-option-checking \ - ; - make -j4 - make install - cd .. - echo MEMCACHED_BINARY="${MEMCACHED_PREFIX}/bin/memcached" >> ${GITHUB_ENV} - fi - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts - - # windows release builds - windows: - name: release - strategy: - fail-fast: false - matrix: - os_ver: [windows-2022, windows-2025] - cc_vnd: [msvc, mingw] - cc_ver: [cur] - runs-on: ${{ matrix.os_ver }} - continue-on-error: true - env: - CMAKE_BUILD_TYPE: "Release" - OS_VND: Windows - OS_VER: ${{ matrix.os_ver }} - CC_VND: ${{ matrix.cc_vnd }} - CC_VER: ${{ matrix.cc_ver }} - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - - name: Prepare environment (Windows) - run: | - echo "c:\msys64\usr\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - echo "c:\msys64\mingw64\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - - name: Prepare environment (for cur msvc on windows-2022) - if: (env.OS_VER=='windows-2022') && (env.CC_VND=='msvc') && (env.CC_VER=='cur') - run: | - echo 'CMAKE_GENERATOR=Visual Studio 17 2022' | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Prepare environment (for cur mingw on windows-2022) - if: (env.OS_VER=='windows-2022') && (env.CC_VND=='mingw') && (env.CC_VER=='cur') - run: | - echo 'CMAKE_GENERATOR=MinGW Makefiles' | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Prepare environment (for cur msvc on windows-2025) - if: (env.OS_VER=='windows-2025') && (env.CC_VND=='msvc') && (env.CC_VER=='cur') - run: | - echo 'CMAKE_GENERATOR=Visual Studio 17 2022' | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Prepare environment (for cur mingw on windows-2025) - if: (env.OS_VER=='windows-2025') && (env.CC_VND=='mingw') && (env.CC_VER=='cur') - run: | - echo 'CMAKE_GENERATOR=MinGW Makefiles' | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Install dependencies (Windows) - if: runner.os == 'Windows' - uses: msys2/setup-msys2@v2 - with: - release: false - path-type: inherit - install: >- - bison - flex - rsync - openssh - pacboy: >- - nsis:p - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts - - # linux release builds - release: - strategy: - fail-fast: false - matrix: - os_ver: [ubuntu-22.04, ubuntu-24.04] - cc_vnd: [gnu, clang] - cc_ver: [new, cur, old] - runs-on: ${{ matrix.os_ver }} - continue-on-error: ${{ matrix.cc_vnd == 'clang' }} - env: - CMAKE_BUILD_TYPE: "Release" - BUILD_DOCS_MANGZ: "ON" - OS_VND: Linux - OS_VER: ${{ matrix.os_ver }} - CC_VND: ${{ matrix.cc_vnd }} - CC_VER: ${{ matrix.cc_ver }} - permissions: - contents: read - steps: - - uses: actions/checkout@v5 - with: - fetch-depth: 0 - - name: Prepare environment (for new gnu on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='gnu') && (env.CC_VER=='new') - run: | - echo CC="gcc-12" >> ${GITHUB_ENV} - echo CXX="g++-12" >> ${GITHUB_ENV} - - name: Prepare environment (for cur gnu on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='gnu') && (env.CC_VER=='cur') - run: | - echo CC="gcc-11" >> ${GITHUB_ENV} - echo CXX="g++-11" >> ${GITHUB_ENV} - - name: Prepare environment (for old gnu on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='gnu') && (env.CC_VER=='old') - run: | - echo CC="gcc-10" >> ${GITHUB_ENV} - echo CXX="g++-10" >> ${GITHUB_ENV} - - name: Prepare environment (for new clang on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='clang') && (env.CC_VER=='new') - run: | - echo CC="clang-15" >> ${GITHUB_ENV} - echo CXX="clang++-15" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-15-dev libc++abi-15-dev" >> ${GITHUB_ENV} - - name: Prepare environment (for cur clang on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='clang') && (env.CC_VER=='cur') - run: | - echo CC="clang-14" >> ${GITHUB_ENV} - echo CXX="clang++-14" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-14-dev libc++abi-14-dev" >> ${GITHUB_ENV} - - name: Prepare environment (for old clang on ubuntu-22.04) - if: (env.OS_VER=='ubuntu-22.04') && (env.CC_VND=='clang') && (env.CC_VER=='old') - run: | - echo CC="clang-13" >> ${GITHUB_ENV} - echo CXX="clang++-13" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-13-dev libc++abi-13-dev" >> ${GITHUB_ENV} - - name: Prepare environment (for new gnu on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='gnu') && (env.CC_VER=='new') - run: | - echo CC="gcc-14" >> ${GITHUB_ENV} - echo CXX="g++-14" >> ${GITHUB_ENV} - - name: Prepare environment (for cur gnu on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='gnu') && (env.CC_VER=='cur') - run: | - echo CC="gcc-13" >> ${GITHUB_ENV} - echo CXX="g++-13" >> ${GITHUB_ENV} - - name: Prepare environment (for new clang on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='clang') && (env.CC_VER=='new') - run: | - echo CC="clang-18" >> ${GITHUB_ENV} - echo CXX="clang++-18" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-18-dev libc++abi-18-dev" >> ${GITHUB_ENV} - - name: Prepare environment (for cur clang on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='clang') && (env.CC_VER=='cur') - run: | - echo CC="clang-17" >> ${GITHUB_ENV} - echo CXX="clang++-17" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-17-dev libc++abi-17-dev" >> ${GITHUB_ENV} - - name: Prepare environment (for old clang on ubuntu-24.04) - if: (env.OS_VER=='ubuntu-24.04') && (env.CC_VND=='clang') && (env.CC_VER=='old') - run: | - echo CC="clang-16" >> ${GITHUB_ENV} - echo CXX="clang++-16" >> ${GITHUB_ENV} - echo CXXFLAGS="-stdlib=libc++" >> ${GITHUB_ENV} - echo INSTALL_CXX="libc++-16-dev libc++abi-16-dev" >> ${GITHUB_ENV} - - name: Install dependencies (Linux) - if: runner.os == 'Linux' - run: | - sudo apt-get update -y - sudo apt-get install -my \ - libevent-dev \ - libsasl2-dev \ - libtbb-dev \ - python3-sphinx \ - ${INSTALL_MEMCACHED} \ - ${INSTALL_CC} ${INSTALL_CXX} - sudo systemctl stop memcached || true - - name: Build memcached - if: runner.os != 'Windows' - run: | - if test -d memcached - then - cd memcached - ./autogen.sh - cp configure{,.old} && sed -e 's/-Werror//g' configure - ./configure CFLAGS="-O2 -pipe -fcommon" \ - --prefix=${MEMCACHED_PREFIX} \ - --enable-sasl \ - --enable-sasl-pwdb \ - --disable-coverage \ - --disable-dependency-tracking \ - --disable-docs \ - --disable-extstore \ - --disable-option-checking \ - ; - make -j4 - make install - cd .. - echo MEMCACHED_BINARY="${MEMCACHED_PREFIX}/bin/memcached" >> ${GITHUB_ENV} - fi - - name: Generate build tree (${{ env.CMAKE_BUILD_TYPE }}) - run: cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - - name: Build all with ${{ env.CXX }} ${{ env.CXXFLAGS }} - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 - - name: Test - if: env.BUILD_TESTING == 'ON' - run: cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target test - - name: Install - if: env.BUILD_TESTING == 'ON' - run: cmake --install build --config ${{ env.CMAKE_BUILD_TYPE }} --prefix /tmp - - name: Failed tests log - if: ${{ env.BUILD_TESTING == 'ON' && failure() }} - run: cat build/Testing/Temporary/LastTest.log || true - - name: Package - env: - PUSH_ARTIFACTS_ID: ${{ secrets.PUSH_ARTIFACTS_ID }} - if: env.PUSH_ARTIFACTS_ID != '' && env.CMAKE_BUILD_TYPE == 'Release' - run: | - cmake -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -S . -B build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake -DCPACK_COMPONENT_INSTALL=ON build - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target package - cmake --build build --config ${{ env.CMAKE_BUILD_TYPE }} -j4 --target push-artifacts diff --git a/.github/workflows/docs-publish-pages.yml b/.github/workflows/docs-publish-pages.yml deleted file mode 100644 index ec6884a08..000000000 --- a/.github/workflows/docs-publish-pages.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: docs-publish-pages - -on: - workflow_dispatch: - release: - types: [published] - push: - paths: - - 'docs/**' - - 'ChangeLog*' - branches: - - v1.x - -env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - -jobs: - publish: - runs-on: ubuntu-latest - permissions: - contents: write - steps: - - uses: actions/checkout@v5 - - name: Install dependencies - run: | - sudo apt-get update -y - sudo apt-get install -y \ - python3-m2r \ - python3-sphinx \ - python3-sphinx-rtd-theme - - name: Configure - run: | - cmake -DBUILD_DOCSONLY=ON -DBUILD_DOCS_HTML=ON -DBUILD_DOCS_MAN=OFF -S . -B build - - name: Build - run: | - make -C build html - - uses: crazy-max/ghaction-github-pages@v4 - if: success() - with: - jekyll: false - keep_history: true - allow_empty_commit: false - build_dir: build/docs/build/html diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 4f845752c..000000000 --- a/.gitignore +++ /dev/null @@ -1,21 +0,0 @@ -*~ -*.log -*.orig -*.output -*.pop -*.rej -*.bak -*TAGS -*patch -.cproject -.idea/ -.project -.settings/ -build-*/ -cmake-build-*/ -ccmake-*/ -tags -venv/ -/infer-out/ -/docs/gh-pages/pages/ -/docs/gh-pages/build/ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index e7b32022d..000000000 --- a/AUTHORS +++ /dev/null @@ -1,22 +0,0 @@ -Andre Cruz - Help with getting the CRC Hash function to match other connectors -Brian Aker - Original work, Client Library, Tools -Brian Pontz - Hsieh hash -Cal Heldenbrand - Awesome feedback on performance -Dustin Sallings - Insight into protocol -Eirik A. Nygaard - IO Patch -Eric Lambert - UDP work -Kevin Dalley - Bug Fixes -Marcelo Fernandez - TCP/IP timeout pieces -Mark Atwood - Tools, Docs -Michael Wallner - CMake build, Catch2 tests, Resurrection -Mingqiang Zhuang - Rewrite of memslap -Monty Taylor - Debian Packages, Cleanup work for configure, Build Releated (Pandora) -Padraig O'Sullivan - C++ Interface -Patrick Galbraith - work on C++ interface -Ross McFarland - Idea for sorting servers -Tim Bunce - Docs, Perl Driver work and feedback on API -Tobias Luetke - Performance Feedback -Toru Maesaka - Stats analysis -Trond Norbye - Binary protocol, Misc -Yin Chen - Ketama support/weighted support - diff --git a/BUGS.md b/BUGS.md deleted file mode 100644 index cb6f68740..000000000 --- a/BUGS.md +++ /dev/null @@ -1,58 +0,0 @@ -# Bugs, Known Issues and Insufficiencies - -## libhashkit - -libhashkit is not usable for general purpose hashing, because it is geared to -usage by libmemcached. - -### MurMur - -Hashkit's MurMur/MurMur3 are limited to the lower 32 bits. - -### crc32 - -Commit "[More Hashing methods](https://github.com/awesomized/libmemcached/commits/1207354f)" -from October 2007 first released in v0.8, which main intention seems to have -been to add FNV1 hash algos, changed the result of the crc32 hash to only its -upper 16 bits sans MSB, without any additional comment. - -The implementations referred to in the file header (Postgres and BSD) -do not exhibit this behavior. - -A [bug report](https://bugs.launchpad.net/libmemcached/+bug/604178) was -filed three years later on launchpad, which was marked `Won't fix` with -the comment that it was for compatibility with other "drivers", which -supposedly refers to other memcached client libraries. - - -## libmemcached - -### Replication - -This is a somewhat badly named feature, because it **does not** provide -any of the guaranties one would expect from a proper replication. - -One can set the intended number of additional servers where data should -be stored with the behavior `MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS` and -specify whether `MGET`s/`GET`s should read from a random server with -`MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ`. `DELETE`s will try to -delete the key from all replicas. - -The binary protocol is required and any other command is unaffected. - -### TLS/SSL - -libmemcached does not support TLS/SSL, yet. -See [github issue #37](https://github.com/awesomized/libmemcached/issues/37). - - -### Coroutines and event loops - -libmemcached does not support explicit asynchronous usage, yet. -See [github issue #54](https://github.com/awesomized/libmemcached/issues/54). - - -### META protocol - -libmemcached deos not support memcached's META protocol, yet. -See [github issue #121](https://github.com/awesomized/libmemcached/issues/121). diff --git a/CMake/CheckAtomics.cmake b/CMake/CheckAtomics.cmake deleted file mode 100644 index 73060fee0..000000000 --- a/CMake/CheckAtomics.cmake +++ /dev/null @@ -1,65 +0,0 @@ -# sets HAVE_ATOMICS, checks for : -# - C++11 std::atomic: HAVE_CXX_STDATOMIC -# - C11 stdatomic: HAVE_C_STDATOMIC -# - builtin __atomic: HAVE_BUILTIN_ATOMIC -# - builtin __sync: HAVE_BUILTIN_SYNC -# - atomic_add_nv: HAVE_ATOMIC_ADD_NV - -configure_define(HAVE_ATOMICS) - -check_cxx_source(" - #include - int main() { - std::atomic i(0); - return atomic_load(&i); - }" - HAVE_CXX_STDATOMIC) - -check_c_source(" - #include - int main() { - atomic_int i; - atomic_init(&i, 0); - return atomic_load(&i); - }" - HAVE_C_STDATOMIC) - - -configure_define(HAVE_BUILTIN_ATOMIC) -configure_define_literal(BUILTIN_ATOMIC_PREFIX) -foreach(BUILTIN_ATOMIC_PREFIX IN ITEMS __c11 _ "") - check_c_source(" - int main() { - long l = -1; - return ${BUILTIN_ATOMIC_PREFIX}_atomic_add_fetch(&l,1,__ATOMIC_RELAXED); - }" - HAVE_BUILTIN_ATOMIC${BUILTIN_ATOMIC_PREFIX}) - if (HAVE_BUILTIN_ATOMIC${BUILTIN_ATOMIC_PREFIX}) - set(HAVE_BUILTIN_ATOMIC 1) - break() - endif() -endforeach() - -check_c_source(" - int main() { - long l = -1; - return __sync_add_and_fetch(&l,1); - }" - HAVE_BUILTIN_SYNC) - -check_c_source(" - #include - int main() { - volatile uint_t i = 0; - return atomic_add_int_nv(&i, 1) == 1 ? 0 : -1; - }" - HAVE_ATOMIC_ADD_NV) - - -if ( (HAVE_CXX_STDATOMIC) - OR (HAVE_C_STDATOMIC) - OR (HAVE_BUILTIN_ATOMIC) - OR (HAVE_BUILTIN_SYNC) - OR (HAVE_ATOMIC_ADD_NV)) - set(HAVE_ATOMICS 1 CACHE INTERNAL "HAVE_ATOMICS") -endif() diff --git a/CMake/CheckBacktrace.cmake b/CMake/CheckBacktrace.cmake deleted file mode 100644 index c4fce9f65..000000000 --- a/CMake/CheckBacktrace.cmake +++ /dev/null @@ -1,10 +0,0 @@ -find_package(Backtrace) -if(Backtrace_FOUND) - configure_set(HAVE_BACKTRACE 1) - configure_define_header(Backtrace_HEADER) - set(BACKTRACE BACKTRACE) - add_library(BACKTRACE INTERFACE IMPORTED) - set_target_properties(BACKTRACE PROPERTIES - INTERFACE_LINK_LIBRARIES "${Backtrace_LIBRARIES}" - INTERFACE_INCLUDE_DIRECTORIES "${Backtrace_INCLUDE_DIR}") -endif() diff --git a/CMake/CheckByteswap.cmake b/CMake/CheckByteswap.cmake deleted file mode 100644 index 110880f9d..000000000 --- a/CMake/CheckByteswap.cmake +++ /dev/null @@ -1,67 +0,0 @@ -# defines HAVE_BYTESWAP -# optionally defines BYTESWAP_HEADER -# optionally defines BYTESWAP_32 -# -# checks whether the following compiles: -# __builtin_bswap32(): defines HAVE_BUILTIN_BSWAP32 -# -# else checks: -# byteswap.h: defines HAVE_BYTESWAP_H -# bswap_32() in byteswap.h: defines HAVE_BSWAP_32 -# -# else checks: -# sys/endian.h: defines HAVE_SYS_ENDIAN_H -# bswap32() in sys/endian.h: defines HAVE_BSWAP32 -# - -include(TestBigEndian) -test_big_endian(WORDS_BIGENDIAN) -configure_define(WORDS_BIGENDIAN) - -configure_define(HAVE_BYTESWAP) -configure_define_header(BYTESWAP_HEADER) -configure_define_literal(BYTESWAP_32) - -check_c_source(" - #include - int main() { - uint32_t a = 1, b = __builtin_bswap32(a); - return b; - }" - HAVE_BUILTIN_BSWAP32 -) - -if(HAVE_BUILTIN_BSWAP32) - configure_undef(BYTESWAP_HEADER) - set(BYTESWAP_32 __builtin_bswap32 CACHE INTERNAL "BYTESWAP_32") - set(HAVE_BYTESWAP 1 CACHE INTERNAL "HAVE_BYTESWAP") - return() -endif() - -check_include(byteswap.h) -check_symbol(bswap_32 byteswap.h) - -if(HAVE_BSWAP_32) - if(HAVE_BYTESWAP_H) - set(BYTESWAP_HEADER byteswap.h CACHE INTERNAL "BYTESWAP_HEADER") - endif() - set(BYTESWAP_32 bswap_32 CACHE INTERNAL "BYTESWAP_32") - set(HAVE_BYTESWAP 1 CACHE INSTERNAL "HAVE_BYTESWAP") - return() -endif() - -check_include(sys/endian.h) -check_symbol(bswap32 sys/endian.h) - -if(HAVE_BSWAP32) - if(HAVE_SYS_ENDIAN_H) - set(BYTESWAP_HEADER sys/endian.h CACHE INTERNAL "BYTESWAP_HEADER") - endif() - set(BYTESWAP_32 bswap32 CACHE INTERNAL "BYTESWAP_32") - set(HAVE_BYTESWAP 1 CACHE INTERNAL "HAVE_BYTESWAP") - return() -endif() - -configure_undef(BYTESWAP_HEADER) -configure_undef(BYTESWAP_32) -set(HAVE_BYTESWAP 0) diff --git a/CMake/CheckCpp17Parallelism.cmake b/CMake/CheckCpp17Parallelism.cmake deleted file mode 100644 index 826cf38fd..000000000 --- a/CMake/CheckCpp17Parallelism.cmake +++ /dev/null @@ -1,31 +0,0 @@ -configure_define(HAVE_CPP17_PARALLELISM) - -# -# see CheckTbb.cmake on change -# - -check_cxx_source_compiles(" - #include - #include - #include - int main() { - std::vector a = {1,2,3}; - std::all_of(std::execution::par, a.begin(), a.end(), [](char i) { - return i>0; - }); - } - " - HAVE_CPP17_PARALLELISM - ) - -if(HAVE_CPP17_PARALLELISM) - add_library(cpp17::parallelism INTERFACE IMPORTED) - # noting to be done -else() - include(CheckTbb) - set(HAVE_CPP17_PARALLELISM "${HAVE_TBB}") - if(HAVE_TBB) - add_library(cpp17::parallelism INTERFACE IMPORTED) - target_link_libraries(cpp17::parallelism INTERFACE "${LIBTBB}") - endif() -endif() diff --git a/CMake/CheckDebug.cmake b/CMake/CheckDebug.cmake deleted file mode 100644 index a280d16a0..000000000 --- a/CMake/CheckDebug.cmake +++ /dev/null @@ -1,75 +0,0 @@ - -function(set_flag FLAG DEFAULT) - unset(FLAG_CONSTANT) - string(MAKE_C_IDENTIFIER CXX${FLAG} FLAG_CONSTANT) - check_cxx_compiler_flag(${FLAG} ${FLAG_CONSTANT}) - if(${FLAG_CONSTANT}) - add_compile_options(${FLAG}) - elseif(DEFAULT) - add_compile_options(${DEFAULT}) - endif() -endfunction() - -macro(check_sanitizer VAR NAME LIB) - message(STATUS "Checking for sanitizer: ${NAME} (-l${LIB})") - if(${NAME} IN_LIST ${VAR} OR ${LIB} IN_LIST ${VAR}) - make_have_identifier(${LIB} HAVE) - cmake_push_check_state(RESET) - set(CMAKE_REQUIRED_LIBRARIES -fsanitize=${NAME}) - check_cxx_compiler_flag(-fsanitize=${NAME} ${HAVE}) - cmake_pop_check_state() - if(${HAVE}) - add_compile_definitions(${HAVE}) - add_compile_options(-fsanitize=${NAME}) - link_libraries(-fsanitize=${NAME}) - set_flag(-fsanitize-recover=${NAME} IGNORE) - message(STATUS " OK: sanitizer ${NAME}") - else() - message(STATUS " NO: not supported") - endif() - else() - message(STATUS " NO: not requested") - endif() -endmacro() - -if(CMAKE_BUILD_TYPE STREQUAL "Debug" AND NOT MSVC) - add_definitions(-DDEBUG=1) - if(CMAKE_CXX_FLAGS MATCHES --coverage) - message("-- Coverage build detected!") - message("-- Skipping debug and sanitizer flag checks.") - else() - set_flag(-Og -O0) - set_flag(-ggdb -g) - foreach(FLAG IN ITEMS - -fno-inline - -fno-omit-frame-pointer - -fno-eliminate-unused-debug-types - -funsafe-loop-optimizations - - -Wall - -Wextra - - -Wdouble-promotion - -Wduplicated-cond - -Wduplicated-branches - -Wformat=2 - -Wlogical-op - -Wnull-dereference - -Wrestrict - -Wshadow - -Wunknown-pragmas - -Wunsafe-loop-optimizations - ) - set_flag(${FLAG} IGNORE) - endforeach() - - if(ENABLE_SANITIZERS) - check_sanitizer(ENABLE_SANITIZERS address asan) - check_sanitizer(ENABLE_SANITIZERS undefined ubsan) - check_sanitizer(ENABLE_SANITIZERS thread tsan) - check_sanitizer(ENABLE_SANITIZERS leak lsan) - endif() - endif() -else() - add_definitions(-DDEBUG=0) -endif() diff --git a/CMake/CheckDependency.cmake b/CMake/CheckDependency.cmake deleted file mode 100644 index 7932b55a3..000000000 --- a/CMake/CheckDependency.cmake +++ /dev/null @@ -1,44 +0,0 @@ -find_package(PkgConfig) - -function(check_dependency NAME LIB) - make_have_identifier(${NAME} HAVE) - configure_define(${HAVE}) - - if(PKG_CONFIG_FOUND) - pkg_check_modules(${NAME} lib${LIB}${ARGN} IMPORTED_TARGET) - if(NOT ${NAME}_FOUND) - pkg_check_modules(${NAME} ${LIB}${ARGN} IMPORTED_TARGET) - endif() - if(${NAME}_FOUND) - set(${NAME} PkgConfig::${NAME} CACHE INTERNAL "${NAME} import target") - set(${HAVE} 1 CACHE INTERNAL "${HAVE}") - return() - endif() - endif() - - message(STATUS "Checking for library '${LIB}' ...") - find_library(${NAME}_LIB NAMES ${LIB}) - if(${NAME}_LIB) - mark_as_advanced(${NAME}_LIB) - message(STATUS " Found '${${NAME}_LIB}'") - - set(${NAME}_INCLUDES "") - foreach(PATH IN_LIST CMAKE_PREFIX_PATHS) - if(${NAME}_LIB MATCHES "^${PATH}") - set(${NAME}_INCLUDES "${PATH}/include") - break() - endif() - endforeach() - - add_library(Imported::${NAME} INTERFACE IMPORTED) - set_target_properties(Imported::${NAME} PROPERTIES - INTERFACE_INCLUDE_DIRECTORIES "${${NAME}_INCLUDES}" - INTERFACE_LINK_LIBRARIES ${${NAME}_LIB}) - - set(${NAME} Imported::${NAME} CACHE INTERNAL "${NAME} import target") - set(${HAVE} 1 CACHE INTERNAL "${HAVE}") - return() - endif() - - message(STATUS " Not found") -endfunction() diff --git a/CMake/CheckDtrace.cmake b/CMake/CheckDtrace.cmake deleted file mode 100644 index 1fb688cf8..000000000 --- a/CMake/CheckDtrace.cmake +++ /dev/null @@ -1,9 +0,0 @@ -include(EnableDtrace) -if(ENABLE_DTRACE) - find_package(DTrace) - if(DTRACE_EXECUTABLE) - configure_set(HAVE_DTRACE 1) - else() - message(WARNING "The dtrace command is required to enable dtrace/systemtap support.") - endif() -endif() diff --git a/CMake/CheckPkgconf.cmake b/CMake/CheckPkgconf.cmake deleted file mode 100644 index 7e8ffdfb1..000000000 --- a/CMake/CheckPkgconf.cmake +++ /dev/null @@ -1,8 +0,0 @@ -if(CMAKE_HOST_SYSTEM_NAME MATCHES "BSD") - find_program(PKGCONF pkgconf) - if(PKGCONF) - set(PKG_CONFIG_EXECUTABLE ${PKGCONF}) - endif() -endif() - -find_package(PkgConfig) diff --git a/CMake/CheckTbb.cmake b/CMake/CheckTbb.cmake deleted file mode 100644 index cd76ab3e4..000000000 --- a/CMake/CheckTbb.cmake +++ /dev/null @@ -1,34 +0,0 @@ - -configure_define(HAVE_TBB) - -# TBBConfig only sets TBB_FOUND to FALSE -check_dependency(LIBTBB tbb) - -if(HAVE_LIBTBB) - - cmake_push_check_state() - get_property(LIBTBB_INCLUDEDIR TARGET ${LIBTBB} PROPERTY INTERFACE_INCLUDE_DIRECTORIES) - get_property(LIBTBB_LIBRARIES TARGET ${LIBTBB} PROPERTY INTERFACE_LINK_LIBRARIES) - set(CMAKE_REQUIRED_INCLUDES "${LIBTBB_INCLUDEDIR}") - set(CMAKE_REQUIRED_LIBRARIES "${LIBTBB_LIBRARIES}") - set(CMAKE_REQUIRED_FLAGS -std=c++17) - - check_cxx_include(execution -std=c++17) - if(HAVE_EXECUTION) - check_cxx_source_compiles(" - #include - #include - #include - int main() { - std::vector a = {1,2,3}; - std::all_of(std::execution::par, a.begin(), a.end(), [](char i) { - return i>0; - }); - } - " - HAVE_TBB - ) - - endif() - cmake_pop_check_state() -endif() diff --git a/CMake/CheckThreads.cmake b/CMake/CheckThreads.cmake deleted file mode 100644 index e4f53c2b8..000000000 --- a/CMake/CheckThreads.cmake +++ /dev/null @@ -1,9 +0,0 @@ -set(THREADS_PREFER_PTHREAD_FLAG ON) -set(CMAKE_THREAD_PREFER_PTHREAD ON) -find_package(Threads) -if(CMAKE_HAVE_PTHREAD_H) - configure_define(HAVE_PTHREAD_H) - set(HAVE_PTHREAD_H ${CMAKE_HAVE_PTHREAD_H} CACHE INTERNAL "FindThreads found pthread.h") -elseif(CMAKE_USE_PTHREADS_INIT) - check_cxx_include(pthread.h) -endif() diff --git a/CMake/CheckVisibility.cmake b/CMake/CheckVisibility.cmake deleted file mode 100644 index 91a103ad8..000000000 --- a/CMake/CheckVisibility.cmake +++ /dev/null @@ -1,22 +0,0 @@ -configure_define(HAVE_VISIBILITY) - -check_flag(-fvisibility=hidden HAVE_VISIBILITY_FLAG) -if(NOT HAVE_VISIBILITY_FLAG) - check_flag(-Wl,-fvisibility=hidden HAVE_VISIBILITY_LINKER_FLAG) -endif() -check_c_source(" - __attribute__ ((visibility (\"default\"))) - int main(int argc, char **argv) { - return *argv[argc-1]; - }" - HAVE_VISIBILITY_ATTR -) - -if(HAVE_VISIBILITY_ATTR AND (HAVE_VISIBILITY_FLAG OR HAVE_VISIBILITY_LINKER_FLAG)) - if(HAVE_VISIBILITY_LINKER_FLAG) - string(APPEND CMAKE_SHARED_LINKER_FLAGS " -Wl,-fvisibility=hidden") - else() - add_compile_options("-fvisibility=hidden") - endif() - set(HAVE_VISIBILITY 1 CACHE INTERNAL "-fvisibility and __attribute__((visibility(...)))") -endif() diff --git a/CMake/EnableDtrace.cmake b/CMake/EnableDtrace.cmake deleted file mode 100644 index add0d7fd6..000000000 --- a/CMake/EnableDtrace.cmake +++ /dev/null @@ -1,58 +0,0 @@ -function(enable_dtrace_for TARGET PROBES_D PROBES_H) - if(HAVE_DTRACE AND NOT CMAKE_CROSSCOMPILING) - add_custom_command( - OUTPUT - ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_H} - MAIN_DEPENDENCY - ${PROBES_D} - COMMAND - ${DTRACE_EXECUTABLE} - ARGS - -x nolibs -h - -s ${CMAKE_CURRENT_SOURCE_DIR}/${PROBES_D} - -o ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_H} - ) - target_sources(${TARGET} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_H}) - if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux") - add_custom_command( - OUTPUT - ${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_probes.o - MAIN_DEPENDENCY - ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_H} - COMMAND - ${DTRACE_EXECUTABLE} - ARGS - -x nolibs -G - -s ${CMAKE_CURRENT_SOURCE_DIR}/${PROBES_D} - -o ${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_probes.o - ) - target_sources(${TARGET} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_probes.o) - set_source_files_properties(${TARGET}_probes.o PROPERTIES - GENERATED true - EXTERNAL_OBJECT true) - return() - endif() - cmake_host_system_information(RESULT OS_RELEASE QUERY OS_RELEASE) - if(NOT (CMAKE_HOST_SYSTEM_NAME STREQUAL Darwin AND OS_RELEASE VERSION_GREATER_EQUAL 11)) - set(PROBES_C ${TARGET}_probes.cc) - file(GENERATE - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_C} - CONTENT "#include \"${PROBES_H}\"\n" - ) - add_custom_command( - TARGET ${TARGET} - PRE_LINK - DEPENDS - ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_H} - COMMAND - rm -f ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TARGET}.dir/${PROBES_C}.o - COMMAND - ${DTRACE_EXECUTABLE} -x nolibs -G - -s ${CMAKE_CURRENT_SOURCE_DIR}/${PROBES_D} - -o ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TARGET}.dir/${PROBES_C}.o - ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${TARGET}.dir/*.o - ) - target_sources(${TARGET} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${PROBES_C}) - endif() - endif() -endfunction() diff --git a/CMake/FindDTrace.cmake b/CMake/FindDTrace.cmake deleted file mode 100644 index 4e7b37906..000000000 --- a/CMake/FindDTrace.cmake +++ /dev/null @@ -1,10 +0,0 @@ -find_program(DTRACE_EXECUTABLE NAMES dtrace - HINTS $ENV{DTRACE_DIR} - PATH_SUFFIXES bin - DOC "DTrace static probe generator" - ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(DTrace DEFAULT_MSG DTRACE_EXECUTABLE) - -mark_as_advanced(DTRACE_EXECUTABLE) diff --git a/CMake/FindMemcached.cmake b/CMake/FindMemcached.cmake deleted file mode 100644 index a1f8cf0d2..000000000 --- a/CMake/FindMemcached.cmake +++ /dev/null @@ -1,10 +0,0 @@ -find_program(MEMCACHED_EXECUTABLE NAMES memcached - HINTS $ENV{MEMCACHED_DIR} - PATH_SUFFIXES bin - DOC "memcached(1), Memcached daemon" - ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(Memcached DEFAULT_MSG MEMCACHED_EXECUTABLE) - -mark_as_advanced(MEMCACHED_EXECUTABLE) diff --git a/CMake/FindSphinx.cmake b/CMake/FindSphinx.cmake deleted file mode 100644 index 75604e890..000000000 --- a/CMake/FindSphinx.cmake +++ /dev/null @@ -1,10 +0,0 @@ -find_program(SPHINX_EXECUTABLE NAMES sphinx-build sphinx-build-3 - HINTS $ENV{SPHINX_DIR} - PATH_SUFFIXES bin - DOC "Sphinx documentation generator" - ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(Sphinx DEFAULT_MSG SPHINX_EXECUTABLE) - -mark_as_advanced(SPHINX_EXECUTABLE) diff --git a/CMake/InstallPublicHeaders.cmake b/CMake/InstallPublicHeaders.cmake deleted file mode 100644 index 7943ddb2e..000000000 --- a/CMake/InstallPublicHeaders.cmake +++ /dev/null @@ -1,49 +0,0 @@ -macro(install_public_headers DIRECTORY) - # validate current directory - string(FIND ${CMAKE_CURRENT_SOURCE_DIR} /include/ INCDIR REVERSE) - string(FIND ${CMAKE_CURRENT_SOURCE_DIR} /src/ SRCDIR REVERSE) - if((INCDIR GREATER_EQUAL 0) OR (SRCDIR GREATER_EQUAL 0)) - if(INCDIR GREATER_EQUAL 0) - math(EXPR POSITION "${INCDIR} + 9") - else() - math(EXPR POSITION "${SRCDIR} + 5") - endif() - string(SUBSTRING ${CMAKE_CURRENT_SOURCE_DIR} ${POSITION} -1 CHKDIR) - if(NOT "${CHKDIR}" STREQUAL "${DIRECTORY}") - message(SEND_ERROR "install_public_headers() directories do not match: '${CHKDIR}' != '${DIRECTORY}'") - set(ENV{INVALID_CONFIGURATION} 1) - endif() - endif() - - string(REGEX MATCH "^[^/-]+" LIBRARY "${DIRECTORY}") - - # validate public interface version - string(FIND "${DIRECTORY}" "-" DASH) - if(DASH GREATER 0) - string(SUBSTRING "${DIRECTORY}" 0 ${DASH} LIBRARY_BASE) - string(TOUPPER ${LIBRARY_BASE} LIBRARY_UCASE) - math(EXPR DASH "${DASH} + 1") - string(SUBSTRING "${DIRECTORY}" ${DASH} -1 VERSION) - if(NOT ${LIBRARY_UCASE}_VERSION_INC VERSION_EQUAL ${VERSION}) - message(SEND_ERROR "${LIBRARY_BASE} public include directory version ${VERSION} != " ${${LIBRARY_UCASE}_VERSION_INC}) - set(ENV{INVALID_CONFIGURATION} 1) - endif() - endif() - - # change local includes to system includes - foreach(HEADER IN ITEMS ${ARGN}) - if(HEADER MATCHES "^@") - string(SUBSTRING ${HEADER} 1 -1 HEADER) - configure_file(${HEADER}.in ${HEADER}) - set(HEADER "${CMAKE_CURRENT_BINARY_DIR}/${HEADER}") - else() - set(HEADER "${CMAKE_CURRENT_SOURCE_DIR}/${HEADER}") - endif() - install(FILES ${HEADER} - COMPONENT dev - DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${DIRECTORY} - ) - list(APPEND ${LIBRARY}_includes ${HEADER}) - endforeach() - set(${LIBRARY}_includes "${${LIBRARY}_includes}" PARENT_SCOPE) -endmacro() diff --git a/CMake/_Configure.cmake b/CMake/_Configure.cmake deleted file mode 100644 index 0c54622f0..000000000 --- a/CMake/_Configure.cmake +++ /dev/null @@ -1,39 +0,0 @@ - -macro(configure_init CONFIG_HEADER_FILE) - set(CONFIGURE_FILE_IN ${CONFIG_HEADER_FILE}.in) - file(WRITE ${CONFIGURE_FILE_IN} "#pragma once\n") - set(CONFIGURE_FILE_OUT ${CONFIG_HEADER_FILE}) -endmacro() - -macro(configure_append) - file(APPEND ${CONFIGURE_FILE_IN} ${ARGN}) -endmacro() - -macro(configure_set VAR VAL) - set(${VAR} ${VAL}) - configure_append("#cmakedefine ${VAR} 1\n") -endmacro() - -macro(configure_define VAR) - configure_append("#cmakedefine ${VAR} 1\n") -endmacro() -macro(configure_undef VAR) - configure_append("#undef ${VAR}\n") -endmacro() - -macro(configure_define_01 VAR) - configure_append("#cmakedefine01 ${VAR}\n") -endmacro() - -macro(configure_define_literal VAR) - string(TOUPPER ${VAR} UPPER) - configure_append("#define ${UPPER} @${VAR}@\n") -endmacro() -macro(configure_define_header VAR) - string(TOUPPER ${VAR} UPPER) - configure_append("#define ${UPPER} <@${VAR}@>\n") -endmacro() -macro(configure_define_string VAR) - string(TOUPPER ${VAR} UPPER) - configure_append("#define ${UPPER} \"@${VAR}@\"\n") -endmacro() diff --git a/CMake/_Include.cmake b/CMake/_Include.cmake deleted file mode 100644 index 7466b4cab..000000000 --- a/CMake/_Include.cmake +++ /dev/null @@ -1,203 +0,0 @@ -include(_Configure) -configure_init(${CMAKE_BINARY_DIR}/mem_config.h) - -add_compile_definitions(${GLOBAL_DEFINITIONS}) -# list(TRANSFORM) requires >=3.12 -string(REPLACE ";" " -D" GLOBAL_DEFINITION_FLAGS "${GLOBAL_DEFINITIONS}") -set(GLOBAL_DEFINITION_FLAGS -D${GLOBAL_DEFINITION_FLAGS}) - -if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) - include(CTest) -endif() - -include(CMakePushCheckState) -include(CMakePackageConfigHelpers) - -macro(make_have_identifier NAME ID) - string(MAKE_C_IDENTIFIER ${NAME} _make_have_identifier) - string(TOUPPER ${_make_have_identifier} _make_have_identifier) - set(${ID} HAVE_${_make_have_identifier}) -endmacro() - -include(CheckCCompilerFlag) -macro(check_flag FLAG HAVE) - configure_define(${HAVE}) - check_c_compiler_flag("${FLAG}" ${HAVE}) -endmacro() -include(CheckCXXCompilerFlag) -macro(check_cxx_flag FLAG HAVE) - configure_define(${HAVE}) - check_cxx_compiler_flag("${FLAG}" ${HAVE}) -endmacro() -include(CheckSymbolExists) -macro(check_symbol NAME HEADER) - make_have_identifier(${NAME} HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - if(${ARGC} GREATER 1) - string(APPEND CMAKE_REQUIRED_FLAGS " ${ARGV2}") - endif() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_symbol_exists(${NAME} ${HEADER} ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckCXXSymbolExists) -macro(check_cxx_symbol NAME HEADER) - make_have_identifier(${NAME} HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - if(${ARGC} GREATER 1) - string(APPEND CMAKE_REQUIRED_FLAGS " ${ARGN}") - endif() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_cxx_symbol_exists(${NAME} ${HEADER} ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckIncludeFile) -macro(check_include HEADER) - make_have_identifier(${HEADER} HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - if(${ARGC} GREATER 1) - string(APPEND CMAKE_REQUIRED_FLAGS " ${ARGN}") - endif() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_include_file(${HEADER} ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckIncludeFileCXX) -macro(check_cxx_include HEADER) - make_have_identifier(${HEADER} HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - if(${ARGC} GREATER 1) - string(APPEND CMAKE_REQUIRED_FLAGS " ${ARGN}") - endif() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_include_file_cxx(${HEADER} ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckTypeSize) -macro(check_type TYPE) - make_have_identifier(${TYPE} HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - if(${ARGC} GREATER 1) - list(APPEND CMAKE_EXTRA_INCLUDE_FILES ${ARGN}) - endif() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_type_size(${TYPE} ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckCSourceCompiles) -macro(check_c_source SOURCE HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_c_source_compiles("${SOURCE}" ${HAVE}) - cmake_pop_check_state() -endmacro() -include(CheckCXXSourceCompiles) -macro(check_cxx_source SOURCE HAVE) - configure_define(${HAVE}) - cmake_push_check_state() - list(APPEND CMAKE_REQUIRED_DEFINITIONS ${GLOBAL_DEFINITION_FLAGS}) - check_cxx_source_compiles("${SOURCE}" ${HAVE}) - cmake_pop_check_state() -endmacro() - -include(CheckBacktrace) -include(CheckByteswap) -include(CheckDependency) -include(CheckDtrace) -include(CheckPkgconf) -include(CheckDebug) -include(CheckThreads) -include(CheckVisibility) -include(InstallPublicHeaders) - -function(pkgconfig_export VAR VAL) - get_property(PREV GLOBAL PROPERTY PKGCONFIG_${VAR}) - set_property(GLOBAL PROPERTY PKGCONFIG_${VAR} "${PREV} ${VAL}") -endfunction() -macro(pkgconfig_import VAR) - get_property(PKGCONFIG_${VAR} GLOBAL PROPERTY PKGCONFIG_${VAR}) -endmacro() - -## sasl -configure_define_01(LIBMEMCACHED_WITH_SASL_SUPPORT) -if(ENABLE_SASL) - check_dependency(LIBSASL sasl2) - if(HAVE_LIBSASL) - set(LIBMEMCACHED_WITH_SASL_SUPPORT 1) - pkgconfig_export(REQUIRES libsasl2) - cmake_push_check_state() - set(CMAKE_REQUIRED_INCLUDES "${LIBSASL_INCLUDEDIR}") - set(CMAKE_REQUIRED_LIBRARIES "${LIBSASL_LIBRARIES}") - check_symbol(sasl_client_done sasl/sasl.h) - cmake_pop_check_state() - endif() -endif() - -## hashes -configure_set(HAVE_FNV64_HASH ${ENABLE_HASH_FNV64}) -configure_set(HAVE_MURMUR_HASH ${ENABLE_HASH_MURMUR}) -configure_set(HAVE_HSIEH_HASH ${ENABLE_HASH_HSIEH}) - -check_include(alloca.h) -check_include(arpa/inet.h) -check_include(dlfcn.h) -check_include(getopt.h) -check_include(libgen.h) -check_include(netdb.h) -check_include(netinet/in.h) -check_include(netinet/tcp.h) -check_include(poll.h) -check_include(strings.h) -check_include(sys/poll.h) -check_include(sys/socket.h) -check_include(sys/time.h) -check_include(sys/un.h) -check_include(unistd.h) - -check_type(in_port_t netinet/in.h) -check_type(pid_t sys/types.h) -check_type(ssize_t sys/types.h) -check_type("struct msghdr" sys/socket.h) -check_type("struct timespec" time.h) - -check_cxx_symbol(abi::__cxa_demangle cxxabi.h) -check_symbol(CLOCK_MONOTONIC time.h) -check_symbol(clock_gettime time.h) -check_symbol(ERESTART errno.h) -check_symbol(fcntl fcntl.h) -check_symbol(gettimeofday sys/time.h) -check_symbol(htonll arpa/inet.h) -check_symbol(index strings.h) -check_symbol(MSG_DONTWAIT sys/socket.h) -check_symbol(MSG_MORE sys/socket.h) -check_symbol(MSG_NOSIGNAL sys/socket.h) -check_symbol(SO_RCVTIMEO sys/socket.h) -check_symbol(SO_SNDTIMEO sys/socket.h) -check_symbol(rand stdlib.h) -check_symbol(random stdlib.h) -check_symbol(realpath stdlib.h) -check_symbol(sendmsg sys/socket.h) -check_symbol(setenv stdlib.h) -check_symbol(strerror_r string.h) -check_c_source(" - #include - int main() { - char x; - return *strerror_r(0, &x, 1); - }" - HAVE_STRERROR_R_CHAR_P -) - -if(WIN32) - check_include(io.h) - check_include(winsock2.h) - check_include(ws2tcpip.h) - - check_symbol(htonll winsock2.h) -endif() diff --git a/CMakeConfig.txt b/CMakeConfig.txt deleted file mode 100644 index 2a8617f1a..000000000 --- a/CMakeConfig.txt +++ /dev/null @@ -1,101 +0,0 @@ -if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) - if(NOT DEFINED ENV{CMAKE_BUILD_TYPE}) - set(ENV{CMAKE_BUILD_TYPE} Release) - endif() - set(CMAKE_BUILD_TYPE $ENV{CMAKE_BUILD_TYPE} - CACHE STRING "build type (Release, Debug, ...)" FORCE) -endif() -set(CMAKE_INSTALL_PREFIX /usr/local - CACHE PATH "install prefix") - -if(APPLE) - set(CMAKE_INSTALL_RPATH @loader_path - CACHE STRING "set relative rpath") -elseif(UNIX) - # FIXME - set(CMAKE_INSTALL_RPATH "\$ORIGIN" - CACHE STRING "set relative rpath") -endif() - -if(${CMAKE_VERSION} VERSION_LESS "3.12") - set(TARGET_NAMELINK_COMPONENT "") -else() - set(TARGET_NAMELINK_COMPONENT NAMELINK_COMPONENT dev DESTINATION ${CMAKE_INSTALL_LIBDIR}) -endif() - -set(CLIENT_PREFIX mem - CACHE STRING "client prefix (default mem; i.e.: memstat, memcp, memcat ...)") - -option(BUILD_SHARED_LIBS "whether to build shared libraries" - ON) -option(BUILD_TESTING "whether to enable build of the test suite" - $ENV{BUILD_TESTING}) -option(BUILD_DOCSONLY "build *only* documentation" - $ENV{BUILD_DOCSONLY}) -option(BUILD_DOCS "build documentation" - ${BUILD_DOCSONLY}) -option(BUILD_DOCS_HTML "build HTML docs" - ${BUILD_DOCS}) -option(BUILD_DOCS_MAN "build manpages" - ${BUILD_DOCS}) -option(BUILD_DOCS_MANGZ "gzip manpages" - ${BUILD_DOCS_MAN}) -if(BUILD_DOCS_MANGZ) - set(BUILD_DOCS_MAN ON CACHE BOOL "forced by BUILD_DOCS_MANGZ" FORCE) -endif() -if(BUILD_DOCS_MAN OR BUILD_DOCS_HTML) - set(BUILD_DOCS ON CACHE BOOL "forced by BUILD_DOCS_MAN OR BUILD_DOCS_HTML" FORCE) -endif() - -set(ENABLE_SANITIZERS "$ENV{ENABLE_SANITIZERS}" - CACHE STRING "sanitizers to enable (e.g. address;undefined ...)") -option(ENABLE_SASL "enable SASL support" - $ENV{ENABLE_SASL}) -option(ENABLE_DTRACE "enable dtrace support" - $ENV{ENABLE_DTRACE}) -option(ENABLE_HASH_HSIEH "enable hsieh hash support" - $ENV{ENABLE_HASH_HSIEH}) -if(NOT DEFINED ENV{ENABLE_HASH_FNV64}) - set(ENV{ENABLE_HASH_FNV64} ON) -endif() -option(ENABLE_HASH_FNV64 "enable fnv64 hash support" - $ENV{ENABLE_HASH_FNV64}) -if(NOT DEFINED ENV{ENABLE_HASH_MURMUR}) - set(ENV{ENABLE_HASH_MURMUR} ON) -endif() -option(ENABLE_HASH_MURMUR "enable murmur hash support" - $ENV{ENABLE_HASH_MURMUR}) -if(NOT DEFINED ENV{ENABLE_MEMASLAP}) - set(ENV{ENABLE_MEMASLAP} ON) -endif() -option(ENABLE_MEMASLAP "enable memaslap client" - $ENV{ENABLE_MEMASLAP}) -option(ENABLE_OPENSSL_CRYPTO - "enable OpenSSL's libcrypto instead of bundled AES implementation" - $ENV{ENABLE_OPENSSL_CRYPTO}) - -if(BUILD_TESTING) - set(MEMCACHED_BINARY "$ENV{MEMCACHED_BINARY}" - CACHE STRING "memcached binary") - set(CMAKE_CTEST_ARGUMENTS "--output-on-failure") - if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.17) - # available since CMake 3.17 - list(APPEND CMAKE_CTEST_ARGUMENTS --repeat until-pass:2) - if(NOT "$ENV{CIRRUS_CI}") - list(APPEND CMAKE_CTEST_ARGUMENTS -j2) - endif() - endif() -endif() - -if(BUILD_DOCS) - set(SPHINX_OPTIONS "" - CACHE STRING "additional sphinx-build command line options") - set(SPHINX_THEME "sphinx_rtd_theme" - CACHE STRING "sphinx HTML theme") - set(SPHINX_THEME_OPTIONS "" - CACHE STRING "sphinx HTML theme options") - set(SPHINX_EXTENSIONS "" - CACHE STRING "comma separated list of quoted sphinx extensions") - set(SPHINX_CONF_APPEND "" - CACHE STRING "append verbatim code to sphinx' conf.py") -endif() diff --git a/CMakeLists.txt b/CMakeLists.txt deleted file mode 100644 index 1396a42a5..000000000 --- a/CMakeLists.txt +++ /dev/null @@ -1,93 +0,0 @@ -cmake_minimum_required(VERSION 3.9...3.18) - -if(${CMAKE_VERSION} VERSION_LESS 3.12) - cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) -endif() - -include(CMakeVersions.txt) - -project(libmemcached-awesome - VERSION "${LIBMEMCACHED_VERSION}" - DESCRIPTION "libmemcached-awesome, a C/C++ memcached client library" - ) -set(PROJECT_HOMEPAGE_URL "https://github.com/awesomized/libmemcached") -set(PROJECT_CONTACT "Michael Wallner ") - -set(CXX_STANDARD 11) -set(CMAKE_POSITION_INDEPENDENT_CODE ON) - -set(GLOBAL_DEFINITIONS _GNU_SOURCE) - -include(CMakeConfig.txt) -include(GNUInstallDirs) -list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/CMake") - -if(BUILD_DOCS OR BUILD_DOCSONLY) - add_subdirectory(docs) -endif() - -if(NOT BUILD_DOCSONLY) - include(CMake/_Include.cmake) - - set(CLIENTS - capable - cat - cp - dump - error - exist - flush - parse - ping - rm - slap - stat - touch - ) - - add_subdirectory(include) - add_subdirectory(src) - add_subdirectory(contrib) - add_subdirectory(support) - - # tests need c++17 support - add_subdirectory(test) - - # keep last - configure_file(${CONFIGURE_FILE_IN} ${CONFIGURE_FILE_OUT} @ONLY) -endif() - -list(APPEND PROJECT_CONFIG ${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_PROCESSOR}) -list(APPEND PROJECT_CONFIG ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}) -list(APPEND PROJECT_CONFIG ${CMAKE_BUILD_TYPE}) - -include(CPack.txt) - -install(FILES - AUTHORS - BUGS.md - ChangeLog-0.md - ChangeLog-1.0.md - ChangeLog-1.1.md - CONTRIBUTING.md - LICENSE - NEWS - README.md - TODO - COMPONENT doc - DESTINATION ${CMAKE_INSTALL_DOCDIR}/ - ) -if(NOT WIN32) - # skip links on windows (cmake bug?) - install(FILES - ChangeLog - ChangeLog.md - COPYING - COMPONENT doc - DESTINATION ${CMAKE_INSTALL_DOCDIR}/ - ) -endif() - -if(ENV{INVALID_CONFIGURATION}) - message(FATAL_ERROR "invalid configuration -- giving up") -endif() diff --git a/CMakeVersions.txt b/CMakeVersions.txt deleted file mode 100644 index a159b3d42..000000000 --- a/CMakeVersions.txt +++ /dev/null @@ -1,51 +0,0 @@ -# -# libmemcached -# - -set(LIBMEMCACHED_VERSION 1.1.4) -set(LIBMEMCACHED_VERSION_INC 1.0) -set(LIBMEMCACHED_VERSION_HEX 0x001001004) - -# libmemcached.so - -set(LIBMEMCACHED_SO_SOVERSION 11) -set(LIBMEMCACHED_SO_VERSION ${LIBMEMCACHED_SO_SOVERSION}.0.0) - -# -# libmemcachedutil -# - -set(LIBMEMCACHEDUTIL_VERSION 1.1.0) -set(LIBMEMCACHEDUTIL_VERSION_INC 1.0) -set(LIBMEMCACHEDUTIL_VERSION_HEX 0x001001000) - -# libmemcachedutil.so - -set(LIBMEMCACHEDUTIL_SO_SOVERSION 2) -set(LIBMEMCACHEDUTIL_SO_VERSION ${LIBMEMCACHEDUTIL_SO_SOVERSION}.0.0) - -# -# libmemcachedprotocol -# - -set(LIBMEMCACHEDPROTOCOL_VERSION 0.1.0) -set(LIBMEMCACHEDPROTOCOL_VERSION_INC 0.0) -set(LIBMEMCACHEDPROTOCOL_VERSION_HEX 0x000001000) - -# libmemcachedprotocol.so - -set(LIBMEMCACHEDPROTOCOL_SO_SOVERSION 0) -set(LIBMEMCACHEDPROTOCOL_SO_VERSION ${LIBMEMCACHEDPROTOCOL_SO_SOVERSION}.0.0) - -# -# libhashkit -# - -set(LIBHASHKIT_VERSION 1.1.0) -set(LIBHASHKIT_VERSION_INC 1.0) -set(LIBHASHKIT_VERSION_HEX 0x00100100) - -# libhashkit.so - -set(LIBHASHKIT_SO_SOVERSION 2) -set(LIBHASHKIT_SO_VERSION ${LIBHASHKIT_SO_SOVERSION}.0.0) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 968bd44ef..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,39 +0,0 @@ -# Contributor Code of Conduct - -As contributors and maintainers of this project, and in the interest of -fostering an open and welcoming community, we pledge to respect all people who -contribute through reporting issues, posting feature requests, updating -documentation, submitting pull requests or patches, and other activities. - -We are committed to making participation in this project a harassment-free -experience for everyone, regardless of level of experience, gender, gender -identity and expression, sexual orientation, disability, personal appearance, -body size, race, ethnicity, age, religion, or nationality. - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery -* Personal attacks -* Trolling or insulting/derogatory comments -* Public or private harassment -* Publishing other's private information, such as physical or electronic - addresses, without explicit permission -* Other unethical or unprofessional conduct. - -Project maintainers have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct. By adopting this Code of Conduct, project -maintainers commit themselves to fairly and consistently applying these -principles to every aspect of managing this project. Project maintainers who do -not follow or enforce the Code of Conduct may be permanently removed from the -project team. - -This code of conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by opening an issue or contacting one or more of the project maintainers. - -This Code of Conduct is adapted from the -[Contributor Covenant](http://contributor-covenant.org), version 1.2.0, -available at http://contributor-covenant.org/version/1/2/0/. diff --git a/COPYING b/COPYING deleted file mode 120000 index 7a694c969..000000000 --- a/COPYING +++ /dev/null @@ -1 +0,0 @@ -LICENSE \ No newline at end of file diff --git a/CPack.txt b/CPack.txt deleted file mode 100644 index 1a4d77dc9..000000000 --- a/CPack.txt +++ /dev/null @@ -1,111 +0,0 @@ -# default options - -set(CPACK_ARCHIVE_COMPONENT_INSTALL ${CPACK_COMPONENT_INSTALL}) -set(CPACK_SOURCE_IGNORE_FILES "/[.]git/;/[.](idea|settings|c?project);~$;[.]log$;[.]bak$") - -macro(cpack_include_if GENERATOR) - message(STATUS "Checking ${GENERATOR} package configuration ...") - if(EXISTS ${CMAKE_SOURCE_DIR}/CPack/${GENERATOR}.txt) - include(${CMAKE_SOURCE_DIR}/CPack/${GENERATOR}.txt) - endif() -endmacro() - -# shell installer -set(CPACK_BINARY_STGZ ${UNIX}) - -# binary archive -set(CPACK_BINARY_TBZ2 0) -set(CPACK_BINARY_TGZ ${UNIX}) -set(CPACK_BINARY_TXZ 0) -set(CPACK_BINARY_TZ 0) -set(CPACK_BINARY_ZIP ${WIN32}) -set(CPACK_BINARY_NSIS ${WIN32}) -set(CPACK_BINARY_NUGET 0) - -# source archive -set(CPACK_SOURCE_TBZ2 0) -set(CPACK_SOURCE_TGZ ${UNIX}) -set(CPACK_SOURCE_TXZ 0) -set(CPACK_SOURCE_TZ 0) -set(CPACK_SOURCE_ZIP ${WIN32}) - -# project internals -set(CPACK_PACKAGE_LICENSE "BSD-3-Clause") -set(CPACK_PACKAGE_CONTACT "${PROJECT_CONTACT}") -set(CPACK_PACKAGE_VENDOR "${PROJECT_CONTACT}") -set(CPACK_PACKAGE_DESCRIPTION - "libmemcached-awesome is an open source C/C++ client library and tools -for the memcached server (http://memcached.org/). It has been designed -to be light on memory usage, thread safe, and provide full access to -server side methods.") -set(CPACK_PROJECT_CONFIG ${PROJECT_CONFIG}) -set(CPACK_PROJECT_CONFIG_FILE "${CMAKE_SOURCE_DIR}/CPack/ProjectConfig.txt") -set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.md") -set(CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}/${PROJECT_VERSION}") -set(CPACK_PACKAGE_CHECKSUM SHA1) -set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE") -set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md") -set(CPACK_CHANGELOG_FILE "${CMAKE_SOURCE_DIR}/ChangeLog-1.1.md") -set(CPACK_PACKAGE_DIRECTORY "${CMAKE_BINARY_DIR}") - -execute_process( - COMMAND git describe --tags --match [0-9]*.* - WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} - OUTPUT_VARIABLE PROJECT_TAG - ERROR_VARIABLE GIT_ERROR_OUTPUT -) -if(GIT_ERROR_OUTPUT) - message(NOTICE "git describe: ${GIT_ERROR_OUTPUT}") -endif() -string(STRIP "${PROJECT_TAG}" PROJECT_TAG) -if(PROJECT_TAG) - set(CPACK_PACKAGE_FILE_NAME ${PROJECT_NAME}-${PROJECT_TAG}) - set(CPACK_PACKAGE_VERSION ${PROJECT_TAG}) -else() - set(CPACK_PACKAGE_FILE_NAME ${PROJECT_NAME}-${PROJECT_VERSION}) - set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION}) -endif() - -# dependencies -if(HAVE_LIBSASL) - string(APPEND CPACK_PACKAGE_DEPENDS " libsasl2") -endif() -if(HAVE_TBB) - string(APPEND CPACK_PACKAGE_DEPENDS " tbb") -endif() -if(HAVE_LIBEVENT) - string(APPEND CPACK_PACKAGE_DEPENDS " libevent") -endif() - -# DEBs -find_program(DPKG dpkg) -if(DPKG) - cpack_include_if(DEB) -endif() - -# WIN -if(WIN32) - cpack_include_if(NSIS) -endif() - -# RPMs -find_program(RPMBUILD rpmbuild) -if(RPMBUILD) - cpack_include_if(RPM) -endif() - -# keep last -include(CPack) - -set(PUSH_ARTIFACTS_SH "${CMAKE_SOURCE_DIR}/scripts/push-artifacts.sh") -if(WIN32) - set(PUSH_ARTIFACTS_CMD msys2 -c '${PUSH_ARTIFACTS_SH} ${CPACK_PACKAGE_VERSION}') -else() - set(PUSH_ARTIFACTS_CMD ${PUSH_ARTIFACTS_SH} ${CPACK_PACKAGE_VERSION}) -endif() - -add_custom_target(push-artifacts - COMMAND ${PUSH_ARTIFACTS_CMD} - WORKING_DIRECTORY ${CPACK_PACKAGE_DIRECTORY} - ) - diff --git a/CPack/DEB.txt b/CPack/DEB.txt deleted file mode 100644 index ea19c9b66..000000000 --- a/CPack/DEB.txt +++ /dev/null @@ -1,6 +0,0 @@ -set(CPACK_BINARY_DEB ON) -set(CPACK_DEB_COMPONENT_INSTALL ${CPACK_COMPONENT_INSTALL}) -set(CPACK_DEBIAN_PACKAGE_DEPENDS "${CPACK_PACKAGE_DEPENDS}") -set(CPACK_DEBIAN_ENABLE_COMPONENT_DEPENDS ON) -set(CPACK_COMPONENT_bin_DEPENDS lib) -set(CPACK_COMPONENT_dev_DEPENDS lib) diff --git a/CPack/NSIS.txt b/CPack/NSIS.txt deleted file mode 100644 index a99cddcfa..000000000 --- a/CPack/NSIS.txt +++ /dev/null @@ -1,5 +0,0 @@ -set(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_FILE_NAME}") -set(CPACK_NSIS_MODIFY_PATH ON) -set(CPACK_NSIS_DISPLAY_NAME "${CPACK_PACKAGE_FILE_NAME}") -set(CPACK_NSIS_PACKAGE_NAME "${CPACK_PACKAGE_FILE_NAME}") -set(CPACK_NSIS_HELP_LINK "${PROJECT_HOMEPAGE_URL}") diff --git a/CPack/ProjectConfig.txt b/CPack/ProjectConfig.txt deleted file mode 100644 index 4e4e3e199..000000000 --- a/CPack/ProjectConfig.txt +++ /dev/null @@ -1 +0,0 @@ -string(REPLACE ";" "-" CPACK_PACKAGE_DIRECTORY "${CPACK_PACKAGE_DIRECTORY}/${CPACK_PACKAGE_VERSION}/${CPACK_GENERATOR}/${CPACK_PROJECT_CONFIG}") diff --git a/CPack/RPM.txt b/CPack/RPM.txt deleted file mode 100644 index bbb9a32f5..000000000 --- a/CPack/RPM.txt +++ /dev/null @@ -1,7 +0,0 @@ -set(CPACK_BINARY_RPM ON) -set(CPACK_RPM_COMPONENT_INSTALL ${CPACK_COMPONENT_INSTALL}) -set(CPACK_RPM_PACKAGE_DEPENDS "${CPACK_PACKAGE_DEPENDS}") -set(CPACK_RPM_PACKAGE_LICENSE "${CPACK_PACKAGE_LICENSE}") -#set(CPACK_RPM_CHANGELOG_FILE "${CPACK_CHANGELOG_FILE}") -set(CPACK_RPM_PACKAGE_DESCRIPTION "${CPACK_PACKAGE_DESCRIPTION}") -set(CPACK_RPM_PACKAGE_GROUP "Development/Libraries") diff --git a/ChangeLog b/ChangeLog deleted file mode 120000 index 89f45902d..000000000 --- a/ChangeLog +++ /dev/null @@ -1 +0,0 @@ -ChangeLog.md \ No newline at end of file diff --git a/ChangeLog-0.html b/ChangeLog-0.html new file mode 100644 index 000000000..b1f704613 --- /dev/null +++ b/ChangeLog-0.html @@ -0,0 +1,897 @@ + + + + + + + ChangeLog v0.x — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

ChangeLog v0.x

+
+

v 0.53

+
+

released 2011-09-27

+
+
    +

  • Fix for FreeBSD/OpenBSD and -lm

    • +

  • Added memcached_exist()

    • +

  • Fix for memory when using config test.

    • +

  • CLI gained --quiet

    • +
+
+
+

v 0.52

+
+

released 2011-09-12

+
+
    +

  • Build fixes for Ubuntu/Suse.

    • +

  • Fixes for OSX Lion.

    • +

  • Bug fix for looping back through dns lookups under certain failures.

    • +

  • Fixes related to dead server failures.

    • +
+
+
+

v 0.51

+
+

released 2011-07-21

+
+
    +

  • memcached_callback_set() now takes its data argument as const

    • +

  • Update to tests.

    • +

  • Fix in parser for port number.

    • +
+
+
+

v 0.50

+
+

released 2011-06-20

+
+
    +

  • Updates to C++ interface

    • +

  • Custom free allocators need to now check for value before calling free.

    • +

  • memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster).

    • +

  • Fix for stats structure.

    • +

  • Updates to documentation.

    • +

  • memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster).

    • +
+
+
+

v 0.49

+
+

released 2011-04-14

+
+
    +

  • Fix calls to auto methods so that if value is not passed in nothing bad happens.

    • +

  • New parser calls for generating memcached_st objects.

    • +

  • New error system.

    • +

  • New flow control for messages means faster get/set calls.

    • +

  • Added new documentation system.

    • +

  • A behavior change has been now made that if you specify a weight for any server, we enable the weight flag and do weight balancing.

    • +

  • Added MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS to simplify the setting of AUTO REJECT for servers.

    • +
+
+
+

v 0.48

+
+

released 2011-03-16

+
+
    +

  • Fix memory leak in server parse.

    • +

  • Move test framework out to be its own library (easier to work with Gearman).

    • +
+
+
+

v 0.47

+
+

released 2011-02-24

+
+
    +

  • Additional fixes for OpenBSD.

    • +

  • Bug fix 677609, 456080.

    • +

  • SIGPIPE fix for Linux send().

    • +

  • memcapable can now test ascii or binary based on flags.

    • +

  • Additional build fixes for SASL.

    • +
+
+
+

v 0.46

+
+

released 2011-02-14

+
+
    +

  • Fixes a number of corner case bugs.

    • +

  • Fixes related to OpenBSD.

    • +

  • Better testing for protocol version.

    • +

  • Removes special case infinite wait on blocking setup.

    • +
+
+
+

v 0.45

+
+

released 2011-02-09

+
+
    +

  • Add support for systemtap

    • +
+
+
+

v 0.44

+
+

released 2010-09-23

+
+
    +

  • Windows bug fixes.

    • +

  • Hudson port support in test harness.

    • +

  • Improved portability of test hanrness.

    • +

  • SASL fixes.

    • +
+
+
+

v 0.43

+
+

released 2010-07-28

+
+
    +

  • Added --args to memstat so that a greater range of values can be returned.

    • +

  • Prelimanary support for Windows.

    • +

  • memcached_stat_execute() merged.

    • +
+
+
+

v 0.42

+
+

released 2010-07-06

+
+
    +

  • Mistake in libtool caused issue with library version

    • +
+
+
+

v 0.41

+
+

released 2010-06-30

+
+
    +

  • Added --file for memcat.

    • +

  • Added limemcached_ping() to libmemcached_util

    • +

  • Bugfix for some cases where connect would have issues with timeout.

    • +

  • Wrong value for errno given as error on an IO failure inside of poll.

    • +

  • Bug fix for issue where multiple interfaces with bad DNS were not being caught.

    • +
+
+
+

v 0.40

+
+

released 2010-04-23

+
+
    +

  • Placed retry logic in for busted resolvers

    • +

  • Add an ignore for SIGPIPE to solve OSX issues.

    • +

  • A couple of fixed for memcached_light server.

    • +

  • Updated to debug mode to track io_wait

    • +
+
+
+

v 0.39

+
+

released 2010-04-06

+
+
    +

  • Add support for prefix keys to binary protocol.

    • +

  • Remove the undocumented call memcached_server_remove().

    • +

  • The undocumented call memcached_server_by_key() now returns const.

    • +

  • memcached_server_error_reset() has been deprecated.

    • +

  • memcached_server_list() has been deprecated. Use memcached_server_cursor() to walk the servers found in a memcached_st() structure.

    • +

  • memcached_verbosity() can now be run concurrently with other operations.

    • +

  • SASL support.

    • +

  • Fixes memory leak found in EJECT HOSTS.

    • +
+
+
+

v 0.38

+
+

released 2010-02-10

+
+
    +

  • C++ interface for libhashkit.

    • +

  • Modified memcached_set_memory_allocators() so that it requires a context pointer.

    • +

  • memcached_clone() now runs 5 times faster.

    • +

  • Functions used for callbacks are now given const memcached_st.

    • +

  • Added MEMCACHED_BEHAVIOR_CORK.

    • +

  • memslap now creates a configuration file at ~/.memslap.cnf

    • +

  • memcached_purge() now calls any callbacks registered during get execution.

    • +

  • Many fixes to memslap.

    • +

  • Updates for memcapable.

    • +

  • Compile fixes for OpenBSD.

    • +

  • Fix for possible recursive decent on IO failure.

    • +
+
+
+

v 0.37

+
+

released 2010-01-12

+
+
    +

  • Fixed build for libhashkit.

    • +

  • Fixed install path regression.

    • +

  • Modified RPM to strict check install.

    • +

  • Added documentation for memcached_server_cursor();

    • +

  • Added memcached_servers_reset().

    • +

  • Modified memcached_st to remove dead cursor_server member.

    • +
+
+
+

v 0.36

+
+

released 2010-01-07

+
+
    +

  • Merged in new memslap utility.

    • +

  • All of constants.h has been updated to match style (all old identifiers continue to work).

    • +

  • Added first pass for libhashkit.

    • +

  • Updated test Framework/extended tests.

    • +

  • Random read support during replication added.

    • +

  • Modified use_sort so that the option can be applied to any distribution type.

    • +

  • We removed the MEMCACHED_BEHAVIOR_KETAMA_COMPAT_MODE added in 0.35. Instead use memcached_behavior_set_distribution().

    • +
+
+
+

v 0.35

+
+

released 2009-11-09

+
+
    +

  • Added support for by_key operations for inc/dec methods.

    • +

  • Added mget test to memslap.

    • +

  • Support for compatible ketama for SpyMemcached

    • +

  • Update C++ interface.

    • +

  • Fix for memcp

    • +
+
+
+

v 0.34

+
+

released 2009-10-13

+
+
    +

  • Added support for setting behavior flags on a connection pool.

    • +

  • Don't increment server_failure_counter on normal disconnects.

    • +

  • Added prototype for a callback based protocol parser (server side) with examples so that you could let your own application speak the memcached protocol

    • +

  • Updated memcapable to test ASCII protocol.

    • +

  • Changed behavior so that server can be removed at first sign of failure.

    • +

  • Added memcached_server_get_last_disconnect() call

    • +
+
+
+

v 0.33

+
+

released 2009-09-23

+
+
    +

  • Added memcapable to test servers for binary compatibility.

    • +

  • Updated C++ interface. Added basic support for C++ exceptions. Added multiple constructors the memcached client object. The C++ interface now takes parameters which are C++ types (such as std::string).

    • +

  • Several bug fixes for binary protocol support.

    • +

  • Fixed crashing issue with dumping from memcachd server (server internals were changed without documenting change).

    • +
+
+
+

v 0.32

+
+

released 2009-09-15

+
+
    +

  • Change of behavior where linger is only modified for no-block and then it is set to zero.

    • +

  • Added Twitter's memcached_server_error() functions.

    • +

  • Fix for OSX compiles in development builds.

    • +

  • Updated C++ interface.

    • +

  • Updated memcached_mget and memcached_mget_by_key to take a size_t as a parameter instead of an unsigned int for number_of_keys.

    • +
+
+
+

v 0.31

+
+

released 2009-07-10

+
+
    +

  • Added support or HA via replication.

    • +

  • malloc() removed for server key usage.

    • +

  • Update build system.

    • +

  • Added support for memcached_set_memory_allocators().

    • +

  • Fixed bug in configure.ac for have_htoll.

    • +
+
+
+

v 0.30

+
+

released 2009-06-01

+
+
    +

  • Added memcachd_dump command (and framework for memdump tool).

    • +

  • Realigned all structures to remove padding (and line up important bits for 64bit caches.

    • +

  • Remove some of sprintf() in storage calls().

    • +

  • Removed printf() in stat call for unknown stat member.

    • +

  • memcached_generate_hash() function added.

    • +

  • Added tests to make sure all hash functions are stable.

    • +
+
+
+

v 0.29

+
+

released 2009-05-19

+
+
    +

  • Fixed malloc usage to calloc for spots where we need zero filled memory.

    • +

  • All code warnings now treated as errors.

    • +

  • Fixes for debian packaging.

    • +

  • Added new pooling mechanism.

    • +

  • MEMCACHED_BEHAVIOR_NO_BLOCK no longer also sets MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.

    • +

  • Updated generic rpm.

    • +
+
+
+

v 0.28

+
+

released 2009-04-15

+
+
    +

  • Fixed bug in init sructure (reapplied)

    • +

  • Fixed bug in get/set by key (nikkhils@gmail.com)

    • +
+
+
+

v 0.27

+
+

released 2009-03-30

+
+
    +

  • Added new UDP fire-forget mode.

    • +

  • Reworked performance for mget() to better make use of async protocol

    • +

  • Cleaned up execution of fetch (just one set of code now)

    • +

  • Fixed Jenkin's for big endian hosts.

    • +

  • Updates for memstat to determine network latency.

    • +

  • Updates for binary protocol.

    • +

  • Many updates to documentation.

    • +
+
+
+

v 0.26

+
+

released 2009-01-29

+
+
    +

  • Fix for decrement on hash key

    • +

  • Fixed assert that was catching bad memset() call in host_reset()

    • +

  • Fix purge issue for blocked IO which has been stacked.

    • +
+
+
+

v 0.25

+
+

released 2008-11-28

+
+
    +

  • Jenkins HASH added.

    • +

  • Update of Murmur hash code

    • +

  • Support explicit weights (Robey Pointer, Evan Weaver)

    • +

  • Bugfix for ketama continuum (Robey Pointer)

    • +

  • New behavior MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY (Robey Pointer)

    • +

  • Don't ever call stats for weighting servers, because it is unstable.

    • +
+
+
+

v 0.24

+
+

released 2008-09-16

+
+
    +

  • Cleanup compile warnings.

    • +

  • Fix issues in partitioning by keys.

    • +

  • Fixed "fail case" to make sure when calling memcached_clone() no memcached_st is over written.

    • +

  • New memcached_server_by_key() method for finding a server from a key.

    • +

  • memcached_server_free() was added for freeing server structures.

    • +
+
+
+

v 0.23

+
+

released 2008-09-07

+
+
    +

  • Added strings.h header for Solaris 9

    • +

  • Solaris 64bit fix.

    • +

  • Support for weighted Ketama from Yin Chen.

    • +

  • Fix for Chinese

    • +

  • Fix for 0 length key to trigger bad key.

    • +

  • Added behaviors MEMCACHED_BEHAVIOR_SND_TIMEOUT, MEMCACHED_BEHAVIOR_RCV_TIMEOUT

    • +

  • Support for Binary Protocol added

    • +
+
+
+

v 0.22

+
+

released 2008-07-14

+
+
    +

  • Fix where master key was no being checked for "bad key"

    • +

  • Fixed bugs in stats output (thread output was wrong)

    • +

  • Clarified MEMCACHED_BAD_KEY_PROVIDED is return for bad prefix key.

    • +

  • Found a bug in Flags return (Jacek Ostrowski)

    • +

  • Fixed issue with compiling on Visual Studio

    • +
+
+
+

v 0.21

+
+

released 2008-05-24

+
+
    +

  • Change of char * to const char * for all key based functions.

    • +

  • New MEMCACHED_CALLBACK_PREFIX_KEY added. You can now create domains for values.

    • +

  • Fixed bug introducd in last version on memcp

    • +

  • Fix for death of file io to call shutdown()

    • +
+
+
+

v 0.20

+
+

released 2008-05-05

+
+
    +

  • New consistent distribution tests.

    • +

  • Found a memory leak when a server constantly fails.

    • +

  • Fix in watchpoint macro

    • +

  • Changed default timeout to 1 second for poll timeouts

    • +

  • Wheel uses less memory/dynamic allocation for size (no longer limited to 512 hosts by default.

    • +

  • memslap memory leak fix

    • +

  • Added Ketama distribution

    • +

  • Fix assert.h compile problem on CentOS

    • +
+
+
+

v 0.19

+
+

released 2008-04-09

+
+
    +

  • Documentation fix in libmemcached.

    • +

  • Fixed bug where sort was always occuring on hosts

    • +

  • Logic fix in branch prediction (thanks Jay!)

    • +

  • Read through cached support.

    • +

  • Fixed for cas by key operation.

    • +

  • Fix for memcached_server_st list structures to have correct count.

    • +

  • Added callback MEMCACHED_CALLBACK_DELETE_TRIGGER

    • +

  • Removed function call in favor of macro (aka cut out some instructions)

    • +
+
+
+

v 0.18

+
+

released 2008-03-17

+
+
    +

  • Fix plus tests for non-zero value objects and flags.

    • +

  • MEMCACHED_HASH_MURMUR added for murmur algorithm provided.

    • +

  • MEMCACHED_BEHAVIOR_RETRY_TIMEOUT added to keep connecting from looping on timeout.

    • +

  • gcc branch prediction optimizations

    • +

  • Refactored entire tree to make include files cleaner

    • +

  • Fixed leaked socket.

    • +
+
+
+

v 0.17

+
+

released 2008-02-27

+
+
    +

  • MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT added for connect timeout in non-block mode.

    • +

  • Incompatible change in memcached_behavior_set() api. We now use a uint64_t, instead of a pointer.

    • +

  • Fix for storage of values for zero.

    • +

  • memcached_server_cursor() function added to API for cycling through servers.

    • +
+
+
+

v 0.16

+
+

released 2008-02-18

+
+
    +

  • Work on the UDP protocol

    • +

  • Added get_by_key, set_by_key tests for C++ API

    • +

  • Fix for limit_maxbytes to be 64bit in stats

    • +

  • Added Atom Smasher test (scale baby, scale!)

    • +

  • Servers are now sorted, meaning that servers are now ordered so that clients with the same lists, will have same distribution. (Idea from Ross McFarland). MEMCACHED_BEHAVIOR_SORT_HOSTS was added to enable this support.

    • +

  • Added MEMCACHED_BAD_KEY_PROVIDED error for auto, set, and get operations. MEMCACHED_BEHAVIOR_VERIFY_KEY was added to enable this feature.

    • +

  • More error messages on command line tools.

    • +

  • Fixed bugs in memcached_cas() operator.

    • +

  • Fix to loop through interfaces

    • +
+
+
+

v 0.15

+
+

released 2008-01-29

+
+
    +

  • More work on the C++ API.

    • +

  • Bug fixes around block corner cases.

    • +

  • Slight performance increase in both read() and write().

    • +
+
+
+

v 0.14

+
+

released 2008-01-22

+
+
    +

  • For for bug found by Evan Weaver where increment() was not returning propper error of value was not found.

    • +

  • Fix for bad null pointer on flag by Toru Maesaka.

    • +

  • Refactor of all IO to just pass in the active server

    • +

  • Problem configuring (PKG_CHECK_MODULES) fixed by removal of "rpath" in support/libmemcached.pc.in (Thanks to Ross McFarland).

    • +

  • Added memcached_callback_get()/set()

    • +

  • First prototype of C++ interface

    • +

  • Updated docs for uint16_t changes in previous release

    • +
+
+
+

v 0.13

+
+

released 2008-01-13

+
+
    +

  • MEMCACHED_BEHAVIOR_USER_DATA added to store user pointer.

    • +

  • Fix for failure to connect to invalidate socket.

    • +

  • Patch from Marc Rossi to add --hash option for memcp, memrm, and memcat.

    • +

  • Kevin's patch for fixing EOF issues during a read.

    • +

  • Toru Maesaka patch for stats mismatch

    • +

  • Fix for when CRC return 0

    • +

  • Fixed uint16_t issues around flags. Turns out the documentation on the protocol was wrong.

    • +

  • Lingering socket fixes for FreeBSD.

    • +

  • Patches from Kevin Dalley for FreeBSD 4.0

    • +

  • Added multi delete functions.

    • +

  • All get key returns have C style null termination

    • +

  • If memcached_server_list_append is passed NULLs instead of pointers it returns NULL.

    • +

  • Added memcached_fetch_execute() method

    • +

  • Found a bug where memcached_fetch() was not null terminating the result value.

    • +

  • memcached_behavior() now has the ability to set "buffering" so that data is not automatically flushed.

    • +

  • Behavior change, buffered commands now return MEMCACHED_BUFFERED

    • +
+
+
+

v 0.12

+
+

released 2007-12-11

+
+
    +

  • Updates for consistent hashing

    • +

  • IPV6 support

    • +

  • Static allocation for hostname (performance)

    • +

  • Fixed bug where in non-block mode all data might not have been sent on close().

    • +

  • Refactor of memcached_get() to use common code.

    • +

  • Change in value fetch, MEMCACHED_END is now returned when keys are no longer in the pipe.

    • +

  • Fixed bug where key could be out of range of characters

    • +

  • Added _by_key() methods to allow partitioning of values to particular servers.

    • +

  • MEMCACHED_DEFAILT_TIMEOUT is now set to a non -1 value.

    • +

  • Performance improvements in get operations.

    • +
+
+
+

v 0.11

+
+

released 2007-11-26

+
+
    +

  • Added option to memcache_behavior_set() so that poll() can be timed out.

    • +

  • Fixed memory leak in case of using memcached_fetch_result() where no value was returned.

    • +

  • Bug fixed in memcached_connect() which would cause servers that did not need to be enabled to be enabled (performance issue).

    • +

  • Rewrote bounds checking code for get calls.

    • +

  • "make test" now starts its own memcached servers.

    • +

  • Added Hseih hash (MEMCACHED_HASH_HSIEH), which is showing about 7% performance over standard hash.

    • +
+
+
+

v 0.10

+
+

released 2007-11-21

+
+
    +

  • Added append binary test.

    • +

  • Added MEMCACHED_BEHAVIOR_CACHE_LOOKUPS behavior so that you can save on multiple DNS lookups.

    • +

  • Added CAS support, though this is optional and must be enabled during runtime.

    • +

  • Added the utility memerror to create human readable error strings from memcached errors (aka convert ints to strings)

    • +

  • Fixed type in MEMCACHED_HOST_LOOKUP_FAILURE

    • +

  • Fixed bug where hostname might not be null terminated

    • +

  • Moved to using gethostbyname_r() on Linux to solve thread safety issue

    • +

  • Added -rpath support for pkg-config

    • +

  • Documentation fix for hash setting using memcached_behavior_set()

    • +
+
+
+

v 0.9

+
+

released 2007-11-15

+
+
    +

  • fix for when no servers are definied.

    • +

  • different buffers are now kept for different connections to speed up async efforts

    • +

  • Modified increment/decrement functions to return uint64_t values

    • +

  • Fixed bug in cases where zero length keys were provided

    • +

  • Thread cleanup issue in memslap

    • +

  • No hostname lookup on reconnect

    • +

  • Fix for flag settings (was doing hex by accident!)

    • +

  • Support for 1.2.4 server additions "prepend" and "append" added.

    • +

  • Added memcached_version()... not sure if I will make this public or not.

    • +
+
+
+

v 0.8

+
+

released 2007-11-05

+
+
    +

  • Adding support for CRC hash method

    • +

  • Adding support for UNIX sockets

    • +

  • Added additional HASHing methods of FNV1_64,FNV1A_64, FNV1_32, FNV1A_32

    • +

  • Added pkgconfig support (PKG_CHECK_MODULES)

    • +

  • Fixed conflict with defined type in MySQL

    • +

  • Added memcached_result_st structure and functions to manipulate it.

    • +
+
+
+

v 0.7

+
+

released 2007-10-30

+
+
    +

  • Poved to poll() from select()

    • +

  • Fixes in internal string class for allocation of large numbers of strings.

    • +

  • memcached_mget() function now sends keys as it parses them instead of building strings as it goes.

    • +

  • Propper flush now for making sure we get all IO sent even when in non-block mode.

    • +

  • Added --enable-debug rule for configure

    • +

  • All asserts() removed (hey this is going into production!)

    • +
+
+
+

v 0.6

+
+

released 2007-10-17

+
+
    +

  • get value returns are now null terminated (request by Cal Heldenbrand)

    • +

  • Fixed connections for more hosts then two.

    • +

  • Rewrite of the read/write IO systems to handle different sorts of host failures.

    • +

  • Added man pages for all functions and tools

    • +

  • Raised buffer size for readinng/writing to 16K

    • +

  • You can now optionally set the socket size for recv/send via memached_behavior_set/get.

    • +
+
+
+

v 0.5

+
+

released 2007-10-09

+
+
    +

  • Ruby maintainer mentioned TCP_NODELAY patch he had added. Added this to C +library as well. (Eric Hodel drbrain@segment7.net)

    • +

  • Added support script for set_benchmark

    • +

  • Updated memslap to allow testing of TCP_NODELAY

    • +

  • Updated memslap to support --flush (aka dump memcache servers before testing)

    • +

  • Fixed bug in multiple hosts not being activated

    • +

  • Added environmental variable MEMCACHED_SERVERS which can be used to set the servers list.

    • +

  • fixed memcached_stat method (and now memstat works)

    • +

  • server connect now happens on demand.

    • +

  • Help for all command line applications

    • +
+
+
+

v 0.4

+
+

released 2007-10-03

+
+
    +

  • Added buffered IO to write calls for keys

    • +

  • Added buffered IO for reads

    • +

  • memstat was broken (bad if/else on connect)

    • +

  • New non-blocking IO (not default yet). Mucho faster

    • +

  • Refactor of test system.

    • +

  • memslap crash solved

    • +
+
+
+

v 0.3

+
+

released 2007-10-01

+
+
    +

  • Jeff Fisher guppy@techmonkeys.org provided a spec file

    • +

  • Added "make rpm" around dist file

    • +

  • Added support for Solaris

    • +

  • Added support for DTrace

    • +

  • Fixed read to be recv and write to be send

    • +

  • Bug fix where memstat would core if no server was found

    • +

  • Added memslap tool (load generator)

    • +

  • Numerous bug fixes in library

    • +

  • Added calls to library for creating host lists (see text cases to understand how to use this).

    • +
+
+
+

v 0.2

+
+

released 2007-09-27

+
+
    +

  • First public version

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ChangeLog-0.md b/ChangeLog-0.md deleted file mode 100644 index 6fca9bb24..000000000 --- a/ChangeLog-0.md +++ /dev/null @@ -1,514 +0,0 @@ -# ChangeLog v0.x - -## v 0.53 -> released 2011-09-27 - -* Fix for FreeBSD/OpenBSD and -lm -* Added memcached_exist() -* Fix for memory when using config test. -* CLI gained --quiet - -## v 0.52 -> released 2011-09-12 - -* Build fixes for Ubuntu/Suse. -* Fixes for OSX Lion. -* Bug fix for looping back through dns lookups under certain failures. -* Fixes related to dead server failures. - -## v 0.51 -> released 2011-07-21 - -* memcached_callback_set() now takes its data argument as const -* Update to tests. -* Fix in parser for port number. - -## v 0.50 -> released 2011-06-20 - -* Updates to C++ interface -* Custom free allocators need to now check for value before calling free. -* memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster). -* Fix for stats structure. -* Updates to documentation. -* memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster). - -## v 0.49 -> released 2011-04-14 - -* Fix calls to auto methods so that if value is not passed in nothing bad happens. -* New parser calls for generating memcached_st objects. -* New error system. -* New flow control for messages means faster get/set calls. -* Added new documentation system. -* A behavior change has been now made that if you specify a weight for any server, we enable the weight flag and do weight balancing. -* Added MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS to simplify the setting of AUTO REJECT for servers. - -## v 0.48 -> released 2011-03-16 - -* Fix memory leak in server parse. -* Move test framework out to be its own library (easier to work with Gearman). - - -## v 0.47 -> released 2011-02-24 - -* Additional fixes for OpenBSD. -* Bug fix 677609, 456080. -* SIGPIPE fix for Linux send(). -* memcapable can now test ascii or binary based on flags. -* Additional build fixes for SASL. - - -## v 0.46 -> released 2011-02-14 - -* Fixes a number of corner case bugs. -* Fixes related to OpenBSD. -* Better testing for protocol version. -* Removes special case infinite wait on blocking setup. - -## v 0.45 -> released 2011-02-09 - -* Add support for systemtap - -## v 0.44 -> released 2010-09-23 - -* Windows bug fixes. -* Hudson port support in test harness. -* Improved portability of test hanrness. -* SASL fixes. - -## v 0.43 -> released 2010-07-28 - -* Added --args to memstat so that a greater range of values can be returned. -* Prelimanary support for Windows. -* memcached_stat_execute() merged. - -## v 0.42 -> released 2010-07-06 - -* Mistake in libtool caused issue with library version - -## v 0.41 -> released 2010-06-30 - -* Added --file for memcat. -* Added limemcached_ping() to libmemcached_util -* Bugfix for some cases where connect would have issues with timeout. -* Wrong value for errno given as error on an IO failure inside of poll. -* Bug fix for issue where multiple interfaces with bad DNS were not being caught. - -## v 0.40 -> released 2010-04-23 - -* Placed retry logic in for busted resolvers -* Add an ignore for SIGPIPE to solve OSX issues. -* A couple of fixed for memcached_light server. -* Updated to debug mode to track io_wait - -## v 0.39 -> released 2010-04-06 - -* Add support for prefix keys to binary protocol. -* Remove the undocumented call memcached_server_remove(). -* The undocumented call memcached_server_by_key() now returns const. -* memcached_server_error_reset() has been deprecated. -* memcached_server_list() has been deprecated. Use memcached_server_cursor() to walk the servers found in a memcached_st() structure. -* memcached_verbosity() can now be run concurrently with other operations. -* SASL support. -* Fixes memory leak found in EJECT HOSTS. - -## v 0.38 -> released 2010-02-10 - -* C++ interface for libhashkit. -* Modified memcached_set_memory_allocators() so that it requires a context pointer. -* memcached_clone() now runs 5 times faster. -* Functions used for callbacks are now given const memcached_st. -* Added MEMCACHED_BEHAVIOR_CORK. -* memslap now creates a configuration file at ~/.memslap.cnf -* memcached_purge() now calls any callbacks registered during get execution. -* Many fixes to memslap. -* Updates for memcapable. -* Compile fixes for OpenBSD. -* Fix for possible recursive decent on IO failure. - -## v 0.37 -> released 2010-01-12 - -* Fixed build for libhashkit. -* Fixed install path regression. -* Modified RPM to strict check install. -* Added documentation for memcached_server_cursor(); -* Added memcached_servers_reset(). -* Modified memcached_st to remove dead cursor_server member. - -## v 0.36 -> released 2010-01-07 - -* Merged in new memslap utility. -* All of constants.h has been updated to match style (all old identifiers continue to work). -* Added first pass for libhashkit. -* Updated test Framework/extended tests. -* Random read support during replication added. -* Modified use_sort so that the option can be applied to any distribution type. -* We removed the MEMCACHED_BEHAVIOR_KETAMA_COMPAT_MODE added in 0.35. Instead use memcached_behavior_set_distribution(). - -## v 0.35 -> released 2009-11-09 - -* Added support for by_key operations for inc/dec methods. -* Added mget test to memslap. -* Support for compatible ketama for SpyMemcached -* Update C++ interface. -* Fix for memcp - -## v 0.34 -> released 2009-10-13 - -* Added support for setting behavior flags on a connection pool. -* Don't increment server_failure_counter on normal disconnects. -* Added prototype for a callback based protocol parser (server side) with examples so that you could let your own application speak the memcached protocol -* Updated memcapable to test ASCII protocol. -* Changed behavior so that server can be removed at first sign of failure. -* Added memcached_server_get_last_disconnect() call - -## v 0.33 -> released 2009-09-23 - -* Added memcapable to test servers for binary compatibility. -* Updated C++ interface. Added basic support for C++ exceptions. Added multiple constructors the memcached client object. The C++ interface now takes parameters which are C++ types (such as std::string). -* Several bug fixes for binary protocol support. -* Fixed crashing issue with dumping from memcachd server (server internals were changed without documenting change). - -## v 0.32 -> released 2009-09-15 - -* Change of behavior where linger is only modified for no-block and then it is set to zero. -* Added Twitter's memcached_server_error() functions. -* Fix for OSX compiles in development builds. -* Updated C++ interface. -* Updated memcached_mget and memcached_mget_by_key to take a size_t as a parameter instead of an unsigned int for number_of_keys. - -## v 0.31 -> released 2009-07-10 - -* Added support or HA via replication. -* malloc() removed for server key usage. -* Update build system. -* Added support for memcached_set_memory_allocators(). -* Fixed bug in configure.ac for have_htoll. - -## v 0.30 -> released 2009-06-01 - -* Added memcachd_dump command (and framework for memdump tool). -* Realigned all structures to remove padding (and line up important bits for 64bit caches. -* Remove some of sprintf() in storage calls(). -* Removed printf() in stat call for unknown stat member. -* memcached_generate_hash() function added. -* Added tests to make sure all hash functions are stable. - -## v 0.29 -> released 2009-05-19 - -* Fixed malloc usage to calloc for spots where we need zero filled memory. -* All code warnings now treated as errors. -* Fixes for debian packaging. -* Added new pooling mechanism. -* MEMCACHED_BEHAVIOR_NO_BLOCK no longer also sets MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. -* Updated generic rpm. - -## v 0.28 -> released 2009-04-15 - -* Fixed bug in init sructure (reapplied) -* Fixed bug in get/set by key (nikkhils@gmail.com) - -## v 0.27 -> released 2009-03-30 - -* Added new UDP fire-forget mode. -* Reworked performance for mget() to better make use of async protocol -* Cleaned up execution of fetch (just one set of code now) -* Fixed Jenkin's for big endian hosts. -* Updates for memstat to determine network latency. -* Updates for binary protocol. -* Many updates to documentation. - -## v 0.26 -> released 2009-01-29 - -* Fix for decrement on hash key -* Fixed assert that was catching bad memset() call in host_reset() -* Fix purge issue for blocked IO which has been stacked. - -## v 0.25 -> released 2008-11-28 - -* Jenkins HASH added. -* Update of Murmur hash code -* Support explicit weights (Robey Pointer, Evan Weaver) -* Bugfix for ketama continuum (Robey Pointer) -* New behavior MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY (Robey Pointer) -* Don't ever call stats for weighting servers, because it is unstable. - -## v 0.24 -> released 2008-09-16 - -* Cleanup compile warnings. -* Fix issues in partitioning by keys. -* Fixed "fail case" to make sure when calling memcached_clone() no memcached_st is over written. -* New memcached_server_by_key() method for finding a server from a key. -* memcached_server_free() was added for freeing server structures. - - -## v 0.23 -> released 2008-09-07 - -* Added strings.h header for Solaris 9 -* Solaris 64bit fix. -* Support for weighted Ketama from Yin Chen. -* Fix for Chinese -* Fix for 0 length key to trigger bad key. -* Added behaviors MEMCACHED_BEHAVIOR_SND_TIMEOUT, MEMCACHED_BEHAVIOR_RCV_TIMEOUT -* Support for Binary Protocol added - -## v 0.22 -> released 2008-07-14 - -* Fix where master key was no being checked for "bad key" -* Fixed bugs in stats output (thread output was wrong) -* Clarified MEMCACHED_BAD_KEY_PROVIDED is return for bad prefix key. -* Found a bug in Flags return (Jacek Ostrowski) -* Fixed issue with compiling on Visual Studio - -## v 0.21 -> released 2008-05-24 - -* Change of char * to const char * for all key based functions. -* New MEMCACHED_CALLBACK_PREFIX_KEY added. You can now create domains for values. -* Fixed bug introducd in last version on memcp -* Fix for death of file io to call shutdown() - -## v 0.20 -> released 2008-05-05 - -* New consistent distribution tests. -* Found a memory leak when a server constantly fails. -* Fix in watchpoint macro -* Changed default timeout to 1 second for poll timeouts -* Wheel uses less memory/dynamic allocation for size (no longer limited to 512 hosts by default. -* memslap memory leak fix -* Added Ketama distribution -* Fix assert.h compile problem on CentOS - -## v 0.19 -> released 2008-04-09 - -* Documentation fix in libmemcached. -* Fixed bug where sort was always occuring on hosts -* Logic fix in branch prediction (thanks Jay!) -* Read through cached support. -* Fixed for cas by key operation. -* Fix for memcached_server_st list structures to have correct count. -* Added callback MEMCACHED_CALLBACK_DELETE_TRIGGER -* Removed function call in favor of macro (aka cut out some instructions) - - -## v 0.18 -> released 2008-03-17 - -* Fix plus tests for non-zero value objects and flags. -* MEMCACHED_HASH_MURMUR added for murmur algorithm provided. -* MEMCACHED_BEHAVIOR_RETRY_TIMEOUT added to keep connecting from looping on timeout. -* gcc branch prediction optimizations -* Refactored entire tree to make include files cleaner -* Fixed leaked socket. - -## v 0.17 -> released 2008-02-27 - -* MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT added for connect timeout in non-block mode. -* Incompatible change in memcached_behavior_set() api. We now use a uint64_t, instead of a pointer. -* Fix for storage of values for zero. -* memcached_server_cursor() function added to API for cycling through servers. - -## v 0.16 -> released 2008-02-18 - -* Work on the UDP protocol -* Added get_by_key, set_by_key tests for C++ API -* Fix for limit_maxbytes to be 64bit in stats -* Added Atom Smasher test (scale baby, scale!) -* Servers are now sorted, meaning that servers are now ordered so that clients with the same lists, will have same distribution. (Idea from Ross McFarland). MEMCACHED_BEHAVIOR_SORT_HOSTS was added to enable this support. -* Added MEMCACHED_BAD_KEY_PROVIDED error for auto, set, and get operations. MEMCACHED_BEHAVIOR_VERIFY_KEY was added to enable this feature. -* More error messages on command line tools. -* Fixed bugs in memcached_cas() operator. -* Fix to loop through interfaces - -## v 0.15 -> released 2008-01-29 - -* More work on the C++ API. -* Bug fixes around block corner cases. -* Slight performance increase in both read() and write(). - -## v 0.14 -> released 2008-01-22 - -* For for bug found by Evan Weaver where increment() was not returning propper error of value was not found. -* Fix for bad null pointer on flag by Toru Maesaka. -* Refactor of all IO to just pass in the active server -* Problem configuring (PKG_CHECK_MODULES) fixed by removal of "rpath" in support/libmemcached.pc.in (Thanks to Ross McFarland). -* Added memcached_callback_get()/set() -* First prototype of C++ interface -* Updated docs for uint16_t changes in previous release - -## v 0.13 -> released 2008-01-13 - -* MEMCACHED_BEHAVIOR_USER_DATA added to store user pointer. -* Fix for failure to connect to invalidate socket. -* Patch from Marc Rossi to add --hash option for memcp, memrm, and memcat. -* Kevin's patch for fixing EOF issues during a read. -* Toru Maesaka patch for stats mismatch -* Fix for when CRC return 0 -* Fixed uint16_t issues around flags. Turns out the documentation on the protocol was wrong. -* Lingering socket fixes for FreeBSD. -* Patches from Kevin Dalley for FreeBSD 4.0 -* Added multi delete functions. -* All get key returns have C style null termination -* If memcached_server_list_append is passed NULLs instead of pointers it returns NULL. -* Added memcached_fetch_execute() method -* Found a bug where memcached_fetch() was not null terminating the result value. -* memcached_behavior() now has the ability to set "buffering" so that data is not automatically flushed. -* Behavior change, buffered commands now return MEMCACHED_BUFFERED - -## v 0.12 -> released 2007-12-11 - -* Updates for consistent hashing -* IPV6 support -* Static allocation for hostname (performance) -* Fixed bug where in non-block mode all data might not have been sent on close(). -* Refactor of memcached_get() to use common code. -* Change in value fetch, MEMCACHED_END is now returned when keys are no longer in the pipe. -* Fixed bug where key could be out of range of characters -* Added _by_key() methods to allow partitioning of values to particular servers. -* MEMCACHED_DEFAILT_TIMEOUT is now set to a non -1 value. -* Performance improvements in get operations. - -## v 0.11 -> released 2007-11-26 - -* Added option to memcache_behavior_set() so that poll() can be timed out. -* Fixed memory leak in case of using memcached_fetch_result() where no value was returned. -* Bug fixed in memcached_connect() which would cause servers that did not need to be enabled to be enabled (performance issue). -* Rewrote bounds checking code for get calls. -* "make test" now starts its own memcached servers. -* Added Hseih hash (MEMCACHED_HASH_HSIEH), which is showing about 7% performance over standard hash. - -## v 0.10 -> released 2007-11-21 - -* Added append binary test. -* Added MEMCACHED_BEHAVIOR_CACHE_LOOKUPS behavior so that you can save on multiple DNS lookups. -* Added CAS support, though this is optional and must be enabled during runtime. -* Added the utility memerror to create human readable error strings from memcached errors (aka convert ints to strings) -* Fixed type in MEMCACHED_HOST_LOOKUP_FAILURE -* Fixed bug where hostname might not be null terminated -* Moved to using gethostbyname_r() on Linux to solve thread safety issue -* Added -rpath support for pkg-config -* Documentation fix for hash setting using memcached_behavior_set() - -## v 0.9 -> released 2007-11-15 - -* fix for when no servers are definied. -* different buffers are now kept for different connections to speed up async efforts -* Modified increment/decrement functions to return uint64_t values -* Fixed bug in cases where zero length keys were provided -* Thread cleanup issue in memslap -* No hostname lookup on reconnect -* Fix for flag settings (was doing hex by accident!) -* Support for 1.2.4 server additions "prepend" and "append" added. -* Added memcached_version()... not sure if I will make this public or not. - -## v 0.8 -> released 2007-11-05 - -* Adding support for CRC hash method -* Adding support for UNIX sockets -* Added additional HASHing methods of FNV1_64,FNV1A_64, FNV1_32, FNV1A_32 -* Added pkgconfig support (PKG_CHECK_MODULES) -* Fixed conflict with defined type in MySQL -* Added memcached_result_st structure and functions to manipulate it. - -## v 0.7 -> released 2007-10-30 - -* Poved to poll() from select() -* Fixes in internal string class for allocation of large numbers of strings. -* memcached_mget() function now sends keys as it parses them instead of building strings as it goes. -* Propper flush now for making sure we get all IO sent even when in non-block mode. -* Added --enable-debug rule for configure -* All asserts() removed (hey this is going into production!) - - -## v 0.6 -> released 2007-10-17 - -* get value returns are now null terminated (request by Cal Heldenbrand) -* Fixed connections for more hosts then two. -* Rewrite of the read/write IO systems to handle different sorts of host failures. -* Added man pages for all functions and tools -* Raised buffer size for readinng/writing to 16K -* You can now optionally set the socket size for recv/send via memached_behavior_set/get. - -## v 0.5 -> released 2007-10-09 - -* Ruby maintainer mentioned TCP_NODELAY patch he had added. Added this to C - library as well. (Eric Hodel drbrain@segment7.net) -* Added support script for set_benchmark -* Updated memslap to allow testing of TCP_NODELAY -* Updated memslap to support --flush (aka dump memcache servers before testing) -* Fixed bug in multiple hosts not being activated -* Added environmental variable MEMCACHED_SERVERS which can be used to set the servers list. -* fixed memcached_stat method (and now memstat works) -* server connect now happens on demand. -* Help for all command line applications - -## v 0.4 -> released 2007-10-03 - -* Added buffered IO to write calls for keys -* Added buffered IO for reads -* memstat was broken (bad if/else on connect) -* New non-blocking IO (not default yet). Mucho faster -* Refactor of test system. -* memslap crash solved - -## v 0.3 -> released 2007-10-01 - -* Jeff Fisher provided a spec file -* Added "make rpm" around dist file -* Added support for Solaris -* Added support for DTrace -* Fixed read to be recv and write to be send -* Bug fix where memstat would core if no server was found -* Added memslap tool (load generator) -* Numerous bug fixes in library -* Added calls to library for creating host lists (see text cases to understand how to use this). - -## v 0.2 -> released 2007-09-27 - -* First public version diff --git a/ChangeLog-1.0.html b/ChangeLog-1.0.html new file mode 100644 index 000000000..8dae85ee2 --- /dev/null +++ b/ChangeLog-1.0.html @@ -0,0 +1,333 @@ + + + + + + + ChangeLog v1.0 — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

ChangeLog v1.0

+
+

v 1.0.18

+
+

released 2014-02-09

+
+
    +

  • MEMCACHED_BEHAVIOR_RETRY_TIMEOUT can now be set to zero.

    • +

  • Numerous bug fixes.

    • +
+
+
+

v 1.0.17

+
+

released 2013-04-03

+
+
    +

  • Remove c++ namespace that was being exposed (the API should be plug compatible)..

    • +

  • Fix cases where --servers wasn't behaving the same in all clients.

    • +
+
+
+

v 1.0.16

+
+

released 2013-02-01

+
+
    +

  • Added support to do two part shutdown of socket.

    • +

  • Fixes for Fedora 18.

    • +

  • Fix for binary memcached_touch()

    • +
+
+
+

v 1.0.15

+
+

released 2012-12-17

+
+
    +

  • Added support for Murmur3 (HASHKIT_HASH_MURMUR3)

    • +

  • Portability fixes.

    • +
+
+
+

v 1.0.14

+
+

released 2012-11-14

+
+
    +

  • CLIENT_ERROR fixed to not be treated as a fatal error.

    • +

  • Compiler fixes for older Ubuntu releases.

    • +
+
+
+

v 1.0.13

+
+

released 2012-10-19

+
+
    +

  • Fix bug that caused version string to not be exported correctly.

    • +
+
+
+

v 1.0.12

+
+

released 2012-10-09

+
+
    +

  • Added memcached_result_take_value().

    • +

  • Added ax_libmemcached.m4

    • +
+
+
+

v 1.0.11

+
+

released 2012-09-17

+
+
    +

  • Removed custom version of memcached.

    • +

  • Updated hardening rules.

    • +

  • Fixed a case where the return error from a socket connection differred from that of a TCP/IP socket.

    • +
+
+
+

v 1.0.10

+
+

released 2012-07-30

+
+
    +

  • --disable-assert has been removed from configure, and --enable-assert has been added in its place.

    • +

  • Compiling fixes for Clang on OSX Mountain Lion.

    • +
+
+
+

v 1.0.9

+
+

released 2012-07-05

+
+
    +

  • Faster close on socket.

    • +

  • Instance allocation is now seperated from server interface. +This should allow for a better preservation of ABI compliance from now on.

    • +

  • Fix close on exec bug.

    • +

  • Numerous other bug fixes.

    • +
+
+
+

v 1.0.8

+
+

released 2012-05-22

+
+
    +

  • Added support for setting options via ENV variable LIBMEMCACHED

    • +

  • Fix corner case on last used result.

    • +
+
+
+

v 1.0.7

+
+

released 2012-04-28

+
+
    +

  • Add API call for exist calls.

    • +

  • Update all license files to be BSD.

    • +
+
+
+

v 1.0.6

+
+

released 2012-04-08

+
+
    +

  • Fixes for gcc 4.7, lp:961812

    • +

  • Fix for restart issue that happens under testing.

    • +

  • Fix for lp:962815.

    • +

  • Support for transparent AES encryption.

    • +
+
+
+

v 1.0.5

+
+

released 2012-03-14

+
+
    +

  • Fixes for OSX.

    • +

  • Version is now parsed directly in the parser, which makes buffered operations now work with it..

    • +

  • memstat has been extended so that it can be used to find the version of the server.

    • +

  • Update documentation.

    • +

  • Fixes for compile issues on Debian and Ubuntu

    • +
+
+
+

v 1.0.4

+
+

released 2012-01-27

+
+
    +

  • Fix for memcached_dump().

    • +

  • Additional testing for memcached_stat_execute().

    • +
+
+
+

v 1.0.3

+
+

released 2012-01-09

+
+
    +

  • Increased size of sort buffer used during Ketama.

    • +

  • Added support for new behavior to handle dead servers.

    • +

  • Overall haul of UDP IO.

    • +

  • Fixed C compile issue with memcached_exist()

    • +

  • Numerous bug fixes.

    • +

  • Clang support for OSX.

    • +

  • All commands now using vector send support.

    • +
+
+
+

v 1.0.2

+
+

released 2011-10-24

+
+
    +

  • Dropped libmemcached/memcached_util.h (undocumented header file)

    • +

  • Added memcached_touch() and memcached_touch_by_key()

    • +

  • UDP support restructured to toggle on a complete memcached_st structure.

    • +
+
+

See ChangeLog-0 for changes prior v1.0.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ChangeLog-1.0.md b/ChangeLog-1.0.md deleted file mode 100644 index 08445dfbc..000000000 --- a/ChangeLog-1.0.md +++ /dev/null @@ -1,122 +0,0 @@ -# ChangeLog v1.0 - -## v 1.0.18 -> released 2014-02-09 - -* MEMCACHED_BEHAVIOR_RETRY_TIMEOUT can now be set to zero. -* Numerous bug fixes. - -## v 1.0.17 -> released 2013-04-03 - -* Remove c++ namespace that was being exposed (the API should be plug compatible).. -* Fix cases where --servers wasn't behaving the same in all clients. - -## v 1.0.16 -> released 2013-02-01 - -* Added support to do two part shutdown of socket. -* Fixes for Fedora 18. -* Fix for binary memcached_touch() - -## v 1.0.15 -> released 2012-12-17 - -* Added support for Murmur3 (HASHKIT_HASH_MURMUR3) -* Portability fixes. - -## v 1.0.14 -> released 2012-11-14 - -* CLIENT_ERROR fixed to not be treated as a fatal error. -* Compiler fixes for older Ubuntu releases. - -## v 1.0.13 -> released 2012-10-19 - -* Fix bug that caused version string to not be exported correctly. - -## v 1.0.12 -> released 2012-10-09 - -* Added memcached_result_take_value(). -* Added ax_libmemcached.m4 - -## v 1.0.11 -> released 2012-09-17 - -* Removed custom version of memcached. -* Updated hardening rules. -* Fixed a case where the return error from a socket connection differred from that of a TCP/IP socket. - -## v 1.0.10 -> released 2012-07-30 - -* --disable-assert has been removed from configure, and --enable-assert has been added in its place. -* Compiling fixes for Clang on OSX Mountain Lion. - -## v 1.0.9 -> released 2012-07-05 - -* Faster close on socket. -* Instance allocation is now seperated from server interface. - This should allow for a better preservation of ABI compliance from now on. -* Fix close on exec bug. -* Numerous other bug fixes. - -## v 1.0.8 -> released 2012-05-22 - -* Added support for setting options via ENV variable LIBMEMCACHED -* Fix corner case on last used result. - -## v 1.0.7 -> released 2012-04-28 - -* Add API call for exist calls. -* Update all license files to be BSD. - -## v 1.0.6 -> released 2012-04-08 - -* Fixes for gcc 4.7, lp:961812 -* Fix for restart issue that happens under testing. -* Fix for lp:962815. -* Support for transparent AES encryption. - -## v 1.0.5 -> released 2012-03-14 - -* Fixes for OSX. -* Version is now parsed directly in the parser, which makes buffered operations now work with it.. -* memstat has been extended so that it can be used to find the version of the server. -* Update documentation. -* Fixes for compile issues on Debian and Ubuntu - -## v 1.0.4 -> released 2012-01-27 - -* Fix for memcached_dump(). -* Additional testing for memcached_stat_execute(). - -## v 1.0.3 -> released 2012-01-09 - -* Increased size of sort buffer used during Ketama. -* Added support for new behavior to handle dead servers. -* Overall haul of UDP IO. -* Fixed C compile issue with memcached_exist() -* Numerous bug fixes. -* Clang support for OSX. -* All commands now using vector send support. - -## v 1.0.2 -> released 2011-10-24 - -* Dropped libmemcached/memcached_util.h (undocumented header file) -* Added memcached_touch() and memcached_touch_by_key() -* UDP support restructured to toggle on a complete memcached_st structure. - ---- - -See [ChangeLog-0](./ChangeLog-0.md) for changes prior v1.0. diff --git a/ChangeLog-1.1.html b/ChangeLog-1.1.html new file mode 100644 index 000000000..7165f6b57 --- /dev/null +++ b/ChangeLog-1.1.html @@ -0,0 +1,374 @@ + + + + + + + ChangeLog v1.1 — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

ChangeLog v1.1

+
+

v 1.1.4

+
+

released 2023-03-06

+
+ +
+
+

v 1.1.3

+
+

released 2022-11-09

+
+ +
+
+

v 1.1.2

+
+

released 2022-08-10

+
+
    +

  • Fix handling of negative expiration values, which are somehow allowed by legacy.
     +See also gh #125, +and gh #76.

    • +

  • Fix gh #122: +If libcrypto implementation of AES is used, do not compile internal.

    • +

  • Fix missing include of in tests.

    • +

  • Fix warnings with non-SASL builds.

    • +

  • Fix pthread.h detection.

    • +
+
+
+

v 1.1.1

+
+

released 2021-09-16

+
+
    +

  • Fix gh #67: +GET returns NOTFOUND on TIMEOUT.

    • +

  • Fix gh #113: +Build failure with Catch2 < 2.13.5.

    • +

  • Add gh #114: +Add possibility to use libcrypto for encryption.

    • +

  • Add gh #115: +Add LIBMEMCACHED_AWESOME CPP define.

    • +

  • Add test for gh #75: +memcached_clone of SASL connection closes random file descriptor.

    • +

  • Fix gh #116: +Add libmemcachedpotocol-0-0/configure.h guarding ssize_t typedef.

    • +

  • Fix gh #120: +libmemcached.pc is missing a Requires entry for libsasl2.

    • +
+
+
+

v 1.1.0

+
+

released 2021-06-23

+
+

Changes from beta3:

+
    +

  • Add ASCII multi get support to bin/memslap.

    • +
+

See logs from beta3, beta2, and beta1 for +the full list of changes since the last 1.0 release.

+
+
+

v 1.1.0-beta3

+
+

released 2021-04-15

+
+

Changes from beta2:

+
    +

  • Fix gh #108: +macOS Big Sur: dtrace does not understand -G switch.

    • +

  • Add support for IPv6 bracketed syntax in memcached_servers_parse.

    • +

  • Make memcat's --file option's argument optional defaulting to <key>.

    • +

  • Fix libmemcachedprotocol's binary STAT and VERSION handlers.

    • +

  • Fix gh #105: +EINTR handled too defensively when polling.

    • +
+
+
+

v 1.1.0-beta2

+
+

released 2020-12-28

+
+

Changes from beta1:

+
    +

  • Fix gh #103: +Build failure on 32-bit.

    • +

  • Fix gh #102: +Doc build with old sphinx.

    • +

  • Fix gh #100: +Revert symbolic rename of public header include directories.

    • +

  • Fix gh #98: +Library SONAMEs and NAME_LINKs differ from 1.0.18.

    • +

  • Fix gh #97: +Location of cmake files installation directory.

    • +

  • Fix gh #96: +LIBXXX_VERSION_HEX constants format.

    • +
+
+
+

v 1.1.0-beta1

+
+

released 2020-12-21

+
+

NOTE:
 +This is a bug fix release, not a feature release. The minor version number +was incremented due to the following changes:

+
    +

  • Ported build system to CMake.

    • +

  • Ported test suite to Catch2.

    • +

  • Build requires C++11 compiler support.

    • +

  • Tests require C++17 compiler support.

    • +

  • Moved to the Semantic Versioning Specification: https://semver.org

    • +

  • Moved the project from launchpad to github:

    + +
    • +

  • Fix build failure due to comparison of incompatible types in bin/memflush and bin/memstat.

    • +

  • Fix wrong type of memcached_instance_st::server_timeout_counter_query_id from uint32_t to uint64_t.

    • +

  • Fix memcached_dump(): +returned MEMCACHED_CLIENT_ERROR on request to dump illegal slab id.

    • +

  • Fix bin/memcapable: +failed with "No hostname was provided" when providing a hostname.

    • +

  • Fix hashkit/murmur and hashkit/murur3: +undefined behavior on platforms requiring aligned access.

    • +

  • Fix Memcache::set(): +possible subscription of empty vector.

    • +

  • Fix libmemcached_util_version_check().

    • +

  • Fix ketama/consistent hashing: +crash on reallocation of continuum.

    • +

  • Fix gh #90: +Build fails on Darwin.

    • +

  • Fix gh #83: +memcp waits forever if file no found.

    • +

  • Fix gh #80: +memparse docs.

    • +

  • Fix gh #72 +and gh #47: +memcached_return_t docs.

    • +

  • Fix gh #62: +uint32_t overflow cause busy loop.

    • +

  • Removed restriction of UDP+IPv6.

    • +

  • Fix SERVER_ERROR_MEMORY_ALLOCATION_FAILURE: +recognize more strings returned by the server.

    • +

  • Fix gh #13: +reset continuum counter after freeing them.

    • +

  • Fix gh #14 +and gh #17: +SASL: AUTH_CONTINUE was considered a failure and caused IO reset.

    • +

  • Fix gh #25: +hashkit/murmur3 unavailable.

    • +

  • Fix missing handling of EAGAIN for non-blocking unix domain socket.

    • +

  • Fix gh #35: +handling of BEHAVIOR_REMOVE_FAILED_SERVERS.

    • +

  • Fix gh #41: +ensure stable sort on continuum host key collision.

    • +

  • Fix gh #42: +MEMCACHED_MAX_BUFFER docs.

    • +

  • Fix gh #43: +libmemcached_configuration docs.

    • +

  • Fix gh #46: +clarification on millisecond timeout docs.

    • +

  • Fix gh #50: +memcached_fetch_result() can return previously returned data.

    • +

  • Fix gh #53: +stack overflow in memcached_fetch_result().

    • +

  • Fix gh #57: +include <inttypes.h> vs

    • +

  • Fix gh #58: +more specific error messages when connect() fails.

    • +

  • Fix gh #59: +bin/memcat: typo in "No servers provied".

    • +

  • Fix gh #77: +undeclared UINT64_C in ketama.cc.

    • +

  • Fix gh #12: +never reconnects after connection reset (binary protocol).

    • +

  • Fix gh #49: +assertion memcached_failed(rc) failed in memcached_send_ascii().

    • +

  • Fix gh #67: +get returns NOTFOUND on timeout.

    • +

  • Fix gh #76: +memcached_touch() crashes when expiration=-1 (ASCII only).

    • +

  • Fix gh #23: +build fails with bison 2.3.

    • +

  • Fix memaslap: build fails with newer compiler versions.

    • +

  • Fix usage of strerror_r() implementations returning pointer to char.

    • +

  • Fix pipelining commands with memcached >= 1.6.

    • +

  • Fix memcached_stat_get_value(): buffer overflow.

    • +

  • Fix memcached_stat(): undefined behavior due to unintialized memcached_return_t.

    • +

  • Fix SASL tests: requires SASL_PWDB_CONF.

    • +

  • Fix bin/memaslap to idnentify itself as memaslap instead of memslap.

    • +

  • Fix bin/memcapable to work with memcached >= 1.6.

    • +

  • Fix murmur and murmur3 hashes on big endian platforms.

    • +

  • Fix gh #82, +gh #64 and +gh #21: +clarify documentation on replication.

    • +

  • Fix gh #95: +MEMCACHED_CALLBACK_GET_FAILURE and MEMCACHED_BEHAVIOR_BUFFER_REQUESTS

    • +

  • Fix bin/memcat to output flags if requested with --flag.

    • +

  • Fix gh #68: +Windows support.

    • +
+
+

See ChangeLog-1.0 for changes prior v1.1.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ChangeLog-1.1.md b/ChangeLog-1.1.md deleted file mode 100644 index 12058b872..000000000 --- a/ChangeLog-1.1.md +++ /dev/null @@ -1,217 +0,0 @@ -# ChangeLog v1.1 - -## v 1.1.4 - -> released 2023-03-06 - -* Fix [gh #107](https://github.com/awesomized/libmemcached/issues/107): - macOS: deprecated sasl API (improve detection of `libsasl2`). -* Fix [gh #131](https://github.com/awesomized/libmemcached/issues/131): - Consider renaming tools (add `CLIENT_PREFIX` build option; default: `mem`) -* Fix [gh #132](https://github.com/awesomized/libmemcached/issues/132): - Add build of static library (add `BUILD_SHARED_LIBS` build option; default: `ON`). -* Fix [gh #134](https://github.com/awesomized/libmemcached/issues/134): - Update client option documentation. -* Fix [gh #136](https://github.com/awesomized/libmemcached/issues/136): - `libmemcachedutil` is underlinked (link against libmemcached). -* Fix [gh php-memcached#531](https://github.com/php-memcached-dev/php-memcached/issues/531): - `get` returns random values when lower than default `OPT_POLL_TIMEOUT` is set. - **NOTE:** This is a security related fix; more information can be found at: - https://github.com/awesomized/libmemcached/security/advisories/GHSA-wwmh-39wj-fx59 - -## v 1.1.3 - -> released 2022-11-09 - -* Fix [gh #130](https://github.com/awesomized/libmemcached/issues/130) - with [gh #124](https://github.com/awesomized/libmemcached/issues/124): - Server response count can underflow. - -## v 1.1.2 - -> released 2022-08-10 - -* Fix handling of negative expiration values, which are somehow allowed by legacy. - See also [gh #125](https://github.com/awesomized/libmemcached/issues/125), - and [gh #76](https://github.com/awesomized/libmemcached/issues/76). -* Fix [gh #122](https://github.com/awesomized/libmemcached/issues/122): - If libcrypto implementation of AES is used, do not compile internal. -* Fix missing include of in tests. -* Fix warnings with non-SASL builds. -* Fix pthread.h detection. - -## v 1.1.1 - -> released 2021-09-16 - -* Fix [gh #67](https://github.com/awesomized/libmemcached/issues/67): - GET returns `NOTFOUND` on `TIMEOUT`. -* Fix [gh #113](https://github.com/awesomized/libmemcached/issues/105): - Build failure with Catch2 < 2.13.5. -* Add [gh #114](https://github.com/awesomized/libmemcached/pull/114): - Add possibility to use libcrypto for encryption. -* Add [gh #115](https://github.com/awesomized/libmemcached/pull/115): - Add `LIBMEMCACHED_AWESOME` CPP define. -* Add test for [gh #75](https://github.com/awesomized/libmemcached/issues/75): - memcached_clone of SASL connection closes random file descriptor. -* Fix [gh #116](https://github.com/awesomized/libmemcached/issues/116): - Add libmemcachedpotocol-0-0/configure.h guarding `ssize_t` typedef. -* Fix [gh #120](https://github.com/awesomized/libmemcached/issues/120): - libmemcached.pc is missing a `Requires` entry for libsasl2. - -## v 1.1.0 - -> released 2021-06-23 - -**Changes from beta3:** - -* Add ASCII multi get support to bin/memslap. - -See logs from `beta3`, `beta2`, and `beta1` for -the full list of changes since the last 1.0 release. - -## v 1.1.0-beta3 - -> released 2021-04-15 - -**Changes from beta2:** - -* Fix [gh #108](https://github.com/awesomized/libmemcached/issues/105): - macOS Big Sur: dtrace does not understand -G switch. -* Add support for IPv6 bracketed syntax in `memcached_servers_parse`. -* Make `memcat`'s `--file` option's argument optional defaulting to ``. -* Fix libmemcachedprotocol's binary `STAT` and `VERSION` handlers. -* Fix [gh #105](https://github.com/awesomized/libmemcached/issues/105): - EINTR handled too defensively when polling. - -## v 1.1.0-beta2 - -> released 2020-12-28 - -**Changes from beta1:** - -* Fix [gh #103](https://github.com/awesomized/libmemcached/issues/103): - Build failure on 32-bit. -* Fix [gh #102](https://github.com/awesomized/libmemcached/issues/102): - Doc build with old sphinx. -* Fix [gh #100](https://github.com/awesomized/libmemcached/issues/100): - Revert symbolic rename of public header include directories. -* Fix [gh #98](https://github.com/awesomized/libmemcached/issues/98): - Library SONAMEs and NAME_LINKs differ from 1.0.18. -* Fix [gh #97](https://github.com/awesomized/libmemcached/issues/97): - Location of cmake files installation directory. -* Fix [gh #96](https://github.com/awesomized/libmemcached/issues/96): - LIBXXX_VERSION_HEX constants format. - -## v 1.1.0-beta1 - -> released 2020-12-21 - -**NOTE:** -This is a bug fix release, not a feature release. The minor version number -was incremented due to the following changes: - -* Ported build system to CMake. -* Ported test suite to Catch2. -* Build requires C++11 compiler support. -* Tests require C++17 compiler support. -* Moved to the Semantic Versioning Specification: https://semver.org -* Moved the project from launchpad to github: - * Source: https://github.com/awesomized/libmemcached - * Documentation: https://awesomized.github.io/libmemcached - * Continuous Integration: - * Github: https://github.com/awesomized/libmemcached/actions (Linux, MacOS, Windows **·** amd64) - * Sourcehut: https://builds.sr.ht/~m6w6/libmemcached (FreeBSD, - OpenBSD **·** amd64) - * Build artifacts: https://artifacts.m6w6.name/libmemcached/ rsync://m6w6.name::artifacts/libmemcached/ - - -* Fix build failure due to comparison of incompatible types in bin/memflush and bin/memstat. -* Fix wrong type of memcached_instance_st::server_timeout_counter_query_id from uint32_t to uint64_t. -* Fix memcached_dump(): - returned MEMCACHED_CLIENT_ERROR on request to dump illegal slab id. -* Fix bin/memcapable: - failed with "No hostname was provided" when providing a hostname. -* Fix hashkit/murmur and hashkit/murur3: - undefined behavior on platforms requiring aligned access. -* Fix Memcache::set(): - possible subscription of empty vector. -* Fix libmemcached_util_version_check(). -* Fix ketama/consistent hashing: - crash on reallocation of continuum. -* Fix [gh #90](https://github.com/awesomized/libmemcached/issues/90): - Build fails on Darwin. -* Fix [gh #83](https://github.com/awesomized/libmemcached/issues/83): - memcp waits forever if file no found. -* Fix [gh #80](https://github.com/awesomized/libmemcached/issues/80): - memparse docs. -* Fix [gh #72](https://github.com/awesomized/libmemcached/issues/72) - and [gh #47](https://github.com/awesomized/libmemcached/issues/47): - memcached_return_t docs. -* Fix [gh #62](https://github.com/awesomized/libmemcached/issues/62): - uint32_t overflow cause busy loop. -* Removed restriction of UDP+IPv6. -* Fix SERVER_ERROR_MEMORY_ALLOCATION_FAILURE: - recognize more strings returned by the server. -* Fix [gh #13](https://github.com/awesomized/libmemcached/issues/13): - reset continuum counter after freeing them. -* Fix [gh #14](https://github.com/awesomized/libmemcached/issues/14) - and [gh #17](https://github.com/awesomized/libmemcached/issues/17): - SASL: AUTH_CONTINUE was considered a failure and caused IO reset. -* Fix [gh #25](https://github.com/awesomized/libmemcached/issues/25): - hashkit/murmur3 unavailable. -* Fix missing handling of EAGAIN for non-blocking unix domain socket. -* Fix [gh #35](https://github.com/awesomized/libmemcached/issues/35): - handling of BEHAVIOR_REMOVE_FAILED_SERVERS. -* Fix [gh #41](https://github.com/awesomized/libmemcached/issues/41): - ensure stable sort on continuum host key collision. -* Fix [gh #42](https://github.com/awesomized/libmemcached/issues/42): - MEMCACHED_MAX_BUFFER docs. -* Fix [gh #43](https://github.com/awesomized/libmemcached/issues/43): - libmemcached_configuration docs. -* Fix [gh #46](https://github.com/awesomized/libmemcached/issues/46): - clarification on millisecond timeout docs. -* Fix [gh #50](https://github.com/awesomized/libmemcached/issues/50): - memcached_fetch_result() can return previously returned data. -* Fix [gh #53](https://github.com/awesomized/libmemcached/issues/53): - stack overflow in memcached_fetch_result(). -* Fix [gh #57](https://github.com/awesomized/libmemcached/issues/57): - include vs -* Fix [gh #58](https://github.com/awesomized/libmemcached/issues/58): - more specific error messages when connect() fails. -* Fix [gh #59](https://github.com/awesomized/libmemcached/issues/59): - bin/memcat: typo in "No servers provied". -* Fix [gh #77](https://github.com/awesomized/libmemcached/issues/77): - undeclared UINT64_C in ketama.cc. -* Fix [gh #12](https://github.com/awesomized/libmemcached/issues/12): - never reconnects after connection reset (binary protocol). -* Fix [gh #49](https://github.com/awesomized/libmemcached/issues/49): - assertion memcached_failed(rc) failed in memcached_send_ascii(). -* Fix [gh #67](https://github.com/awesomized/libmemcached/issues/67): - get returns NOTFOUND on timeout. -* Fix [gh #76](https://github.com/awesomized/libmemcached/issues/76): - memcached_touch() crashes when expiration=-1 (ASCII only). -* Fix [gh #23](https://github.com/awesomized/libmemcached/issues/23): - build fails with bison 2.3. -* Fix memaslap: build fails with newer compiler versions. -* Fix usage of strerror_r() implementations returning pointer to char. -* Fix pipelining commands with memcached >= 1.6. -* Fix memcached_stat_get_value(): buffer overflow. -* Fix memcached_stat(): undefined behavior due to unintialized memcached_return_t. -* Fix SASL tests: requires SASL_PWDB_CONF. -* Fix bin/memaslap to idnentify itself as memaslap instead of memslap. -* Fix bin/memcapable to work with memcached >= 1.6. -* Fix murmur and murmur3 hashes on big endian platforms. -* Fix [gh #82](https://github.com/awesomized/libmemcached/issues/82), - [gh #64](https://github.com/awesomized/libmemcached/issues/64) and - [gh #21](https://github.com/awesomized/libmemcached/issues/21): - clarify documentation on replication. -* Fix [gh #95](https://github.com/awesomized/libmemcached/issues/95): - MEMCACHED_CALLBACK_GET_FAILURE and MEMCACHED_BEHAVIOR_BUFFER_REQUESTS -* Fix bin/memcat to output flags if requested with `--flag`. -* Fix [gh #68](https://github.com/awesomized/libmemcached/issues/68): - Windows support. - ---- - -See [ChangeLog-1.0](./ChangeLog-1.0.md) for changes prior v1.1. diff --git a/ChangeLog.md b/ChangeLog.md deleted file mode 120000 index a78d08eb9..000000000 --- a/ChangeLog.md +++ /dev/null @@ -1 +0,0 @@ -ChangeLog-1.1.md \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 1d50957d8..000000000 --- a/LICENSE +++ /dev/null @@ -1,29 +0,0 @@ -Copyright (c) 2006-2014 Brian Aker, DataDifferential, https://datadifferential.com/ -Copyright (c) 2020-2021 Michael Wallner, Awesome Inc, https://awesome.co/ - -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSE.HEADER b/LICENSE.HEADER deleted file mode 100644 index beb72743d..000000000 --- a/LICENSE.HEADER +++ /dev/null @@ -1,14 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020-2021 Michael Wallner https://awesome.co/ | - +--------------------------------------------------------------------+ -*/ diff --git a/NEWS b/NEWS deleted file mode 100644 index b39336c7a..000000000 --- a/NEWS +++ /dev/null @@ -1 +0,0 @@ -See Changelog diff --git a/README.md b/README.md deleted file mode 100644 index d51e0fc28..000000000 --- a/README.md +++ /dev/null @@ -1,121 +0,0 @@ -# libmemcached-awesome - -[![License Badge]](https://opensource.org/licenses/BSD-3-Clause) - -[License Badge]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg "BSD 3-Clause" - -libmemcached-awesome is an open source C/C++ client library and tools -for the memcached server (http://memcached.org/). It has been designed -to be light on memory usage, thread safe, and provide full access to -server side methods. - -> **NOTE:** -> This is a resurrection of the original work from Brian Aker at -> [libmemcached.org](https://libmemcached.org). - -## Documentation - -[![Docs Actions Badge]]( - https://github.com/awesomized/libmemcached/actions?query=workflow%3Adocs-publish-pages) - -[Docs Actions Badge]: - https://github.com/awesomized/libmemcached/workflows/docs-publish-pages/badge.svg?branch=v1.x - "Github Docs Action" - -See https://awesomized.github.io/libmemcached - -### Building and updating docs - -See [gh-pages/publish](./docs/gh-pages/publish.sh) script and the -[docs-publish-pages](./.github/workflows/docs-publish-pages.yml) workflow, -which automate pushing updated documentation to github pages. - -## Installing - -libmemcached-awesome uses `CMake`. -Please see/edit [`CMakeConfig.txt`](./CMakeConfig.txt) or use `ccmake(1)` or -`cmake-gui(1)` to set any preferred options. - -### From source - - git clone github.com:awesomized/libmemcached - mkdir build-libmemcached - cd $_ - cmake ../libmemcached - make - sudo make install - -#### Requirements - -* CMake 3.9+ -* C++11 compiler -* GNU Bison 2.3+ and Flex - -##### Optional dependencies - -* C++17 compiler (required for: tests) -* Intel's libtbb (optional for: tests; for GCC's stdlib parallelism support) -* pthreads (required for: tests, contrib/bin/memaslap, libmemcachedutil/pool) -* libevent (required for: contrib/bin/memaslap) -* Cyrus' libsasl2 (required for: libmemcached/sasl) - -### Binaries - -CI and release builds for Linux, a couple BSDs, MacOS and Windows are available at -https://artifacts.m6w6.name/libmemcached/ and rsync://m6w6.name::artifacts/libmemcached/. - -## Testing - -Enable the `BUILD_TESTING` setting for a build and run `make test`. - - cmake -DBUILD_TESTING=ON ../libmemcached - make test - -### Continuous integration - -[![Actions Badge]](https://github.com/awesomized/libmemcached/actions?query=workflow%3Acmake-build-ci) -[![Sourcehut Badge]](https://builds.sr.ht/~m6w6/libmemcached) - -[Actions Badge]: - https://github.com/awesomized/libmemcached/workflows/cmake-build-ci/badge.svg?branch=v1.x - "Github Actions" -[Sourcehut Badge]: - https://builds.sr.ht/~m6w6/libmemcached/commits.svg - "Sourcehut Builds" - -CI/Testing is performed on the following system matrix: - -| OS | Compiler | Arch | Comments | -|------------------|-------------|------------|------------------------------| -| Linux | GNU, Clang | amd64 | sasl, sanitizers | -| MacOS | AppleClang | amd64, arm | sasl | -| FreeBSD | Clang | amd64 | sasl | -| OpenBSD | Clang | amd64 | sasl | -| Windows | MSVC, MinGW | amd64 | no sasl, no tests | -| Solaris | SunPro | amd64 | no sasl, no tests, manually | - -libmemcached-awesome has been tested against [memcached](https://github.com/memcached/memcached) -v1.5 and v1.6. - -## ChangeLog - -Check out the latest [releases](https://github.com/awesomized/libmemcached/releases) -or the bundled [ChangeLog](./ChangeLog-1.1.md) for a comprehensive list of changes. - -## License - -libmemcached-awesome is licensed under the 3-Clause-BSD license, which -can be -found in the accompanying [LICENSE](./LICENSE) file. - -## Contributing - -Please report any issues on the [bug tracker](https://github.com/awesomized/libmemcached/issues). - -A list of known permanent issues is maintained in [BUGS](./BUGS.md). - -All forms of contribution are welcome! Please see the bundled -[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed. - -The list of current and past maintainers and contributors is available in [AUTHORS](./AUTHORS). - diff --git a/TODO b/TODO deleted file mode 100644 index bc71ac3f9..000000000 --- a/TODO +++ /dev/null @@ -1,23 +0,0 @@ -- Stats: - - redo -- Deprecations: - - UDP, disabled by default from memcached-1.5.6 - soft (maybe only discourage in docs) - - API: - - memcached_delete(): expires param is obsolete -Includes: - - Rename all headers with a standard name like `string.h` and `limits.h`. - -## Legacy: - -- Write a shell application (?) -- Fix version in command line tools -- Write (more) test cases for all command line tools (!!!) -- Write some sort of "default" options bit for tools -- More examples using libraries -- Doxygen? -- implement more connection/hash algo -- implement compression -- Revisit get() code (look for performance enhancements) -- Add support for managing servers for clusters. -- Build embedded version diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 000000000..81415803e --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 000000000..30fee9d0f --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 000000000..707d99e41 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:normal;src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2") format("woff2"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60}.rst-versions .rst-current-version::after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge .fa-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 000000000..6cb600001 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 000000000..7059e2314 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 000000000..f815f63f9 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 000000000..f2c76e5bd Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 000000000..e9f60ca95 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 000000000..855c845e5 --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 000000000..35acda2fa Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 000000000..400014a4b Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 000000000..4d13fc604 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 000000000..88ad05b9f Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 000000000..c4e3d804b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 000000000..c6dff51f0 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 000000000..bb195043c Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 000000000..76114bc03 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 000000000..3404f37e2 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 000000000..ae1307ff5 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 000000000..3bf984332 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 000000000..6a65e2f90 --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,*::after,*::before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper>p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper>p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p .headerlink,.rst-content p a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption a .headerlink,a .rst-content .eqno .headerlink,.rst-content .eqno a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .btn button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.btn .wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p .headerlink,.rst-content p .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .btn .headerlink,.btn .rst-content .eqno .headerlink,.rst-content .eqno .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand,.nav .wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p .headerlink,.rst-content p .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .nav .headerlink,.nav .rst-content .eqno .headerlink,.rst-content .eqno .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .btn .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .btn .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li button.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p .headerlink:before,.rst-content p .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576520234%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576520234%;width:48.8211739883%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576520234%;width:31.7615653177%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9 ;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper>p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper>p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content .section ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content .section ol.arabic li,.rst-content section ol li,.rst-content section ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content .toctree-wrapper ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content section ol li p:last-child,.rst-content .toctree-wrapper ol li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content .section ol.arabic li ul,.rst-content section ol li ul,.rst-content section ol.arabic li ul,.rst-content .toctree-wrapper ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content .section ol.arabic li ul li,.rst-content section ol li ul li,.rst-content section ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs>li code,.wy-breadcrumbs>li .rst-content tt,.rst-content .wy-breadcrumbs>li tt{all:inherit;color:inherit}.breadcrumb-item::before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0 0;display:block;font-weight:bold;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover button.toctree-expand,.wy-menu-vertical li.current>a:hover button.toctree-expand{color:gray}.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li.current>a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 4.045em;padding-right:1.618em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 5.663em;padding-right:1.618em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 7.281em;padding-right:1.618em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 8.899em;padding-right:1.618em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 10.517em;padding-right:1.618em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 12.135em;padding-right:1.618em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 13.753em;padding-right:1.618em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 15.371em;padding-right:1.618em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em;padding-right:1.618em}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content h1,.rst-content h2,.rst-content .toctree-wrapper>p.caption,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img,.rst-content section>img,.rst-content section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight span.linenos,.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0px;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{clear:both}.rst-content .note .last,.rst-content .note>*:last-child,.rst-content .attention .last,.rst-content .attention>*:last-child,.rst-content .caution .last,.rst-content .caution>*:last-child,.rst-content .danger .last,.rst-content .danger>*:last-child,.rst-content .error .last,.rst-content .error>*:last-child,.rst-content .hint .last,.rst-content .hint>*:last-child,.rst-content .important .last,.rst-content .important>*:last-child,.rst-content .tip .last,.rst-content .tip>*:last-child,.rst-content .warning .last,.rst-content .warning>*:last-child,.rst-content .seealso .last,.rst-content .seealso>*:last-child,.rst-content .admonition-todo .last,.rst-content .admonition-todo>*:last-child,.rst-content .admonition .last,.rst-content .admonition>*:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content section ol li>*,.rst-content section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>*:first-child,.rst-content .section ul li>*:first-child,.rst-content section ol li>*:first-child,.rst-content section ul li>*:first-child,.rst-content .toctree-wrapper ol li>*:first-child,.rst-content .toctree-wrapper ul li>*:first-child{margin-top:0rem}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child{margin-bottom:0rem}.rst-content .section ol li>ul,.rst-content .section ol li>ol,.rst-content .section ul li>ul,.rst-content .section ul li>ol,.rst-content section ol li>ul,.rst-content section ol li>ol,.rst-content section ul li>ul,.rst-content section ul li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content .toctree-wrapper ul li>ol{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ul.simple li>*,.rst-content section ol.simple li>*,.rst-content section ul.simple li>*,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ul.simple li>*{margin-top:0rem;margin-bottom:0rem}.rst-content .section ol.simple li ul,.rst-content .section ol.simple li ol,.rst-content .section ul.simple li ul,.rst-content .section ul.simple li ol,.rst-content section ol.simple li ul,.rst-content section ol.simple li ol,.rst-content section ul.simple li ul,.rst-content section ul.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content .toctree-wrapper ul.simple li ol{margin-top:0rem;margin-bottom:0rem}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content h1 .headerlink:focus,.rst-content h2 .headerlink:focus,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content h3 .headerlink:focus,.rst-content h4 .headerlink:focus,.rst-content h5 .headerlink:focus,.rst-content h6 .headerlink:focus,.rst-content dl dt .headerlink:focus,.rst-content p .headerlink:focus,.rst-content p.caption .headerlink:focus,.rst-content table>caption .headerlink:focus,.rst-content .code-block-caption .headerlink:focus,.rst-content .eqno .headerlink:focus{opacity:1}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink,.rst-content p:hover .headerlink,.rst-content p.caption:hover .headerlink,.rst-content table>caption:hover .headerlink,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table th p,.rst-content table.docutils th p,.rst-content table.field-list th p,.rst-content .wy-table th ul,.rst-content table.docutils th ul,.rst-content table.field-list th ul,.rst-content .wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p,.rst-content .wy-table td ul,.rst-content table.docutils td ul,.rst-content table.field-list td ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>*:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;box-shadow:0 0 0 2px #F1C40F;display:inline;font-weight:bold}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content .footnote-reference>span.fn-bracket,.rst-content .citation-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none !important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.footnote,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list{display:grid;grid-template-columns:auto minmax(80%, 95%)}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem, auto) minmax(40%, 95%)}html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.footnote,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list{margin-bottom:24px}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt{padding-left:1rem}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.field-list>dd{margin-bottom:0rem}html.writer-html5 .rst-content dl.footnote,html.writer-html5 .rst-content dl.citation{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt,html.writer-html5 .rst-content dl.citation>dt{margin:0rem .5rem .5rem 0rem;line-height:1.2rem;word-break:break-all;font-weight:normal}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before,html.writer-html5 .rst-content dl.citation>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after,html.writer-html5 .rst-content dl.citation>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref,html.writer-html5 .rst-content dl.citation>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-0.1rem;max-width:5rem}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child)::before,html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child)::before{content:" "}html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.citation>dd{margin:0rem 0rem .5rem 0rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.citation>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-0.1rem;max-width:5rem}html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child)::before,html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child)::before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child)::before{content:" "}html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}html.writer-html4 .rst-content table.docutils.citation,.rst-content table.docutils.footnote,html.writer-html5 .rst-content dl.footnote,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation{color:gray}html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html4 .rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code,html.writer-html5 .rst-content dl.footnote tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content div.citation-list>div.citation code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils th>p,html.writer-html5 .rst-content table.docutils td>p{line-height:1rem;margin-bottom:0rem;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>*:last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C;white-space:normal}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040;overflow-wrap:normal}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>p:last-child,.rst-content dl dd>ol:last-child,.rst-content dl dd>ul:last-child,.rst-content dl dd>table:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname{font-weight:bold}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#000}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content *:not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd,.rst-content *:not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:grey 0px 2px;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Lato";src:url("../fonts/Lato-Regular.woff2") format("woff2"),url("../fonts/Lato-Regular.ttf") format("truetype");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:"Lato";src:url("../fonts/Lato-Bold.woff2") format("woff2"),url("../fonts/Lato-Bold.ttf") format("truetype");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:"Lato";src:url("../fonts/Lato-BoldItalic.woff2") format("woff2"),url("../fonts/Lato-BoldItalic.ttf") format("truetype");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:"Lato";src:url("../fonts/Lato-Italic.woff2") format("woff2"),url("../fonts/Lato-Italic.ttf") format("truetype");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:url("../fonts/RobotoSlab-Regular.woff2") format("woff2");font-display:block}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:url("../fonts/RobotoSlab-Bold.woff2") format("woff2");font-display:block} diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 000000000..d06a71d75 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 000000000..7eee94a89 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '1.1.4', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: false, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 000000000..a858a410e Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fonts/FontAwesome.otf b/_static/fonts/FontAwesome.otf new file mode 100644 index 000000000..401ec0f36 Binary files /dev/null and b/_static/fonts/FontAwesome.otf differ diff --git a/_static/fonts/Inconsolata-Bold.ttf b/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 000000000..809c1f582 Binary files /dev/null and b/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/_static/fonts/Inconsolata-Regular.ttf b/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 000000000..fc981ce7a Binary files /dev/null and b/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/_static/fonts/Inconsolata.ttf b/_static/fonts/Inconsolata.ttf new file mode 100644 index 000000000..4b8a36d24 Binary files /dev/null and b/_static/fonts/Inconsolata.ttf differ diff --git a/_static/fonts/Lato-Bold.ttf b/_static/fonts/Lato-Bold.ttf new file mode 100644 index 000000000..ef5ae3b43 Binary files /dev/null and b/_static/fonts/Lato-Bold.ttf differ diff --git a/_static/fonts/Lato-Bold.woff2 b/_static/fonts/Lato-Bold.woff2 new file mode 100644 index 000000000..5711413da Binary files /dev/null and b/_static/fonts/Lato-Bold.woff2 differ diff --git a/_static/fonts/Lato-BoldItalic.ttf b/_static/fonts/Lato-BoldItalic.ttf new file mode 100644 index 000000000..664cd02c1 Binary files /dev/null and b/_static/fonts/Lato-BoldItalic.ttf differ diff --git a/_static/fonts/Lato-BoldItalic.woff2 b/_static/fonts/Lato-BoldItalic.woff2 new file mode 100644 index 000000000..04450a92c Binary files /dev/null and b/_static/fonts/Lato-BoldItalic.woff2 differ diff --git a/_static/fonts/Lato-Italic.ttf b/_static/fonts/Lato-Italic.ttf new file mode 100644 index 000000000..b23256ff5 Binary files /dev/null and b/_static/fonts/Lato-Italic.ttf differ diff --git a/_static/fonts/Lato-Italic.woff2 b/_static/fonts/Lato-Italic.woff2 new file mode 100644 index 000000000..2526bb748 Binary files /dev/null and b/_static/fonts/Lato-Italic.woff2 differ diff --git a/_static/fonts/Lato-Regular.ttf b/_static/fonts/Lato-Regular.ttf new file mode 100644 index 000000000..adbfc467d Binary files /dev/null and b/_static/fonts/Lato-Regular.ttf differ diff --git a/_static/fonts/Lato-Regular.woff2 b/_static/fonts/Lato-Regular.woff2 new file mode 100644 index 000000000..41baa4f2b Binary files /dev/null and b/_static/fonts/Lato-Regular.woff2 differ diff --git a/_static/fonts/Lato/lato-bold.eot b/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 000000000..3361183a4 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.eot differ diff --git a/_static/fonts/Lato/lato-bold.ttf b/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 000000000..29f691d5e Binary files /dev/null and b/_static/fonts/Lato/lato-bold.ttf differ diff --git a/_static/fonts/Lato/lato-bold.woff b/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 000000000..c6dff51f0 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff differ diff --git a/_static/fonts/Lato/lato-bold.woff2 b/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 000000000..bb195043c Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/_static/fonts/Lato/lato-bolditalic.eot b/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 000000000..3d4154936 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/_static/fonts/Lato/lato-bolditalic.ttf b/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 000000000..f402040b3 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff b/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 000000000..88ad05b9f Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff2 b/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 000000000..c4e3d804b Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/_static/fonts/Lato/lato-italic.eot b/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 000000000..3f826421a Binary files /dev/null and b/_static/fonts/Lato/lato-italic.eot differ diff --git a/_static/fonts/Lato/lato-italic.ttf b/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 000000000..b4bfc9b24 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.ttf differ diff --git a/_static/fonts/Lato/lato-italic.woff b/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 000000000..76114bc03 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff differ diff --git a/_static/fonts/Lato/lato-italic.woff2 b/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 000000000..3404f37e2 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/_static/fonts/Lato/lato-regular.eot b/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 000000000..11e3f2a5f Binary files /dev/null and b/_static/fonts/Lato/lato-regular.eot differ diff --git a/_static/fonts/Lato/lato-regular.ttf b/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 000000000..74decd9eb Binary files /dev/null and b/_static/fonts/Lato/lato-regular.ttf differ diff --git a/_static/fonts/Lato/lato-regular.woff b/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 000000000..ae1307ff5 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff differ diff --git a/_static/fonts/Lato/lato-regular.woff2 b/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 000000000..3bf984332 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/_static/fonts/Roboto-Slab-Bold.woff b/_static/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 000000000..6cb600001 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/fonts/Roboto-Slab-Bold.woff2 b/_static/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 000000000..7059e2314 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/fonts/Roboto-Slab-Light.woff b/_static/fonts/Roboto-Slab-Light.woff new file mode 100644 index 000000000..337d28711 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Light.woff differ diff --git a/_static/fonts/Roboto-Slab-Light.woff2 b/_static/fonts/Roboto-Slab-Light.woff2 new file mode 100644 index 000000000..20398aff3 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Light.woff2 differ diff --git a/_static/fonts/Roboto-Slab-Regular.woff b/_static/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 000000000..f815f63f9 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/fonts/Roboto-Slab-Regular.woff2 b/_static/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 000000000..f2c76e5bd Binary files /dev/null and b/_static/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/fonts/Roboto-Slab-Thin.woff b/_static/fonts/Roboto-Slab-Thin.woff new file mode 100644 index 000000000..6b30ea630 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Thin.woff differ diff --git a/_static/fonts/Roboto-Slab-Thin.woff2 b/_static/fonts/Roboto-Slab-Thin.woff2 new file mode 100644 index 000000000..328f5bb04 Binary files /dev/null and b/_static/fonts/Roboto-Slab-Thin.woff2 differ diff --git a/_static/fonts/RobotoSlab-Bold.ttf b/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 000000000..df5d1df27 Binary files /dev/null and b/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/_static/fonts/RobotoSlab-Bold.woff2 b/_static/fonts/RobotoSlab-Bold.woff2 new file mode 100644 index 000000000..40a6cbc8e Binary files /dev/null and b/_static/fonts/RobotoSlab-Bold.woff2 differ diff --git a/_static/fonts/RobotoSlab-Regular.ttf b/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 000000000..eb52a7907 Binary files /dev/null and b/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/_static/fonts/RobotoSlab-Regular.woff2 b/_static/fonts/RobotoSlab-Regular.woff2 new file mode 100644 index 000000000..d36556f28 Binary files /dev/null and b/_static/fonts/RobotoSlab-Regular.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 000000000..79dc8efed Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 000000000..df5d1df27 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 000000000..6cb600001 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 000000000..7059e2314 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 000000000..2f7ca78a1 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 000000000..eb52a7907 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 000000000..f815f63f9 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 000000000..f2c76e5bd Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/_static/fonts/fontawesome-webfont.eot b/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 000000000..e9f60ca95 Binary files /dev/null and b/_static/fonts/fontawesome-webfont.eot differ diff --git a/_static/fonts/fontawesome-webfont.svg b/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 000000000..855c845e5 --- /dev/null +++ b/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/fonts/fontawesome-webfont.ttf b/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 000000000..35acda2fa Binary files /dev/null and b/_static/fonts/fontawesome-webfont.ttf differ diff --git a/_static/fonts/fontawesome-webfont.woff b/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 000000000..400014a4b Binary files /dev/null and b/_static/fonts/fontawesome-webfont.woff differ diff --git a/_static/fonts/fontawesome-webfont.woff2 b/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 000000000..4d13fc604 Binary files /dev/null and b/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/fonts/lato-bold-italic.woff b/_static/fonts/lato-bold-italic.woff new file mode 100644 index 000000000..88ad05b9f Binary files /dev/null and b/_static/fonts/lato-bold-italic.woff differ diff --git a/_static/fonts/lato-bold-italic.woff2 b/_static/fonts/lato-bold-italic.woff2 new file mode 100644 index 000000000..c4e3d804b Binary files /dev/null and b/_static/fonts/lato-bold-italic.woff2 differ diff --git a/_static/fonts/lato-bold.woff b/_static/fonts/lato-bold.woff new file mode 100644 index 000000000..c6dff51f0 Binary files /dev/null and b/_static/fonts/lato-bold.woff differ diff --git a/_static/fonts/lato-bold.woff2 b/_static/fonts/lato-bold.woff2 new file mode 100644 index 000000000..bb195043c Binary files /dev/null and b/_static/fonts/lato-bold.woff2 differ diff --git a/_static/fonts/lato-normal-italic.woff b/_static/fonts/lato-normal-italic.woff new file mode 100644 index 000000000..76114bc03 Binary files /dev/null and b/_static/fonts/lato-normal-italic.woff differ diff --git a/_static/fonts/lato-normal-italic.woff2 b/_static/fonts/lato-normal-italic.woff2 new file mode 100644 index 000000000..3404f37e2 Binary files /dev/null and b/_static/fonts/lato-normal-italic.woff2 differ diff --git a/_static/fonts/lato-normal.woff b/_static/fonts/lato-normal.woff new file mode 100644 index 000000000..ae1307ff5 Binary files /dev/null and b/_static/fonts/lato-normal.woff differ diff --git a/_static/fonts/lato-normal.woff2 b/_static/fonts/lato-normal.woff2 new file mode 100644 index 000000000..3bf984332 Binary files /dev/null and b/_static/fonts/lato-normal.woff2 differ diff --git a/_static/jquery-3.4.1.js b/_static/jquery-3.4.1.js new file mode 100644 index 000000000..773ad95c5 --- /dev/null +++ b/_static/jquery-3.4.1.js @@ -0,0 +1,10598 @@ +/*! + * jQuery JavaScript Library v3.4.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2019-05-01T21:04Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.4.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code, options ) { + DOMEval( code, { nonce: options && options.nonce } ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.4 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2019-04-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) && + + // Support: IE 8 only + // Exclude object elements + (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && rdescend.test( selector ) ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = (elem.ownerDocument || elem).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( typeof elem.contentDocument !== "undefined" ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + } ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + // Support: IE 9-11 only + // Also use offsetWidth/offsetHeight for when box sizing is unreliable + // We use getClientRects() to check for hidden/disconnected. + // In those cases, the computed value can be trusted to be border-box + if ( ( !support.boxSizingReliable() && isBorderBox || + val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url, options ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/common/note_contrib_options.html b/bin/common/note_contrib_options.html new file mode 100644 index 000000000..d6fe9336a --- /dev/null +++ b/bin/common/note_contrib_options.html @@ -0,0 +1,118 @@ + + + + + + + CONTRIBUTED PROGRAM — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

CONTRIBUTED PROGRAM

+

This is a contributed program.

+

This program doesn't follow the standard flag/option scheme.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/common/note_program_prefix.html b/bin/common/note_program_prefix.html new file mode 100644 index 000000000..e82011ce4 --- /dev/null +++ b/bin/common/note_program_prefix.html @@ -0,0 +1,120 @@ + + + + + + + PROGRAM PREFIX — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/index.html b/bin/index.html new file mode 100644 index 000000000..304dc6eb9 --- /dev/null +++ b/bin/index.html @@ -0,0 +1,172 @@ + + + + + + + Client Applications — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memaslap.html b/bin/memaslap.html new file mode 100644 index 000000000..d5ebc1727 --- /dev/null +++ b/bin/memaslap.html @@ -0,0 +1,1001 @@ + + + + + + + memaslap - Load testing and benchmarking a server — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memaslap - Load testing and benchmarking a server

+
+

SYNOPSIS

+

memaslap [options]

+
+
+--help
+
+ +
+
+--servers
+
+ +
+
+MEMCACHED_SERVERS
+
+ +
+
+

DESCRIPTION

+

memaslap is a load generation and benchmark tool for memcached +servers. It generates configurable workload such as threads, concurrency, +connections, run time, overwrite, miss rate, key size, value size, get/set +proportion, expected throughput, and so on. Furthermore, it also tests data +verification, expire-time verification, UDP, binary protocol, facebook test, +replication test, multi-get and reconnection, etc.

+

Memaslap manages network connections like memcached with +libevent. Each thread of memaslap is bound with a CPU core, all +the threads don't communicate with each other, and there are several socket +connections in each thread. Each connection keeps key size distribution, +value size distribution, and command distribution by itself.

+

You can specify servers via the memaslap --servers option or via the +environment variable MEMCACHED_SERVERS.

+
+
+

FEATURES

+

Memslap is developed to for the following purposes:

+

Manages network connections with libevent asynchronously.

+

Set both TCP and UDP up to use non-blocking IO.

+

Improves parallelism: higher performance in multi-threads environments.

+

Improves time efficiency: faster processing speed.

+

Generates key and value more efficiently; key size distribution and value size distribution are configurable.

+

Supports get, multi-get, and set commands; command distribution is configurable.

+

Supports controllable miss rate and overwrite rate.

+

Supports data and expire-time verification.

+

Supports dumping statistic information periodically.

+

Supports thousands of TCP connections.

+

Supports binary protocol.

+

Supports facebook test (set with TCP and multi-get with UDP) and replication test.

+
+
+

DETAILS

+
+

Effective implementation of network.

+

For memaslap, both TCP and UDP use non-blocking network IO. All +the network events are managed by libevent as memcached. The network module +of memaslap is similar to memcached. Libevent can ensure +memaslap can handle network very efficiently.

+
+
+

Effective implementation of multi-threads and concurrency

+

Memslap has the similar implementation of multi-threads to +memcached. Memslap creates one or more self-governed threads; +each thread is bound with one CPU core if the system tests setting CPU +core affinity.

+

In addition, each thread has a libevent to manage the events of the network; +each thread has one or more self-governed concurrency; and each +concurrency has one or more socket connections. All the concurrent tasks don't +communicate with each other even though they are in the same thread.

+

Memslap can create thousands of socket connections, and each +concurrency has tens of socket connections. Each concurrency randomly or +sequentially selects one socket connection from its socket connection pool +to run, so memaslap can ensure each concurrency handles one +socket connection at any given time. Users can specify the number of +concurrency and socket connections of each concurrency according to their +expected workload.

+
+
+

Effective implementation of generating key and value

+

In order to improve time efficiency and space efficiency, +memaslap creates a random characters table with 10M characters. All the +suffixes of keys and values are generated from this random characters table.

+

Memslap uses the offset in the character table and the length +of the string to identify a string. It can save much memory. +Each key contains two parts, a prefix and a suffix. The prefix is an +uint64_t, 8 bytes. In order to verify the data set before, +memaslap need to ensure each key is unique, so it uses the prefix to identify +a key. The prefix cannot include illegal characters, such as 'r', 'n', +'0' and ' '. And memaslap has an algorithm to ensure that.

+

Memslap doesn't generate all the objects (key-value pairs) at +the beginning. It only generates enough objects to fill the task window +(default 10K objects) of each concurrency. Each object has the following +basic information, key prefix, key suffix offset in the character table, key +length, value offset in the character table, and value length.

+

In the work process, each concurrency sequentially or randomly selects an +object from the window to do set operation or get operation. At the same +time, each concurrency kicks objects out of its window and adds new object +into it.

+
+
+

Simple but useful task scheduling

+

Memslap uses libevent to schedule all concurrent tasks of +threads, and each concurrency schedules tasks based on the local task +window. Memslap assumes that if each concurrency keeps the same +key distribution, value distribution and commands distribution, from +outside, memaslap keeps all the distribution as a whole. +Each task window includes a lot of objects, each object stores its basic +information, such as key, value, expire time, and so on. At any time, all +the objects in the window keep the same and fixed key and value +distribution. If an object is overwritten, the value of the object will be +updated. Memslap verifies the data or expire-time according to +the object information stored in the task window.

+

Libevent selects which concurrency to handle based on a specific network +event. Then the concurrency selects which command (get or set) to operate +based on the command distribution. If it needs to kick out an old object and +add a new object, in order to keep the same key and value distribution, the +new object must have the same key length and value length.

+

If memcached server has two cache layers (memory and SSD), running +memaslap with different window sizes can get different cache +miss rates. If memaslap adds enough objects into the windows at +the beginning, and the cache of memcached cannot store all the objects +initialized, then memaslap will get some objects from the second +cache layer. It causes the first cache layer to miss. So the user can +specify the window size to get the expected miss rate of the first cache +layer.

+
+
+

Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol

+

Because each thread is self-governed, memaslap can assign +different threads to handle different memcached servers. This is just one of +the ways in which memaslap tests multiple servers. The only +limitation is that the number of servers cannot be greater than the number +of threads. The other way to test multiple servers is for replication +test. Each concurrency has one socket connection to each memcached server. +For the implementation, memaslap can set some objects to one +memcached server, and get these objects from the other servers.

+

By default, Memslap does single get. If the user specifies +multi-get option, memaslap will collect enough get commands and +pack and send the commands together.

+

Memslap tests both the ASCII protocol and binary protocol, +but it runs on the ASCII protocol by default. +Memslap by default runs on the TCP protocol, but it also +tests UDP. Because UDP is unreliable, dropped packages and out-of-order +packages may occur. Memslap creates a memory buffer to handle +these problems. Memslap tries to read all the response data of +one command from the server and reorders the response data. If some packages +get lost, the waiting timeout mechanism can ensure half-baked packages will +be discarded and the next command will be sent.

+
+
+
+

USAGE

+

Below are some usage samples:

+

memaslap -s 127.0.0.1:11211 -S 5s

+

memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2

+

The user must specify one server at least to run memaslap. The +rest of the parameters have default values, as shown below:

+

Thread number = 1 Concurrency = 16

+

Run time = 600 seconds Configuration file = NULL

+

Key size = 64 Value size = 1024

+

Get/set = 9:1 Window size = 10k

+

Execute number = 0 Single get = true

+

Multi-get = false Number of sockets of each concurrency = 1

+

Reconnect = false Data verification = false

+

Expire-time verification = false ASCII protocol = true

+

Binary protocol = false Dumping statistic information periodically = false

+

Overwrite proportion = 0% UDP = false

+

TCP = true Limit throughput = false

+

Facebook test = false Replication test = false

+
+

Key size, value size and command distribution.

+

All the distributions are read from the configuration file specified by user +with "—cfg_cmd" option. If the user does not specify a configuration file, +memaslap will run with the default distribution (key size = 64, +value size = 1024, get/set = 9:1). For information on how to edit the +configuration file, refer to the "Configuration File" section.

+

The minimum key size is 16 bytes; the maximum key size is 250 bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places.

+

The minimum value size is 1 bytes; the maximum value size is 1M bytes. The +precision of proportion is 0.001. The proportion of distribution will be +rounded to 3 decimal places. +Currently, memaslap only tests set and get commands. And it +testss 100% set and 100% get. For 100% get, it will preset some objects to +the server.

+
+
+

Multi-thread and concurrency

+

The high performance of memaslap benefits from the special +schedule of thread and concurrency. It's important to specify the proper +number of them. The default number of threads is 1; the default number of +concurrency is 16. The user can use "—threads" and "--concurrency" to +specify these variables.

+

If the system tests setting CPU affinity and the number of threads +specified by the user is greater than 1, memaslap will try to +bind each thread to a different CPU core. So if you want to get the best +performance memaslap, it is better to specify the number of +thread equal to the number of CPU cores. The number of threads specified by +the user can also be less or greater than the number of CPU cores. Because +of the limitation of implementation, the number of concurrencies could be +the multiple of the number of threads.

+
    +

  1. For 8 CPU cores system

    2. +
+

For example:

+

--threads=2 --concurrency=128

+

--threads=8 --concurrency=128

+

--threads=8 --concurrency=256

+

--threads=12 --concurrency=144

+
    +

  1. For 16 CPU cores system

    2. +
+

For example:

+

--threads=8 --concurrency=128

+

--threads=16 --concurrency=256

+

--threads=16 --concurrency=512

+

--threads=24 --concurrency=288

+

The memaslap performs very well, when +used to test the performance of memcached servers. +Most of the time, the bottleneck is the network or +the server. If for some reason the user wants to +limit the performance of memaslap, there +are two ways to do this:

+

Decrease the number of threads and concurrencies. +Use the option "--tps" that memaslap +provides to limit the throughput. This option allows +the user to get the expected throughput. For +example, assume that the maximum throughput is 50 +kops/s for a specific configuration, you can specify +the throughput equal to or less than the maximum +throughput using "--tps" option.

+
+
+

Window size

+

Most of the time, the user does not need to specify the window size. The +default window size is 10k. For Schooner Memcached, the user can specify +different window sizes to get different cache miss rates based on the test +case. Memslap testss cache miss rate between 0% and 100%. +If you use this utility to test the performance of Schooner Memcached, you +can specify a proper window size to get the expected cache miss rate. The +formula for calculating window size is as follows:

+

Assume that the key size is 128 bytes, and the value size is 2048 bytes, and +concurrency=128.

+

1. Small cache cache_size=1M, 100% cache miss (all data get from SSD). +win_size=10k

+
    +

  1. cache_size=4G

    2. +
+

(1). cache miss rate 0%

+

win_size=8k

+

(2). cache miss rate 5%

+

win_size=11k

+
    +

  1. cache_size=16G

    2. +
+

(1). cache miss rate 0%

+

win_size=32k

+

(2). cache miss

+

rate 5%

+

win_size=46k

+

The formula for calculating window size for cache miss rate 0%:

+

cache_size / concurrency / (key_size + value_size) * 0.5

+

The formula for calculating window size for cache miss rate 5%:

+

cache_size / concurrency / (key_size + value_size) * 0.7

+
+
+

Verification

+

Memslap testss both data verification and expire-time +verification. The user can use "--verify=" or "-v" to specify the proportion +of data verification. In theory, it testss 100% data verification. The +user can use "--exp_verify=" or "-e" to specify the proportion of +expire-time verification. In theory, it testss 100% expire-time +verification. Specify the "--verbose" options to get more detailed error +information.

+

For example: --exp_verify=0.01 –verify=0.1 , it means that 1% of the objects +set with expire-time, 10% of the objects gotten will be verified. If the +objects are gotten, memaslap will verify the expire-time and +value.

+
+
+

multi-servers and multi-config

+

Memslap testss multi-servers based on self-governed thread. +There is a limitation that the number of servers cannot be greater than the +number of threads. Memslap assigns one thread to handle one +server at least. The user can use the "--servers=" or "-s" option to specify +multi-servers.

+

For example:

+

--servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 --threads=6 --concurrency=36

+

The above command means that there are 6 threads, with each thread having 6 +concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1 +and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2 +(10.1.1.3).

+

All the threads and concurrencies in memaslap are self-governed.

+

So is memaslap. The user can start up several +memaslap instances. The user can run memaslap on different client +machines to communicate with the same memcached server at the same. It is +recommended that the user start different memaslap on different +machines using the same configuration.

+
+
+

Run with execute number mode or time mode

+

The default memaslap runs with time mode. The default run time +is 10 minutes. If it times out, memaslap will exit. Do not +specify both execute number mode and time mode at the same time; just +specify one instead.

+

For example:

+

--time=30s (It means the test will run 30 seconds.)

+

--execute_number=100000 (It means that after running 100000 commands, the test will exit.)

+
+
+

Dump statistic information periodically.

+

The user can use "--stat_freq=" or "-S" to specify the frequency.

+

For example:

+

--stat_freq=20s

+

Memslap will dump the statistics of the commands (get and set) at the frequency of every 20 +seconds.

+

For more information on the format of dumping statistic information, refer to "Format of Output" section.

+
+
+

Multi-get

+

The user can use "--division=" or "-d" to specify multi-get keys count. +Memslap by default does single get with TCP. Memslap also testss data +verification and expire-time verification for multi-get.

+

Memslap testss multi-get with both TCP and UDP. Because of +the different implementation of the ASCII protocol and binary protocol, +there are some differences between the two. For the ASCII protocol, +memaslap sends one "multi-get" to the server once. For the +binary protocol, memaslap sends several single get commands +together as "multi-get" to the server.

+
+
+

UDP and TCP

+

Memslap testss both UDP and TCP. For TCP, +memaslap does not reconnect the memcached server if socket connections are +lost. If all the socket connections are lost or memcached server crashes, +memaslap will exit. If the user specifies the "--reconnect" +option when socket connections are lost, it will reconnect them.

+

User can use "--udp" to enable the UDP feature, but UDP comes with some +limitations:

+

UDP cannot set data more than 1400 bytes.

+

UDP is not tested by the binary protocol because the binary protocol of +memcached does not tests that.

+

UDP doesn't tests reconnection.

+
+
+

Facebook test

+

Set data with TCP and multi-get with UDP. Specify the following options:

+

"--facebook --division=50"

+

If you want to create thousands of TCP connections, specify the

+

"--conn_sock=" option.

+

For example: --facebook --division=50 --conn_sock=200

+

The above command means that memaslap will do facebook test, +each concurrency has 200 socket TCP connections and one UDP socket.

+

Memslap sets objects with the TCP socket, and multi-gets 50 +objects once with the UDP socket.

+

If you specify "--division=50", the key size must be less that 25 bytes +because the UDP packet size is 1400 bytes.

+
+
+

Replication test

+

For replication test, the user must specify at least two memcached servers. +The user can use "—rep_write=" option to enable feature.

+

For example:

+

--servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2

+

The above command means that there are 2 replication memcached servers, +memaslap will set objects to both server 0 and server 1, get +objects which are set to server 0 before from server 1, and also get objects +which are set to server 1 before from server 0. If server 0 crashes, +memaslap will only get objects from server 1. If server 0 comes +back to life again, memaslap will reconnect server 0. If both +server 0 and server 1 crash, memaslap will exit.

+
+
+

Supports thousands of TCP connections

+

Start memaslap with "--conn_sock=" or "-n" to enable this +feature. Make sure that your system can tests opening thousands of files +and creating thousands of sockets. However, this feature does not tests +reconnection if sockets disconnect.

+

For example:

+

--threads=8 --concurrency=128 --conn_sock=128

+

The above command means that memaslap starts up 8 threads, each +thread has 16 concurrencies, each concurrency has 128 TCP socket +connections, and the total number of TCP socket connections is 128 * 128 = +16384.

+
+
+

Supports binary protocol

+

Start memaslap with "--binary" or "-B" options to enable this +feature. It testss all the above features except UDP, because the latest +memcached 1.3.3 does not implement binary UDP protocol.

+

For example:

+

--binary

+

Since memcached 1.3.3 doesn't implement binary UDP protocol, +memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests +multi-get. If you specify "--division=50" option, it just sends 50 get +commands together as "multi-get" to the server.

+
+
+
+

Configuration file

+

This section describes the format of the configuration file. By default +when no configuration file is specified memaslap reads the default +one located at ~/.memaslap.cnf.

+

Below is a sample configuration file:

+
---------------------------------------------------------------------------
+#comments should start with '#'
+#key
+#start_len end_len proportion
+#
+#key length range from start_len to end_len
+#start_len must be equal to or greater than 16
+#end_len must be equal to or less than 250
+#start_len must be equal to or greater than end_len
+#memaslap will generate keys according to the key range
+#proportion: indicates keys generated from one range accounts for the total
+generated keys
+#
+#example1: key range 16~100 accounts for 80%
+#          key range 101~200 accounts for 10%
+#          key range 201~250 accounts for 10%
+#          total should be 1 (0.8+0.1+0.1 = 1)
+#
+#          16 100 0.8
+#          101 200 0.1
+#          201 249 0.1
+#
+#example2: all keys length are 128 bytes
+#
+#          128 128 1
+key
+128 128 1
+#value
+#start_len end_len proportion
+#
+#value length range from start_len to end_len
+#start_len must be equal to or greater than 1
+#end_len must be equal to or less than 1M
+#start_len must be equal to or greater than end_len
+#memaslap will generate values according to the value range
+#proportion: indicates values generated from one range accounts for the
+total generated values
+#
+#example1: value range 1~1000 accounts for 80%
+#          value range 1001~10000 accounts for 10%
+#          value range 10001~100000 accounts for 10%
+#          total should be 1 (0.8+0.1+0.1 = 1)
+#
+#          1 1000 0.8
+#          1001 10000 0.1
+#          10001 100000 0.1
+#
+#example2: all value length are 128 bytes
+#
+#          128 128 1
+value
+2048 2048 1
+#cmd
+#cmd_type cmd_proportion
+#
+#currently memaslap only testss get and set command.
+#
+#cmd_type
+#set     0
+#get     1
+#
+#example: set command accounts for 50%
+#         get command accounts for 50%
+#         total should be 1 (0.5+0.5 = 1)
+#
+#         cmd
+#         0    0.5
+#         1    0.5
+cmd
+0    0.1
+1.0 0.9
+
+
+
+
+

Format of output

+

At the beginning, memaslap displays some configuration information as follows:

+

servers : 127.0.0.1:11211

+

threads count: 1

+

concurrency: 16

+

run time: 20s

+

windows size: 10k

+

set proportion: set_prop=0.10

+

get proportion: get_prop=0.90

+
+

Where

+

servers : "servers"

+
+

The servers used by memaslap.

+
+

threads count

+
+

The number of threads memaslap runs with.

+
+

concurrency

+
+

The number of concurrencies memaslap runs with.

+
+

run time

+
+

How long to run memaslap.

+
+

windows size

+
+

The task window size of each concurrency.

+
+

set proportion

+
+

The proportion of set command.

+
+

get proportion

+
+

The proportion of get command.

+
+

The output of dynamic statistics is something like this:

+
---------------------------------------------------------------------------------------------------------------------------------
+Get Statistics
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5   345826  69165     65.3      0         27      2198     203
+95.43      177.29
+Global  20  1257935  62896     71.8      0         26      3791     224
+117.79     192.60
+Set Statistics
+
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5    38425   7685      7.3       0         42      628     240
+88.05      220.21
+Global   20   139780  6989      8.0       0         37      3790    253
+117.93     224.83
+Total Statistics
+
+Type  Time(s)  Ops   TPS(ops/s)  Net(M/s)  Get_miss  Min(us)  Max(us)
+Avg(us)  Std_dev    Geo_dist
+Period   5   384252   76850     72.5      0        27      2198     207
+94.72      181.18
+Global  20  1397720   69886     79.7      0        26      3791     227
+117.93     195.60
+---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+
+

Where

+

Get Statistics

+
+

Statistics information of get command

+
+

Set Statistics

+
+

Statistics information of set command

+
+

Total Statistics

+
+

Statistics information of both get and set command

+
+

Period

+
+

Result within a period

+
+

Global

+
+

Accumulated results

+
+

Ops

+
+

Total operations

+
+

TPS

+
+

Throughput, operations/second

+
+

Net

+
+

The rate of network

+
+

Get_miss

+
+

How many objects can't be gotten

+
+

Min

+
+

The minimum response time

+
+

Max

+
+

The maximum response time

+
+

Avg:

+
+

The average response time

+
+

Std_dev

+
+

Standard deviation of response time

+
+

Geo_dist

+
+

Geometric distribution based on natural exponential function

+
+

At the end, memaslap will output something like this:

+
---------------------------------------------------------------------------------------------------------------------------------
+Get Statistics (1257956 events)
+  Min:        26
+  Max:      3791
+  Avg:       224
+  Geo:    192.60
+  Std:    116.23
+                  Log2 Dist:
+                    4:        0       10    84490   215345
+                    8:   484890   459823    12543      824
+                   12:       31
+
+ Set Statistics (139782 events)
+    Min:        37
+    Max:      3790
+    Avg:       253
+    Geo:    224.84
+    Std:    116.83
+    Log2 Dist:
+      4:        0        0     4200 16988
+      8:    50784    65574 2064      167
+      12:        5
+
+  Total Statistics (1397738 events)
+      Min:        26
+      Max:      3791
+      Avg:       227
+      Geo:    195.60
+      Std:    116.60
+      Log2 Dist:
+        4:        0       10    88690   232333
+        8:   535674   525397    14607      991
+        12:       36
+
+cmd_get: 1257969
+cmd_set: 139785
+get_misses: 0
+verify_misses: 0
+verify_failed: 0
+expired_get: 0
+unexpired_unget: 0
+written_bytes: 242516030
+read_bytes: 1003702556
+object_bytes: 152086080
+packet_disorder: 0
+packet_drop: 0
+udp_timeout: 0
+
+Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
+---------------------------------------------------------------------------------------------------------------------------------
+
+
+
+
+

Where

+

Get Statistics

+
+

Get statistics of response time

+
+

Set Statistics

+
+

Set statistics of response time

+
+

Total Statistics

+
+

Both get and set statistics of response time

+
+

Min

+
+

The accumulated and minimum response time

+
+

Max

+
+

The accumulated and maximum response time

+
+

Avg

+
+

The accumulated and average response time

+
+

Std

+
+

Standard deviation of response time

+
+

Log2 Dist

+
+

Geometric distribution based on logarithm 2

+
+

cmd_get

+
+

Total get commands done

+
+

cmd_set

+
+

Total set commands done

+
+

get_misses

+
+

How many objects can't be gotten from server

+
+

verify_misses

+
+

How many objects need to verify but can't get them

+
+

verify_failed

+
+

How many objects with insistent value

+
+

expired_get

+
+

How many objects are expired but we get them

+
+

unexpired_unget

+
+

How many objects are unexpired but we can't get them

+
+

written_bytes

+
+

Total written bytes

+
+

read_bytes

+
+

Total read bytes

+
+

object_bytes

+
+

Total object bytes

+
+

packet_disorder

+
+

How many UDP packages are disorder

+
+

packet_drop

+
+

How many UDP packages are lost

+
+

udp_timeout

+
+

How many times UDP time out happen

+
+

Run time

+
+

Total run time

+
+

Ops

+
+

Total operations

+
+

TPS

+
+

Throughput, operations/second

+
+

Net_rate

+
+

The average rate of network

+
+
+
+
+

OPTIONS

+
+
-s, --servers=

List one or more servers to connect. Servers count must be less than +threads count. e.g.: --servers=localhost:1234,localhost:11211

+
+
-T, --threads=

Number of threads to startup, better equal to CPU numbers. Default 8.

+
+
-c, --concurrency=

Number of concurrency to simulate with load. Default 128.

+
+
-n, --conn_sock=

Number of TCP socks per concurrency. Default 1.

+
+
-x, --execute_number=

Number of operations(get and set) to execute for the +given test. Default 1000000.

+
+
-t, --time=

How long the test to run, suffix: s-seconds, m-minutes, h-hours, +d-days e.g.: --time=2h.

+
+
-F, --cfg_cmd=

Load the configure file to get command,key and value distribution list.

+
+
-w, --win_size=

Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k. +Default 10k.

+
+
-X, --fixed_size=

Fixed length of value.

+
+
-v, --verify=

The proportion of date verification, e.g.: --verify=0.01

+
+
-d, --division=

Number of keys to multi-get once. Default 1, means single get.

+
+
-S, --stat_freq=

Frequency of dumping statistic information. suffix: s-seconds, +m-minutes, e.g.: --resp_freq=10s.

+
+
-e, --exp_verify=

The proportion of objects with expire time, e.g.: --exp_verify=0.01. +Default no object with expire time

+
+
-o, --overwrite=

The proportion of objects need overwrite, e.g.: --overwrite=0.01. +Default never overwrite object.

+
+
+
+
-R, --reconnect
+

Reconnect tests, when connection is closed it will be reconnected.

+
+
-U, --udp
+

UDP tests, default memaslap uses TCP, TCP port and UDP port of +server must be same.

+
+
-a, --facebook
+

Whether it enables facebook test feature, set with TCP and multi-get with UDP.

+
+
-B, --binary
+

Whether it enables binary protocol. Default with ASCII protocol.

+
+
+
+
-P, --tps=

Expected throughput, suffix: K, e.g.: --tps=10k.

+
+
-p, --rep_write=

The first nth servers can write data, e.g.: --rep_write=2.

+
+
+
+
-b, --verbose
+

Whether it outputs detailed information when verification fails.

+
+
-h, --help
+

Display this message and then exit.

+
+
-V, --version
+

Display the version of the application and then exit.

+
+
+
+
+

EXAMPLES

+

memaslap -s 127.0.0.1:11211 -S 5s

+

memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k

+

memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m

+

memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2

+
+
+

NOTES

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+

This is a contributed program.

+

This program doesn't follow the standard flag/option scheme.

+
+
+

SEE ALSO

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memcapable.html b/bin/memcapable.html new file mode 100644 index 000000000..033613558 --- /dev/null +++ b/bin/memcapable.html @@ -0,0 +1,202 @@ + + + + + + + memcapable — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memcapable

+
+

SYNOPSIS

+

memcapable [options]

+

Check a memcached server's capabilities and compatibility.

+
+
+

DESCRIPTION

+

memcapable connects to the specified memcached server and tries to +determine its capabilities by running various commands and verifying the response.

+
+
+

OPTIONS

+
+
+-h hostname
+

Specify the hostname to connect to. The default is localhost.

+
+ +
+
+-p port
+

Specify the port number to connect to. The default is 11211.

+
+ +
+
+-c
+

abort(3) when detecting an error from the server.

+
+ +
+
+-v
+

Print out the comparison when it detects an error from the server.

+
+ +
+
+-t n
+

Set the timeout for an IO operation to/from the server to n seconds.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+

CONTRIBUTED PROGRAM

+

This is a contributed program.

+

This program doesn't follow the standard flag/option scheme.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memcat.html b/bin/memcat.html new file mode 100644 index 000000000..c3b5b624d --- /dev/null +++ b/bin/memcat.html @@ -0,0 +1,271 @@ + + + + + + + memcat — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memcat

+
+

SYNOPSIS

+

memcat [options] key [key...]

+

Read and output the value of one key or the values of a set of keys.

+
+
+

DESCRIPTION

+

memcat reads and outputs the value of a single or a set of keys +stored in a memcached(1) server.

+

If any key is not found an error is returned.

+

It is similar to the standard UNIX cat(1) utility.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-F|--flags
+

Display key's flags.

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-f|--file [<file>]
+

Output to file instead of standard output.

+

NOTE: defaults to <key> if no argument was provided.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memcp.html b/bin/memcp.html new file mode 100644 index 000000000..b15c631ce --- /dev/null +++ b/bin/memcp.html @@ -0,0 +1,313 @@ + + + + + + + memcp — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memcp

+
+

SYNOPSIS

+

memcp [options] --servers <hostname[:port]...> <file...>

+

Copy files to a collection of memcached servers.

+
+
+

DESCRIPTION

+

memcp copies one or more files into memcached(1) servers. +It is similar to the standard UNIX cp(1) command.

+

The key names will be the names of the files, without any directory path.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-F|--flags <number>
+

Use number as key's flags.

+
+ +
+
+-U|--udp
+

Enable UDP operation mode.

+
+ +
+
+-S|--set
+

Issue SET command(s). This is the default mode. +See also -A|--add and -R|--replace.

+
+ +
+
+-A|--add
+

Issue ADD command(s).

+
+ +
+
+-R|--replace
+

Issue REPLACE command(s).

+
+ +
+
+-.|--basename
+

Use basename of path as key (default).

+
+ +
+
+-+|--relative
+

Use relative path (as passed), instead of basename only.

+
+ +
+
+-/|--absolute
+

Use absolute path (real path), instead of basename only.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memdump.html b/bin/memdump.html new file mode 100644 index 000000000..eca9ba7a7 --- /dev/null +++ b/bin/memdump.html @@ -0,0 +1,257 @@ + + + + + + + memdump — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memdump

+
+

SYNOPSIS

+

memdump [options]

+

Dump a list of keys from a server.

+
+
+

DESCRIPTION

+

memdump dumps a list of "keys" from all servers that +it is told to fetch from. Because memcached does not guarantee to +provide all keys it is not possible to get a complete "dump".

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-f|--file [<file>]
+

Output to file instead of standard output.

+

NOTE: defaults to <key> if no argument was provided.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memerror.html b/bin/memerror.html new file mode 100644 index 000000000..60b3ce782 --- /dev/null +++ b/bin/memerror.html @@ -0,0 +1,207 @@ + + + + + + + memerror — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memerror

+
+

SYNOPSIS

+

memerror [options] <error code>

+

Translate a memcached error code into a string.

+
+
+

DESCRIPTION

+

memerror translates an error code from libmemcached into a human +readable string.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memexist.html b/bin/memexist.html new file mode 100644 index 000000000..f95ab1fd3 --- /dev/null +++ b/bin/memexist.html @@ -0,0 +1,255 @@ + + + + + + + memexist — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memexist

+
+

SYNOPSIS

+

memexist [options] <key>

+

Check for the existence of a key.

+
+
+

DESCRIPTION

+

memexist checks for the existence of a key within a cluster.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memflush.html b/bin/memflush.html new file mode 100644 index 000000000..b71a7dbb7 --- /dev/null +++ b/bin/memflush.html @@ -0,0 +1,280 @@ + + + + + + + memflush — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memflush

+
+

SYNOPSIS

+

memflush [options]

+

Reset a server or list of servers

+
+
+

DESCRIPTION

+

memflush resets the contents of memcached(1) servers.

+
+

Warning

+

This means that all data in the specified servers will be deleted.

+
+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ +
+

Note

+

Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist.

+

Quoting the memcached protocol documentation, it states:

+
+

Its effect is to invalidate all +existing items immediately (by default) or after the expiration +specified. After invalidation none of the items will be returned in +response to a retrieval command (unless it's stored again under the +same key after flush_all has invalidated the items).

+

The most precise +definition of what flush_all does is the following: it causes all +items whose update time is earlier than the time at which flush_all +was set to be executed to be ignored for retrieval purposes.

+

The intent of flush_all with a delay, was that in a setting where you +have a pool of memcached servers, and you need to flush all content, +you have the option of not resetting all memcached servers at the +same time (which could e.g. cause a spike in database load with all +clients suddenly needing to recreate content that would otherwise +have been found in the memcached daemon).

+
+
+
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memparse.html b/bin/memparse.html new file mode 100644 index 000000000..a0a1da0fc --- /dev/null +++ b/bin/memparse.html @@ -0,0 +1,168 @@ + + + + + + + memparse — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memparse

+
+

SYNOPSIS

+

memparse <option string>

+

Parse and validate an option string.

+
+
+

DESCRIPTION

+

memparse can be used to validate an option string.

+
+
+

OPTIONS

+

None.

+
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memping.html b/bin/memping.html new file mode 100644 index 000000000..8ceb52ed6 --- /dev/null +++ b/bin/memping.html @@ -0,0 +1,223 @@ + + + + + + + memping — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memping

+
+

SYNOPSIS

+

memping [options] [server]

+

Test for availability of a server

+
+
+

DESCRIPTION

+

memping can be used to ping a memcached server to see if it is accepting connections.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memrm.html b/bin/memrm.html new file mode 100644 index 000000000..215c764db --- /dev/null +++ b/bin/memrm.html @@ -0,0 +1,261 @@ + + + + + + + memrm — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memrm

+
+

SYNOPSIS

+

memrm [options] <key ...>

+

Remove key(s) from a collection of memcached servers

+
+
+

DESCRIPTION

+

memrm removes items, specified by key, from memcached(1) servers.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memslap.html b/bin/memslap.html new file mode 100644 index 000000000..a6ce291d5 --- /dev/null +++ b/bin/memslap.html @@ -0,0 +1,299 @@ + + + + + + + memslap — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memslap

+
+

SYNOPSIS

+

memslap [options]

+

Load testing and benchmarking a server

+
+
+

DESCRIPTION

+

memslap is a load generation and benchmark tool for memcached(1) +servers. It generates configurable workload such as threads, concurrencies, connections, +run time, overwrite, miss rate, key size, value size, get/set proportion, expected +throughput, and so on.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-U|--udp
+

Enable UDP operation mode.

+
+ +
+
+-R|--noreply
+

Enable the NOREPLY behavior for storage commands.

+
+ +
+
+-F|--flush
+

Flush all servers prior test.

+
+ +
+
+-t|--test <arg>
+

Test to perform (options: get, mget, set; default: get).

+
+ +
+
+-c|--concurrency <num>
+

Concurrency (number of threads to start; default: 1).

+
+ +
+
+-e|--execute-number <num>
+

Number of times to execute the tests (default: 10000).

+
+ +
+
+-l|--initial-load <num>
+

Number of keys to load before executing tests (default: 10000).

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memstat.html b/bin/memstat.html new file mode 100644 index 000000000..15bfc3f1a --- /dev/null +++ b/bin/memstat.html @@ -0,0 +1,285 @@ + + + + + + + memstat — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memstat

+
+

SYNOPSIS

+

memstat [options] [stat args]

+

Gather statistics from a server

+
+
+

DESCRIPTION

+

memstat dumps the state of memcached(1) servers. +It prints all data to stdout.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-A|--args <stat>
+

Stat args.

+

DEPRECATED: use positional arguments.

+
+ +
+
+-a|--analyze [<arg>]
+

Analyze and print differences of a server cluster. +A memory and uptime comparison is performed by default.

+

Options:

+
+
--analyze[=default]

Memory and uptime comparison.

+
+
+
+
--analyze=latency
+

Network latency comparison.

+
+
+
+ +
+
+-S|-server-version
+

Obtain and print server version(s) only.

+
+ +
+
+--iterations
+

Iteration count of GETs sent by the latency test (default: 1000).

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/memtouch.html b/bin/memtouch.html new file mode 100644 index 000000000..2a73ae4a2 --- /dev/null +++ b/bin/memtouch.html @@ -0,0 +1,260 @@ + + + + + + + memtouch — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

memtouch

+
+

SYNOPSIS

+

memtouch [options] <key>

+
+
+

DESCRIPTION

+

memtouch does a "touch" on the specified key.

+
+
+

OPTIONS

+
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ +
+
+

ENVIRONMENT

+
+
+MEMCACHED_SERVERS
+

Specify a list of servers.

+
+ +
+
+

NOTES

+
+

PROGRAM PREFIX

+

The prefix of this program is variable, i.e. it can be configured at build time.

+

Usually the client programs of libmemcached-awesome are prefixed with mem, like memcat or memcp.

+

It can be configured, though, to replace the prefix with something else like mc, in case of that, +the client programs of libmemcached-awesome would be called mccat, mccp, etc. respectively.

+
+
+
+

SEE ALSO

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/all.html b/bin/options/all.html new file mode 100644 index 000000000..6b0f5acdb --- /dev/null +++ b/bin/options/all.html @@ -0,0 +1,125 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/common.html b/bin/options/common.html new file mode 100644 index 000000000..fdec51016 --- /dev/null +++ b/bin/options/common.html @@ -0,0 +1,131 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/common_get.html b/bin/options/common_get.html new file mode 100644 index 000000000..ecd07094b --- /dev/null +++ b/bin/options/common_get.html @@ -0,0 +1,185 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/common_set.html b/bin/options/common_set.html new file mode 100644 index 000000000..8f3a4d29f --- /dev/null +++ b/bin/options/common_set.html @@ -0,0 +1,198 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-h|--help
+

Display help.

+
+ +
+
+-V|--version
+

Display version.

+
+ +
+
+-q|--quiet
+

Operate quietly.

+
+ +
+
+-v|--verbose
+

Operate more verbosely.

+
+ +
+
+-d|--debug
+

See -v|--verbose.

+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/expire.html b/bin/options/expire.html new file mode 100644 index 000000000..249b52514 --- /dev/null +++ b/bin/options/expire.html @@ -0,0 +1,119 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-e|--expire <expiration>
+

Use expiration seconds (or a UNIX timestamp).

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/file_out.html b/bin/options/file_out.html new file mode 100644 index 000000000..94e103c51 --- /dev/null +++ b/bin/options/file_out.html @@ -0,0 +1,120 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-f|--file [<file>]
+

Output to file instead of standard output.

+

NOTE: defaults to <key> if no argument was provided.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/flag.html b/bin/options/flag.html new file mode 100644 index 000000000..695eb5bdf --- /dev/null +++ b/bin/options/flag.html @@ -0,0 +1,211 @@ + + + + + + + + + + + <no title> — libmemcached-awesome 1.1.3 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+
+--flag <number>
+

Use number as flag.

+
+ + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/bin/options/flags_noarg.html b/bin/options/flags_noarg.html new file mode 100644 index 000000000..f8d0510eb --- /dev/null +++ b/bin/options/flags_noarg.html @@ -0,0 +1,119 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-F|--flags
+

Display key's flags.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/flags_reqarg.html b/bin/options/flags_reqarg.html new file mode 100644 index 000000000..2a97009a7 --- /dev/null +++ b/bin/options/flags_reqarg.html @@ -0,0 +1,119 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-F|--flags <number>
+

Use number as key's flags.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/hash.html b/bin/options/hash.html new file mode 100644 index 000000000..a9a3e3811 --- /dev/null +++ b/bin/options/hash.html @@ -0,0 +1,120 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-H|--hash <algorithm>
+

Use algorithm as key hash algo. +See memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/net.html b/bin/options/net.html new file mode 100644 index 000000000..61f644d00 --- /dev/null +++ b/bin/options/net.html @@ -0,0 +1,131 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-s|--servers <list of servers>
+

Specify the list of servers as hostname[:port][,hostname[:port]...].

+
+ +
+
+-n|--non-blocking
+

Enable non-blocking operations.

+
+ +
+
+-N|--tcp-nodelay
+

Disable Nagle's algorithm.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/proto.html b/bin/options/proto.html new file mode 100644 index 000000000..6ba661b7c --- /dev/null +++ b/bin/options/proto.html @@ -0,0 +1,125 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-b|--binary
+

Enable binary protocol.

+
+ +
+
+-B|--buffer
+

Buffer requests.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/sasl.html b/bin/options/sasl.html new file mode 100644 index 000000000..ecad7793b --- /dev/null +++ b/bin/options/sasl.html @@ -0,0 +1,125 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-u|--username <username>
+

Use username for SASL authentication.

+
+ +
+
+-p|--password <password>
+

Use password for SASL authentication.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/bin/options/udp.html b/bin/options/udp.html new file mode 100644 index 000000000..6c5be22da --- /dev/null +++ b/bin/options/udp.html @@ -0,0 +1,119 @@ + + + + + + + <no title> — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+
+-U|--udp
+

Enable UDP operation mode.

+
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/changelogs.html b/changelogs.html new file mode 100644 index 000000000..c53d68c52 --- /dev/null +++ b/changelogs.html @@ -0,0 +1,147 @@ + + + + + + + Change Logs — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/contrib/CMakeLists.txt b/contrib/CMakeLists.txt deleted file mode 100644 index ad1ab41ab..000000000 --- a/contrib/CMakeLists.txt +++ /dev/null @@ -1 +0,0 @@ -add_subdirectory(bin) diff --git a/contrib/bin/CMakeLists.txt b/contrib/bin/CMakeLists.txt deleted file mode 100644 index 0cc3ab2a3..000000000 --- a/contrib/bin/CMakeLists.txt +++ /dev/null @@ -1 +0,0 @@ -add_subdirectory(memaslap) diff --git a/contrib/bin/memaslap/CMakeLists.txt b/contrib/bin/memaslap/CMakeLists.txt deleted file mode 100644 index 49a852c60..000000000 --- a/contrib/bin/memaslap/CMakeLists.txt +++ /dev/null @@ -1,36 +0,0 @@ -if(ENABLE_MEMASLAP AND CMAKE_USE_PTHREADS_INIT) - - include(CheckAtomics) - - check_type(cpu_set_t sched.h) - check_symbol(getline stdio.h) - check_symbol(_SC_NPROCESSORS_ONLN unistd.h) - - check_dependency(LIBEVENT event) - - if(HAVE_LIBEVENT AND HAVE_ATOMICS) - add_executable(aslap - ms_main.c - ms_conn.c - ms_setting.c - ms_sigsegv.c - ms_stats.c - ms_task.c - ms_thread.c) - target_include_directories(aslap PRIVATE - ${CMAKE_SOURCE_DIR}/include - ${CMAKE_BINARY_DIR}/include - ${CMAKE_SOURCE_DIR}/src - ${CMAKE_BINARY_DIR}/src - ${CMAKE_BINARY_DIR}) - target_link_libraries(aslap PRIVATE libmemcached Threads::Threads ${LIBEVENT} m) - set_target_properties(aslap PROPERTIES C_STANDARD 11 OUTPUT_NAME ${CLIENT_PREFIX}aslap) - if(CMAKE_INSTALL_RPATH) - set_target_properties(aslap PROPERTIES - INSTALL_RPATH ${CMAKE_INSTALL_RPATH}/../${CMAKE_INSTALL_LIBDIR}) - endif() - install(TARGETS aslap - RUNTIME COMPONENT bin DESTINATION ${CMAKE_INSTALL_BINDIR}) - endif() - -endif() diff --git a/contrib/bin/memaslap/ms_atomic.h b/contrib/bin/memaslap/ms_atomic.h deleted file mode 100644 index 0697ae238..000000000 --- a/contrib/bin/memaslap/ms_atomic.h +++ /dev/null @@ -1,64 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef CLIENTS_MS_ATOMIC_H -#define CLIENTS_MS_ATOMIC_H - -#include "mem_config.h" - -#if defined(__SUNPRO_C) || defined(HAVE_ATOMIC_ADD_NV) -# define ATOMIC volatile -# define _KERNEL -# include -# if SIZEOF_SIZE_T == 8 -# define atomic_add_size(X, Y) atomic_add_64((X), (Y)) -# else -# define atomic_add_size(X, Y) atomic_add_32((X), (Y)) -# endif -# undef _KERNEL - -#elif HAVE_C_STDATOMIC -# define ATOMIC _Atomic -# include -# define atomic_dec_32(X) atomic_fetch_sub(X,1) -# define atomic_add_32 atomic_fetch_add -# define atomic_add_32_nv(X,Y) (atomic_fetch_add(X,Y)+(Y)) -# define atomic_add_size atomic_fetch_add - -#elif HAVE_BUILTIN_ATOMIC -# define ATOMIC -# define atomic_dec_32(X) BUILTIN_ATOMIC_PREFIX ## _atomic_fetch_sub(X,1) -# define atomic_add_32 BUILTIN_ATOMIC_PREFIX ## _atomic_fetch_add -# define atomic_add_32_nv BUILTIN_ATOMIC_PREFIX ## _atomic_add_fetch(X,Y) -# define atomic_add_size BUILTIN_ATOMIC_PREFIX ## _atomic_fetch_add - -#elif HAVE_BUILTIN_SYNC -# define ATOMIC -# define atomic_dec_32(X) __sync_fetch_and_sub((X), 1) -# define atomic_add_32 __sync_fetch_and_add -# define atomic_add_32_nv __sync_add_and_fetch -# define atomic_add_size __sync_fetch_and_add - -#else -# warning "Atomic operators not found so memslap will not work correctly" -# define ATOMIC -# define atomic_dec_32(X) (--(*(X))) -# define atomic_add_32(X,Y) ((*(X))+=(Y)) -# define atomic_add_32_nv atomic_add_32 -# define atomic_add_size atomic_add_32 - -#endif - -#endif /* CLIENTS_MS_ATOMIC_H */ diff --git a/contrib/bin/memaslap/ms_conn.c b/contrib/bin/memaslap/ms_conn.c deleted file mode 100644 index 0c74fb91f..000000000 --- a/contrib/bin/memaslap/ms_conn.c +++ /dev/null @@ -1,2861 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#include -#include -#include -#include -#include -#include -#include -#include - -#if defined(HAVE_ARPA_INET_H) -# include -#endif - -#if defined(HAVE_SYS_TIME_H) -# include -#endif -#include - -#include "ms_setting.h" -#include "ms_thread.h" -#include "ms_atomic.h" - -#ifdef linux -/* /usr/include/netinet/in.h defines macros from ntohs() to _bswap_nn to - * optimize the conversion functions, but the prototypes generate warnings - * from gcc. The conversion methods isn't the bottleneck for my app, so - * just remove the warnings by undef'ing the optimization .. - */ -# undef ntohs -# undef ntohl -# undef htons -# undef htonl -#endif - -/* for network write */ -#define TRANSMIT_COMPLETE 0 -#define TRANSMIT_INCOMPLETE 1 -#define TRANSMIT_SOFT_ERROR 2 -#define TRANSMIT_HARD_ERROR 3 - -/* for generating key */ -#define KEY_PREFIX_BASE 0x1010101010101010 /* not include ' ' '\r' '\n' '\0' */ -#define KEY_PREFIX_MASK 0x1010101010101010 - -/* For parse the value length return by server */ -#define KEY_TOKEN 1 -#define VALUELEN_TOKEN 3 - -/* global increasing counter, to ensure the key prefix unique */ -static uint64_t key_prefix_seq = KEY_PREFIX_BASE; - -/* global increasing counter, generating request id for UDP */ -static ATOMIC uint32_t udp_request_id = 0; - -extern pthread_key_t ms_thread_key; - -/* generate upd request id */ -static uint32_t ms_get_udp_request_id(void); - -/* connect initialize */ -static void ms_task_init(ms_conn_t *c); -static int ms_conn_udp_init(ms_conn_t *c, const bool is_udp); -static int ms_conn_sock_init(ms_conn_t *c); -static int ms_conn_event_init(ms_conn_t *c); -static int ms_conn_init(ms_conn_t *c, const int init_state, const int read_buffer_size, - const bool is_udp); -static void ms_warmup_num_init(ms_conn_t *c); -static int ms_item_win_init(ms_conn_t *c); - -/* connection close */ -void ms_conn_free(ms_conn_t *c); -static void ms_conn_close(ms_conn_t *c); - -/* create network connection */ -static int ms_new_socket(struct addrinfo *ai); -static void ms_maximize_sndbuf(const int sfd); -static int ms_network_connect(ms_conn_t *c, char *srv_host_name, const int srv_port, - const bool is_udp, int *ret_sfd); -static int ms_reconn(ms_conn_t *c); - -/* read and parse */ -static int ms_tokenize_command(char *command, token_t *tokens, const int max_tokens); -static int ms_ascii_process_line(ms_conn_t *c, char *command); -static int ms_try_read_line(ms_conn_t *c); -static int ms_sort_udp_packet(ms_conn_t *c, char *buf, int rbytes); -static int ms_udp_read(ms_conn_t *c, char *buf, int len); -static int ms_try_read_network(ms_conn_t *c); -static void ms_verify_value(ms_conn_t *c, ms_mlget_task_item_t *mlget_item, char *value, int vlen); -static void ms_ascii_complete_nread(ms_conn_t *c); -static void ms_bin_complete_nread(ms_conn_t *c); -static void ms_complete_nread(ms_conn_t *c); - -/* send functions */ -static int ms_add_msghdr(ms_conn_t *c); -static int ms_ensure_iov_space(ms_conn_t *c); -static int ms_add_iov(ms_conn_t *c, const void *buf, int len); -static int ms_build_udp_headers(ms_conn_t *c); -static int ms_transmit(ms_conn_t *c); - -/* status adjustment */ -static void ms_conn_shrink(ms_conn_t *c); -static void ms_conn_set_state(ms_conn_t *c, int state); -static bool ms_update_event(ms_conn_t *c, const int new_flags); -static uint32_t ms_get_rep_sock_index(ms_conn_t *c, int cmd); -static uint32_t ms_get_next_sock_index(ms_conn_t *c); -static int ms_update_conn_sock_event(ms_conn_t *c); -static bool ms_need_yield(ms_conn_t *c); -static void ms_update_start_time(ms_conn_t *c); - -/* main loop */ -static void ms_drive_machine(ms_conn_t *c); -void ms_event_handler(const int fd, const short which, void *arg); - -/* ascii protocol */ -static int ms_build_ascii_write_buf_set(ms_conn_t *c, ms_task_item_t *item); -static int ms_build_ascii_write_buf_get(ms_conn_t *c, ms_task_item_t *item); -static int ms_build_ascii_write_buf_mlget(ms_conn_t *c); - -/* binary protocol */ -static int ms_bin_process_response(ms_conn_t *c); -static void ms_add_bin_header(ms_conn_t *c, uint8_t opcode, uint8_t hdr_len, uint16_t key_len, - uint32_t body_len); -static void ms_add_key_to_iov(ms_conn_t *c, ms_task_item_t *item); -static int ms_build_bin_write_buf_set(ms_conn_t *c, ms_task_item_t *item); -static int ms_build_bin_write_buf_get(ms_conn_t *c, ms_task_item_t *item); -static int ms_build_bin_write_buf_mlget(ms_conn_t *c); - -/** - * each key has two parts, prefix and suffix. The suffix is a - * string random get form the character table. The prefix is a - * uint64_t variable. And the prefix must be unique. we use the - * prefix to identify a key. And the prefix can't include - * character ' ' '\r' '\n' '\0'. - * - * @return uint64_t - */ -uint64_t ms_get_key_prefix(void) { - uint64_t key_prefix; - - pthread_mutex_lock(&ms_global.seq_mutex); - key_prefix_seq |= KEY_PREFIX_MASK; - key_prefix = key_prefix_seq; - key_prefix_seq++; - pthread_mutex_unlock(&ms_global.seq_mutex); - - return key_prefix; -} /* ms_get_key_prefix */ - -/** - * get an unique udp request id - * - * @return an unique UDP request id - */ -static uint32_t ms_get_udp_request_id(void) { - return atomic_add_32_nv(&udp_request_id, 1); -} - -/** - * initialize current task structure - * - * @param c, pointer of the concurrency - */ -static void ms_task_init(ms_conn_t *c) { - c->curr_task.cmd = CMD_NULL; - c->curr_task.item = 0; - c->curr_task.verify = false; - c->curr_task.finish_verify = true; - c->curr_task.get_miss = true; - - c->curr_task.get_opt = 0; - c->curr_task.set_opt = 0; - c->curr_task.cycle_undo_get = 0; - c->curr_task.cycle_undo_set = 0; - c->curr_task.verified_get = 0; - c->curr_task.overwrite_set = 0; -} /* ms_task_init */ - -/** - * initialize udp for the connection structure - * - * @param c, pointer of the concurrency - * @param is_udp, whether it's udp - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_conn_udp_init(ms_conn_t *c, const bool is_udp) { - c->hdrbuf = 0; - c->rudpbuf = 0; - c->udppkt = 0; - - c->rudpsize = UDP_DATA_BUFFER_SIZE; - c->hdrsize = 0; - - c->rudpbytes = 0; - c->packets = 0; - c->recvpkt = 0; - c->pktcurr = 0; - c->ordcurr = 0; - - c->udp = is_udp; - - if (c->udp || (!c->udp && ms_setting.facebook_test)) { - c->rudpbuf = (char *) malloc((size_t) c->rudpsize); - c->udppkt = (ms_udppkt_t *) malloc(MAX_UDP_PACKET * sizeof(ms_udppkt_t)); - - if ((c->rudpbuf == NULL) || (c->udppkt == NULL)) { - if (c->rudpbuf) - free(c->rudpbuf); - if (c->udppkt) - free(c->udppkt); - fprintf(stderr, "malloc()\n"); - return -1; - } - memset(c->udppkt, 0, MAX_UDP_PACKET * sizeof(ms_udppkt_t)); - } - - return EXIT_SUCCESS; -} /* ms_conn_udp_init */ - -/** - * initialize the connection structure - * - * @param c, pointer of the concurrency - * @param init_state, (conn_read, conn_write, conn_closing) - * @param read_buffer_size - * @param is_udp, whether it's udp - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_conn_init(ms_conn_t *c, const int init_state, const int read_buffer_size, - const bool is_udp) { - assert(c); - - c->rbuf = c->wbuf = 0; - c->iov = 0; - c->msglist = 0; - - c->rsize = read_buffer_size; - c->wsize = WRITE_BUFFER_SIZE; - c->iovsize = IOV_LIST_INITIAL; - c->msgsize = MSG_LIST_INITIAL; - - /* for replication, each connection need connect all the server */ - if (ms_setting.rep_write_srv > 0) { - c->total_sfds = ms_setting.srv_cnt * ms_setting.sock_per_conn; - } else { - c->total_sfds = ms_setting.sock_per_conn; - } - c->alive_sfds = 0; - - c->rbuf = (char *) malloc((size_t) c->rsize); - c->wbuf = (char *) malloc((size_t) c->wsize); - c->iov = (struct iovec *) malloc(sizeof(struct iovec) * (size_t) c->iovsize); - c->msglist = (struct msghdr *) malloc(sizeof(struct msghdr) * (size_t) c->msgsize); - if (ms_setting.mult_key_num > 1) { - c->mlget_task.mlget_item = (ms_mlget_task_item_t *) malloc(sizeof(ms_mlget_task_item_t) - * (size_t) ms_setting.mult_key_num); - } - c->tcpsfd = (int *) malloc((size_t) c->total_sfds * sizeof(int)); - - if ((c->rbuf == NULL) || (c->wbuf == NULL) || (c->iov == NULL) || (c->msglist == NULL) - || (c->tcpsfd == NULL) - || ((ms_setting.mult_key_num > 1) && (c->mlget_task.mlget_item == NULL))) - { - if (c->rbuf) - free(c->rbuf); - if (c->wbuf) - free(c->wbuf); - if (c->iov) - free(c->iov); - if (c->msglist) - free(c->msglist); - if (c->mlget_task.mlget_item) - free(c->mlget_task.mlget_item); - if (c->tcpsfd) - free(c->tcpsfd); - fprintf(stderr, "malloc()\n"); - return -1; - } - - c->state = init_state; - c->rvbytes = 0; - c->rbytes = 0; - c->rcurr = c->rbuf; - c->wcurr = c->wbuf; - c->iovused = 0; - c->msgcurr = 0; - c->msgused = 0; - c->cur_idx = c->total_sfds; /* default index is a invalid value */ - - c->ctnwrite = false; - c->readval = false; - c->change_sfd = false; - - c->precmd.cmd = c->currcmd.cmd = CMD_NULL; - c->precmd.isfinish = true; /* default the previous command finished */ - c->currcmd.isfinish = false; - c->precmd.retstat = c->currcmd.retstat = MCD_FAILURE; - c->precmd.key_prefix = c->currcmd.key_prefix = 0; - - c->mlget_task.mlget_num = 0; - c->mlget_task.value_index = -1; /* default invalid value */ - - if (ms_setting.binary_prot_) { - c->protocol = binary_prot; - } else { - c->protocol = ascii_prot; - } - - /* initialize udp */ - if (ms_conn_udp_init(c, is_udp)) { - return -1; - } - - /* initialize task */ - ms_task_init(c); - - if (!(ms_setting.facebook_test && is_udp)) { - atomic_add_32(&ms_stats.active_conns, 1); - } - - return EXIT_SUCCESS; -} /* ms_conn_init */ - -/** - * when doing 100% get operation, it could preset some objects - * to warmup the server. this function is used to initialize the - * number of the objects to preset. - * - * @param c, pointer of the concurrency - */ -static void ms_warmup_num_init(ms_conn_t *c) { - /* no set operation, preset all the items in the window */ - if (ms_setting.cmd_distr[CMD_SET].cmd_prop < PROP_ERROR) { - c->warmup_num = c->win_size; - c->remain_warmup_num = c->warmup_num; - } else { - c->warmup_num = 0; - c->remain_warmup_num = c->warmup_num; - } -} /* ms_warmup_num_init */ - -/** - * each connection has an item window, this function initialize - * the window. The window is used to generate task. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_item_win_init(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - int exp_cnt = 0; - - c->win_size = (int) ms_setting.win_size; - c->set_cursor = 0; - c->exec_num = ms_thread->thread_ctx->exec_num_perconn; - c->remain_exec_num = c->exec_num; - - c->item_win = (ms_task_item_t *) malloc(sizeof(ms_task_item_t) * (size_t) c->win_size); - if (c->item_win == NULL) { - fprintf(stderr, "Can't allocate task item array for conn.\n"); - return -1; - } - memset(c->item_win, 0, sizeof(ms_task_item_t) * (size_t) c->win_size); - - for (int i = 0; i < c->win_size; i++) { - c->item_win[i].key_size = (int) ms_setting.distr[i].key_size; - c->item_win[i].key_prefix = ms_get_key_prefix(); - c->item_win[i].key_suffix_offset = ms_setting.distr[i].key_offset; - c->item_win[i].value_size = (int) ms_setting.distr[i].value_size; - c->item_win[i].value_offset = INVALID_OFFSET; /* default in invalid offset */ - c->item_win[i].client_time = 0; - - /* set expire time base on the proportion */ - if (exp_cnt < ms_setting.exp_ver_per * i) { - c->item_win[i].exp_time = FIXED_EXPIRE_TIME; - exp_cnt++; - } else { - c->item_win[i].exp_time = 0; - } - } - - ms_warmup_num_init(c); - - return EXIT_SUCCESS; -} /* ms_item_win_init */ - -/** - * each connection structure can include one or more sock - * handlers. this function create these socks and connect the - * server(s). - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_conn_sock_init(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - uint32_t i; - int ret_sfd; - uint32_t srv_idx = 0; - - assert(c); - assert(c->tcpsfd); - - for (i = 0; i < c->total_sfds; i++) { - ret_sfd = 0; - if (ms_setting.rep_write_srv > 0) { - /* for replication, each connection need connect all the server */ - srv_idx = i % ms_setting.srv_cnt; - } else { - /* all the connections in a thread connects the same server */ - srv_idx = ms_thread->thread_ctx->srv_idx; - } - - if (ms_network_connect(c, ms_setting.servers[srv_idx].srv_host_name, - ms_setting.servers[srv_idx].srv_port, ms_setting.udp, &ret_sfd) -) - { - break; - } - - if (i == 0) { - c->sfd = ret_sfd; - } - - if (!ms_setting.udp) { - c->tcpsfd[i] = ret_sfd; - } - - c->alive_sfds++; - } - - /* initialize udp sock handler if necessary */ - if (ms_setting.facebook_test) { - ret_sfd = 0; - if (ms_network_connect(c, ms_setting.servers[srv_idx].srv_host_name, - ms_setting.servers[srv_idx].srv_port, true, &ret_sfd) -) - { - c->udpsfd = 0; - } else { - c->udpsfd = ret_sfd; - } - } - - if ((i != c->total_sfds) || (ms_setting.facebook_test && (c->udpsfd == 0))) { - if (ms_setting.udp) { - close(c->sfd); - } else { - for (uint32_t j = 0; j < i; j++) { - close(c->tcpsfd[j]); - } - } - - if (c->udpsfd) { - close(c->udpsfd); - } - - return -1; - } - - return EXIT_SUCCESS; -} /* ms_conn_sock_init */ - -/** - * each connection is managed by libevent, this function - * initialize the event of the connection structure. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_conn_event_init(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - short event_flags = EV_WRITE | EV_PERSIST; - - event_set(&c->event, c->sfd, event_flags, ms_event_handler, (void *) c); - event_base_set(ms_thread->base, &c->event); - c->ev_flags = event_flags; - - if (event_add(&c->event, NULL) == -1) { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_conn_event_init */ - -/** - * setup a connection, each connection structure of each - * thread must call this function to initialize. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_setup_conn(ms_conn_t *c) { - if (ms_item_win_init(c)) { - return -1; - } - - if (ms_conn_init(c, conn_write, DATA_BUFFER_SIZE, ms_setting.udp)) { - return -1; - } - - if (ms_conn_sock_init(c)) { - return -1; - } - - if (ms_conn_event_init(c)) { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_setup_conn */ - -/** - * Frees a connection. - * - * @param c, pointer of the concurrency - */ -void ms_conn_free(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - if (c) { - if (c->hdrbuf) - free(c->hdrbuf); - if (c->msglist) - free(c->msglist); - if (c->rbuf) - free(c->rbuf); - if (c->wbuf) - free(c->wbuf); - if (c->iov) - free(c->iov); - if (c->mlget_task.mlget_item) - free(c->mlget_task.mlget_item); - if (c->rudpbuf) - free(c->rudpbuf); - if (c->udppkt) - free(c->udppkt); - if (c->item_win) - free(c->item_win); - if (c->tcpsfd) - free(c->tcpsfd); - - if (--ms_thread->nactive_conn == 0) { - free(ms_thread->conn); - } - } -} /* ms_conn_free */ - -/** - * close a connection - * - * @param c, pointer of the concurrency - */ -static void ms_conn_close(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - assert(c); - - /* delete the event, the socket and the connection */ - event_del(&c->event); - - for (uint32_t i = 0; i < c->total_sfds; i++) { - if (c->tcpsfd[i] > 0) { - close(c->tcpsfd[i]); - } - } - c->sfd = 0; - - if (ms_setting.facebook_test) { - close(c->udpsfd); - } - - atomic_dec_32(&ms_stats.active_conns); - - ms_conn_free(c); - - if (ms_setting.run_time == 0) { - pthread_mutex_lock(&ms_global.run_lock.lock); - ms_global.run_lock.count++; - pthread_cond_signal(&ms_global.run_lock.cond); - pthread_mutex_unlock(&ms_global.run_lock.lock); - } - - if (ms_thread->nactive_conn == 0) { - event_base_loopbreak(ms_thread->base); - } -} /* ms_conn_close */ - -/** - * create a new sock - * - * @param ai, server address information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_new_socket(struct addrinfo *ai) { - int sfd; - - if ((sfd = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol)) == -1) { - fprintf(stderr, "socket() error: %s.\n", strerror(errno)); - return -1; - } - - return sfd; -} /* ms_new_socket */ - -/** - * Sets a socket's send buffer size to the maximum allowed by the system. - * - * @param sfd, file descriptor of socket - */ -static void ms_maximize_sndbuf(const int sfd) { - socklen_t intsize = sizeof(int); - unsigned int last_good = 0; - unsigned int min, max, avg; - unsigned int old_size; - - /* Start with the default size. */ - if (getsockopt(sfd, SOL_SOCKET, SO_SNDBUF, &old_size, &intsize)) { - fprintf(stderr, "getsockopt(SO_SNDBUF)\n"); - return; - } - - /* Binary-search for the real maximum. */ - min = old_size; - max = MAX_SENDBUF_SIZE; - - while (min <= max) { - avg = ((unsigned int) (min + max)) / 2; - if (setsockopt(sfd, SOL_SOCKET, SO_SNDBUF, (void *) &avg, intsize) == 0) { - last_good = avg; - min = avg + 1; - } else { - max = avg - 1; - } - } - (void) last_good; -} /* ms_maximize_sndbuf */ - -/** - * socket connects the server - * - * @param c, pointer of the concurrency - * @param srv_host_name, the host name of the server - * @param srv_port, port of server - * @param is_udp, whether it's udp - * @param ret_sfd, the connected socket file descriptor - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_network_connect(ms_conn_t *c, char *srv_host_name, const int srv_port, - const bool is_udp, int *ret_sfd) { - int sfd; - struct linger ling = {0, 0}; - struct addrinfo *ai; - struct addrinfo *next; - struct addrinfo hints; - char port_buf[NI_MAXSERV]; - int error; - int success = 0; - - int flags = 1; - - /* - * the memset call clears nonstandard fields in some impementations - * that otherwise mess things up. - */ - memset(&hints, 0, sizeof(hints)); -#ifdef AI_ADDRCONFIG - hints.ai_flags = AI_PASSIVE | AI_ADDRCONFIG; -#else - hints.ai_flags = AI_PASSIVE; -#endif /* AI_ADDRCONFIG */ - if (is_udp) { - hints.ai_protocol = IPPROTO_UDP; - hints.ai_socktype = SOCK_DGRAM; - hints.ai_family = AF_INET; /* This left here because of issues with OSX 10.5 */ - } else { - hints.ai_family = AF_UNSPEC; - hints.ai_protocol = IPPROTO_TCP; - hints.ai_socktype = SOCK_STREAM; - } - - snprintf(port_buf, NI_MAXSERV, "%d", srv_port); - error = getaddrinfo(srv_host_name, port_buf, &hints, &ai); - if (error) { - if (error != EAI_SYSTEM) - fprintf(stderr, "getaddrinfo(): %s.\n", gai_strerror(error)); - else - perror("getaddrinfo()"); - - return -1; - } - - for (next = ai; next; next = next->ai_next) { - if ((sfd = ms_new_socket(next)) == -1) { - freeaddrinfo(ai); - return -1; - } - - setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, (void *) &flags, sizeof(flags)); - if (is_udp) { - ms_maximize_sndbuf(sfd); - } else { - setsockopt(sfd, SOL_SOCKET, SO_KEEPALIVE, (void *) &flags, sizeof(flags)); - setsockopt(sfd, SOL_SOCKET, SO_LINGER, (void *) &ling, sizeof(ling)); - setsockopt(sfd, IPPROTO_TCP, TCP_NODELAY, (void *) &flags, sizeof(flags)); - } - - if (is_udp) { - c->srv_recv_addr_size = sizeof(struct sockaddr); - memcpy(&c->srv_recv_addr, next->ai_addr, c->srv_recv_addr_size); - } else { - if (connect(sfd, next->ai_addr, next->ai_addrlen) == -1) { - close(sfd); - freeaddrinfo(ai); - return -1; - } - } - - if (((flags = fcntl(sfd, F_GETFL, 0)) < 0) || (fcntl(sfd, F_SETFL, flags | O_NONBLOCK) < 0)) { - fprintf(stderr, "setting O_NONBLOCK\n"); - close(sfd); - freeaddrinfo(ai); - return -1; - } - - if (ret_sfd) { - *ret_sfd = sfd; - } - - success++; - } - - freeaddrinfo(ai); - - /* Return zero if we detected no errors in starting up connections */ - return success == 0; -} /* ms_network_connect */ - -/** - * reconnect a disconnected sock - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_reconn(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - uint32_t srv_idx = 0; - uint32_t srv_conn_cnt = 0; - - if (ms_setting.rep_write_srv > 0) { - srv_idx = c->cur_idx % ms_setting.srv_cnt; - srv_conn_cnt = ms_setting.sock_per_conn * ms_setting.nconns; - } else { - srv_idx = ms_thread->thread_ctx->srv_idx; - srv_conn_cnt = ms_setting.nconns / ms_setting.srv_cnt; - } - - /* close the old socket handler */ - close(c->sfd); - c->tcpsfd[c->cur_idx] = 0; - - if (atomic_add_32_nv(&ms_setting.servers[srv_idx].disconn_cnt, 1) % srv_conn_cnt == 0) { - gettimeofday(&ms_setting.servers[srv_idx].disconn_time, NULL); - fprintf(stderr, "Server %s:%d disconnect\n", ms_setting.servers[srv_idx].srv_host_name, - ms_setting.servers[srv_idx].srv_port); - } - - if (ms_setting.rep_write_srv > 0) { - uint32_t i = 0; - - for (i = 0; i < c->total_sfds; i++) { - if (c->tcpsfd[i]) { - break; - } - } - - /* all socks disconnect */ - if (i == c->total_sfds) { - return -1; - } - } else { - do { - /* reconnect success, break the loop */ - if (ms_network_connect(c, ms_setting.servers[srv_idx].srv_host_name, - ms_setting.servers[srv_idx].srv_port, ms_setting.udp, &c->sfd) - == 0) - { - c->tcpsfd[c->cur_idx] = c->sfd; - if (atomic_add_32_nv(&ms_setting.servers[srv_idx].reconn_cnt, 1) % (uint32_t) srv_conn_cnt - == 0) { - gettimeofday(&ms_setting.servers[srv_idx].reconn_time, NULL); - int reconn_time = (int) (ms_setting.servers[srv_idx].reconn_time.tv_sec - - ms_setting.servers[srv_idx].disconn_time.tv_sec); - fprintf(stderr, "Server %s:%d reconnect after %ds\n", - ms_setting.servers[srv_idx].srv_host_name, ms_setting.servers[srv_idx].srv_port, - reconn_time); - } - break; - } - - if (ms_setting.rep_write_srv == 0 && c->total_sfds > 0) { - /* wait a second and reconnect */ - sleep(1); - } - } while (ms_setting.rep_write_srv == 0 && c->total_sfds > 0); - } - - if ((c->total_sfds > 1) && (c->tcpsfd[c->cur_idx] == 0)) { - c->sfd = 0; - c->alive_sfds--; - } - - return EXIT_SUCCESS; -} /* ms_reconn */ - -/** - * reconnect several disconnected socks in the connection - * structure, the ever-1-second timer of the thread will check - * whether some socks in the connections disconnect. if - * disconnect, reconnect the sock. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_reconn_socks(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - uint32_t srv_idx = 0; - int ret_sfd = 0; - uint32_t srv_conn_cnt = 0; - struct timeval cur_time; - - assert(c); - - if ((c->total_sfds == 1) || (c->total_sfds == c->alive_sfds)) { - return EXIT_SUCCESS; - } - - for (uint32_t i = 0; i < c->total_sfds; i++) { - if (c->tcpsfd[i] == 0) { - gettimeofday(&cur_time, NULL); - - /** - * For failover test of replication, reconnect the socks after - * it disconnects more than 5 seconds, Otherwise memslap will - * block at connect() function and the work threads can't work - * in this interval. - */ - if (cur_time.tv_sec - ms_setting.servers[srv_idx].disconn_time.tv_sec < 5) { - break; - } - - if (ms_setting.rep_write_srv > 0) { - srv_idx = i % ms_setting.srv_cnt; - srv_conn_cnt = ms_setting.sock_per_conn * ms_setting.nconns; - } else { - srv_idx = ms_thread->thread_ctx->srv_idx; - srv_conn_cnt = ms_setting.nconns / ms_setting.srv_cnt; - } - - if (ms_network_connect(c, ms_setting.servers[srv_idx].srv_host_name, - ms_setting.servers[srv_idx].srv_port, ms_setting.udp, &ret_sfd) - == 0) - { - c->tcpsfd[i] = ret_sfd; - c->alive_sfds++; - - if (atomic_add_32_nv(&ms_setting.servers[srv_idx].reconn_cnt, 1) % (uint32_t) srv_conn_cnt - == 0) { - gettimeofday(&ms_setting.servers[srv_idx].reconn_time, NULL); - int reconn_time = (int) (ms_setting.servers[srv_idx].reconn_time.tv_sec - - ms_setting.servers[srv_idx].disconn_time.tv_sec); - fprintf(stderr, "Server %s:%d reconnect after %ds\n", - ms_setting.servers[srv_idx].srv_host_name, ms_setting.servers[srv_idx].srv_port, - reconn_time); - } - } - } - } - - return EXIT_SUCCESS; -} /* ms_reconn_socks */ - -/** - * Tokenize the command string by replacing whitespace with '\0' and update - * the token array tokens with pointer to start of each token and length. - * Returns total number of tokens. The last valid token is the terminal - * token (value points to the first unprocessed character of the string and - * length zero). - * - * Usage example: - * - * while(ms_tokenize_command(command, ncommand, tokens, max_tokens) > 0) { - * for(int ix = 0; tokens[ix].length; ix++) { - * ... - * } - * ncommand = tokens[ix].value - command; - * command = tokens[ix].value; - * } - * - * @param command, the command string to token - * @param tokens, array to store tokens - * @param max_tokens, maximum tokens number - * - * @return int, the number of tokens - */ -static int ms_tokenize_command(char *command, token_t *tokens, const int max_tokens) { - char *s, *e; - int ntokens = 0; - - assert(command && tokens && max_tokens > 1); - - for (s = e = command; ntokens < max_tokens - 1; ++e) { - if (*e == ' ') { - if (s != e) { - tokens[ntokens].value = s; - tokens[ntokens].length = (size_t)(e - s); - ntokens++; - *e = '\0'; - } - s = e + 1; - } else if (*e == '\0') { - if (s != e) { - tokens[ntokens].value = s; - tokens[ntokens].length = (size_t)(e - s); - ntokens++; - } - - break; /* string end */ - } - } - - return ntokens; -} /* ms_tokenize_command */ - -/** - * parse the response of server. - * - * @param c, pointer of the concurrency - * @param command, the string responded by server - * - * @return int, if the command completed return EXIT_SUCCESS, else return - * -1 - */ -static int ms_ascii_process_line(ms_conn_t *c, char *command) { - int ret = 0; - int64_t value_len; - char *buffer = command; - - assert(c); - - /** - * for command get, we store the returned value into local buffer - * then continue in ms_complete_nread(). - */ - - switch (buffer[0]) { - case 'V': /* VALUE || VERSION */ - if (buffer[1] == 'A') /* VALUE */ { - token_t tokens[MAX_TOKENS]; - ms_tokenize_command(command, tokens, MAX_TOKENS); - errno = 0; - value_len = strtol(tokens[VALUELEN_TOKEN].value, NULL, 10); - if (errno) { - printf("<%d ERROR %s\n", c->sfd, strerror(errno)); - } - memcpy(&c->currcmd.key_prefix, tokens[KEY_TOKEN].value, sizeof(c->currcmd.key_prefix)); - - /* - * We read the \r\n into the string since not doing so is more - * cycles then the waster of memory to do so. - * - * We are null terminating through, which will most likely make - * some people lazy about using the return length. - */ - c->rvbytes = (int) (value_len + 2); - c->readval = true; - ret = -1; - } - - break; - - case 'O': /* OK */ - c->currcmd.retstat = MCD_SUCCESS; - break; - - case 'S': /* STORED STATS SERVER_ERROR */ - if (buffer[2] == 'A') /* STORED STATS */ { /* STATS*/ - c->currcmd.retstat = MCD_STAT; - } else if (buffer[1] == 'E') { - /* SERVER_ERROR */ - printf("<%d %s\n", c->sfd, buffer); - - c->currcmd.retstat = MCD_SERVER_ERROR; - } else if (buffer[1] == 'T') { - /* STORED */ - c->currcmd.retstat = MCD_STORED; - } else { - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - } - break; - - case 'D': /* DELETED DATA */ - if (buffer[1] == 'E') { - c->currcmd.retstat = MCD_DELETED; - } else { - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - } - - break; - - case 'N': /* NOT_FOUND NOT_STORED*/ - if (buffer[4] == 'F') { - c->currcmd.retstat = MCD_NOTFOUND; - } else if (buffer[4] == 'S') { - printf("<%d %s\n", c->sfd, buffer); - c->currcmd.retstat = MCD_NOTSTORED; - } else { - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - } - break; - - case 'E': /* PROTOCOL ERROR or END */ - if (buffer[1] == 'N') { - /* END */ - c->currcmd.retstat = MCD_END; - } else if (buffer[1] == 'R') { - printf("<%d ERROR\n", c->sfd); - c->currcmd.retstat = MCD_PROTOCOL_ERROR; - } else if (buffer[1] == 'X') { - c->currcmd.retstat = MCD_DATA_EXISTS; - printf("<%d %s\n", c->sfd, buffer); - } else { - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - } - break; - - case 'C': /* CLIENT ERROR */ - printf("<%d %s\n", c->sfd, buffer); - c->currcmd.retstat = MCD_CLIENT_ERROR; - break; - - default: - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - break; - } /* switch */ - - return ret; -} /* ms_ascii_process_line */ - -/** - * after one operation completes, reset the concurrency - * - * @param c, pointer of the concurrency - * @param timeout, whether it's timeout - */ -void ms_reset_conn(ms_conn_t *c, bool timeout) { - assert(c); - - if (c->udp) { - if ((c->packets > 0) && (c->packets < MAX_UDP_PACKET)) { - memset(c->udppkt, 0, sizeof(ms_udppkt_t) * (size_t) c->packets); - } - - c->packets = 0; - c->recvpkt = 0; - c->pktcurr = 0; - c->ordcurr = 0; - c->rudpbytes = 0; - } - c->currcmd.isfinish = true; - c->ctnwrite = false; - c->rbytes = 0; - c->rcurr = c->rbuf; - c->msgcurr = 0; - c->msgused = 0; - c->iovused = 0; - ms_conn_set_state(c, conn_write); - memcpy(&c->precmd, &c->currcmd, sizeof(ms_cmdstat_t)); /* replicate command state */ - - if (timeout) { - ms_drive_machine(c); - } -} /* ms_reset_conn */ - -/** - * if we have a complete line in the buffer, process it. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_try_read_line(ms_conn_t *c) { - if (c->protocol == binary_prot) { - /* Do we have the complete packet header? */ - if ((uint64_t) c->rbytes < sizeof(c->binary_header)) { - /* need more data! */ - return EXIT_SUCCESS; - } else { -#ifdef NEED_ALIGN - if (((long) (c->rcurr)) % 8) { - /* must realign input buffer */ - memmove(c->rbuf, c->rcurr, c->rbytes); - c->rcurr = c->rbuf; - if (settings.verbose) { - fprintf(stderr, "%d: Realign input buffer.\n", c->sfd); - } - } -#endif - protocol_binary_response_header *rsp; - rsp = (protocol_binary_response_header *) c->rcurr; - - c->binary_header = *rsp; - c->binary_header.response.extlen = rsp->response.extlen; - c->binary_header.response.keylen = ntohs(rsp->response.keylen); - c->binary_header.response.bodylen = ntohl(rsp->response.bodylen); - c->binary_header.response.status = ntohs(rsp->response.status); - - if (c->binary_header.response.magic != PROTOCOL_BINARY_RES) { - fprintf(stderr, "Invalid magic: %x\n", c->binary_header.response.magic); - ms_conn_set_state(c, conn_closing); - return EXIT_SUCCESS; - } - - /* process this complete response */ - if (ms_bin_process_response(c) == 0) { - /* current operation completed */ - ms_reset_conn(c, false); - return -1; - } else { - c->rbytes -= (int32_t) sizeof(c->binary_header); - c->rcurr += sizeof(c->binary_header); - } - } - } else { - char *el, *cont; - - assert(c); - assert(c->rcurr <= (c->rbuf + c->rsize)); - - if (c->rbytes == 0) - return EXIT_SUCCESS; - - el = memchr(c->rcurr, '\n', (size_t) c->rbytes); - if (!el) - return EXIT_SUCCESS; - - cont = el + 1; - if (((el - c->rcurr) > 1) && (*(el - 1) == '\r')) { - el--; - } - *el = '\0'; - - assert(cont <= (c->rcurr + c->rbytes)); - - /* process this complete line */ - if (ms_ascii_process_line(c, c->rcurr) == 0) { - /* current operation completed */ - ms_reset_conn(c, false); - return -1; - } else { - /* current operation didn't complete */ - c->rbytes -= (int32_t)(cont - c->rcurr); - c->rcurr = cont; - } - - assert(c->rcurr <= (c->rbuf + c->rsize)); - } - - return -1; -} /* ms_try_read_line */ - -/** - * because the packet of UDP can't ensure the order, the - * function is used to sort the received udp packet. - * - * @param c, pointer of the concurrency - * @param buf, the buffer to store the ordered packages data - * @param rbytes, the maximum capacity of the buffer - * - * @return int, if success, return the copy bytes, else return - * -1 - */ -static int ms_sort_udp_packet(ms_conn_t *c, char *buf, int rbytes) { - int len = 0; - int wbytes = 0; - uint16_t req_id = 0; - uint16_t seq_num = 0; - uint16_t packets = 0; - unsigned char *header = NULL; - - /* no enough data */ - assert(c); - assert(buf); - assert(c->rudpbytes >= UDP_HEADER_SIZE); - - /* calculate received packets count */ - if (c->rudpbytes % UDP_MAX_PAYLOAD_SIZE >= UDP_HEADER_SIZE) { - /* the last packet has some data */ - c->recvpkt = c->rudpbytes / UDP_MAX_PAYLOAD_SIZE + 1; - } else { - c->recvpkt = c->rudpbytes / UDP_MAX_PAYLOAD_SIZE; - } - - /* get the total packets count if necessary */ - if (c->packets == 0) { - c->packets = HEADER_TO_PACKETS((unsigned char *) c->rudpbuf); - } - - /* build the ordered packet array */ - for (int i = c->pktcurr; i < c->recvpkt; i++) { - header = (unsigned char *) c->rudpbuf + i * UDP_MAX_PAYLOAD_SIZE; - req_id = (uint16_t) HEADER_TO_REQID(header); - assert(req_id == c->request_id % (1 << 16)); - - packets = (uint16_t) HEADER_TO_PACKETS(header); - assert(c->packets == HEADER_TO_PACKETS(header)); - - seq_num = (uint16_t) HEADER_TO_SEQNUM(header); - c->udppkt[seq_num].header = header; - c->udppkt[seq_num].data = (char *) header + UDP_HEADER_SIZE; - - if (i == c->recvpkt - 1) { - /* last received packet */ - if (c->rudpbytes % UDP_MAX_PAYLOAD_SIZE == 0) { - c->udppkt[seq_num].rbytes = UDP_MAX_PAYLOAD_SIZE - UDP_HEADER_SIZE; - c->pktcurr++; - } else { - c->udppkt[seq_num].rbytes = c->rudpbytes % UDP_MAX_PAYLOAD_SIZE - UDP_HEADER_SIZE; - } - } else { - c->udppkt[seq_num].rbytes = UDP_MAX_PAYLOAD_SIZE - UDP_HEADER_SIZE; - c->pktcurr++; - } - } - - for (int i = c->ordcurr; i < c->recvpkt; i++) { - /* there is some data to copy */ - if ((c->udppkt[i].data) && (c->udppkt[i].copybytes < c->udppkt[i].rbytes)) { - header = c->udppkt[i].header; - len = c->udppkt[i].rbytes - c->udppkt[i].copybytes; - if (len > rbytes - wbytes) { - len = rbytes - wbytes; - } - - assert(len <= rbytes - wbytes); - assert(i == HEADER_TO_SEQNUM(header)); - - memcpy(buf + wbytes, c->udppkt[i].data + c->udppkt[i].copybytes, (size_t) len); - wbytes += len; - c->udppkt[i].copybytes += len; - - if ((c->udppkt[i].copybytes == c->udppkt[i].rbytes) - && (c->udppkt[i].rbytes == UDP_MAX_PAYLOAD_SIZE - UDP_HEADER_SIZE)) - { - /* finish copying all the data of this packet, next */ - c->ordcurr++; - } - - /* last received packet, and finish copying all the data */ - if ((c->recvpkt == c->packets) && (i == c->recvpkt - 1) - && (c->udppkt[i].copybytes == c->udppkt[i].rbytes)) - { - break; - } - - /* no space to copy data */ - if (wbytes >= rbytes) { - break; - } - - /* it doesn't finish reading all the data of the packet from network */ - if ((i != c->recvpkt - 1) && (c->udppkt[i].rbytes < UDP_MAX_PAYLOAD_SIZE - UDP_HEADER_SIZE)) { - break; - } - } else { - /* no data to copy */ - break; - } - } - (void) packets; - - return wbytes == 0 ? -1 : wbytes; -} /* ms_sort_udp_packet */ - -/** - * encapsulate upd read like tcp read - * - * @param c, pointer of the concurrency - * @param buf, read buffer - * @param len, length to read - * - * @return int, if success, return the read bytes, else return - * -1 - */ -static int ms_udp_read(ms_conn_t *c, char *buf, int len) { - int res = 0; - int avail = 0; - int rbytes = 0; - int copybytes = 0; - - assert(c->udp); - - while (1) { - if (c->rudpbytes + UDP_MAX_PAYLOAD_SIZE > c->rudpsize) { - char *new_rbuf = realloc(c->rudpbuf, (size_t) c->rudpsize * 2); - if (!new_rbuf) { - fprintf(stderr, "Couldn't realloc input buffer.\n"); - c->rudpbytes = 0; /* ignore what we read */ - return -1; - } - c->rudpbuf = new_rbuf; - c->rudpsize *= 2; - } - - avail = c->rudpsize - c->rudpbytes; - /* UDP each time read a packet, 1400 bytes */ - res = (int) read(c->sfd, c->rudpbuf + c->rudpbytes, (size_t) avail); - - if (res > 0) { - atomic_add_size(&ms_stats.bytes_read, res); - c->rudpbytes += res; - rbytes += res; - if (res == avail) { - continue; - } else { - break; - } - } - - if (res == 0) { - /* "connection" closed */ - return res; - } - - if (res == -1) { - /* no data to read */ - return res; - } - } - - /* copy data to read buffer */ - if (rbytes > 0) { - copybytes = ms_sort_udp_packet(c, buf, len); - } - - if (copybytes == -1) { - atomic_add_size(&ms_stats.pkt_disorder, 1); - } - - return copybytes; -} /* ms_udp_read */ - -/* - * read from network as much as we can, handle buffer overflow and connection - * close. - * before reading, move the remaining incomplete fragment of a command - * (if any) to the beginning of the buffer. - * return EXIT_SUCCESS if there's nothing to read on the first read. - */ - -/** - * read from network as much as we can, handle buffer overflow and connection - * close. before reading, move the remaining incomplete fragment of a command - * (if any) to the beginning of the buffer. - * - * @param c, pointer of the concurrency - * - * @return int, - * return EXIT_SUCCESS if there's nothing to read on the first read. - * return EXIT_FAILURE if get data - * return -1 if error happens - */ -static int ms_try_read_network(ms_conn_t *c) { - int gotdata = 0; - int res; - int64_t avail; - - assert(c); - - if ((c->rcurr != c->rbuf) - && (!c->readval || (c->rvbytes > c->rsize - (c->rcurr - c->rbuf)) - || (c->readval && (c->rcurr - c->rbuf > c->rbytes)))) - { - if (c->rbytes) /* otherwise there's nothing to copy */ - memmove(c->rbuf, c->rcurr, (size_t) c->rbytes); - c->rcurr = c->rbuf; - } - - while (1) { - if (c->rbytes >= c->rsize) { - char *new_rbuf = realloc(c->rbuf, (size_t) c->rsize * 2); - if (!new_rbuf) { - fprintf(stderr, "Couldn't realloc input buffer.\n"); - c->rbytes = 0; /* ignore what we read */ - return -1; - } - c->rcurr = c->rbuf = new_rbuf; - c->rsize *= 2; - } - - avail = c->rsize - c->rbytes - (c->rcurr - c->rbuf); - if (avail == 0) { - break; - } - - if (c->udp) { - res = (int32_t) ms_udp_read(c, c->rcurr + c->rbytes, (int32_t) avail); - } else { - res = (int) read(c->sfd, c->rcurr + c->rbytes, (size_t) avail); - } - - if (res > 0) { - if (!c->udp) { - atomic_add_size(&ms_stats.bytes_read, res); - } - gotdata = 1; - c->rbytes += res; - if (res == avail) { - continue; - } else { - break; - } - } - if (res == 0) { - /* connection closed */ - ms_conn_set_state(c, conn_closing); - return -1; - } - if (res == -1) { - if ((errno == EAGAIN) || (EAGAIN != EWOULDBLOCK && errno == EWOULDBLOCK)) - break; - /* Should close on unhandled errors. */ - ms_conn_set_state(c, conn_closing); - return -1; - } - } - - return gotdata; -} /* ms_try_read_network */ - -/** - * after get the object from server, verify the value if - * necessary. - * - * @param c, pointer of the concurrency - * @param mlget_item, pointer of mulit-get task item structure - * @param value, received value string - * @param vlen, received value string length - */ -static void ms_verify_value(ms_conn_t *c, ms_mlget_task_item_t *mlget_item, char *value, int vlen) { - if (c->curr_task.verify) { - assert(c->curr_task.item->value_offset != INVALID_OFFSET); - char *orignval = &ms_setting.char_block[c->curr_task.item->value_offset]; - char *orignkey = &ms_setting.char_block[c->curr_task.item->key_suffix_offset]; - - /* verify expire time if necessary */ - if (c->curr_task.item->exp_time > 0) { - struct timeval curr_time; - gettimeofday(&curr_time, NULL); - - /* object expired but get it now */ - if (curr_time.tv_sec - c->curr_task.item->client_time - > c->curr_task.item->exp_time + EXPIRE_TIME_ERROR) - { - atomic_add_size(&ms_stats.exp_get, 1); - - if (ms_setting.verbose) { - char set_time[64]; - char cur_time[64]; - strftime(set_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&c->curr_task.item->client_time)); - strftime(cur_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&curr_time.tv_sec)); - fprintf(stderr, - "\n<%d expire time verification failed, " - "object expired but get it now\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\tset time: %s current time: %s " - "diff time: %d expire time: %d\n" - "\texpected data: \n" - "\treceived data len: %d\n" - "\treceived data: %.*s\n", - c->sfd, c->curr_task.item->key_size, c->curr_task.item->key_prefix, - c->curr_task.item->key_size - (int) KEY_PREFIX_SIZE, orignkey, set_time, cur_time, - (int) (curr_time.tv_sec - c->curr_task.item->client_time), - c->curr_task.item->exp_time, vlen, vlen, value); - fflush(stderr); - } - } - } else { - if ((c->curr_task.item->value_size != vlen) || (memcmp(orignval, value, (size_t) vlen))) - { - atomic_add_size(&ms_stats.vef_failed, 1); - - if (ms_setting.verbose) { - fprintf(stderr, - "\n<%d data verification failed\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\texpected data len: %d\n" - "\texpected data: %.*s\n" - "\treceived data len: %d\n" - "\treceived data: %.*s\n", - c->sfd, c->curr_task.item->key_size, c->curr_task.item->key_prefix, - c->curr_task.item->key_size - (int) KEY_PREFIX_SIZE, orignkey, - c->curr_task.item->value_size, c->curr_task.item->value_size, orignval, vlen, - vlen, value); - fflush(stderr); - } - } - } - - c->curr_task.finish_verify = true; - - if (mlget_item) { - mlget_item->finish_verify = true; - } - } -} /* ms_verify_value */ - -/** - * For ASCII protocol, after store the data into the local - * buffer, run this function to handle the data. - * - * @param c, pointer of the concurrency - */ -static void ms_ascii_complete_nread(ms_conn_t *c) { - assert(c); - assert(c->rbytes >= c->rvbytes); - assert(c->protocol == ascii_prot); - if (c->rvbytes > 2) { - assert(c->rcurr[c->rvbytes - 1] == '\n' && c->rcurr[c->rvbytes - 2] == '\r'); - } - - /* multi-get */ - ms_mlget_task_item_t *mlget_item = NULL; - if (((ms_setting.mult_key_num > 1) && (c->mlget_task.mlget_num >= ms_setting.mult_key_num)) - || ((c->remain_exec_num == 0) && (c->mlget_task.mlget_num > 0))) - { - c->mlget_task.value_index++; - mlget_item = &c->mlget_task.mlget_item[c->mlget_task.value_index]; - - if (mlget_item->item->key_prefix == c->currcmd.key_prefix) { - c->curr_task.item = mlget_item->item; - c->curr_task.verify = mlget_item->verify; - c->curr_task.finish_verify = mlget_item->finish_verify; - mlget_item->get_miss = false; - } else { - /* Try to find the task item in multi-get task array */ - for (int i = 0; i < c->mlget_task.mlget_num; i++) { - mlget_item = &c->mlget_task.mlget_item[i]; - if (mlget_item->item->key_prefix == c->currcmd.key_prefix) { - c->curr_task.item = mlget_item->item; - c->curr_task.verify = mlget_item->verify; - c->curr_task.finish_verify = mlget_item->finish_verify; - mlget_item->get_miss = false; - - break; - } - } - } - } - - ms_verify_value(c, mlget_item, c->rcurr, c->rvbytes - 2); - - c->curr_task.get_miss = false; - c->rbytes -= c->rvbytes; - c->rcurr = c->rcurr + c->rvbytes; - assert(c->rcurr <= (c->rbuf + c->rsize)); - c->readval = false; - c->rvbytes = 0; -} /* ms_ascii_complete_nread */ - -/** - * For binary protocol, after store the data into the local - * buffer, run this function to handle the data. - * - * @param c, pointer of the concurrency - */ -static void ms_bin_complete_nread(ms_conn_t *c) { - assert(c); - assert(c->rbytes >= c->rvbytes); - assert(c->protocol == binary_prot); - - int extlen = c->binary_header.response.extlen; - int keylen = c->binary_header.response.keylen; - uint8_t opcode = c->binary_header.response.opcode; - - /* not get command or not include value, just return */ - if (((opcode != PROTOCOL_BINARY_CMD_GET) && (opcode != PROTOCOL_BINARY_CMD_GETQ)) - || (c->rvbytes <= extlen + keylen)) - { - /* get miss */ - if (c->binary_header.response.opcode == PROTOCOL_BINARY_CMD_GET) { - c->currcmd.retstat = MCD_END; - c->curr_task.get_miss = true; - } - - c->readval = false; - c->rvbytes = 0; - ms_reset_conn(c, false); - return; - } - - /* multi-get */ - ms_mlget_task_item_t *mlget_item = NULL; - if (((ms_setting.mult_key_num > 1) && (c->mlget_task.mlget_num >= ms_setting.mult_key_num)) - || ((c->remain_exec_num == 0) && (c->mlget_task.mlget_num > 0))) - { - c->mlget_task.value_index++; - mlget_item = &c->mlget_task.mlget_item[c->mlget_task.value_index]; - - c->curr_task.item = mlget_item->item; - c->curr_task.verify = mlget_item->verify; - c->curr_task.finish_verify = mlget_item->finish_verify; - mlget_item->get_miss = false; - } - - ms_verify_value(c, mlget_item, c->rcurr + extlen + keylen, c->rvbytes - extlen - keylen); - - c->currcmd.retstat = MCD_END; - c->curr_task.get_miss = false; - c->rbytes -= c->rvbytes; - c->rcurr = c->rcurr + c->rvbytes; - assert(c->rcurr <= (c->rbuf + c->rsize)); - c->readval = false; - c->rvbytes = 0; - - if (ms_setting.mult_key_num > 1) { - /* multi-get have check all the item */ - if (c->mlget_task.value_index == c->mlget_task.mlget_num - 1) { - ms_reset_conn(c, false); - } - } else { - /* single get */ - ms_reset_conn(c, false); - } -} /* ms_bin_complete_nread */ - -/** - * we get here after reading the value of get commands. - * - * @param c, pointer of the concurrency - */ -static void ms_complete_nread(ms_conn_t *c) { - assert(c); - assert(c->rbytes >= c->rvbytes); - assert(c->protocol == ascii_prot || c->protocol == binary_prot); - - if (c->protocol == binary_prot) { - ms_bin_complete_nread(c); - } else { - ms_ascii_complete_nread(c); - } -} /* ms_complete_nread */ - -/** - * Adds a message header to a connection. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_add_msghdr(ms_conn_t *c) { - struct msghdr *msg; - - assert(c); - - if (c->msgsize == c->msgused) { - msg = realloc(c->msglist, (size_t) c->msgsize * 2 * sizeof(struct msghdr)); - if (!msg) - return -1; - - c->msglist = msg; - c->msgsize *= 2; - } - - msg = c->msglist + c->msgused; - - /** - * this wipes msg_iovlen, msg_control, msg_controllen, and - * msg_flags, the last 3 of which aren't defined on solaris: - */ - memset(msg, 0, sizeof(struct msghdr)); - - msg->msg_iov = &c->iov[c->iovused]; - - if (c->udp && (c->srv_recv_addr_size > 0)) { - msg->msg_name = &c->srv_recv_addr; - msg->msg_namelen = c->srv_recv_addr_size; - } - - c->msgbytes = 0; - c->msgused++; - - if (c->udp) { - /* Leave room for the UDP header, which we'll fill in later. */ - return ms_add_iov(c, NULL, UDP_HEADER_SIZE); - } - - return EXIT_SUCCESS; -} /* ms_add_msghdr */ - -/** - * Ensures that there is room for another structure iovec in a connection's - * iov list. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_ensure_iov_space(ms_conn_t *c) { - assert(c); - - if (c->iovused >= c->iovsize) { - int i, iovnum; - struct iovec *new_iov = - (struct iovec *) realloc(c->iov, ((size_t) c->iovsize * 2) * sizeof(struct iovec)); - if (!new_iov) - return -1; - - c->iov = new_iov; - c->iovsize *= 2; - - /* Point all the msghdr structures at the new list. */ - for (i = 0, iovnum = 0; i < c->msgused; i++) { - c->msglist[i].msg_iov = &c->iov[iovnum]; - iovnum += (int) c->msglist[i].msg_iovlen; - } - } - - return EXIT_SUCCESS; -} /* ms_ensure_iov_space */ - -/** - * Adds data to the list of pending data that will be written out to a - * connection. - * - * @param c, pointer of the concurrency - * @param buf, the buffer includes data to send - * @param len, the data length in the buffer - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_add_iov(ms_conn_t *c, const void *buf, int len) { - struct msghdr *m; - int leftover; - bool limit_to_mtu; - - assert(c); - - do { - m = &c->msglist[c->msgused - 1]; - - /* - * Limit UDP packets, to UDP_MAX_PAYLOAD_SIZE bytes. - */ - limit_to_mtu = c->udp; - -#ifdef IOV_MAX - /* We may need to start a new msghdr if this one is full. */ - if ((m->msg_iovlen == IOV_MAX) || (limit_to_mtu && (c->msgbytes >= UDP_MAX_SEND_PAYLOAD_SIZE))) - { - ms_add_msghdr(c); - m = &c->msglist[c->msgused - 1]; - } -#endif - - if (ms_ensure_iov_space(c)) - return -1; - - /* If the fragment is too big to fit in the datagram, split it up */ - if (limit_to_mtu && (len + c->msgbytes > UDP_MAX_SEND_PAYLOAD_SIZE)) { - leftover = len + c->msgbytes - UDP_MAX_SEND_PAYLOAD_SIZE; - len -= leftover; - } else { - leftover = 0; - } - - m = &c->msglist[c->msgused - 1]; - m->msg_iov[m->msg_iovlen].iov_base = (void *) buf; - m->msg_iov[m->msg_iovlen].iov_len = (size_t) len; - - c->msgbytes += len; - c->iovused++; - m->msg_iovlen++; - - buf = ((char *) buf) + len; - len = leftover; - } while (leftover > 0); - - return EXIT_SUCCESS; -} /* ms_add_iov */ - -/** - * Constructs a set of UDP headers and attaches them to the outgoing messages. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_udp_headers(ms_conn_t *c) { - int i; - unsigned char *hdr; - - assert(c); - - c->request_id = ms_get_udp_request_id(); - - if (c->msgused > c->hdrsize) { - void *new_hdrbuf; - if (c->hdrbuf) - new_hdrbuf = realloc(c->hdrbuf, (size_t) c->msgused * 2 * UDP_HEADER_SIZE); - else - new_hdrbuf = malloc((size_t) c->msgused * 2 * UDP_HEADER_SIZE); - if (!new_hdrbuf) - return -1; - - c->hdrbuf = (unsigned char *) new_hdrbuf; - c->hdrsize = c->msgused * 2; - } - - /* If this is a multi-packet request, drop it. */ - if (c->udp && (c->msgused > 1)) { - fprintf(stderr, "multi-packet request for UDP not supported.\n"); - return -1; - } - - hdr = c->hdrbuf; - for (i = 0; i < c->msgused; i++) { - c->msglist[i].msg_iov[0].iov_base = (void *) hdr; - c->msglist[i].msg_iov[0].iov_len = UDP_HEADER_SIZE; - *hdr++ = (unsigned char) (c->request_id / 256); - *hdr++ = (unsigned char) (c->request_id % 256); - *hdr++ = (unsigned char) (i / 256); - *hdr++ = (unsigned char) (i % 256); - *hdr++ = (unsigned char) (c->msgused / 256); - *hdr++ = (unsigned char) (c->msgused % 256); - *hdr++ = (unsigned char) 1; /* support facebook memcached */ - *hdr++ = (unsigned char) 0; - assert(hdr == ((unsigned char *) c->msglist[i].msg_iov[0].iov_base + UDP_HEADER_SIZE)); - } - - return EXIT_SUCCESS; -} /* ms_build_udp_headers */ - -/** - * Transmit the next chunk of data from our list of msgbuf structures. - * - * @param c, pointer of the concurrency - * - * @return TRANSMIT_COMPLETE All done writing. - * TRANSMIT_INCOMPLETE More data remaining to write. - * TRANSMIT_SOFT_ERROR Can't write any more right now. - * TRANSMIT_HARD_ERROR Can't write (c->state is set to conn_closing) - */ -static int ms_transmit(ms_conn_t *c) { - assert(c); - - if ((c->msgcurr < c->msgused) && (c->msglist[c->msgcurr].msg_iovlen == 0)) { - /* Finished writing the current msg; advance to the next. */ - c->msgcurr++; - } - - if (c->msgcurr < c->msgused) { - ssize_t res; - struct msghdr *m = &c->msglist[c->msgcurr]; - - res = sendmsg(c->sfd, m, 0); - if (res > 0) { - atomic_add_size(&ms_stats.bytes_written, res); - - /* We've written some of the data. Remove the completed - * iovec entries from the list of pending writes. */ - while (m->msg_iovlen > 0 && res >= (ssize_t) m->msg_iov->iov_len) { - res -= (ssize_t) m->msg_iov->iov_len; - m->msg_iovlen--; - m->msg_iov++; - } - - /* Might have written just part of the last iovec entry; - * adjust it so the next write will do the rest. */ - if (res > 0) { - m->msg_iov->iov_base = (void *) ((unsigned char *) m->msg_iov->iov_base + res); - m->msg_iov->iov_len -= (size_t) res; - } - return TRANSMIT_INCOMPLETE; - } - if ((res == -1) && ((errno == EAGAIN) || (EAGAIN != EWOULDBLOCK && errno == EWOULDBLOCK))) { - if (!ms_update_event(c, EV_WRITE | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - return TRANSMIT_HARD_ERROR; - } - return TRANSMIT_SOFT_ERROR; - } - - /* if res==0 or res==-1 and error is not EAGAIN or EWOULDBLOCK, - * we have a real error, on which we close the connection */ - fprintf(stderr, "Failed to write, and not due to blocking.\n"); - - ms_conn_set_state(c, conn_closing); - return TRANSMIT_HARD_ERROR; - } else { - return TRANSMIT_COMPLETE; - } -} /* ms_transmit */ - -/** - * Shrinks a connection's buffers if they're too big. This prevents - * periodic large "mget" response from server chewing lots of client - * memory. - * - * This should only be called in between requests since it can wipe output - * buffers! - * - * @param c, pointer of the concurrency - */ -static void ms_conn_shrink(ms_conn_t *c) { - assert(c); - - if (c->udp) - return; - - if ((c->rsize > READ_BUFFER_HIGHWAT) && (c->rbytes < DATA_BUFFER_SIZE)) { - char *newbuf; - - if (c->rcurr != c->rbuf) - memmove(c->rbuf, c->rcurr, (size_t) c->rbytes); - - newbuf = (char *) realloc((void *) c->rbuf, DATA_BUFFER_SIZE); - - if (newbuf) { - c->rbuf = newbuf; - c->rsize = DATA_BUFFER_SIZE; - } - c->rcurr = c->rbuf; - } - - if (c->udp && (c->rudpsize > UDP_DATA_BUFFER_HIGHWAT) - && (c->rudpbytes + UDP_MAX_PAYLOAD_SIZE < UDP_DATA_BUFFER_SIZE)) - { - char *new_rbuf = (char *) realloc(c->rudpbuf, (size_t) c->rudpsize * 2); - if (new_rbuf) { - c->rudpbuf = new_rbuf; - c->rudpsize = UDP_DATA_BUFFER_SIZE; - } - /* TODO check error condition? */ - } - - if (c->msgsize > MSG_LIST_HIGHWAT) { - struct msghdr *newbuf = - (struct msghdr *) realloc((void *) c->msglist, MSG_LIST_INITIAL * sizeof(c->msglist[0])); - if (newbuf) { - c->msglist = newbuf; - c->msgsize = MSG_LIST_INITIAL; - } - /* TODO check error condition? */ - } - - if (c->iovsize > IOV_LIST_HIGHWAT) { - struct iovec *newbuf = - (struct iovec *) realloc((void *) c->iov, IOV_LIST_INITIAL * sizeof(c->iov[0])); - if (newbuf) { - c->iov = newbuf; - c->iovsize = IOV_LIST_INITIAL; - } - /* TODO check return value */ - } -} /* ms_conn_shrink */ - -/** - * Sets a connection's current state in the state machine. Any special - * processing that needs to happen on certain state transitions can - * happen here. - * - * @param c, pointer of the concurrency - * @param state, connection state - */ -static void ms_conn_set_state(ms_conn_t *c, int state) { - assert(c); - - if (state != c->state) { - if (state == conn_read) { - ms_conn_shrink(c); - } - c->state = state; - } -} /* ms_conn_set_state */ - -/** - * update the event if socks change state. for example: when - * change the listen scoket read event to sock write event, or - * change socket handler, we could call this function. - * - * @param c, pointer of the concurrency - * @param new_flags, new event flags - * - * @return bool, if success, return true, else return false - */ -static bool ms_update_event(ms_conn_t *c, const int new_flags) { - assert(c); - - struct event_base *base = c->event.ev_base; - if ((c->ev_flags == new_flags) && (ms_setting.rep_write_srv == 0) - && (!ms_setting.facebook_test || (c->total_sfds == 1))) - { - return true; - } - - if (event_del(&c->event) == -1) { - /* try to delete the event again */ - if (event_del(&c->event) == -1) { - return false; - } - } - - event_set(&c->event, c->sfd, (short) new_flags, ms_event_handler, (void *) c); - event_base_set(base, &c->event); - c->ev_flags = (short) new_flags; - - if (event_add(&c->event, NULL) == -1) { - return false; - } - - return true; -} /* ms_update_event */ - -/** - * If user want to get the expected throughput, we could limit - * the performance of memslap. we could give up some work and - * just wait a short time. The function is used to check this - * case. - * - * @param c, pointer of the concurrency - * - * @return bool, if success, return true, else return false - */ -static bool ms_need_yield(ms_conn_t *c) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - int64_t tps = 0; - int64_t time_diff = 0; - struct timeval curr_time; - ms_task_t *task = &c->curr_task; - - if (ms_setting.expected_tps > 0) { - gettimeofday(&curr_time, NULL); - time_diff = ms_time_diff(&ms_thread->startup_time, &curr_time); - tps = (int64_t)(((task->get_opt + task->set_opt) / (uint64_t) time_diff) * 1000000); - - /* current throughput is greater than expected throughput */ - if (tps > ms_thread->thread_ctx->tps_perconn) { - return true; - } - } - - return false; -} /* ms_need_yield */ - -/** - * used to update the start time of each operation - * - * @param c, pointer of the concurrency - */ -static void ms_update_start_time(ms_conn_t *c) { - ms_task_item_t *item = c->curr_task.item; - - if ((ms_setting.stat_freq > 0) || c->udp || ((c->currcmd.cmd == CMD_SET) && (item->exp_time > 0))) - { - gettimeofday(&c->start_time, NULL); - if ((c->currcmd.cmd == CMD_SET) && (item->exp_time > 0)) { - /* record the current time */ - item->client_time = c->start_time.tv_sec; - } - } -} /* ms_update_start_time */ - -/** - * run the state machine - * - * @param c, pointer of the concurrency - */ -static void ms_drive_machine(ms_conn_t *c) { - bool stop = false; - - assert(c); - - while (!stop) { - switch (c->state) { - case conn_read: - if (c->readval) { - if (c->rbytes >= c->rvbytes) { - ms_complete_nread(c); - break; - } - } else { - if (ms_try_read_line(c)) { - break; - } - } - - if (ms_try_read_network(c)) { - break; - } - - /* doesn't read all the response data, wait event wake up */ - if (!c->currcmd.isfinish) { - if (!ms_update_event(c, EV_READ | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - break; - } - stop = true; - break; - } - - /* we have no command line and no data to read from network, next write */ - ms_conn_set_state(c, conn_write); - memcpy(&c->precmd, &c->currcmd, sizeof(ms_cmdstat_t)); /* replicate command state */ - - break; - - case conn_write: - if (!c->ctnwrite && ms_need_yield(c)) { - usleep(10); - - if (!ms_update_event(c, EV_WRITE | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - break; - } - stop = true; - break; - } - - if (!c->ctnwrite && (ms_exec_task(c))) { - ms_conn_set_state(c, conn_closing); - break; - } - - /* record the start time before starting to send data if necessary */ - if (!c->ctnwrite || (c->change_sfd && c->ctnwrite)) { - if (c->change_sfd) { - c->change_sfd = false; - } - ms_update_start_time(c); - } - - /* change sfd if necessary */ - if (c->change_sfd) { - c->ctnwrite = true; - stop = true; - break; - } - - /* execute task until nothing need be written to network */ - if (!c->ctnwrite && (c->msgcurr == c->msgused)) { - if (!ms_update_event(c, EV_WRITE | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - break; - } - stop = true; - break; - } - - switch (ms_transmit(c)) { - case TRANSMIT_COMPLETE: - /* we have no data to write to network, next wait repose */ - if (!ms_update_event(c, EV_READ | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - c->ctnwrite = false; - break; - } - ms_conn_set_state(c, conn_read); - c->ctnwrite = false; - stop = true; - break; - - case TRANSMIT_INCOMPLETE: - c->ctnwrite = true; - break; /* Continue in state machine. */ - - case TRANSMIT_HARD_ERROR: - c->ctnwrite = false; - break; - - case TRANSMIT_SOFT_ERROR: - c->ctnwrite = true; - stop = true; - break; - - default: - break; - } /* switch */ - - break; - - case conn_closing: - /* recovery mode, need reconnect if connection close */ - if (ms_setting.reconnect - && (!ms_global.time_out || ((ms_setting.run_time == 0) && (c->remain_exec_num > 0)))) - { - if (ms_reconn(c)) { - ms_conn_close(c); - stop = true; - break; - } - - ms_reset_conn(c, false); - - if (c->total_sfds == 1) { - if (!ms_update_event(c, EV_WRITE | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - break; - } - } - - break; - } else { - ms_conn_close(c); - stop = true; - break; - } - - default: - assert(0); - } /* switch */ - } -} /* ms_drive_machine */ - -/** - * the event handler of each thread - * - * @param fd, the file descriptor of socket - * @param which, event flag - * @param arg, argument - */ -void ms_event_handler(const int fd, const short which, void *arg) { - ms_conn_t *c = (ms_conn_t *) arg; - - assert(c); - - c->which = which; - - /* sanity */ - if (fd != c->sfd) { - fprintf(stderr, "Catastrophic: event fd: %d doesn't match conn fd: %d\n", fd, c->sfd); - ms_conn_close(c); - exit(1); - } - assert(fd == c->sfd); - - ms_drive_machine(c); - - /* wait for next event */ -} /* ms_event_handler */ - -/** - * get the next socket descriptor index to run for replication - * - * @param c, pointer of the concurrency - * @param cmd, command(get or set ) - * - * @return int, if success, return the index, else return EXIT_SUCCESS - */ -static uint32_t ms_get_rep_sock_index(ms_conn_t *c, int cmd) { - uint32_t sock_index = 0; - uint32_t i = 0; - - if (c->total_sfds == 1) { - return EXIT_SUCCESS; - } - - if (ms_setting.rep_write_srv == 0) { - return sock_index; - } - - do { - if (cmd == CMD_SET) { - for (i = 0; i < ms_setting.rep_write_srv; i++) { - if (c->tcpsfd[i] > 0) { - break; - } - } - - if (i == ms_setting.rep_write_srv) { - /* random get one replication server to read */ - sock_index = (uint32_t) random() % c->total_sfds; - } else { - /* random get one replication writing server to write */ - sock_index = (uint32_t) random() % ms_setting.rep_write_srv; - } - } else if (cmd == CMD_GET) { - /* random get one replication server to read */ - sock_index = (uint32_t) random() % c->total_sfds; - } - } while (c->tcpsfd[sock_index] == 0); - - return sock_index; -} /* ms_get_rep_sock_index */ - -/** - * get the next socket descriptor index to run - * - * @param c, pointer of the concurrency - * - * @return int, return the index - */ -static uint32_t ms_get_next_sock_index(ms_conn_t *c) { - uint32_t sock_index = 0; - - do { - sock_index = (++c->cur_idx == c->total_sfds) ? 0 : c->cur_idx; - } while (c->tcpsfd[sock_index] == 0); - - return sock_index; -} /* ms_get_next_sock_index */ - -/** - * update socket event of the connections - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_update_conn_sock_event(ms_conn_t *c) { - assert(c); - - switch (c->currcmd.cmd) { - case CMD_SET: - if (ms_setting.facebook_test && c->udp) { - c->sfd = c->tcpsfd[0]; - c->udp = false; - c->change_sfd = true; - } - break; - - case CMD_GET: - if (ms_setting.facebook_test && !c->udp) { - c->sfd = c->udpsfd; - c->udp = true; - c->change_sfd = true; - } - break; - - default: - break; - } /* switch */ - - if (!c->udp && (c->total_sfds > 1)) { - if (c->cur_idx != c->total_sfds) { - if (ms_setting.rep_write_srv == 0) { - c->cur_idx = ms_get_next_sock_index(c); - } else { - c->cur_idx = ms_get_rep_sock_index(c, c->currcmd.cmd); - } - } else { - /* must select the first sock of the connection at the beginning */ - c->cur_idx = 0; - } - - c->sfd = c->tcpsfd[c->cur_idx]; - assert(c->sfd); - c->change_sfd = true; - } - - if (c->change_sfd) { - if (!ms_update_event(c, EV_WRITE | EV_PERSIST)) { - fprintf(stderr, "Couldn't update event.\n"); - ms_conn_set_state(c, conn_closing); - return -1; - } - } - - return EXIT_SUCCESS; -} /* ms_update_conn_sock_event */ - -/** - * for ASCII protocol, this function build the set command - * string and send the command. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_ascii_write_buf_set(ms_conn_t *c, ms_task_item_t *item) { - int value_offset; - int write_len; - char *buffer = c->wbuf; - - write_len = snprintf(buffer, c->wsize, " %u %d %d\r\n", 0, item->exp_time, item->value_size); - - if (write_len > c->wsize || write_len < 0) { - /* ought to be always enough. just fail for simplicity */ - fprintf(stderr, "output command line too long.\n"); - return -1; - } - - if (item->value_offset == INVALID_OFFSET) { - value_offset = item->key_suffix_offset; - } else { - value_offset = item->value_offset; - } - - if ((ms_add_iov(c, "set ", 4)) - || (ms_add_iov(c, (char *) &item->key_prefix, (int) KEY_PREFIX_SIZE)) - || (ms_add_iov(c, &ms_setting.char_block[item->key_suffix_offset], - item->key_size - (int) KEY_PREFIX_SIZE) -) - || (ms_add_iov(c, buffer, write_len)) - || (ms_add_iov(c, &ms_setting.char_block[value_offset], item->value_size)) - || (ms_add_iov(c, "\r\n", 2)) || (c->udp && (ms_build_udp_headers(c)))) - { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_build_ascii_write_buf_set */ - -/** - * used to send set command to server - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_mcd_set(ms_conn_t *c, ms_task_item_t *item) { - assert(c); - - c->currcmd.cmd = CMD_SET; - c->currcmd.isfinish = false; - c->currcmd.retstat = MCD_FAILURE; - - if (ms_update_conn_sock_event(c)) { - return -1; - } - - c->msgcurr = 0; - c->msgused = 0; - c->iovused = 0; - if (ms_add_msghdr(c)) { - fprintf(stderr, "Out of memory preparing request."); - return -1; - } - - /* binary protocol */ - if (c->protocol == binary_prot) { - if (ms_build_bin_write_buf_set(c, item)) { - return -1; - } - } else { - if (ms_build_ascii_write_buf_set(c, item)) { - return -1; - } - } - - atomic_add_size(&ms_stats.obj_bytes, item->key_size + item->value_size); - atomic_add_size(&ms_stats.cmd_set, 1); - - return EXIT_SUCCESS; -} /* ms_mcd_set */ - -/** - * for ASCII protocol, this function build the get command - * string and send the command. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_ascii_write_buf_get(ms_conn_t *c, ms_task_item_t *item) { - if ((ms_add_iov(c, "get ", 4)) - || (ms_add_iov(c, (char *) &item->key_prefix, (int) KEY_PREFIX_SIZE)) - || (ms_add_iov(c, &ms_setting.char_block[item->key_suffix_offset], - item->key_size - (int) KEY_PREFIX_SIZE) -) - || (ms_add_iov(c, "\r\n", 2)) || (c->udp && (ms_build_udp_headers(c)))) - { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_build_ascii_write_buf_get */ - -/** - * used to send the get command to server - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_mcd_get(ms_conn_t *c, ms_task_item_t *item) { - assert(c); - - c->currcmd.cmd = CMD_GET; - c->currcmd.isfinish = false; - c->currcmd.retstat = MCD_FAILURE; - - if (ms_update_conn_sock_event(c)) { - return -1; - } - - c->msgcurr = 0; - c->msgused = 0; - c->iovused = 0; - if (ms_add_msghdr(c)) { - fprintf(stderr, "Out of memory preparing request."); - return -1; - } - - /* binary protocol */ - if (c->protocol == binary_prot) { - if (ms_build_bin_write_buf_get(c, item)) { - return -1; - } - } else { - if (ms_build_ascii_write_buf_get(c, item)) { - return -1; - } - } - - atomic_add_size(&ms_stats.cmd_get, 1); - - return EXIT_SUCCESS; -} /* ms_mcd_get */ - -/** - * for ASCII protocol, this function build the multi-get command - * string and send the command. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_ascii_write_buf_mlget(ms_conn_t *c) { - ms_task_item_t *item; - - if (ms_add_iov(c, "get", 3)) { - return -1; - } - - for (int i = 0; i < c->mlget_task.mlget_num; i++) { - item = c->mlget_task.mlget_item[i].item; - assert(item); - if ((ms_add_iov(c, " ", 1)) - || (ms_add_iov(c, (char *) &item->key_prefix, (int) KEY_PREFIX_SIZE)) - || (ms_add_iov(c, &ms_setting.char_block[item->key_suffix_offset], - item->key_size - (int) KEY_PREFIX_SIZE) -)) - { - return -1; - } - } - - if ((ms_add_iov(c, "\r\n", 2)) || (c->udp && (ms_build_udp_headers(c)))) { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_build_ascii_write_buf_mlget */ - -/** - * used to send the multi-get command to server - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_mcd_mlget(ms_conn_t *c) { - ms_task_item_t *item; - - assert(c); - assert(c->mlget_task.mlget_num >= 1); - - c->currcmd.cmd = CMD_GET; - c->currcmd.isfinish = false; - c->currcmd.retstat = MCD_FAILURE; - - if (ms_update_conn_sock_event(c)) { - return -1; - } - - c->msgcurr = 0; - c->msgused = 0; - c->iovused = 0; - if (ms_add_msghdr(c)) { - fprintf(stderr, "Out of memory preparing request."); - return -1; - } - - /* binary protocol */ - if (c->protocol == binary_prot) { - if (ms_build_bin_write_buf_mlget(c)) { - return -1; - } - } else { - if (ms_build_ascii_write_buf_mlget(c)) { - return -1; - } - } - - /* decrease operation time of each item */ - for (int i = 0; i < c->mlget_task.mlget_num; i++) { - item = c->mlget_task.mlget_item[i].item; - atomic_add_size(&ms_stats.cmd_get, 1); - } - - (void) item; - - return EXIT_SUCCESS; -} /* ms_mcd_mlget */ - -/** - * binary protocol support - */ - -/** - * for binary protocol, parse the response of server - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_bin_process_response(ms_conn_t *c) { - const char *errstr = NULL; - - assert(c); - - uint32_t bodylen = c->binary_header.response.bodylen; - uint8_t opcode = c->binary_header.response.opcode; - uint16_t status = c->binary_header.response.status; - - if (bodylen > 0) { - c->rvbytes = (int32_t) bodylen; - c->readval = true; - return EXIT_FAILURE; - } else { - switch (status) { - case PROTOCOL_BINARY_RESPONSE_SUCCESS: - if (opcode == PROTOCOL_BINARY_CMD_SET) { - c->currcmd.retstat = MCD_STORED; - } else if (opcode == PROTOCOL_BINARY_CMD_DELETE) { - c->currcmd.retstat = MCD_DELETED; - } else if (opcode == PROTOCOL_BINARY_CMD_GET) { - c->currcmd.retstat = MCD_END; - } - break; - - case PROTOCOL_BINARY_RESPONSE_ENOMEM: - errstr = "Out of memory"; - c->currcmd.retstat = MCD_SERVER_ERROR; - break; - - case PROTOCOL_BINARY_RESPONSE_UNKNOWN_COMMAND: - errstr = "Unknown command"; - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - break; - - case PROTOCOL_BINARY_RESPONSE_KEY_ENOENT: - errstr = "Not found"; - c->currcmd.retstat = MCD_NOTFOUND; - break; - - case PROTOCOL_BINARY_RESPONSE_EINVAL: - errstr = "Invalid arguments"; - c->currcmd.retstat = MCD_PROTOCOL_ERROR; - break; - - case PROTOCOL_BINARY_RESPONSE_KEY_EEXISTS: - errstr = "Data exists for key."; - break; - - case PROTOCOL_BINARY_RESPONSE_E2BIG: - errstr = "Too large."; - c->currcmd.retstat = MCD_SERVER_ERROR; - break; - - case PROTOCOL_BINARY_RESPONSE_NOT_STORED: - errstr = "Not stored."; - c->currcmd.retstat = MCD_NOTSTORED; - break; - - default: - errstr = "Unknown error"; - c->currcmd.retstat = MCD_UNKNOWN_READ_FAILURE; - break; - } /* switch */ - - if (errstr) { - fprintf(stderr, "%s\n", errstr); - } - } - - return EXIT_SUCCESS; -} /* ms_bin_process_response */ - -/* build binary header and add the header to the buffer to send */ - -/** - * build binary header and add the header to the buffer to send - * - * @param c, pointer of the concurrency - * @param opcode, operation code - * @param hdr_len, length of header - * @param key_len, length of key - * @param body_len. length of body - */ -static void ms_add_bin_header(ms_conn_t *c, uint8_t opcode, uint8_t hdr_len, uint16_t key_len, - uint32_t body_len) { - protocol_binary_request_header *header; - - assert(c); - - header = (protocol_binary_request_header *) c->wcurr; - - header->request.magic = (uint8_t) PROTOCOL_BINARY_REQ; - header->request.opcode = (uint8_t) opcode; - header->request.keylen = htons(key_len); - - header->request.extlen = (uint8_t) hdr_len; - header->request.datatype = (uint8_t) PROTOCOL_BINARY_RAW_BYTES; - header->request.vbucket = 0; - - header->request.bodylen = htonl(body_len); - header->request.opaque = 0; - header->request.cas = 0; - - ms_add_iov(c, c->wcurr, sizeof(header->request)); -} /* ms_add_bin_header */ - -/** - * add the key to the socket write buffer array - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - */ -static void ms_add_key_to_iov(ms_conn_t *c, ms_task_item_t *item) { - ms_add_iov(c, (char *) &item->key_prefix, (int) KEY_PREFIX_SIZE); - ms_add_iov(c, &ms_setting.char_block[item->key_suffix_offset], - item->key_size - (int) KEY_PREFIX_SIZE); -} - -/** - * for binary protocol, this function build the set command - * and add the command to send buffer array. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_bin_write_buf_set(ms_conn_t *c, ms_task_item_t *item) { - assert(c->wbuf == c->wcurr); - - int value_offset; - protocol_binary_request_set *rep = (protocol_binary_request_set *) c->wcurr; - uint16_t keylen = (uint16_t) item->key_size; - uint32_t bodylen = - (uint32_t) sizeof(rep->message.body) + (uint32_t) keylen + (uint32_t) item->value_size; - - ms_add_bin_header(c, PROTOCOL_BINARY_CMD_SET, sizeof(rep->message.body), keylen, bodylen); - rep->message.body.flags = 0; - rep->message.body.expiration = htonl((uint32_t) item->exp_time); - ms_add_iov(c, &rep->message.body, sizeof(rep->message.body)); - ms_add_key_to_iov(c, item); - - if (item->value_offset == INVALID_OFFSET) { - value_offset = item->key_suffix_offset; - } else { - value_offset = item->value_offset; - } - ms_add_iov(c, &ms_setting.char_block[value_offset], item->value_size); - - return EXIT_SUCCESS; -} /* ms_build_bin_write_buf_set */ - -/** - * for binary protocol, this function build the get command and - * add the command to send buffer array. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_bin_write_buf_get(ms_conn_t *c, ms_task_item_t *item) { - assert(c->wbuf == c->wcurr); - - ms_add_bin_header(c, PROTOCOL_BINARY_CMD_GET, 0, (uint16_t) item->key_size, - (uint32_t) item->key_size); - ms_add_key_to_iov(c, item); - - return EXIT_SUCCESS; -} /* ms_build_bin_write_buf_get */ - -/** - * for binary protocol, this function build the multi-get - * command and add the command to send buffer array. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_build_bin_write_buf_mlget(ms_conn_t *c) { - ms_task_item_t *item; - - assert(c->wbuf == c->wcurr); - - for (int i = 0; i < c->mlget_task.mlget_num; i++) { - item = c->mlget_task.mlget_item[i].item; - assert(item); - - ms_add_bin_header(c, PROTOCOL_BINARY_CMD_GET, 0, (uint16_t) item->key_size, - (uint32_t) item->key_size); - ms_add_key_to_iov(c, item); - c->wcurr += sizeof(protocol_binary_request_get); - } - - c->wcurr = c->wbuf; - - return EXIT_SUCCESS; -} /* ms_build_bin_write_buf_mlget */ diff --git a/contrib/bin/memaslap/ms_conn.h b/contrib/bin/memaslap/ms_conn.h deleted file mode 100644 index 74d493e83..000000000 --- a/contrib/bin/memaslap/ms_conn.h +++ /dev/null @@ -1,229 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_CONN_H -#define MS_CONN_H - -#include -#include -#include -#include - -#include "ms_task.h" -#include "libmemcachedprotocol-0.0/binary.h" - -#ifdef __cplusplus -extern "C" { -#endif - -#define DATA_BUFFER_SIZE \ - (1024 * 1024 + 2048) /* read buffer, 1M + 2k, enough for the max value(1M) */ -#define WRITE_BUFFER_SIZE (32 * 1024) /* write buffer, 32k */ -#define UDP_DATA_BUFFER_SIZE (1 * 1024 * 1024) /* read buffer for UDP, 1M */ -#define UDP_MAX_PAYLOAD_SIZE 1400 /* server limit UDP payload size */ -#define UDP_MAX_SEND_PAYLOAD_SIZE 1400 /* mtu size is 1500 */ -#define UDP_HEADER_SIZE 8 /* UDP header size */ -#define MAX_SENDBUF_SIZE (256 * 1024 * 1024) /* Maximum socket buffer size */ -#define SOCK_WAIT_TIMEOUT 30 /* maximum waiting time of UDP, 30s */ -#define MAX_UDP_PACKET (1 << 16) /* maximum UDP packets, 65536 */ - -/* Initial size of the sendmsg() scatter/gather array. */ -#define IOV_LIST_INITIAL 400 - -/* Initial number of sendmsg() argument structures to allocate. */ -#define MSG_LIST_INITIAL 10 - -/* High water marks for buffer shrinking */ -#define READ_BUFFER_HIGHWAT (2 * DATA_BUFFER_SIZE) -#define UDP_DATA_BUFFER_HIGHWAT (4 * UDP_DATA_BUFFER_SIZE) -#define IOV_LIST_HIGHWAT 600 -#define MSG_LIST_HIGHWAT 100 - -/* parse udp header */ -#define HEADER_TO_REQID(ptr) ((uint16_t) *ptr * 256 + (uint16_t) * (ptr + 1)) -#define HEADER_TO_SEQNUM(ptr) ((uint16_t) * (ptr + 2) * 256 + (uint16_t) * (ptr + 3)) -#define HEADER_TO_PACKETS(ptr) ((uint16_t) * (ptr + 4) * 256 + (uint16_t) * (ptr + 5)) - -/* states of connection */ -enum conn_states { - conn_read, /* reading in a command line */ - conn_write, /* writing out a simple response */ - conn_closing /* closing this connection */ -}; - -/* returned states of memcached command */ -enum mcd_ret { - MCD_SUCCESS, /* command success */ - MCD_FAILURE, /* command failure */ - MCD_UNKNOWN_READ_FAILURE, /* unknown read failure */ - MCD_PROTOCOL_ERROR, /* protocol error */ - MCD_CLIENT_ERROR, /* client error, wrong command */ - MCD_SERVER_ERROR, /* server error, server run command failed */ - MCD_DATA_EXISTS, /* object is existent in server */ - MCD_NOTSTORED, /* server doesn't set the object successfully */ - MCD_STORED, /* server set the object successfully */ - MCD_NOTFOUND, /* server not find the object */ - MCD_END, /* end of the response of get command */ - MCD_DELETED, /* server delete the object successfully */ - MCD_STAT /* response of stats command */ -}; - -/* used to store the current or previous running command state */ -typedef struct cmdstat { - int cmd; /* command name */ - int retstat; /* return state of this command */ - bool isfinish; /* if it read all the response data */ - uint64_t key_prefix; /* key prefix */ -} ms_cmdstat_t; - -/* udp packet structure */ -typedef struct udppkt { - uint8_t *header; /* udp header of the packet */ - char *data; /* udp data of the packet */ - int rbytes; /* number of data in the packet */ - int copybytes; /* number of copied data in the packet */ -} ms_udppkt_t; - -/* three protocols supported */ -enum protocol { - ascii_prot = 3, /* ASCII protocol */ - binary_prot /* binary protocol */ -}; - -/** - * concurrency structure - * - * Each thread has a libevent to manage the events of network. - * Each thread has one or more self-governed concurrencies; - * each concurrency has one or more socket connections. This - * concurrency structure includes all the private variables of - * the concurrency. - */ -typedef struct conn { - uint32_t conn_idx; /* connection index in the thread */ - int sfd; /* current tcp sock handler of the connection structure */ - int udpsfd; /* current udp sock handler of the connection structure*/ - int state; /* state of the connection */ - struct event event; /* event for libevent */ - short ev_flags; /* event flag for libevent */ - short which; /* which events were just triggered */ - bool change_sfd; /* whether change sfd */ - - int *tcpsfd; /* TCP sock array */ - uint32_t total_sfds; /* how many socks in the tcpsfd array */ - uint32_t alive_sfds; /* alive socks */ - uint32_t cur_idx; /* current sock index in tcpsfd array */ - - ms_cmdstat_t precmd; /* previous command state */ - ms_cmdstat_t currcmd; /* current command state */ - - char *rbuf; /* buffer to read commands into */ - char *rcurr; /* but if we parsed some already, this is where we stopped */ - int rsize; /* total allocated size of rbuf */ - int rbytes; /* how much data, starting from rcur, do we have unparsed */ - - bool readval; /* read value state, read known data size */ - int rvbytes; /* total value size need to read */ - - char *wbuf; /* buffer to write commands out */ - char *wcurr; /* for multi-get, where we stopped */ - int wsize; /* total allocated size of wbuf */ - bool ctnwrite; /* continue to write */ - - /* data for the mwrite state */ - struct iovec *iov; - int iovsize; /* number of elements allocated in iov[] */ - int iovused; /* number of elements used in iov[] */ - - struct msghdr *msglist; - int msgsize; /* number of elements allocated in msglist[] */ - int msgused; /* number of elements used in msglist[] */ - int msgcurr; /* element in msglist[] being transmitted now */ - int msgbytes; /* number of bytes in current msg */ - - /* data for UDP clients */ - bool udp; /* is this is a UDP "connection" */ - uint32_t request_id; /* UDP request ID of current operation, if this is a UDP "connection" */ - uint8_t *hdrbuf; /* udp packet headers */ - int hdrsize; /* number of headers' worth of space is allocated */ - struct sockaddr srv_recv_addr; /* Sent the most recent request to which server */ - socklen_t srv_recv_addr_size; - - /* udp read buffer */ - char *rudpbuf; /* buffer to read commands into for udp */ - int rudpsize; /* total allocated size of rudpbuf */ - int rudpbytes; /* how much data, starting from rudpbuf */ - - /* order udp packet */ - ms_udppkt_t *udppkt; /* the offset of udp packet in rudpbuf */ - int packets; /* number of total packets need to read */ - int recvpkt; /* number of received packets */ - int pktcurr; /* current packet in rudpbuf being ordered */ - int ordcurr; /* current ordered packet */ - - ms_task_item_t *item_win; /* task sequence */ - int win_size; /* current task window size */ - uint64_t set_cursor; /* current set item index in the item window */ - ms_task_t curr_task; /* current running task */ - ms_mlget_task_t mlget_task; /* multi-get task */ - - int warmup_num; /* to run how many warm up operations*/ - int remain_warmup_num; /* left how many warm up operations to run */ - int64_t exec_num; /* to run how many task operations */ - int64_t remain_exec_num; /* how many remained task operations to run */ - - /* response time statistic and time out control */ - struct timeval start_time; /* start time of current operation(s) */ - struct timeval end_time; /* end time of current operation(s) */ - - /* Binary protocol stuff */ - protocol_binary_response_header binary_header; /* local temporary binary header */ - enum protocol protocol; /* which protocol this connection speaks */ -} ms_conn_t; - -/* used to generate the key prefix */ -uint64_t ms_get_key_prefix(void); - -/** - * setup a connection, each connection structure of each - * thread must call this function to initialize. - */ -int ms_setup_conn(ms_conn_t *c); - -/* after one operation completes, reset the connection */ -void ms_reset_conn(ms_conn_t *c, bool timeout); - -/** - * reconnect several disconnected socks in the connection - * structure, the ever-1-second timer of the thread will check - * whether some socks in the connections disconnect. if - * disconnect, reconnect the sock. - */ -int ms_reconn_socks(ms_conn_t *c); - -/* used to send set command to server */ -int ms_mcd_set(ms_conn_t *c, ms_task_item_t *item); - -/* used to send the get command to server */ -int ms_mcd_get(ms_conn_t *c, ms_task_item_t *item); - -/* used to send the multi-get command to server */ -int ms_mcd_mlget(ms_conn_t *c); - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_CONN_H */ diff --git a/contrib/bin/memaslap/ms_main.c b/contrib/bin/memaslap/ms_main.c deleted file mode 100644 index 8bde4bfb0..000000000 --- a/contrib/bin/memaslap/ms_main.c +++ /dev/null @@ -1,775 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#include -#include -#include -#include -#include - -#if defined(HAVE_SYS_TIME_H) -# include -#endif -#include - -#include "ms_atomic.h" -#include "ms_sigsegv.h" -#include "ms_setting.h" -#include "ms_thread.h" - -/* global structure */ -ms_global_t ms_global; - -/* global stats information structure */ -ms_stats_t ms_stats; - -/* global statistic structure */ -ms_statistic_t ms_statistic; - -#define PROGRAM_NAME "memaslap" -#define PROGRAM_DESCRIPTION "Generates workload against memcached servers." - -#ifdef __sun -/* For some odd reason the option struct on solaris defines the argument - * as char* and not const char* - */ -# define OPTIONSTRING char * -#else -# define OPTIONSTRING const char * -#endif - -/* options */ -static struct option long_options[] = { - {(OPTIONSTRING) "servers", required_argument, NULL, OPT_SERVERS}, - {(OPTIONSTRING) "threads", required_argument, NULL, OPT_THREAD_NUMBER}, - {(OPTIONSTRING) "concurrency", required_argument, NULL, OPT_CONCURRENCY}, - {(OPTIONSTRING) "conn_sock", required_argument, NULL, OPT_SOCK_PER_CONN}, - {(OPTIONSTRING) "execute_number", required_argument, NULL, OPT_EXECUTE_NUMBER}, - {(OPTIONSTRING) "time", required_argument, NULL, OPT_TIME}, - {(OPTIONSTRING) "cfg_cmd", required_argument, NULL, OPT_CONFIG_CMD}, - {(OPTIONSTRING) "win_size", required_argument, NULL, OPT_WINDOW_SIZE}, - {(OPTIONSTRING) "fixed_size", required_argument, NULL, OPT_FIXED_LTH}, - {(OPTIONSTRING) "verify", required_argument, NULL, OPT_VERIFY}, - {(OPTIONSTRING) "division", required_argument, NULL, OPT_GETS_DIVISION}, - {(OPTIONSTRING) "stat_freq", required_argument, NULL, OPT_STAT_FREQ}, - {(OPTIONSTRING) "exp_verify", required_argument, NULL, OPT_EXPIRE}, - {(OPTIONSTRING) "overwrite", required_argument, NULL, OPT_OVERWRITE}, - {(OPTIONSTRING) "reconnect", no_argument, NULL, OPT_RECONNECT}, - {(OPTIONSTRING) "udp", no_argument, NULL, OPT_UDP}, - {(OPTIONSTRING) "facebook", no_argument, NULL, OPT_FACEBOOK_TEST}, - {(OPTIONSTRING) "binary", no_argument, NULL, OPT_BINARY_PROTOCOL}, - {(OPTIONSTRING) "tps", required_argument, NULL, OPT_TPS}, - {(OPTIONSTRING) "rep_write", required_argument, NULL, OPT_REP_WRITE_SRV}, - {(OPTIONSTRING) "verbose", no_argument, NULL, OPT_VERBOSE}, - {(OPTIONSTRING) "help", no_argument, NULL, OPT_HELP}, - {(OPTIONSTRING) "version", no_argument, NULL, OPT_VERSION}, - {0, 0, 0, 0}, -}; - -/* Prototypes */ -static void ms_sync_lock_init(void); -static void ms_sync_lock_destroy(void); -static void ms_global_struct_init(void); -static void ms_global_struct_destroy(void); -static void ms_version_command(const char *command_name); -static const char *ms_lookup_help(ms_options_t option); -static int64_t ms_parse_time(void); -static int64_t ms_parse_size(void); -static void ms_options_parse(int argc, char *argv[]); -static int ms_check_para(void); -static void ms_statistic_init(void); -static void ms_stats_init(void); -static void ms_print_statistics(int in_time); -static void ms_print_memaslap_stats(struct timeval *start_time, struct timeval *end_time); -static void ms_monitor_slap_mode(void); - -/** - * output the help information - * - * @param command_name, the string of this process - * @param description, description of this process - * @param long_options, global options array - */ -static void ms_help_command(const char *command_name, const char *description) { - char *help_message = NULL; - - printf("%s v%u.%u\n", command_name, 1U, 0U); - printf(" %s\n\n", description); - printf("Usage:\n" - " memaslap -hV | -s servers [-F config_file] [-t time | -x exe_num] [...]\n\n" - "Options:\n"); - - for (int x = 0; long_options[x].name; x++) { - printf(" -%c, --%s%c\n", long_options[x].val, long_options[x].name, - long_options[x].has_arg ? '=' : ' '); - - if ((help_message = (char *) ms_lookup_help(long_options[x].val))) { - printf(" %s\n", help_message); - } - } - - printf("\nExamples:\n" - " memaslap -s 127.0.0.1:11211 -S 5s\n" - " memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b\n" - " memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2\n" - " memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k\n" - " memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40\n" - " memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m\n" - " memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2\n\n"); -} /* ms_help_command */ - -/* initialize the global locks */ -static void ms_sync_lock_init() { - ms_global.init_lock.count = 0; - pthread_mutex_init(&ms_global.init_lock.lock, NULL); - pthread_cond_init(&ms_global.init_lock.cond, NULL); - - ms_global.warmup_lock.count = 0; - pthread_mutex_init(&ms_global.warmup_lock.lock, NULL); - pthread_cond_init(&ms_global.warmup_lock.cond, NULL); - - ms_global.run_lock.count = 0; - pthread_mutex_init(&ms_global.run_lock.lock, NULL); - pthread_cond_init(&ms_global.run_lock.cond, NULL); - - pthread_mutex_init(&ms_global.quit_mutex, NULL); - pthread_mutex_init(&ms_global.seq_mutex, NULL); -} /* ms_sync_lock_init */ - -/* destroy the global locks */ -static void ms_sync_lock_destroy() { - pthread_mutex_destroy(&ms_global.init_lock.lock); - pthread_cond_destroy(&ms_global.init_lock.cond); - - pthread_mutex_destroy(&ms_global.warmup_lock.lock); - pthread_cond_destroy(&ms_global.warmup_lock.cond); - - pthread_mutex_destroy(&ms_global.run_lock.lock); - pthread_cond_destroy(&ms_global.run_lock.cond); - - pthread_mutex_destroy(&ms_global.quit_mutex); - pthread_mutex_destroy(&ms_global.seq_mutex); - - if (ms_setting.stat_freq > 0) { - pthread_mutex_destroy(&ms_statistic.stat_mutex); - } -} /* ms_sync_lock_destroy */ - -/* initialize the global structure */ -static void ms_global_struct_init() { - ms_sync_lock_init(); - ms_global.finish_warmup = false; - ms_global.time_out = false; -} - -/* destroy the global structure */ -static void ms_global_struct_destroy() { - ms_sync_lock_destroy(); -} - -/** - * output the version information - * - * @param command_name, the string of this process - */ -static void ms_version_command(const char *command_name) { - printf("%s v%u.%u\n", command_name, 1U, 0U); - exit(0); -} - -/** - * get the description of the option - * - * @param option, option of command line - * - * @return char*, description of the command option - */ -static const char *ms_lookup_help(ms_options_t option) { - switch (option) { - case OPT_SERVERS: - return "List one or more servers to connect. Servers count must be less than\n" - " threads count. e.g.: --servers=localhost:1234,localhost:11211"; - - case OPT_VERSION: - return "Display the version of the application and then exit."; - - case OPT_HELP: - return "Display this message and then exit."; - - case OPT_EXECUTE_NUMBER: - return "Number of operations(get and set) to execute for the\n" - " given test. Default 1000000."; - - case OPT_THREAD_NUMBER: - return "Number of threads to startup, better equal to CPU numbers. Default 8."; - - case OPT_CONCURRENCY: - return "Number of concurrency to simulate with load. Default 128."; - - case OPT_FIXED_LTH: - return "Fixed length of value."; - - case OPT_VERIFY: - return "The proportion of date verification, e.g.: --verify=0.01"; - - case OPT_GETS_DIVISION: - return "Number of keys to multi-get once. Default 1, means single get."; - - case OPT_TIME: - return "How long the test to run, suffix: s-seconds, m-minutes, h-hours,\n" - " d-days e.g.: --time=2h."; - - case OPT_CONFIG_CMD: - return "Load the configure file to get command,key and value distribution list."; - - case OPT_WINDOW_SIZE: - return "Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k.\n" - " Default 10k."; - - case OPT_UDP: - return "UDP support, by default memaslap uses TCP; TCP port and UDP port of\n" - " server must be same."; - - case OPT_EXPIRE: - return "The proportion of objects with expire time, e.g.: --exp_verify=0.01.\n" - " Default no object with expire time"; - - case OPT_OVERWRITE: - return "The proportion of objects need overwrite, e.g.: --overwrite=0.01.\n" - " Default never overwrite object."; - - case OPT_STAT_FREQ: - return "Frequency of dumping statistic information. suffix: s-seconds,\n" - " m-minutes, e.g.: --resp_freq=10s."; - - case OPT_SOCK_PER_CONN: - return "Number of TCP socks per concurrency. Default 1."; - - case OPT_RECONNECT: - return "Reconnect support, when connection is closed it will be reconnected."; - - case OPT_VERBOSE: - return "Whether it outputs detailed information when verification fails."; - - case OPT_FACEBOOK_TEST: - return "Whether it enables facebook test feature, set with TCP and multi-get with UDP."; - - case OPT_BINARY_PROTOCOL: - return "Whether it enables binary protocol. Default with ASCII protocol."; - - case OPT_TPS: - return "Expected throughput, suffix: K, e.g.: --tps=10k."; - - case OPT_REP_WRITE_SRV: - return "The first nth servers can write data, e.g.: --rep_write=2."; - - default: - return "Forgot to document this option :)"; - } /* switch */ -} /* ms_lookup_help */ - -/* used to parse the time string */ -static int64_t ms_parse_time() { - int64_t ret = 0; - char unit = optarg[strlen(optarg) - 1]; - - optarg[strlen(optarg) - 1] = '\0'; - ret = atoi(optarg); - - switch (unit) { - case 'd': - case 'D': - ret *= 24; - /* fall through */ - case 'h': - case 'H': - ret *= 60; - /* fall through */ - case 'm': - case 'M': - ret *= 60; - /* fall through */ - case 's': - case 'S': - break; - - default: - ret = -1; - break; - } /* switch */ - - return ret; -} /* ms_parse_time */ - -/* used to parse the size string */ -static int64_t ms_parse_size() { - int64_t ret = -1; - char unit = optarg[strlen(optarg) - 1]; - - optarg[strlen(optarg) - 1] = '\0'; - errno = 0; - ret = strtoll(optarg, (char **) NULL, 10); - if (errno) { - fprintf(stderr, "strtoll(optarg,..): %s\n", strerror(errno)); - exit(1); - } - - switch (unit) { - case 'k': - case 'K': - ret *= 1024; - break; - - case 'm': - case 'M': - ret *= 1024 * 1024; - break; - - case 'g': - case 'G': - ret *= 1024 * 1024 * 1024; - break; - - default: - ret = -1; - break; - } /* switch */ - - return ret; -} /* ms_parse_size */ - -/* used to parse the options of command line */ -static void ms_options_parse(int argc, char *argv[]) { - int option_index = 0; - int option_rv; - - while ((option_rv = getopt_long(argc, argv, - "VhURbaBs:x:T:c:X:v:d:" - "t:S:F:w:e:o:n:P:p:", - long_options, &option_index)) - != -1) - { - switch (option_rv) { - case 0: - break; - - case OPT_VERSION: /* --version or -V */ - ms_version_command(PROGRAM_NAME); - break; - - case OPT_HELP: /* --help or -h */ - ms_help_command(PROGRAM_NAME, PROGRAM_DESCRIPTION); - exit(0); - break; - - case OPT_SERVERS: /* --servers or -s */ - ms_setting.srv_str = strdup(optarg); - break; - - case OPT_CONCURRENCY: /* --concurrency or -c */ - errno = 0; - ms_setting.nconns = (uint32_t) strtoul(optarg, (char **) NULL, 10); - if (ms_setting.nconns <= 0 || errno) { - fprintf(stderr, "Concurrency must be greater than 0.:-)\n"); - exit(1); - } - break; - - case OPT_EXECUTE_NUMBER: /* --execute_number or -x */ - errno = 0; - ms_setting.exec_num = (int) strtol(optarg, (char **) NULL, 10); - if (ms_setting.exec_num <= 0 || errno) { - fprintf(stderr, "Execute number must be greater than 0.:-)\n"); - exit(1); - } - break; - - case OPT_THREAD_NUMBER: /* --threads or -T */ - errno = 0; - ms_setting.nthreads = (uint32_t) strtoul(optarg, (char **) NULL, 10); - if (ms_setting.nthreads <= 0 || errno) { - fprintf(stderr, "Threads number must be greater than 0.:-)\n"); - exit(1); - } - break; - - case OPT_FIXED_LTH: /* --fixed_size or -X */ - errno = 0; - ms_setting.fixed_value_size = (size_t) strtoull(optarg, (char **) NULL, 10); - if ((ms_setting.fixed_value_size <= 0 || errno) - || (ms_setting.fixed_value_size > MAX_VALUE_SIZE)) - { - fprintf(stderr, "Value size must be between 0 and 1M.:-)\n"); - exit(1); - } - break; - - case OPT_VERIFY: /* --verify or -v */ - ms_setting.verify_percent = atof(optarg); - if ((ms_setting.verify_percent <= 0) || (ms_setting.verify_percent > 1.0)) { - fprintf(stderr, - "Data verification rate must be " - "greater than 0 and less than 1.0. :-)\n"); - exit(1); - } - break; - - case OPT_GETS_DIVISION: /* --division or -d */ - errno = 0; - ms_setting.mult_key_num = (int) strtol(optarg, (char **) NULL, 10); - if (ms_setting.mult_key_num <= 0 || errno) { - fprintf(stderr, "Multi-get key number must be greater than 0.:-)\n"); - exit(1); - } - break; - - case OPT_TIME: /* --time or -t */ - ms_setting.run_time = (int) ms_parse_time(); - if (ms_setting.run_time == -1) { - fprintf(stderr, - "Please specify the run time. :-)\n" - "'s' for second, 'm' for minute, 'h' for hour, " - "'d' for day. e.g.: --time=24h (means 24 hours).\n"); - exit(1); - } - - if (ms_setting.run_time == 0) { - fprintf(stderr, "Running time can not be 0. :-)\n"); - exit(1); - } - break; - - case OPT_CONFIG_CMD: /* --cfg_cmd or -F */ - ms_setting.cfg_file = strdup(optarg); - break; - - case OPT_WINDOW_SIZE: /* --win_size or -w */ - ms_setting.win_size = (size_t) ms_parse_size(); - if (ms_setting.win_size == (size_t) -1) { - fprintf(stderr, - "Please specify the item window size. :-)\n" - "e.g.: --win_size=10k (means 10k task window size).\n"); - exit(1); - } - break; - - case OPT_UDP: /* --udp or -U*/ - ms_setting.udp = true; - break; - - case OPT_EXPIRE: /* --exp_verify or -e */ - ms_setting.exp_ver_per = atof(optarg); - if ((ms_setting.exp_ver_per <= 0) || (ms_setting.exp_ver_per > 1.0)) { - fprintf(stderr, - "Expire time verification rate must be " - "greater than 0 and less than 1.0. :-)\n"); - exit(1); - } - break; - - case OPT_OVERWRITE: /* --overwrite or -o */ - ms_setting.overwrite_percent = atof(optarg); - if ((ms_setting.overwrite_percent <= 0) || (ms_setting.overwrite_percent > 1.0)) { - fprintf(stderr, - "Objects overwrite rate must be " - "greater than 0 and less than 1.0. :-)\n"); - exit(1); - } - break; - - case OPT_STAT_FREQ: /* --stat_freq or -S */ - ms_setting.stat_freq = (int) ms_parse_time(); - if (ms_setting.stat_freq == -1) { - fprintf(stderr, - "Please specify the frequency of dumping " - "statistic information. :-)\n" - "'s' for second, 'm' for minute, 'h' for hour, " - "'d' for day. e.g.: --time=24h (means 24 hours).\n"); - exit(1); - } - - if (ms_setting.stat_freq == 0) { - fprintf(stderr, - "The frequency of dumping statistic information " - "can not be 0. :-)\n"); - exit(1); - } - break; - - case OPT_SOCK_PER_CONN: /* --conn_sock or -n */ - errno = 0; - ms_setting.sock_per_conn = (uint32_t) strtoul(optarg, (char **) NULL, 10); - if (ms_setting.sock_per_conn <= 0 || errno) { - fprintf(stderr, - "Number of socks of each concurrency " - "must be greater than 0.:-)\n"); - exit(1); - } - break; - - case OPT_RECONNECT: /* --reconnect or -R */ - ms_setting.reconnect = true; - break; - - case OPT_VERBOSE: /* --verbose or -b */ - ms_setting.verbose = true; - break; - - case OPT_FACEBOOK_TEST: /* --facebook or -a */ - ms_setting.facebook_test = true; - break; - - case OPT_BINARY_PROTOCOL: /* --binary or -B */ - ms_setting.binary_prot_ = true; - break; - - case OPT_TPS: /* --tps or -P */ - ms_setting.expected_tps = (int) ms_parse_size(); - if (ms_setting.expected_tps == -1) { - fprintf(stderr, - "Please specify the item expected throughput. :-)\n" - "e.g.: --tps=10k (means 10k throughput).\n"); - exit(1); - } - break; - - case OPT_REP_WRITE_SRV: /* --rep_write or -p */ - errno = 0; - ms_setting.rep_write_srv = (uint32_t) strtoul(optarg, (char **) NULL, 10); - if (ms_setting.rep_write_srv <= 0 || errno) { - fprintf(stderr, - "Number of replication writing server must be greater " - "than 0.:-)\n"); - exit(1); - } - break; - - case '?': - /* getopt_long already printed an error message. */ - exit(1); - - default: - abort(); - } /* switch */ - } -} /* ms_options_parse */ - -static int ms_check_para() { - if (ms_setting.srv_str == NULL) { - char *temp; - - if ((temp = getenv("MEMCACHED_SERVERS"))) { - ms_setting.srv_str = strdup(temp); - } else { - fprintf(stderr, "No servers provided\n\n"); - return -1; - } - } - - if (ms_setting.nconns % (uint32_t) ms_setting.nthreads) { - fprintf(stderr, "Concurrency must be the multiples of threads count.\n"); - return -1; - } - - if (ms_setting.win_size % UNIT_ITEMS_COUNT) { - fprintf(stderr, "Window size must be the multiples of 1024.\n\n"); - return -1; - } - - return EXIT_SUCCESS; -} /* ms_check_para */ - -/* initialize the statistic structure */ -static void ms_statistic_init() { - pthread_mutex_init(&ms_statistic.stat_mutex, NULL); - ms_init_stats(&ms_statistic.get_stat, "Get"); - ms_init_stats(&ms_statistic.set_stat, "Set"); - ms_init_stats(&ms_statistic.total_stat, "Total"); -} /* ms_statistic_init */ - -/* initialize the global state structure */ -static void ms_stats_init() { - memset(&ms_stats, 0, sizeof(ms_stats_t)); - if (ms_setting.stat_freq > 0) { - ms_statistic_init(); - } -} /* ms_stats_init */ - -/* use to output the statistic */ -static void ms_print_statistics(int in_time) { - int obj_size = (int) (ms_setting.avg_key_size + ms_setting.avg_val_size); - - printf("\033[1;1H\033[2J\n"); - ms_dump_format_stats(&ms_statistic.get_stat, in_time, ms_setting.stat_freq, obj_size); - ms_dump_format_stats(&ms_statistic.set_stat, in_time, ms_setting.stat_freq, obj_size); - ms_dump_format_stats(&ms_statistic.total_stat, in_time, ms_setting.stat_freq, obj_size); -} /* ms_print_statistics */ - -/* used to print the states of memaslap */ -static void ms_print_memaslap_stats(struct timeval *start_time, struct timeval *end_time) { - char buf[0x2000]; - char *pos = buf; - - pos += snprintf(pos, sizeof(buf), "cmd_get: %lu\n", (unsigned long) ms_stats.cmd_get); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "cmd_set: %lu\n", - (unsigned long) ms_stats.cmd_set); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "get_misses: %lu\n", - (unsigned long) ms_stats.get_misses); - - if (ms_setting.verify_percent > 0) { - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "verify_misses: %lu\n", - (unsigned long) ms_stats.vef_miss); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "verify_failed: %lu\n", - (unsigned long) ms_stats.vef_failed); - } - - if (ms_setting.exp_ver_per > 0) { - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "expired_get: %lu\n", - (unsigned long) ms_stats.exp_get); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "unexpired_unget: %lu\n", - (unsigned long) ms_stats.unexp_unget); - } - - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "written_bytes: %lu\n", - (unsigned long) ms_stats.bytes_written); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "read_bytes: %lu\n", - (unsigned long) ms_stats.bytes_read); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "object_bytes: %lu\n", - (unsigned long) ms_stats.obj_bytes); - - if (ms_setting.udp || ms_setting.facebook_test) { - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "packet_disorder: %lu\n", - (unsigned long) ms_stats.pkt_disorder); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "packet_drop: %lu\n", - (unsigned long) ms_stats.pkt_drop); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), "udp_timeout: %lu\n", - (unsigned long) ms_stats.udp_timeout); - } - - if (ms_setting.stat_freq > 0) { - ms_dump_stats(&ms_statistic.get_stat); - ms_dump_stats(&ms_statistic.set_stat); - ms_dump_stats(&ms_statistic.total_stat); - } - - int64_t time_diff = ms_time_diff(start_time, end_time); - pos += snprintf(pos, sizeof(buf) - (size_t)(pos - buf), - "\nRun time: %.1fs Ops: %llu TPS: %.0Lf Net_rate: %.1fM/s\n", - (double) time_diff / 1000000, - (unsigned long long) (ms_stats.cmd_get + ms_stats.cmd_set), - (ms_stats.cmd_get + ms_stats.cmd_set) / ((long double) time_diff / 1000000), - (double) (ms_stats.bytes_written + ms_stats.bytes_read) / 1024 / 1024 - / ((double) time_diff / 1000000)); - assert(pos <= (buf + sizeof(buf))); - - fwrite(buf, 1, pos - buf, stdout); - fflush(stdout); -} /* ms_print_memaslap_stats */ - -/* the loop of the main thread, wait the work threads to complete */ -static void ms_monitor_slap_mode() { - struct timeval start_time, end_time; - - /* Wait all the threads complete initialization. */ - pthread_mutex_lock(&ms_global.init_lock.lock); - while (ms_global.init_lock.count < ms_setting.nthreads) { - pthread_cond_wait(&ms_global.init_lock.cond, &ms_global.init_lock.lock); - } - pthread_mutex_unlock(&ms_global.init_lock.lock); - - /* only when there is no set operation it need warm up */ - if (ms_setting.cmd_distr[CMD_SET].cmd_prop < PROP_ERROR) { - /* Wait all the connects complete warm up. */ - pthread_mutex_lock(&ms_global.warmup_lock.lock); - while (ms_global.warmup_lock.count < ms_setting.nconns) { - pthread_cond_wait(&ms_global.warmup_lock.cond, &ms_global.warmup_lock.lock); - } - pthread_mutex_unlock(&ms_global.warmup_lock.lock); - } - ms_global.finish_warmup = true; - - /* running in "run time" mode, user specify run time */ - if (ms_setting.run_time > 0) { - int second = 0; - gettimeofday(&start_time, NULL); - while (1) { - sleep(1); - second++; - - if ((ms_setting.stat_freq > 0) && (second % ms_setting.stat_freq == 0) - && (ms_stats.active_conns >= ms_setting.nconns) && (ms_stats.active_conns <= INT_MAX)) - { - ms_print_statistics(second); - } - - if (ms_setting.run_time <= second) { - ms_global.time_out = true; - break; - } - - /* all connections disconnect */ - if ((second > 5) && (ms_stats.active_conns == 0)) { - break; - } - } - gettimeofday(&end_time, NULL); - sleep(1); /* wait all threads clean up */ - } else { - /* running in "execute number" mode, user specify execute number */ - gettimeofday(&start_time, NULL); - - /* - * We loop until we know that all connects have cleaned up. - */ - pthread_mutex_lock(&ms_global.run_lock.lock); - while (ms_global.run_lock.count < ms_setting.nconns) { - pthread_cond_wait(&ms_global.run_lock.cond, &ms_global.run_lock.lock); - } - pthread_mutex_unlock(&ms_global.run_lock.lock); - - gettimeofday(&end_time, NULL); - } - - ms_print_memaslap_stats(&start_time, &end_time); -} /* ms_monitor_slap_mode */ - -/* the main function */ -int main(int argc, char *argv[]) { - srandom((unsigned int) time(NULL)); - ms_global_struct_init(); - - /* initialization */ - ms_setting_init_pre(); - ms_options_parse(argc, argv); - if (ms_check_para()) { - ms_help_command(PROGRAM_NAME, PROGRAM_DESCRIPTION); - exit(1); - } - ms_setting_init_post(); - ms_stats_init(); - ms_thread_init(); - - /* waiting work thread complete its task */ - ms_monitor_slap_mode(); - - /* clean up */ - ms_thread_cleanup(); - ms_global_struct_destroy(); - ms_setting_cleanup(); - - return EXIT_SUCCESS; -} /* main */ diff --git a/contrib/bin/memaslap/ms_memslap.h b/contrib/bin/memaslap/ms_memslap.h deleted file mode 100644 index 16eb6935e..000000000 --- a/contrib/bin/memaslap/ms_memslap.h +++ /dev/null @@ -1,133 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_MEMSLAP_H -#define MS_MEMSLAP_H - -#include -#include -#include -#include -#include -#include -#include -#include -#if !defined(__cplusplus) -# include -#endif -#include - -#include "ms_stats.h" -#include "ms_atomic.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/* command line option */ -typedef enum { - OPT_VERSION = 'V', - OPT_HELP = 'h', - OPT_UDP = 'U', - OPT_SERVERS = 's', - OPT_EXECUTE_NUMBER = 'x', - OPT_THREAD_NUMBER = 'T', - OPT_CONCURRENCY = 'c', - OPT_FIXED_LTH = 'X', - OPT_VERIFY = 'v', - OPT_GETS_DIVISION = 'd', - OPT_TIME = 't', - OPT_CONFIG_CMD = 'F', - OPT_WINDOW_SIZE = 'w', - OPT_EXPIRE = 'e', - OPT_STAT_FREQ = 'S', - OPT_RECONNECT = 'R', - OPT_VERBOSE = 'b', - OPT_FACEBOOK_TEST = 'a', - OPT_SOCK_PER_CONN = 'n', - OPT_BINARY_PROTOCOL = 'B', - OPT_OVERWRITE = 'o', - OPT_TPS = 'P', - OPT_REP_WRITE_SRV = 'p' -} ms_options_t; - -/* global statistic of response time */ -typedef struct statistic { - pthread_mutex_t stat_mutex; /* synchronize the following members */ - - ms_stat_t get_stat; /* statistics of get command */ - ms_stat_t set_stat; /* statistics of set command */ - ms_stat_t total_stat; /* statistics of both get and set commands */ -} ms_statistic_t; - -/* global status statistic structure */ -typedef struct stats { - ATOMIC uint32_t active_conns; /* active connections */ - ATOMIC size_t bytes_read; /* read bytes */ - ATOMIC size_t bytes_written; /* written bytes */ - ATOMIC size_t obj_bytes; /* object bytes */ - ATOMIC size_t pre_cmd_get; /* previous total get command count */ - ATOMIC size_t pre_cmd_set; /* previous total set command count */ - ATOMIC size_t cmd_get; /* current total get command count */ - ATOMIC size_t cmd_set; /* current total set command count */ - ATOMIC size_t get_misses; /* total objects of get miss */ - ATOMIC size_t vef_miss; /* total objects of verification miss */ - ATOMIC size_t vef_failed; /* total objects of verification failed */ - ATOMIC size_t unexp_unget; /* total objects which is unexpired but not get */ - ATOMIC size_t exp_get; /* total objects which is expired but get */ - ATOMIC size_t pkt_disorder; /* disorder packages of UDP */ - ATOMIC size_t pkt_drop; /* packages dropped of UDP */ - ATOMIC size_t udp_timeout; /* how many times timeout of UDP happens */ -} ms_stats_t; - -/* lock adapter */ -typedef struct sync_lock { - uint32_t count; - pthread_mutex_t lock; - pthread_cond_t cond; -} ms_sync_lock_t; - -/* global variable structure */ -typedef struct global { - /* synchronize lock */ - ms_sync_lock_t init_lock; - ms_sync_lock_t warmup_lock; - ms_sync_lock_t run_lock; - - /* mutex for outputing error log synchronously when memslap crashes */ - pthread_mutex_t quit_mutex; - - /* mutex for generating key prefix */ - pthread_mutex_t seq_mutex; - - /* global synchronous flags for slap mode */ - ATOMIC bool finish_warmup; - ATOMIC bool time_out; -} ms_global_t; - -/* global structure */ -extern ms_global_t ms_global; - -/* global stats information structure */ -extern ms_stats_t ms_stats; - -/* global statistic structure */ -extern ms_statistic_t ms_statistic; - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_MEMSLAP_H */ diff --git a/contrib/bin/memaslap/ms_setting.c b/contrib/bin/memaslap/ms_setting.c deleted file mode 100644 index ec698d9b7..000000000 --- a/contrib/bin/memaslap/ms_setting.c +++ /dev/null @@ -1,900 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#include "libmemcached/memcached.h" - -#include -#include -#include -#include -#if HAVE_STRINGS_H -# include -#endif -#include -#if HAVE_UNISTD_H -# include -#endif - -#include "ms_setting.h" -#include "ms_conn.h" - -#define MAX_EXEC_NUM 0x4000000000000000 /* 1 << 62 */ -#define ADDR_ALIGN(addr) ((addr + 15) & ~(16 - 1)) /* 16 bytes aligned */ -#define RAND_CHAR_SIZE (10 * 1024 * 1024) /* 10M character table */ -#define RESERVED_RAND_CHAR_SIZE (2 * 1024 * 1024) /* reserved 2M to avoid pointer sloping over */ - -#define DEFAULT_CONFIG_NAME ".memslap.cnf" - -#define DEFAULT_THREADS_NUM 1 /* default start one thread */ -#define DEFAULT_CONNS_NUM 16 /* default each thread with 16 connections */ -#define DEFAULT_EXE_NUM 0 /* default execute number is 0 */ -#define DEFAULT_VERIFY_RATE 0.0 /* default it doesn't do data verification */ -#define DEFAULT_OVERWRITE_RATE 0.0 /* default it doesn't do overwrite */ -#define DEFAULT_DIV 1 /* default it runs single get */ -#define DEFAULT_RUN_TIME 600 /* default run time 10 minutes */ -#define DEFAULT_WINDOW_SIZE (10 * UNIT_ITEMS_COUNT) /* default window size is 10k */ -#define DEFAULT_SOCK_PER_CONN 1 /* default socks per connection is 1 */ - -/* Use this for string generation */ -#define CHAR_COUNT 64 /* number of characters used to generate character table */ -const char ALPHANUMBERICS[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz.-"; - -ms_setting_st ms_setting; /* store the settings specified by user */ - -/* read setting from configuration file */ -static void ms_get_serverlist(char *str); -static uint32_t ms_get_cpu_count(void); -ms_conf_type_t ms_get_conf_type(char *line); -static int ms_is_line_data(char *line); -static int ms_read_is_data(char *line, ssize_t nread); -static void ms_no_config_file(void); -static void ms_parse_cfg_file(char *cfg_file); - -/* initialize setting structure */ -static void ms_init_random_block(void); -static void ms_calc_avg_size(void); -static int ms_shuffle_distr(ms_distr_t *distr, int length); -static void ms_build_distr(void); -static void ms_print_setting(void); -static void ms_setting_slapmode_init_pre(void); -static void ms_setting_slapmode_init_post(void); - -#if !defined(HAVE_GETLINE) -# include -static ssize_t getline(char **line, size_t *line_size, FILE *fp) { - char delim = '\n'; - ssize_t result = 0; - size_t cur_len = 0; - - if (line == NULL || line_size == NULL || fp == NULL) { - errno = EINVAL; - return -1; - } - - if (*line == NULL || *line_size == 0) { - char *new_line; - *line_size = 120; - new_line = (char *) realloc(*line, *line_size); - if (new_line == NULL) { - result = -1; - return result; - } - *line = new_line; - } - - for (;;) { - int i = getc(fp); - if (i == EOF) { - result = -1; - break; - } - - /* Make enough space for len+1 (for final NUL) bytes. */ - if (cur_len + 1 >= *line_size) { - size_t needed_max = SSIZE_MAX < SIZE_MAX ? (size_t) SSIZE_MAX + 1 : SIZE_MAX; - size_t needed = (2 * (*line_size)) + 1; - char *new_line; - - if (needed_max < needed) - needed = needed_max; - if (cur_len + 1 >= needed) { - result = -1; - errno = EOVERFLOW; - return result; - } - - new_line = (char *) realloc(*line, needed); - if (new_line == NULL) { - result = -1; - return result; - } - - *line = new_line; - *line_size = needed; - } - - (*line)[cur_len] = (char) i; - cur_len++; - - if (i == delim) - break; - } - (*line)[cur_len] = '\0'; - if (cur_len) - return (ssize_t) cur_len; - return result; -} -#endif - -/** - * parse the server list string, and build the servers - * information structure array. this function is used to parse - * the command line options specified by user. - * - * @param str, the string of server list - */ -static void ms_get_serverlist(char *str) { - ms_mcd_server_t *srvs = NULL; - - /** - * Servers list format is like this. For example: - * "localhost:11108, localhost:11109" - */ - memcached_server_st *server_pool; - server_pool = memcached_servers_parse(str); - - for (uint32_t loop = 0; loop < memcached_server_list_count(server_pool); loop++) { - assert(ms_setting.srv_cnt < ms_setting.total_srv_cnt); - strcpy(ms_setting.servers[ms_setting.srv_cnt].srv_host_name, server_pool[loop].hostname); - ms_setting.servers[ms_setting.srv_cnt].srv_port = server_pool[loop].port; - ms_setting.servers[ms_setting.srv_cnt].disconn_cnt = 0; - ms_setting.servers[ms_setting.srv_cnt].reconn_cnt = 0; - ms_setting.srv_cnt++; - - if (ms_setting.srv_cnt >= ms_setting.total_srv_cnt) { - srvs = (ms_mcd_server_t *) realloc( - ms_setting.servers, (size_t) ms_setting.total_srv_cnt * sizeof(ms_mcd_server_t) * 2); - if (srvs == NULL) { - fprintf(stderr, "Can't reallocate servers structure.\n"); - exit(1); - } - ms_setting.servers = srvs; - ms_setting.total_srv_cnt *= 2; - } - } - - memcached_server_free(server_pool); -} /* ms_get_serverlist */ - -/** - * used to get the CPU count of the current system - * - * @return return the cpu count if possible, else return 1 - */ -static uint32_t ms_get_cpu_count() { -#ifdef HAVE_CPU_SET_T - unsigned cpu_count = 0; - cpu_set_t cpu_set; - - sched_getaffinity(0, sizeof(cpu_set_t), &cpu_set); - - for (unsigned i = 0; i < (sizeof(cpu_set_t) * 8); i++) { - if (CPU_ISSET(i, &cpu_set)) { - cpu_count++; - } - } - - return cpu_count; -#elif defined HAVE__SC_NPROCESSORS_ONLN - return sysconf(_SC_NPROCESSORS_CONF); -#endif - - /* the system with one cpu at least */ - return 1; -} /* ms_get_cpu_count */ - -/** - * used to get the configure type based on the type string read - * from the configuration file. - * - * @param line, string of one line - * - * @return ms_conf_type_t - */ -ms_conf_type_t ms_get_conf_type(char *line) { - if (!memcmp(line, "key", strlen("key"))) { - return CONF_KEY; - } else if (!memcmp(line, "value", strlen("value"))) { - return CONF_VALUE; - } else if (!memcmp(line, "cmd", strlen("cmd"))) { - return CONF_CMD; - } else { - return CONF_NULL; - } -} /* ms_get_conf_type */ - -/** - * judge whether the line is a line with useful data. used to - * parse the configuration file. - * - * @param line, string of one line - * - * @return if success, return EXIT_FAILURE, else return EXIT_SUCCESS - */ -static int ms_is_line_data(char *line) { - assert(line); - - char *begin_ptr = line; - - while (isspace(*begin_ptr)) { - begin_ptr++; - } - if ((begin_ptr[0] == '\0') || (begin_ptr[0] == '#')) - return EXIT_SUCCESS; - - return EXIT_FAILURE; -} /* ms_is_line_data */ - -/** - * function to bypass blank line and comments - * - * @param line, string of one line - * @param nread, length of the line - * - * @return if it's EOF or not line data, return EXIT_SUCCESS, else return EXIT_FAILURE - */ -static int ms_read_is_data(char *line, ssize_t nread) { - if ((nread == EOF) || !ms_is_line_data(line)) - return EXIT_SUCCESS; - - return EXIT_FAILURE; -} /* ms_read_is_data */ - -/** - * if no configuration file, use this function to create the default - * configuration file. - */ -static void ms_no_config_file() { - char userpath[PATH_MAX]; - struct passwd *usr = NULL; - FILE *fd; - - usr = getpwuid(getuid()); - - snprintf(userpath, PATH_MAX, "%s/%s", usr->pw_dir, DEFAULT_CONFIG_NAME); - - if (access(userpath, F_OK | R_OK) == 0) - goto exit; - - fd = fopen(userpath, "w+"); - - if (fd == NULL) { - fprintf(stderr, "Could not create default configure file %s\n", userpath); - perror("fopen"); - exit(1); - } - fprintf(fd, "%s", DEFAULT_CONGIF_STR); - fclose(fd); - -exit: - ms_setting.cfg_file = strdup(userpath); -} /* ms_no_config_file */ - -/** - * parse the configuration file - * - * @param cfg_file, the configuration file name - */ -static void ms_parse_cfg_file(char *cfg_file) { - FILE *f; - size_t start_len, end_len; - double proportion; - char *line = NULL; - size_t read_len; - ssize_t nread; - int cmd_type; - ms_conf_type_t conf_type; - int end_of_file = 0; - ms_key_distr_t *key_distr = NULL; - ms_value_distr_t *val_distr = NULL; - - if (cfg_file == NULL) { - ms_no_config_file(); - cfg_file = ms_setting.cfg_file; - } - - /*read key value configure file*/ - if ((f = fopen(cfg_file, "r")) == NULL) { - fprintf(stderr, "Can not open file: '%s'.\n", cfg_file); - exit(1); - } - - while (1) { - if ((((nread = getline(&line, &read_len, f)) == 1) || !ms_read_is_data(line, nread)) - && (nread != EOF)) /* bypass blank line */ - continue; - - if (nread == EOF) { - fprintf(stderr, "Bad configuration file, no configuration find.\n"); - exit(1); - } - conf_type = ms_get_conf_type(line); - break; - } - - while (!end_of_file) { - switch (conf_type) { - case CONF_KEY: - while (1) { - if ((((nread = getline(&line, &read_len, f)) == 1) || !ms_read_is_data(line, nread)) - && (nread != EOF)) /* bypass blank line */ - continue; - - if (nread != EOF) { - if (sscanf(line, "%zu %zu %lf ", &start_len, &end_len, &proportion) != 3) { - conf_type = ms_get_conf_type(line); - break; - } - ms_setting.key_distr[ms_setting.key_rng_cnt].start_len = start_len; - ms_setting.key_distr[ms_setting.key_rng_cnt].end_len = end_len; - ms_setting.key_distr[ms_setting.key_rng_cnt].key_prop = proportion; - ms_setting.key_rng_cnt++; - - if (ms_setting.key_rng_cnt >= ms_setting.total_key_rng_cnt) { - key_distr = (ms_key_distr_t *) realloc(ms_setting.key_distr, - (size_t) ms_setting.total_key_rng_cnt - * sizeof(ms_key_distr_t) * 2); - if (key_distr == NULL) { - fprintf(stderr, "Can't reallocate key distribution structure.\n"); - exit(1); - } - ms_setting.key_distr = key_distr; - ms_setting.total_key_rng_cnt *= 2; - } - continue; - } - end_of_file = 1; - break; - } - break; - - case CONF_VALUE: - while (1) { - if ((((nread = getline(&line, &read_len, f)) == 1) || !ms_read_is_data(line, nread)) - && (nread != EOF)) /* bypass blank line */ - continue; - - if (nread != EOF) { - if (sscanf(line, "%zu %zu %lf", &start_len, &end_len, &proportion) != 3) { - conf_type = ms_get_conf_type(line); - break; - } - ms_setting.value_distr[ms_setting.val_rng_cnt].start_len = start_len; - ms_setting.value_distr[ms_setting.val_rng_cnt].end_len = end_len; - ms_setting.value_distr[ms_setting.val_rng_cnt].value_prop = proportion; - ms_setting.val_rng_cnt++; - - if (ms_setting.val_rng_cnt >= ms_setting.total_val_rng_cnt) { - val_distr = (ms_value_distr_t *) realloc(ms_setting.value_distr, - (size_t) ms_setting.total_val_rng_cnt - * sizeof(ms_value_distr_t) * 2); - if (val_distr == NULL) { - fprintf(stderr, "Can't reallocate key distribution structure.\n"); - exit(1); - } - ms_setting.value_distr = val_distr; - ms_setting.total_val_rng_cnt *= 2; - } - continue; - } - end_of_file = 1; - break; - } - break; - - case CONF_CMD: - while (1) { - if ((((nread = getline(&line, &read_len, f)) == 1) || !ms_read_is_data(line, nread)) - && (nread != EOF)) /* bypass blank line */ - continue; - - if (nread != EOF) { - if (sscanf(line, "%d %lf", &cmd_type, &proportion) != 2) { - conf_type = ms_get_conf_type(line); - break; - } - if (cmd_type >= CMD_NULL) { - continue; - } - ms_setting.cmd_distr[ms_setting.cmd_used_count].cmd_type = cmd_type; - ms_setting.cmd_distr[ms_setting.cmd_used_count].cmd_prop = proportion; - ms_setting.cmd_used_count++; - continue; - } - end_of_file = 1; - break; - } - - case CONF_NULL: - while (1) { - if ((((nread = getline(&line, &read_len, f)) == 1) || !ms_read_is_data(line, nread)) - && (nread != EOF)) /* bypass blank line */ - continue; - - if (nread != EOF) { - if ((conf_type = ms_get_conf_type(line)) != CONF_NULL) { - break; - } - continue; - } - end_of_file = 1; - break; - } - break; - - default: - assert(0); - break; - } /* switch */ - } - - fclose(f); - - if (line) { - free(line); - } -} /* ms_parse_cfg_file */ - -/* calculate the average size of key and value */ -static void ms_calc_avg_size() { - double avg_val_size = 0.0; - double avg_key_size = 0.0; - double val_pro = 0.0; - double key_pro = 0.0; - double averge_len = 0.0; - size_t start_len = 0; - size_t end_len = 0; - - for (int j = 0; j < ms_setting.val_rng_cnt; j++) { - val_pro = ms_setting.value_distr[j].value_prop; - start_len = ms_setting.value_distr[j].start_len; - end_len = ms_setting.value_distr[j].end_len; - - averge_len = val_pro * ((double) (start_len + end_len)) / 2; - avg_val_size += averge_len; - } - - for (int j = 0; j < ms_setting.key_rng_cnt; j++) { - key_pro = ms_setting.key_distr[j].key_prop; - start_len = ms_setting.key_distr[j].start_len; - end_len = ms_setting.key_distr[j].end_len; - - averge_len = key_pro * ((double) (start_len + end_len)) / 2; - avg_key_size += averge_len; - } - - ms_setting.avg_val_size = (size_t) avg_val_size; - ms_setting.avg_key_size = (size_t) avg_key_size; -} /* ms_calc_avg_size */ - -/** - * used to shuffle key and value distribution array to ensure - * (key, value) pair with different set. - * - * @param distr, pointer of distribution structure array - * @param length, length of the array - * - * @return always return EXIT_SUCCESS - */ -static int ms_shuffle_distr(ms_distr_t *distr, int length) { - int i, j; - int tmp_offset; - size_t tmp_size; - int64_t rnd; - - for (i = 0; i < length; i++) { - rnd = random(); - j = (int) (rnd % (length - i)) + i; - - switch (rnd % 3) { - case 0: - tmp_size = distr[j].key_size; - distr[j].key_size = distr[i].key_size; - distr[i].key_size = tmp_size; - break; - - case 1: - tmp_offset = distr[j].key_offset; - distr[j].key_offset = distr[i].key_offset; - distr[i].key_offset = tmp_offset; - break; - - case 2: - tmp_size = distr[j].value_size; - distr[j].value_size = distr[i].value_size; - distr[i].value_size = tmp_size; - break; - - default: - break; - } /* switch */ - } - - return EXIT_SUCCESS; -} /* ms_shuffle_distr */ - -/** - * according to the key and value distribution, to build the - * (key, value) pair distribution. the (key, value) pair - * distribution array is global, each connection set or get - * object keeping this distribution, for the final result, we - * can reach the expected key and value distribution. - */ -static void ms_build_distr() { - int offset = 0; - int end = 0; - int key_cnt = 0; - int value_cnt = 0; - size_t average_len = 0; - size_t diff_len = 0; - size_t start_len = 0; - size_t end_len = 0; - int rnd = 0; - ms_distr_t *distr = NULL; - int units = (int) ms_setting.win_size / UNIT_ITEMS_COUNT; - - /* calculate average value size and key size */ - ms_calc_avg_size(); - - ms_setting.char_blk_size = RAND_CHAR_SIZE; - int key_scope_size = - (int) ((ms_setting.char_blk_size - RESERVED_RAND_CHAR_SIZE) / UNIT_ITEMS_COUNT); - - ms_setting.distr = (ms_distr_t *) malloc(sizeof(ms_distr_t) * ms_setting.win_size); - if (ms_setting.distr == NULL) { - fprintf(stderr, "Can't allocate distribution array."); - exit(1); - } - - /** - * character block is divided by how many different key - * size, each different key size has the same size character - * range. - */ - for (int m = 0; m < units; m++) { - for (int i = 0; i < UNIT_ITEMS_COUNT; i++) { - ms_setting.distr[m * UNIT_ITEMS_COUNT + i].key_offset = ADDR_ALIGN(key_scope_size * i); - } - } - - /* initialize key size distribution */ - for (int m = 0; m < units; m++) { - for (int j = 0; j < ms_setting.key_rng_cnt; j++) { - key_cnt = (int) (UNIT_ITEMS_COUNT * ms_setting.key_distr[j].key_prop); - start_len = ms_setting.key_distr[j].start_len; - end_len = ms_setting.key_distr[j].end_len; - if ((start_len < MIN_KEY_SIZE) || (end_len < MIN_KEY_SIZE)) { - fprintf(stderr, "key length must be greater than 16 bytes.\n"); - exit(1); - } - - if (!ms_setting.binary_prot_ && ((start_len > MAX_KEY_SIZE) || (end_len > MAX_KEY_SIZE))) { - fprintf(stderr, "key length must be less than 250 bytes.\n"); - exit(1); - } - - average_len = (start_len + end_len) / 2; - diff_len = (end_len - start_len) / 2; - for (int k = 0; k < key_cnt; k++) { - if (offset >= (m + 1) * UNIT_ITEMS_COUNT) { - break; - } - rnd = (int) random(); - if (k % 2 == 0) { - ms_setting.distr[offset].key_size = - (diff_len == 0) ? average_len : average_len + (size_t) rnd % diff_len; - } else { - ms_setting.distr[offset].key_size = - (diff_len == 0) ? average_len : average_len - (size_t) rnd % diff_len; - } - offset++; - } - } - - if (offset < (m + 1) * UNIT_ITEMS_COUNT) { - end = (m + 1) * UNIT_ITEMS_COUNT - offset; - for (int i = 0; i < end; i++) { - ms_setting.distr[offset].key_size = ms_setting.avg_key_size; - offset++; - } - } - } - offset = 0; - - /* initialize value distribution */ - if (ms_setting.fixed_value_size) { - for (int i = 0; i < units * UNIT_ITEMS_COUNT; i++) { - ms_setting.distr[i].value_size = ms_setting.fixed_value_size; - } - } else { - for (int m = 0; m < units; m++) { - for (int j = 0; j < ms_setting.val_rng_cnt; j++) { - value_cnt = (int) (UNIT_ITEMS_COUNT * ms_setting.value_distr[j].value_prop); - start_len = ms_setting.value_distr[j].start_len; - end_len = ms_setting.value_distr[j].end_len; - if ((start_len <= 0) || (end_len <= 0)) { - fprintf(stderr, "value length must be greater than 0 bytes.\n"); - exit(1); - } - - if ((start_len > MAX_VALUE_SIZE) || (end_len > MAX_VALUE_SIZE)) { - fprintf(stderr, "key length must be less than or equal to 1M.\n"); - exit(1); - } - - average_len = (start_len + end_len) / 2; - diff_len = (end_len - start_len) / 2; - for (int k = 0; k < value_cnt; k++) { - if (offset >= (m + 1) * UNIT_ITEMS_COUNT) { - break; - } - rnd = (int) random(); - if (k % 2 == 0) { - ms_setting.distr[offset].value_size = - (diff_len == 0) ? average_len : average_len + (size_t) rnd % diff_len; - } else { - ms_setting.distr[offset].value_size = - (diff_len == 0) ? average_len : average_len - (size_t) rnd % diff_len; - } - offset++; - } - } - - if (offset < (m + 1) * UNIT_ITEMS_COUNT) { - end = (m + 1) * UNIT_ITEMS_COUNT - offset; - for (int i = 0; i < end; i++) { - ms_setting.distr[offset++].value_size = ms_setting.avg_val_size; - } - } - } - } - - /* shuffle distribution */ - for (int i = 0; i < units; i++) { - distr = &ms_setting.distr[i * UNIT_ITEMS_COUNT]; - for (int j = 0; j < 4; j++) { - ms_shuffle_distr(distr, UNIT_ITEMS_COUNT); - } - } -} /* ms_build_distr */ - -/** - * used to initialize the global character block. The character - * block is used to generate the suffix of the key and value. we - * only store a pointer in the character block for each key - * suffix or value string. It can save much memory to store key - * or value string. - */ -static void ms_init_random_block() { - char *ptr = NULL; - - assert(ms_setting.char_blk_size > 0); - - ms_setting.char_block = (char *) malloc(ms_setting.char_blk_size); - if (ms_setting.char_block == NULL) { - fprintf(stderr, "Can't allocate global char block."); - exit(1); - } - ptr = ms_setting.char_block; - - for (int i = 0; (size_t) i < ms_setting.char_blk_size; i++) { - *(ptr++) = ALPHANUMBERICS[random() % CHAR_COUNT]; - } -} /* ms_init_random_block */ - -/** - * after initialization, call this function to output the main - * configuration user specified. - */ -static void ms_print_setting() { - fprintf(stdout, "servers: %s\n", ms_setting.srv_str); - fprintf(stdout, "threads count: %d\n", ms_setting.nthreads); - fprintf(stdout, "concurrency: %d\n", ms_setting.nconns); - if (ms_setting.run_time > 0) { - fprintf(stdout, "run time: %ds\n", ms_setting.run_time); - } else { - fprintf(stdout, "execute number: %" PRId64 "\n", ms_setting.exec_num); - } - fprintf(stdout, "windows size: %" PRId64 "k\n", (int64_t)(ms_setting.win_size / 1024)); - fprintf(stdout, "set proportion: set_prop=%.2f\n", ms_setting.cmd_distr[CMD_SET].cmd_prop); - fprintf(stdout, "get proportion: get_prop=%.2f\n", ms_setting.cmd_distr[CMD_GET].cmd_prop); - fflush(stdout); -} /* ms_print_setting */ - -/** - * previous part of slap mode initialization of setting structure - */ -static void ms_setting_slapmode_init_pre() { - ms_setting.exec_num = DEFAULT_EXE_NUM; - ms_setting.verify_percent = DEFAULT_VERIFY_RATE; - ms_setting.exp_ver_per = DEFAULT_VERIFY_RATE; - ms_setting.overwrite_percent = DEFAULT_OVERWRITE_RATE; - ms_setting.mult_key_num = DEFAULT_DIV; - ms_setting.fixed_value_size = 0; - ms_setting.win_size = DEFAULT_WINDOW_SIZE; - ms_setting.udp = false; - ms_setting.reconnect = false; - ms_setting.verbose = false; - ms_setting.facebook_test = false; - ms_setting.binary_prot_ = false; - ms_setting.stat_freq = 0; - ms_setting.srv_str = NULL; - ms_setting.cfg_file = NULL; - ms_setting.sock_per_conn = DEFAULT_SOCK_PER_CONN; - ms_setting.expected_tps = 0; - ms_setting.rep_write_srv = 0; -} /* ms_setting_slapmode_init_pre */ - -/** - * previous part of initialization of setting structure - */ -void ms_setting_init_pre() { - memset(&ms_setting, 0, sizeof(ms_setting)); - - /* common initialize */ - ms_setting.ncpu = ms_get_cpu_count(); - ms_setting.nthreads = DEFAULT_THREADS_NUM; - ms_setting.nconns = DEFAULT_CONNS_NUM; - ms_setting.run_time = DEFAULT_RUN_TIME; - ms_setting.total_srv_cnt = MCD_SRVS_NUM_INIT; - ms_setting.servers = - (ms_mcd_server_t *) malloc((size_t) ms_setting.total_srv_cnt * sizeof(ms_mcd_server_t)); - if (ms_setting.servers == NULL) { - fprintf(stderr, "Can't allocate servers structure.\n"); - exit(1); - } - - ms_setting_slapmode_init_pre(); -} /* ms_setting_init_pre */ - -/** - * post part of slap mode initialization of setting structure - */ -static void ms_setting_slapmode_init_post() { - ms_setting.total_key_rng_cnt = KEY_RANGE_COUNT_INIT; - ms_setting.key_distr = - (ms_key_distr_t *) malloc((size_t) ms_setting.total_key_rng_cnt * sizeof(ms_key_distr_t)); - - if (ms_setting.key_distr == NULL) { - fprintf(stderr, "Can't allocate key distribution structure.\n"); - exit(1); - } - - ms_setting.total_val_rng_cnt = VALUE_RANGE_COUNT_INIT; - - ms_setting.value_distr = - (ms_value_distr_t *) malloc((size_t) ms_setting.total_val_rng_cnt * sizeof(ms_value_distr_t)); - - if (ms_setting.value_distr == NULL) { - fprintf(stderr, "Can't allocate value distribution structure.\n"); - exit(1); - } - - ms_parse_cfg_file(ms_setting.cfg_file); - - /* run time mode */ - if ((ms_setting.exec_num == 0) && (ms_setting.run_time)) { - ms_setting.exec_num = (int64_t) MAX_EXEC_NUM; - } else { - /* execute number mode */ - ms_setting.run_time = 0; - } - - if (ms_setting.rep_write_srv > 0) { - /* for replication test, need enable reconnect feature */ - ms_setting.reconnect = true; - } - - if (ms_setting.facebook_test && (ms_setting.mult_key_num < 2)) { - fprintf(stderr, - "facebook test must work with multi-get, " - "please specify multi-get key number " - "with '--division' option.\n"); - exit(1); - } - - if (ms_setting.facebook_test && ms_setting.udp) { - fprintf(stderr, "facebook test couldn't work with UDP.\n"); - exit(1); - } - - if (ms_setting.udp && (ms_setting.sock_per_conn > 1)) { - fprintf(stderr, - "UDP doesn't support multi-socks " - "in one connection structure.\n"); - exit(1); - } - - if ((ms_setting.rep_write_srv > 0) && (ms_setting.srv_cnt < 2)) { - fprintf(stderr, "Please specify 2 servers at least for replication\n"); - exit(1); - } - - if ((ms_setting.rep_write_srv > 0) && (ms_setting.srv_cnt < ms_setting.rep_write_srv)) { - fprintf(stderr, - "Servers to do replication writing " - "is larger than the total servers\n"); - exit(1); - } - - if (ms_setting.udp && (ms_setting.rep_write_srv > 0)) { - fprintf(stderr, "UDP doesn't support replication.\n"); - exit(1); - } - - if (ms_setting.facebook_test && (ms_setting.rep_write_srv > 0)) { - fprintf(stderr, "facebook test couldn't work with replication.\n"); - exit(1); - } - - ms_build_distr(); - - /* initialize global character block */ - ms_init_random_block(); - ms_print_setting(); -} /* ms_setting_slapmode_init_post */ - -/** - * post part of initialization of setting structure - */ -void ms_setting_init_post() { - ms_get_serverlist(ms_setting.srv_str); - ms_setting_slapmode_init_post(); -} - -/** - * clean up the global setting structure - */ -void ms_setting_cleanup() { - if (ms_setting.distr) { - free(ms_setting.distr); - } - - if (ms_setting.char_block) { - free(ms_setting.char_block); - } - - if (ms_setting.srv_str) { - free(ms_setting.srv_str); - } - - if (ms_setting.cfg_file) { - free(ms_setting.cfg_file); - } - - if (ms_setting.servers) { - free(ms_setting.servers); - } - - if (ms_setting.key_distr) { - free(ms_setting.key_distr); - } - - if (ms_setting.value_distr) { - free(ms_setting.value_distr); - } -} /* ms_setting_cleanup */ diff --git a/contrib/bin/memaslap/ms_setting.h b/contrib/bin/memaslap/ms_setting.h deleted file mode 100644 index 8d6486ae7..000000000 --- a/contrib/bin/memaslap/ms_setting.h +++ /dev/null @@ -1,169 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_SETTING_H -#define MS_SETTING_H - -#include "ms_memslap.h" - -#ifdef HAVE_SYS_TIME_H -# include -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -#define MCD_SRVS_NUM_INIT 8 -#define MCD_HOST_LENGTH 64 -#define KEY_RANGE_COUNT_INIT 8 -#define VALUE_RANGE_COUNT_INIT 8 -#define PROP_ERROR 0.001 - -#define MIN_KEY_SIZE 16 -#define MAX_KEY_SIZE 250 -#define MAX_VALUE_SIZE (1024 * 1024) - -/* the content of the configuration file for memslap running without configuration file */ -#define DEFAULT_CONGIF_STR \ - "key\n" \ - "64 64 1\n" \ - "value\n" \ - "1024 1024 1\n" \ - "cmd\n" \ - "0 0.1\n" \ - "1 0.9" - -/* Used to parse the value length return by server and path string */ -typedef struct token_s { - char *value; - size_t length; -} token_t; - -#define MAX_TOKENS 10 - -/* server information */ -typedef struct mcd_server { - char srv_host_name[MCD_HOST_LENGTH]; /* host name of server */ - int srv_port; /* server port */ - - /* for calculating how long the server disconnects */ - ATOMIC uint32_t disconn_cnt; /* number of disconnections count */ - ATOMIC uint32_t reconn_cnt; /* number of reconnections count */ - struct timeval disconn_time; /* start time of disconnection */ - struct timeval reconn_time; /* end time of reconnection */ -} ms_mcd_server_t; - -/* information of an item distribution including key and value */ -typedef struct distr { - size_t key_size; /* size of key */ - int key_offset; /* offset of one key in character block */ - size_t value_size; /* size of value */ -} ms_distr_t; - -/* information of key distribution */ -typedef struct key_distr { - size_t start_len; /* start of the key length range */ - size_t end_len; /* end of the key length range */ - double key_prop; /* key proportion */ -} ms_key_distr_t; - -/* information of value distribution */ -typedef struct value_distr { - size_t start_len; /* start of the value length range */ - size_t end_len; /* end of the value length range */ - double value_prop; /* value proportion */ -} ms_value_distr_t; - -/* memcached command types */ -typedef enum cmd_type { CMD_SET, CMD_GET, CMD_NULL } ms_cmd_type_t; - -/* types in the configuration file */ -typedef enum conf_type { CONF_KEY, CONF_VALUE, CONF_CMD, CONF_NULL } ms_conf_type_t; - -/* information of command distribution */ -typedef struct cmd_distr { - ms_cmd_type_t cmd_type; /* command type */ - double cmd_prop; /* proportion of the command */ -} ms_cmd_distr_t; - -/* global setting structure */ -typedef struct setting { - uint32_t ncpu; /* cpu count of this system */ - uint32_t nthreads; /* total thread count, must equal or less than cpu cores */ - uint32_t nconns; /* total conn count, must multiply by total thread count */ - int64_t exec_num; /* total execute number */ - int run_time; /* total run time */ - - uint32_t char_blk_size; /* global character block size */ - char *char_block; /* global character block with random character */ - ms_distr_t *distr; /* distribution from configure file */ - - char *srv_str; /* string includes servers information */ - char *cfg_file; /* configure file name */ - - ms_mcd_server_t *servers; /* servers array */ - uint32_t total_srv_cnt; /* total servers count of the servers array */ - uint32_t srv_cnt; /* servers count */ - - ms_key_distr_t *key_distr; /* array of key distribution */ - int total_key_rng_cnt; /* total key range count of the array */ - int key_rng_cnt; /* actual key range count */ - - ms_value_distr_t *value_distr; /* array of value distribution */ - int total_val_rng_cnt; /* total value range count of the array */ - int val_rng_cnt; /* actual value range count */ - - ms_cmd_distr_t cmd_distr[CMD_NULL]; /* total we have CMD_NULL commands */ - int cmd_used_count; /* supported command count */ - - size_t fixed_value_size; /* fixed value size */ - size_t avg_val_size; /* average value size */ - size_t avg_key_size; /* average value size */ - - double verify_percent; /* percent of data verification */ - double exp_ver_per; /* percent of data verification with expire time */ - double overwrite_percent; /* percent of overwrite */ - int mult_key_num; /* number of keys used by multi-get once */ - size_t win_size; /* item window size per connection */ - bool udp; /* whether or not use UDP */ - int stat_freq; /* statistic frequency second */ - bool reconnect; /* whether it reconnect when connection close */ - bool verbose; /* whether it outputs detailed information when verification */ - bool facebook_test; /* facebook test, TCP set and multi-get with UDP */ - uint32_t sock_per_conn; /* number of socks per connection structure */ - bool binary_prot_; /* whether it use binary protocol */ - int expected_tps; /* expected throughput */ - uint32_t rep_write_srv; /* which servers are used to do replication writing */ -} ms_setting_st; - -extern ms_setting_st ms_setting; - -/* previous part of initialization of setting structure */ -void ms_setting_init_pre(void); - -/* post part of initialization of setting structure */ -void ms_setting_init_post(void); - -/* clean up the global setting structure */ -void ms_setting_cleanup(void); - -#define UNUSED_ARGUMENT(x) (void) x - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_SETTING_H */ diff --git a/contrib/bin/memaslap/ms_sigsegv.c b/contrib/bin/memaslap/ms_sigsegv.c deleted file mode 100644 index 5baea2a63..000000000 --- a/contrib/bin/memaslap/ms_sigsegv.c +++ /dev/null @@ -1,116 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#include -#include -#include -#include -#include - -#include "ms_memslap.h" -#include "ms_setting.h" - -/* prototypes */ -int ms_setup_sigsegv(void); -int ms_setup_sigpipe(void); -int ms_setup_sigint(void); - -/* signal seg reaches, this function will run */ -static void ms_signal_segv(int signum, siginfo_t *info, void *ptr) { - UNUSED_ARGUMENT(signum); - UNUSED_ARGUMENT(info); - UNUSED_ARGUMENT(ptr); - - pthread_mutex_lock(&ms_global.quit_mutex); - fprintf(stderr, "Segmentation fault occurred.\nStack trace:\n"); -#if 0 - pandora_print_callstack(stderr); -#endif - fprintf(stderr, "End of stack trace\n"); - pthread_mutex_unlock(&ms_global.quit_mutex); - abort(); -} - -/* signal int reaches, this function will run */ -static void ms_signal_int(int signum, siginfo_t *info, void *ptr) { - UNUSED_ARGUMENT(signum); - UNUSED_ARGUMENT(info); - UNUSED_ARGUMENT(ptr); - - pthread_mutex_lock(&ms_global.quit_mutex); - fprintf(stderr, "SIGINT handled.\n"); - pthread_mutex_unlock(&ms_global.quit_mutex); - exit(1); -} /* ms_signal_int */ - -/** - * redirect signal seg - * - * @return if success, return EXIT_SUCCESS, else return -1 - */ -int ms_setup_sigsegv(void) { - struct sigaction action; - - memset(&action, 0, sizeof(action)); - action.sa_sigaction = ms_signal_segv; - action.sa_flags = SA_SIGINFO; - if (sigaction(SIGSEGV, &action, NULL) < 0) { - perror("sigaction"); - return EXIT_SUCCESS; - } - - return -1; -} /* ms_setup_sigsegv */ - -/** - * redirect signal pipe - * - * @return if success, return EXIT_SUCCESS, else return -1 - */ -int ms_setup_sigpipe(void) { - /* ignore the SIGPIPE signal */ - signal(SIGPIPE, SIG_IGN); - - return -1; -} /* ms_setup_sigpipe */ - -/** - * redirect signal int - * - * @return if success, return EXIT_SUCCESS, else return -1 - */ -int ms_setup_sigint(void) { - struct sigaction action_3; - - memset(&action_3, 0, sizeof(action_3)); - action_3.sa_sigaction = ms_signal_int; - action_3.sa_flags = SA_SIGINFO; - if (sigaction(SIGINT, &action_3, NULL) < 0) { - perror("sigaction"); - return EXIT_SUCCESS; - } - - return -1; -} /* ms_setup_sigint */ - -#ifndef SIGSEGV_NO_AUTO_INIT -static void __attribute((constructor)) ms_init(void) { - ms_setup_sigsegv(); - ms_setup_sigpipe(); - ms_setup_sigint(); -} -#endif diff --git a/contrib/bin/memaslap/ms_sigsegv.h b/contrib/bin/memaslap/ms_sigsegv.h deleted file mode 100644 index cde1f4f90..000000000 --- a/contrib/bin/memaslap/ms_sigsegv.h +++ /dev/null @@ -1,36 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_SIGSEGV_H -#define MS_SIGSEGV_H - -#ifdef __cplusplus -extern "C" { -#endif - -/* redirect signal seg */ -int ms_setup_sigsegv(void); - -/* redirect signal pipe */ -int ms_setup_sigpipe(void); - -/* redirect signal int */ -int ms_setup_sigint(void); - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_SIGSEGV_H */ diff --git a/contrib/bin/memaslap/ms_stats.c b/contrib/bin/memaslap/ms_stats.c deleted file mode 100644 index 3b6970c75..000000000 --- a/contrib/bin/memaslap/ms_stats.c +++ /dev/null @@ -1,251 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#include -#include "ms_stats.h" - -#define array_size(x) (sizeof(x) / sizeof((x)[0])) - -static int ms_local_log2(uint64_t value); -static uint64_t ms_get_events(ms_stat_t *stat); - -/** - * get the index of local log2 array - * - * @param value - * - * @return return the index of local log2 array - */ -static int ms_local_log2(uint64_t value) { - int result = 0; - - while (result <= 63 && ((uint64_t) 1 << result) < value) { - result++; - } - - return result; -} /* ms_local_log2 */ - -/** - * initialize statistic structure - * - * @param stat, pointer of the statistic structure - * @param name, name of the statistic - */ -void ms_init_stats(ms_stat_t *stat, const char *name) { - memset(stat, 0, sizeof(*stat)); - - stat->name = (char *) name; - stat->min_time = (uint64_t) -1; - stat->max_time = 0; - stat->period_min_time = (uint64_t) -1; - stat->period_max_time = 0; - stat->log_product = 0; - stat->total_time = 0; - stat->pre_total_time = 0; - stat->squares = 0; - stat->pre_squares = 0; - stat->pre_events = 0; - stat->pre_log_product = 0; - stat->get_miss = 0; - stat->pre_get_miss = 0; -} /* ms_init_stats */ - -/** - * record one event - * - * @param stat, pointer of the statistic structure - * @param total_time, response time of the command - * @param get_miss, whether it gets miss - */ -void ms_record_event(ms_stat_t *stat, uint64_t total_time, int get_miss) { - stat->total_time += total_time; - - if (total_time < stat->min_time) { - stat->min_time = total_time; - } - - if (total_time > stat->max_time) { - stat->max_time = total_time; - } - - if (total_time < stat->period_min_time) { - stat->period_min_time = total_time; - } - - if (total_time > stat->period_max_time) { - stat->period_max_time = total_time; - } - - if (get_miss) { - stat->get_miss++; - } - - stat->dist[ms_local_log2(total_time)]++; - stat->squares += (double) (total_time * total_time); - - if (total_time) { - stat->log_product += log((double) total_time); - } -} /* ms_record_event */ - -/** - * get the events count - * - * @param stat, pointer of the statistic structure - * - * @return total events recorded - */ -#if HAVE_TSAN -__attribute__ (( no_sanitize_thread, no_sanitize("thread"))) -#endif -static uint64_t ms_get_events(ms_stat_t *stat) { - uint64_t events = 0; - - for (uint32_t i = 0; i < array_size(stat->dist); i++) { - events += stat->dist[i]; - } - - return events; -} /* ms_get_events */ - -/** - * dump the statistics - * - * @param stat, pointer of the statistic structure - */ -void ms_dump_stats(ms_stat_t *stat) { - uint64_t events = 0; - int max_non_zero = 0; - int min_non_zero = 0; - double average = 0; - - for (uint32_t i = 0; i < array_size(stat->dist); i++) { - events += stat->dist[i]; - if (stat->dist[i]) { - max_non_zero = (int) i; - } - } - - if (events == 0) { - return; - } - average = (double) (stat->total_time / events); - - printf("%s Statistics (%lld events)\n", stat->name, (long long) events); - printf(" Min: %8lld\n", (long long) stat->min_time); - printf(" Max: %8lld\n", (long long) stat->max_time); - printf(" Avg: %8lld\n", (long long) (stat->total_time / events)); - printf(" Geo: %8.2lf\n", exp(stat->log_product / (double) events)); - - if (events > 1) { - printf(" Std: %8.2lf\n", - sqrt((stat->squares - (double) events * average * average) / ((double) events - 1))); - } - printf(" Log2 Dist:"); - - for (int i = 0; i <= max_non_zero - 4; i += 4) { - if ((stat->dist[i + 0]) || (stat->dist[i + 1]) || (stat->dist[i + 2]) - || (stat->dist[i + 3])) - { - min_non_zero = i; - break; - } - } - - for (int i = min_non_zero; i <= max_non_zero; i++) { - if ((i % 4) == 0) { - printf("\n %2d:", (int) i); - } - printf(" %6" PRIu64, stat->dist[i]); - } - - printf("\n\n"); -} /* ms_dump_stats */ - -/** - * dump the format statistics - * - * @param stat, pointer of the statistic structure - * @param run_time, the total run time - * @param freq, statistic frequency - * @param obj_size, average object size - */ -#if HAVE_TSAN -__attribute__ (( no_sanitize_thread, no_sanitize("thread"))) -#endif -void ms_dump_format_stats(ms_stat_t *stat, int run_time, int freq, int obj_size) { - uint64_t events = 0; - double global_average = 0; - uint64_t global_tps = 0; - double global_rate = 0; - double global_std = 0; - double global_log = 0; - - double period_average = 0; - uint64_t period_tps = 0; - double period_rate = 0; - double period_std = 0; - double period_log = 0; - - if ((events = ms_get_events(stat)) == 0) { - return; - } - - global_average = (double) (stat->total_time / events); - global_tps = events / (uint64_t) run_time; - global_rate = (double) events * obj_size / 1024 / 1024 / run_time; - global_std = sqrt((stat->squares - (double) events * global_average * global_average) - / (double) (events - 1)); - global_log = exp(stat->log_product / (double) events); - - uint64_t diff_time = stat->total_time - stat->pre_total_time; - uint64_t diff_events = events - stat->pre_events; - if (diff_events >= 1) { - period_average = (double) (diff_time / diff_events); - period_tps = diff_events / (uint64_t) freq; - period_rate = (double) diff_events * obj_size / 1024 / 1024 / freq; - double diff_squares = (double) stat->squares - (double) stat->pre_squares; - period_std = sqrt((diff_squares - (double) diff_events * period_average * period_average) - / (double) (diff_events - 1)); - double diff_log_product = stat->log_product - stat->pre_log_product; - period_log = exp(diff_log_product / (double) diff_events); - } - - printf("%s Statistics\n", stat->name); - printf("%-8s %-8s %-12s %-12s %-10s %-10s %-8s %-10s %-10s %-10s %-10s\n", "Type", "Time(s)", - "Ops", "TPS(ops/s)", "Net(M/s)", "Get_miss", "Min(us)", "Max(us)", "Avg(us)", "Std_dev", - "Geo_dist"); - - printf("%-8s %-8d %-12llu %-12lld %-10.1f %-10lld %-8lld %-10lld %-10lld %-10.2f %.2f\n", - "Period", freq, (long long) diff_events, (long long) period_tps, period_rate, - (long long) (stat->get_miss - stat->pre_get_miss), (long long) stat->period_min_time, - (long long) stat->period_max_time, (long long) period_average, period_std, period_log); - - printf("%-8s %-8d %-12llu %-12lld %-10.1f %-10lld %-8lld %-10lld %-10lld %-10.2f %.2f\n\n", - "Global", run_time, (long long) events, (long long) global_tps, global_rate, - (long long) stat->get_miss, (long long) stat->min_time, (long long) stat->max_time, - (long long) global_average, global_std, global_log); - - stat->pre_events = events; - stat->pre_squares = (uint64_t) stat->squares; - stat->pre_total_time = stat->total_time; - stat->pre_log_product = stat->log_product; - stat->period_min_time = (uint64_t) -1; - stat->period_max_time = 0; - stat->pre_get_miss = stat->get_miss; -} /* ms_dump_format_stats */ diff --git a/contrib/bin/memaslap/ms_stats.h b/contrib/bin/memaslap/ms_stats.h deleted file mode 100644 index 2cdab7599..000000000 --- a/contrib/bin/memaslap/ms_stats.h +++ /dev/null @@ -1,66 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_STAT_H -#define MS_STAT_H - -#include -#include -#include -#include -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/* statistic structure of response time */ -typedef struct { - char *name; - uint64_t total_time; - uint64_t min_time; - uint64_t max_time; - uint64_t get_miss; - uint64_t dist[65]; - double squares; - double log_product; - - uint64_t period_min_time; - uint64_t period_max_time; - uint64_t pre_get_miss; - uint64_t pre_events; - uint64_t pre_total_time; - uint64_t pre_squares; - double pre_log_product; -} ms_stat_t; - -/* initialize statistic */ -void ms_init_stats(ms_stat_t *stat, const char *name); - -/* record one event */ -void ms_record_event(ms_stat_t *stat, uint64_t time, int get_miss); - -/* dump the statistics */ -void ms_dump_stats(ms_stat_t *stat); - -/* dump the format statistics */ -void ms_dump_format_stats(ms_stat_t *stat, int run_time, int freq, int obj_size); - -#ifdef __cplusplus -} -#endif - -#endif /* MS_STAT_H */ diff --git a/contrib/bin/memaslap/ms_task.c b/contrib/bin/memaslap/ms_task.c deleted file mode 100644 index 42e840b0f..000000000 --- a/contrib/bin/memaslap/ms_task.c +++ /dev/null @@ -1,925 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#if defined(HAVE_SYS_TIME_H) -# include -#endif -#include -#include - -#include "ms_thread.h" -#include "ms_setting.h" -#include "ms_atomic.h" - -/* command distribution adjustment cycle */ -#define CMD_DISTR_ADJUST_CYCLE 1000 -#define DISADJUST_FACTOR \ - 0.03 /** \ - * In one adjustment cycle, if undo set or get \ - * operations proportion is more than 3% , means \ - * there are too many new item or need more new \ - * item in the window. This factor shows it. \ - */ - -/* get item from task window */ -static ms_task_item_t *ms_get_cur_opt_item(ms_conn_t *c); -static ms_task_item_t *ms_get_next_get_item(ms_conn_t *c); -static ms_task_item_t *ms_get_next_set_item(ms_conn_t *c); -static ms_task_item_t *ms_get_random_overwrite_item(ms_conn_t *c); - -/* select next operation to do */ -static void ms_select_opt(ms_conn_t *c, ms_task_t *task); - -/* set and get speed estimate for controlling and adjustment */ -static bool ms_is_set_too_fast(ms_task_t *task); -static bool ms_is_get_too_fast(ms_task_t *task); -static void ms_kick_out_item(ms_task_item_t *item); - -/* miss rate adjustment */ -static bool ms_need_overwrite_item(ms_task_t *task); -static bool ms_adjust_opt(ms_conn_t *c, ms_task_t *task); - -/* deal with data verification initialization */ -static void ms_task_data_verify_init(ms_task_t *task); -static void ms_task_expire_verify_init(ms_task_t *task); - -/* select a new task to do */ -static ms_task_t *ms_get_task(ms_conn_t *c, bool warmup); - -/* run the selected task */ -static void ms_update_set_result(ms_conn_t *c, ms_task_item_t *item); -static void ms_update_stat_result(ms_conn_t *c); -static void ms_update_multi_get_result(ms_conn_t *c); -static void ms_update_single_get_result(ms_conn_t *c, ms_task_item_t *item); -static void ms_update_task_result(ms_conn_t *c); -static void ms_single_getset_task_sch(ms_conn_t *c); -static void ms_multi_getset_task_sch(ms_conn_t *c); -static void ms_send_signal(ms_sync_lock_t *sync_lock); -static void ms_warmup_server(ms_conn_t *c); -static int ms_run_getset_task(ms_conn_t *c); - -/** - * used to get the current operation item(object) - * - * @param c, pointer of the concurrency - * - * @return ms_task_item_t*, current operating item - */ -static ms_task_item_t *ms_get_cur_opt_item(ms_conn_t *c) { - return c->curr_task.item; -} - -/** - * used to get the next item to do get operation - * - * @param c, pointer of the concurrency - * - * @return ms_task_item_t*, the pointer of the next item to do - * get operation - */ -static ms_task_item_t *ms_get_next_get_item(ms_conn_t *c) { - ms_task_item_t *item = NULL; - - if (c->set_cursor <= 0) { - /* the first item in the window */ - item = &c->item_win[0]; - } else if (c->set_cursor > 0 && c->set_cursor < (uint32_t) c->win_size) { - /* random get one item set before */ - item = &c->item_win[random() % (int64_t) c->set_cursor]; - } else { - /* random get one item from the window */ - item = &c->item_win[random() % c->win_size]; - } - - return item; -} /* ms_get_next_get_item */ - -/** - * used to get the next item to do set operation - * - * @param c, pointer of the concurrency - * - * @return ms_task_item_t*, the pointer of the next item to do - * set operation - */ -static ms_task_item_t *ms_get_next_set_item(ms_conn_t *c) { - /** - * when a set command successes, the cursor will plus 1. If set - * fails, the cursor doesn't change. it isn't necessary to - * increase the cursor here. - */ - return &c->item_win[(int64_t) c->set_cursor % c->win_size]; -} - -/** - * If we need do overwrite, we could select a item set before. - * This function is used to get a item set before to do - * overwrite. - * - * @param c, pointer of the concurrency - * - * @return ms_task_item_t*, the pointer of the previous item of - * set operation - */ -static ms_task_item_t *ms_get_random_overwrite_item(ms_conn_t *c) { - return ms_get_next_get_item(c); -} /* ms_get_random_overwrite_item */ - -/** - * According to the proportion of operations(get or set), select - * an operation to do. - * - * @param c, pointer of the concurrency - * @param task, pointer of current task in the concurrency - */ -static void ms_select_opt(ms_conn_t *c, ms_task_t *task) { - double get_prop = ms_setting.cmd_distr[CMD_GET].cmd_prop; - double set_prop = ms_setting.cmd_distr[CMD_SET].cmd_prop; - - /* update cycle operation number if necessary */ - if ((task->cycle_undo_get == 0) || (task->cycle_undo_set == 0)) { - task->cycle_undo_get += (int) (CMD_DISTR_ADJUST_CYCLE * get_prop); - task->cycle_undo_set += (int) (CMD_DISTR_ADJUST_CYCLE * set_prop); - } - - /** - * According to operation distribution to choose doing which - * operation. If it can't set new object to sever, just change - * to do get operation. - */ - if ((set_prop > PROP_ERROR) - && ((double) task->get_opt * set_prop >= (double) task->set_opt * get_prop)) - { - task->cmd = CMD_SET; - task->item = ms_get_next_set_item(c); - } else { - task->cmd = CMD_GET; - task->item = ms_get_next_get_item(c); - } -} /* ms_select_opt */ - -/** - * used to judge whether the number of get operations done is - * more than expected number of get operations to do right now. - * - * @param task, pointer of current task in the concurrency - * - * @return bool, if get too fast, return true, else return false - */ -static bool ms_is_get_too_fast(ms_task_t *task) { - double get_prop = ms_setting.cmd_distr[CMD_GET].cmd_prop; - double set_prop = ms_setting.cmd_distr[CMD_SET].cmd_prop; - - /* no get operation */ - if (get_prop < PROP_ERROR) { - return false; - } - - int max_undo_set = (int) (set_prop / get_prop * (1.0 + DISADJUST_FACTOR)) * task->cycle_undo_get; - - if (((double) task->get_opt * set_prop > (double) task->set_opt * get_prop) - && (task->cycle_undo_set > max_undo_set)) - { - return true; - } - - return false; -} /* ms_is_get_too_fast */ - -/** - * used to judge whether the number of set operations done is - * more than expected number of set operations to do right now. - * - * @param task, pointer of current task in the concurrency - * - * @return bool, if set too fast, return true, else return false - */ -static bool ms_is_set_too_fast(ms_task_t *task) { - double get_prop = ms_setting.cmd_distr[CMD_GET].cmd_prop; - double set_prop = ms_setting.cmd_distr[CMD_SET].cmd_prop; - - /* no set operation */ - if (set_prop < PROP_ERROR) { - return false; - } - - /* If it does set operation too fast, skip some */ - int max_undo_get = - (int) ((get_prop / set_prop * (1.0 + DISADJUST_FACTOR)) * (double) task->cycle_undo_set); - - if (((double) task->get_opt * set_prop < (double) task->set_opt * get_prop) - && (task->cycle_undo_get > max_undo_get)) - { - return true; - } - - return false; -} /* ms_is_set_too_fast */ - -/** - * kick out the old item in the window, and add a new item to - * overwrite the old item. When we don't want to do overwrite - * object, and the current item to do set operation is an old - * item, we could kick out the old item and add a new item. Then - * we can ensure we set new object every time. - * - * @param item, pointer of task item which includes the object - * information - */ -static void ms_kick_out_item(ms_task_item_t *item) { - /* allocate a new item */ - item->key_prefix = ms_get_key_prefix(); - - item->key_suffix_offset++; - item->value_offset = INVALID_OFFSET; /* new item use invalid value offset */ - item->client_time = 0; -} /* ms_kick_out_item */ - -/** - * used to judge whether we need overwrite object based on the - * options user specified - * - * @param task, pointer of current task in the concurrency - * - * @return bool, if need overwrite, return true, else return - * false - */ -static bool ms_need_overwrite_item(ms_task_t *task) { - ms_task_item_t *item = task->item; - - assert(item); - assert(task->cmd == CMD_SET); - - /** - * according to data overwrite percent to determine if do data - * overwrite. - */ - if (task->overwrite_set < (double) task->set_opt * ms_setting.overwrite_percent) { - return true; - } - - return false; -} /* ms_need_overwirte_item */ - -/** - * used to adjust operation. the function must be called after - * select operation. the function change get operation to set - * operation, or set operation to get operation based on the - * current case. - * - * @param c, pointer of the concurrency - * @param task, pointer of current task in the concurrency - * - * @return bool, if success, return true, else return false - */ -static bool ms_adjust_opt(ms_conn_t *c, ms_task_t *task) { - ms_task_item_t *item = task->item; - - assert(item); - - if (task->cmd == CMD_SET) { - /* If did set operation too fast, skip some */ - if (ms_is_set_too_fast(task)) { - /* get the item instead */ - if (item->value_offset != INVALID_OFFSET) { - task->cmd = CMD_GET; - return true; - } - } - - /* If the current item is not a new item, kick it out */ - if (item->value_offset != INVALID_OFFSET) { - if (ms_need_overwrite_item(task)) { - /* overwrite */ - task->overwrite_set++; - } else { - /* kick out the current item to do set operation */ - ms_kick_out_item(item); - } - } else /* it's a new item */ { - /* need overwrite */ - if (ms_need_overwrite_item(task)) { - /** - * overwrite not use the item with current set cursor, revert - * set cursor. - */ - c->set_cursor--; - - item = ms_get_random_overwrite_item(c); - if (item->value_offset != INVALID_OFFSET) { - task->item = item; - task->overwrite_set++; - } else /* item is a new item */ { - /* select the item to run, and cancel overwrite */ - task->item = item; - } - } - } - task->cmd = CMD_SET; - return true; - } else { - if (item->value_offset == INVALID_OFFSET) { - task->cmd = CMD_SET; - return true; - } - - /** - * If It does get operation too fast, it will change the - * operation to set. - */ - if (ms_is_get_too_fast(task)) { - /* don't kick out the first item in the window */ - if (!ms_is_set_too_fast(task)) { - ms_kick_out_item(item); - task->cmd = CMD_SET; - return true; - } else { - return false; - } - } - - assert(item->value_offset != INVALID_OFFSET); - - task->cmd = CMD_GET; - return true; - } -} /* ms_adjust_opt */ - -/** - * used to initialize the task which need verify data. - * - * @param task, pointer of current task in the concurrency - */ -static void ms_task_data_verify_init(ms_task_t *task) { - ms_task_item_t *item = task->item; - - assert(item); - assert(task->cmd == CMD_GET); - - /** - * according to data verification percent to determine if do - * data verification. - */ - if (task->verified_get < (double) task->get_opt * ms_setting.verify_percent) { - /** - * currently it doesn't do verify, just increase the counter, - * and do verification next proper get command - */ - if ((task->item->value_offset != INVALID_OFFSET) && (item->exp_time == 0)) { - task->verify = true; - task->finish_verify = false; - task->verified_get++; - } - } -} /* ms_task_data_verify_init */ - -/** - * used to initialize the task which need verify expire time. - * - * @param task, pointer of current task in the concurrency - */ -static void ms_task_expire_verify_init(ms_task_t *task) { - ms_task_item_t *item = task->item; - - assert(item); - assert(task->cmd == CMD_GET); - assert(item->exp_time > 0); - - task->verify = true; - task->finish_verify = false; -} /* ms_task_expire_verify_init */ - -/** - * used to get one task, the function initializes the task - * structure. - * - * @param c, pointer of the concurrency - * @param warmup, whether it need warmup - * - * @return ms_task_t*, pointer of current task in the - * concurrency - */ -static ms_task_t *ms_get_task(ms_conn_t *c, bool warmup) { - ms_task_t *task = &c->curr_task; - - while (1) { - task->verify = false; - task->finish_verify = true; - task->get_miss = true; - - if (warmup) { - task->cmd = CMD_SET; - task->item = ms_get_next_set_item(c); - - return task; - } - - /* according to operation distribution to choose doing which operation */ - ms_select_opt(c, task); - - if (!ms_adjust_opt(c, task)) { - continue; - } - - if ((ms_setting.verify_percent > 0) && (task->cmd == CMD_GET)) { - ms_task_data_verify_init(task); - } - - if ((ms_setting.exp_ver_per > 0) && (task->cmd == CMD_GET) && (task->item->exp_time > 0)) { - ms_task_expire_verify_init(task); - } - - break; - } - - /** - * Only update get and delete counter, set counter will be - * updated after set operation successes. - */ - if (task->cmd == CMD_GET) { - task->get_opt++; - task->cycle_undo_get--; - } - - return task; -} /* ms_get_task */ - -/** - * send a signal to the main monitor thread - * - * @param sync_lock, pointer of the lock - */ -static void ms_send_signal(ms_sync_lock_t *sync_lock) { - pthread_mutex_lock(&sync_lock->lock); - sync_lock->count++; - pthread_cond_signal(&sync_lock->cond); - pthread_mutex_unlock(&sync_lock->lock); -} /* ms_send_signal */ - -/** - * If user only want to do get operation, but there is no object - * in server , so we use this function to warmup the server, and - * set some objects to server. It runs at the beginning of task. - * - * @param c, pointer of the concurrency - */ -static void ms_warmup_server(ms_conn_t *c) { - ms_task_t *task; - ms_task_item_t *item; - - /** - * Extra one loop to get the last command returned state. - * Normally it gets the previous command returned state. - */ - if ((c->remain_warmup_num >= 0) && (c->remain_warmup_num != c->warmup_num)) { - item = ms_get_cur_opt_item(c); - /* only update the set command result state for data verification */ - if ((c->precmd.cmd == CMD_SET) && (c->precmd.retstat == MCD_STORED)) { - item->value_offset = item->key_suffix_offset; - /* set success, update counter */ - c->set_cursor++; - } else if (c->precmd.cmd == CMD_SET && c->precmd.retstat != MCD_STORED) { - printf("key: %" PRIx64 " didn't set success\n", item->key_prefix); - } - } - - /* the last time don't run a task */ - if (c->remain_warmup_num-- > 0) { - /* operate next task item */ - task = ms_get_task(c, true); - item = task->item; - ms_mcd_set(c, item); - } - - /** - * finish warming up server, wait all connects initialize - * complete. Then all connects can start do task at the same - * time. - */ - if (c->remain_warmup_num == -1) { - ms_send_signal(&ms_global.warmup_lock); - c->remain_warmup_num--; /* never run the if branch */ - } -} /* ms_warmup_server */ - -/** - * dispatch single get and set task - * - * @param c, pointer of the concurrency - */ -static void ms_single_getset_task_sch(ms_conn_t *c) { - ms_task_t *task; - ms_task_item_t *item; - - /* the last time don't run a task */ - if (c->remain_exec_num-- > 0) { - task = ms_get_task(c, false); - item = task->item; - if (task->cmd == CMD_SET) { - ms_mcd_set(c, item); - } else if (task->cmd == CMD_GET) { - assert(task->cmd == CMD_GET); - ms_mcd_get(c, item); - } - } -} /* ms_single_getset_task_sch */ - -/** - * dispatch multi-get and set task - * - * @param c, pointer of the concurrency - */ -static void ms_multi_getset_task_sch(ms_conn_t *c) { - ms_task_t *task; - ms_mlget_task_item_t *mlget_item; - - while (1) { - if (c->remain_exec_num-- > 0) { - task = ms_get_task(c, false); - if (task->cmd == CMD_SET) /* just do it */ { - ms_mcd_set(c, task->item); - break; - } else { - assert(task->cmd == CMD_GET); - mlget_item = &c->mlget_task.mlget_item[c->mlget_task.mlget_num]; - mlget_item->item = task->item; - mlget_item->verify = task->verify; - mlget_item->finish_verify = task->finish_verify; - mlget_item->get_miss = task->get_miss; - c->mlget_task.mlget_num++; - - /* enough multi-get task items can be done */ - if ((c->mlget_task.mlget_num >= ms_setting.mult_key_num) - || ((c->remain_exec_num == 0) && (c->mlget_task.mlget_num > 0))) - { - ms_mcd_mlget(c); - break; - } - } - } else { - if ((c->remain_exec_num <= 0) && (c->mlget_task.mlget_num > 0)) { - ms_mcd_mlget(c); - } - break; - } - } -} /* ms_multi_getset_task_sch */ - -/** - * calculate the difference value of two time points - * - * @param start_time, the start time - * @param end_time, the end time - * - * @return uint64_t, the difference value between start_time and end_time in us - */ -int64_t ms_time_diff(struct timeval *start_time, struct timeval *end_time) { - int64_t endtime = end_time->tv_sec * 1000000 + end_time->tv_usec; - int64_t starttime = start_time->tv_sec * 1000000 + start_time->tv_usec; - - assert(endtime >= starttime); - - return endtime - starttime; -} /* ms_time_diff */ - -/** - * after get the response from server for multi-get, the - * function update the state of the task and do data verify if - * necessary. - * - * @param c, pointer of the concurrency - */ -static void ms_update_multi_get_result(ms_conn_t *c) { - ms_mlget_task_item_t *mlget_item; - ms_task_item_t *item; - char *orignval = NULL; - char *orignkey = NULL; - - if (c == NULL) { - return; - } - assert(c); - - for (int i = 0; i < c->mlget_task.mlget_num; i++) { - mlget_item = &c->mlget_task.mlget_item[i]; - item = mlget_item->item; - orignval = &ms_setting.char_block[item->value_offset]; - orignkey = &ms_setting.char_block[item->key_suffix_offset]; - - /* update get miss counter */ - if (mlget_item->get_miss) { - atomic_add_size(&ms_stats.get_misses, 1); - } - - /* get nothing from server for this task item */ - if (mlget_item->verify && !mlget_item->finish_verify) { - /* verify expire time if necessary */ - if (item->exp_time > 0) { - struct timeval curr_time; - gettimeofday(&curr_time, NULL); - - /* object doesn't expire but can't get it now */ - if (curr_time.tv_sec - item->client_time < item->exp_time - EXPIRE_TIME_ERROR) { - atomic_add_size(&ms_stats.unexp_unget, 1); - - if (ms_setting.verbose) { - char set_time[64]; - char cur_time[64]; - strftime(set_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&item->client_time)); - strftime(cur_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&curr_time.tv_sec)); - fprintf(stderr, - "\n\t<%d expire time verification failed, object " - "doesn't expire but can't get it now\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\tset time: %s current time: %s " - "diff time: %d expire time: %d\n" - "\texpected data len: %d\n" - "\texpected data: %.*s\n" - "\treceived data: \n", - c->sfd, item->key_size, item->key_prefix, - item->key_size - (int) KEY_PREFIX_SIZE, orignkey, set_time, cur_time, - (int) (curr_time.tv_sec - item->client_time), item->exp_time, item->value_size, - item->value_size, orignval); - fflush(stderr); - } - } - } else { - atomic_add_size(&ms_stats.vef_miss, 1); - - if (ms_setting.verbose) { - fprintf(stderr, - "\n<%d data verification failed\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\texpected data len: %d\n" - "\texpected data: %.*s\n" - "\treceived data: \n", - c->sfd, item->key_size, item->key_prefix, item->key_size - (int) KEY_PREFIX_SIZE, - orignkey, item->value_size, item->value_size, orignval); - fflush(stderr); - } - } - } - } - c->mlget_task.mlget_num = 0; - c->mlget_task.value_index = INVALID_OFFSET; -} /* ms_update_multi_get_result */ - -/** - * after get the response from server for single get, the - * function update the state of the task and do data verify if - * necessary. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - */ -static void ms_update_single_get_result(ms_conn_t *c, ms_task_item_t *item) { - char *orignval = NULL; - char *orignkey = NULL; - - if ((c == NULL) || (item == NULL)) { - return; - } - assert(c); - assert(item); - - orignval = &ms_setting.char_block[item->value_offset]; - orignkey = &ms_setting.char_block[item->key_suffix_offset]; - - /* update get miss counter */ - if ((c->precmd.cmd == CMD_GET) && c->curr_task.get_miss) { - atomic_add_size(&ms_stats.get_misses, 1); - } - - /* get nothing from server for this task item */ - if ((c->precmd.cmd == CMD_GET) && c->curr_task.verify && !c->curr_task.finish_verify) { - /* verify expire time if necessary */ - if (item->exp_time > 0) { - struct timeval curr_time; - gettimeofday(&curr_time, NULL); - - /* object doesn't expire but can't get it now */ - if (curr_time.tv_sec - item->client_time < item->exp_time - EXPIRE_TIME_ERROR) { - atomic_add_size(&ms_stats.unexp_unget, 1); - - if (ms_setting.verbose) { - char set_time[64]; - char cur_time[64]; - strftime(set_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&item->client_time)); - strftime(cur_time, 64, "%Y-%m-%d %H:%M:%S", localtime(&curr_time.tv_sec)); - fprintf(stderr, - "\n\t<%d expire time verification failed, object " - "doesn't expire but can't get it now\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\tset time: %s current time: %s " - "diff time: %d expire time: %d\n" - "\texpected data len: %d\n" - "\texpected data: %.*s\n" - "\treceived data: \n", - c->sfd, item->key_size, item->key_prefix, item->key_size - (int) KEY_PREFIX_SIZE, - orignkey, set_time, cur_time, (int) (curr_time.tv_sec - item->client_time), - item->exp_time, item->value_size, item->value_size, orignval); - fflush(stderr); - } - } - } else { - atomic_add_size(&ms_stats.vef_miss, 1); - - if (ms_setting.verbose) { - fprintf(stderr, - "\n<%d data verification failed\n" - "\tkey len: %d\n" - "\tkey: %" PRIx64 " %.*s\n" - "\texpected data len: %d\n" - "\texpected data: %.*s\n" - "\treceived data: \n", - c->sfd, item->key_size, item->key_prefix, item->key_size - (int) KEY_PREFIX_SIZE, - orignkey, item->value_size, item->value_size, orignval); - fflush(stderr); - } - } - } -} /* ms_update_single_get_result */ - -/** - * after get the response from server for set the function - * update the state of the task and do data verify if necessary. - * - * @param c, pointer of the concurrency - * @param item, pointer of task item which includes the object - * information - */ -static void ms_update_set_result(ms_conn_t *c, ms_task_item_t *item) { - if ((c == NULL) || (item == NULL)) { - return; - } - assert(c); - assert(item); - - if (c->precmd.cmd == CMD_SET) { - switch (c->precmd.retstat) { - case MCD_STORED: - if (item->value_offset == INVALID_OFFSET) { - /* first set with the same offset of key suffix */ - item->value_offset = item->key_suffix_offset; - } else { - /* not first set, just increase the value offset */ - item->value_offset += 1; - } - - /* set successes, update counter */ - c->set_cursor++; - c->curr_task.set_opt++; - c->curr_task.cycle_undo_set--; - break; - - case MCD_SERVER_ERROR: - default: - break; - } /* switch */ - } -} /* ms_update_set_result */ - -/** - * update the response time result - * - * @param c, pointer of the concurrency - */ -static void ms_update_stat_result(ms_conn_t *c) { - bool get_miss = false; - - if (c == NULL) { - return; - } - assert(c); - - gettimeofday(&c->end_time, NULL); - uint64_t time_diff = (uint64_t) ms_time_diff(&c->start_time, &c->end_time); - - pthread_mutex_lock(&ms_statistic.stat_mutex); - - switch (c->precmd.cmd) { - case CMD_SET: - ms_record_event(&ms_statistic.set_stat, time_diff, false); - break; - - case CMD_GET: - if (c->curr_task.get_miss) { - get_miss = true; - } - ms_record_event(&ms_statistic.get_stat, time_diff, get_miss); - break; - - default: - break; - } /* switch */ - - ms_record_event(&ms_statistic.total_stat, time_diff, get_miss); - pthread_mutex_unlock(&ms_statistic.stat_mutex); -} /* ms_update_stat_result */ - -/** - * after get response from server for the current operation, and - * before doing the next operation, update the state of the - * current operation. - * - * @param c, pointer of the concurrency - */ -static void ms_update_task_result(ms_conn_t *c) { - ms_task_item_t *item; - - if (c == NULL) { - return; - } - assert(c); - - item = ms_get_cur_opt_item(c); - if (item == NULL) { - return; - } - assert(item); - - ms_update_set_result(c, item); - - if ((ms_setting.stat_freq > 0) && ((c->precmd.cmd == CMD_SET) || (c->precmd.cmd == CMD_GET))) { - ms_update_stat_result(c); - } - - /* update multi-get task item */ - if (((ms_setting.mult_key_num > 1) && (c->mlget_task.mlget_num >= ms_setting.mult_key_num)) - || ((c->remain_exec_num == 0) && (c->mlget_task.mlget_num > 0))) - { - ms_update_multi_get_result(c); - } else { - ms_update_single_get_result(c, item); - } -} /* ms_update_task_result */ - -/** - * run get and set operation - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_run_getset_task(ms_conn_t *c) { - /** - * extra one loop to get the last command return state. get the - * last command return state. - */ - if ((c->remain_exec_num >= 0) && (c->remain_exec_num != c->exec_num)) { - ms_update_task_result(c); - } - - /* multi-get */ - if (ms_setting.mult_key_num > 1) { - /* operate next task item */ - ms_multi_getset_task_sch(c); - } else { - /* operate next task item */ - ms_single_getset_task_sch(c); - } - - /* no task to do, exit */ - if ((c->remain_exec_num == -1) || ms_global.time_out) { - return -1; - } - - return EXIT_SUCCESS; -} /* ms_run_getset_task */ - -/** - * the state machine call the function to execute task. - * - * @param c, pointer of the concurrency - * - * @return int, if success, return EXIT_SUCCESS, else return -1 - */ -int ms_exec_task(struct conn *c) { - if (!ms_global.finish_warmup) { - ms_warmup_server(c); - } else { - if (ms_run_getset_task(c)) { - return -1; - } - } - - return EXIT_SUCCESS; -} /* ms_exec_task */ diff --git a/contrib/bin/memaslap/ms_task.h b/contrib/bin/memaslap/ms_task.h deleted file mode 100644 index 7d28f0772..000000000 --- a/contrib/bin/memaslap/ms_task.h +++ /dev/null @@ -1,93 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_TASK_H -#define MS_TASK_H - -#include -#include -#if !defined(__cplusplus) -# include -#endif -#include - -#ifdef __cplusplus -extern "C" { -#endif - -#define UNIT_ITEMS_COUNT 1024 /* each window unit has 1024 items */ -#define KEY_PREFIX_SIZE (sizeof(uint64_t)) /* key prefix length: 8 bytes */ -#define INVALID_OFFSET (-1) /* invalid offset in the character table */ -#define FIXED_EXPIRE_TIME 60 /* default expire time is 60s */ -#define EXPIRE_TIME_ERROR 5 /* default expire time error is 5s */ - -/* information of a task item(object) */ -typedef struct task_item { - uint64_t key_prefix; /* prefix of the key, 8 bytes, binary */ - int key_size; /* key size */ - int key_suffix_offset; /* suffix offset in the global character table */ - - int value_size; /* data size */ - int value_offset; /* data offset in the global character table */ - - time_t client_time; /* the current client time */ - int exp_time; /* expire time */ -} ms_task_item_t; - -/* task item for multi-get */ -typedef struct mlget_task_item { - ms_task_item_t *item; /* task item */ - bool verify; /* whether verify data or not */ - bool finish_verify; /* whether finish data verify or not */ - bool get_miss; /* whether get miss or not */ -} ms_mlget_task_item_t; - -/* information of multi-get task */ -typedef struct mlget_task { - ms_mlget_task_item_t *mlget_item; /* multi-get task array */ - int mlget_num; /* how many tasks in mlget_task array */ - int value_index; /* the nth value received by the connect, for multi-get */ -} ms_mlget_task_t; - -/* structure used to store the state of the running task */ -typedef struct task { - int cmd; /* command name */ - bool verify; /* whether verify data or not */ - bool finish_verify; /* whether finish data verify or not */ - bool get_miss; /* whether get miss or not */ - ms_task_item_t *item; /* task item */ - - /* counter for command distribution adjustment */ - uint64_t get_opt; /* number of total get operations */ - uint64_t set_opt; /* number of total set operations, no including warmup set count */ - int cycle_undo_get; /* number of undo get in an adjustment cycle */ - int cycle_undo_set; /* number of undo set in an adjustment cycle */ - uint64_t verified_get; /* number of total verified get operations */ - uint64_t overwrite_set; /* number of total overwrite set operations */ -} ms_task_t; - -struct conn; - -/* the state machine call the function to execute task.*/ -int ms_exec_task(struct conn *c); - -/* calculate the difference value of two time points */ -int64_t ms_time_diff(struct timeval *start_time, struct timeval *end_time); - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_TASK_H */ diff --git a/contrib/bin/memaslap/ms_thread.c b/contrib/bin/memaslap/ms_thread.c deleted file mode 100644 index 6a4cf047b..000000000 --- a/contrib/bin/memaslap/ms_thread.c +++ /dev/null @@ -1,300 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#include "mem_config.h" - -#if defined(HAVE_SYS_TIME_H) -# include -#endif -#include - -#include "ms_thread.h" -#include "ms_setting.h" -#include "ms_atomic.h" - -/* global variable */ -pthread_key_t ms_thread_key; - -/* array of thread context structure, each thread has a thread context structure */ -static ms_thread_ctx_t *ms_thread_ctx; - -/* functions */ -static void ms_set_current_time(void); -static void ms_check_sock_timeout(void); -static void ms_clock_handler(const int fd, const short which, void *arg); -static uint32_t ms_set_thread_cpu_affinity(uint32_t cpu); -static int ms_setup_thread(ms_thread_ctx_t *thread_ctx); -static void *ms_worker_libevent(void *arg); -static void ms_create_worker(void *(*func)(void *), ms_thread_ctx_t *arg); - -/** - * time-sensitive callers can call it by hand with this, - * outside the normal ever-1-second timer - */ -static void ms_set_current_time() { - struct timeval timer; - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - - gettimeofday(&timer, NULL); - ms_thread->curr_time = (rel_time_t) timer.tv_sec; -} /* ms_set_current_time */ - -/** - * used to check whether UDP of command are waiting timeout - * by the ever-1-second timer - */ -static void ms_check_sock_timeout(void) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - ms_conn_t *c = NULL; - int time_diff = 0; - - for (uint32_t i = 0; i < ms_thread->thread_ctx->nconns; i++) { - c = &ms_thread->conn[i]; - - if (c->udp) { - time_diff = (int) (ms_thread->curr_time - (rel_time_t) c->start_time.tv_sec); - - /* wait time out */ - if (time_diff > SOCK_WAIT_TIMEOUT) { - /* calculate dropped packets count */ - if (c->recvpkt > 0) { - atomic_add_size(&ms_stats.pkt_drop, c->packets - c->recvpkt); - } - - atomic_add_size(&ms_stats.udp_timeout, 1); - ms_reset_conn(c, true); - } - } - } -} /* ms_check_sock_timeout */ - -/* if disconnect, the ever-1-second timer will call this function to reconnect */ -static void ms_reconn_thread_socks(void) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - for (uint32_t i = 0; i < ms_thread->thread_ctx->nconns; i++) { - ms_reconn_socks(&ms_thread->conn[i]); - } -} /* ms_reconn_thread_socks */ - -/** - * the handler of the ever-1-second timer - * - * @param fd, the descriptors of the socket - * @param which, event flags - * @param arg, argument - */ -static void ms_clock_handler(const int fd, const short which, void *arg) { - ms_thread_t *ms_thread = pthread_getspecific(ms_thread_key); - struct timeval t = {.tv_sec = 1, .tv_usec = 0}; - - UNUSED_ARGUMENT(fd); - UNUSED_ARGUMENT(which); - UNUSED_ARGUMENT(arg); - - ms_set_current_time(); - - if (ms_thread->initialized) { - /* only delete the event if it's actually there. */ - evtimer_del(&ms_thread->clock_event); - ms_check_sock_timeout(); - } else { - ms_thread->initialized = true; - } - - ms_reconn_thread_socks(); - - evtimer_set(&ms_thread->clock_event, ms_clock_handler, 0); - event_base_set(ms_thread->base, &ms_thread->clock_event); - evtimer_add(&ms_thread->clock_event, &t); -} /* ms_clock_handler */ - -/** - * used to bind thread to CPU if the system supports - * - * @param cpu, cpu index - * - * @return if success, return EXIT_SUCCESS, else return -1 - */ -static uint32_t ms_set_thread_cpu_affinity(uint32_t cpu) { - uint32_t ret = 0; - -#ifdef HAVE_CPU_SET_T - cpu_set_t cpu_set; - CPU_ZERO(&cpu_set); - CPU_SET(cpu, &cpu_set); - - if (sched_setaffinity(0, sizeof(cpu_set_t), &cpu_set) == -1) { - fprintf(stderr, "WARNING: Could not set CPU Affinity, continuing...\n"); - ret = 1; - } -#else - UNUSED_ARGUMENT(cpu); -#endif - - return ret; -} /* ms_set_thread_cpu_affinity */ - -/** - * Set up a thread's information. - * - * @param thread_ctx, pointer of the thread context structure - * - * @return if success, return EXIT_SUCCESS, else return -1 - */ -static int ms_setup_thread(ms_thread_ctx_t *thread_ctx) { - ms_thread_t *ms_thread = (ms_thread_t *) calloc(sizeof(*ms_thread), 1); - pthread_setspecific(ms_thread_key, (void *) ms_thread); - - ms_thread->thread_ctx = thread_ctx; - ms_thread->nactive_conn = thread_ctx->nconns; - ms_thread->initialized = false; - static ATOMIC uint32_t cnt = 0; - - gettimeofday(&ms_thread->startup_time, NULL); - - ms_thread->base = event_base_new(); - if (ms_thread->base == NULL) { - if (atomic_add_32_nv(&cnt, 1) == 0) { - fprintf(stderr, "Can't allocate event base.\n"); - } - - return -1; - } - - ms_thread->conn = (ms_conn_t *) malloc((size_t) thread_ctx->nconns * sizeof(ms_conn_t)); - if (ms_thread->conn == NULL) { - if (atomic_add_32_nv(&cnt, 1) == 0) { - fprintf(stderr, "Can't allocate concurrency structure for thread descriptors."); - } - - return -1; - } - memset(ms_thread->conn, 0, (size_t) thread_ctx->nconns * sizeof(ms_conn_t)); - - for (uint32_t i = 0; i < thread_ctx->nconns; i++) { - ms_thread->conn[i].conn_idx = i; - if (ms_setup_conn(&ms_thread->conn[i])) { - /* only output this error once */ - if (atomic_add_32_nv(&cnt, 1) == 0) { - fprintf(stderr, "Initializing connection failed.\n"); - } - - return -1; - } - } - - return EXIT_SUCCESS; -} /* ms_setup_thread */ - -/** - * Worker thread: main event loop - * - * @param arg, the pointer of argument - * - * @return void* - */ -static void *ms_worker_libevent(void *arg) { - ms_thread_t *ms_thread = NULL; - ms_thread_ctx_t *thread_ctx = (ms_thread_ctx_t *) arg; - - /** - * If system has more than one cpu and supports set cpu - * affinity, try to bind each thread to a cpu core; - */ - if (ms_setting.ncpu > 1) { - ms_set_thread_cpu_affinity(thread_ctx->thd_idx % ms_setting.ncpu); - } - - if (ms_setup_thread(thread_ctx)) { - exit(1); - } - - /* each thread with a timer */ - ms_clock_handler(0, 0, 0); - - pthread_mutex_lock(&ms_global.init_lock.lock); - ms_global.init_lock.count++; - pthread_cond_signal(&ms_global.init_lock.cond); - pthread_mutex_unlock(&ms_global.init_lock.lock); - - ms_thread = pthread_getspecific(ms_thread_key); - event_base_loop(ms_thread->base, 0); - event_base_free(ms_thread->base); - free(ms_thread); - - return NULL; -} /* ms_worker_libevent */ - -/** - * Creates a worker thread. - * - * @param func, the callback function - * @param arg, the argument to pass to the callback function - */ -static void ms_create_worker(void *(*func)(void *), ms_thread_ctx_t *arg) { - pthread_attr_t attr; - int ret; - - pthread_attr_init(&attr); - - if ((ret = pthread_create(&arg->pth_id, &attr, func, arg))) { - fprintf(stderr, "Can't create thread: %s.\n", strerror(ret)); - exit(1); - } -} /* ms_create_worker */ - -/* initialize threads */ -void ms_thread_init() { - ms_thread_ctx = - (ms_thread_ctx_t *) malloc(sizeof(ms_thread_ctx_t) * (size_t) ms_setting.nthreads); - if (ms_thread_ctx == NULL) { - fprintf(stderr, "Can't allocate thread descriptors."); - exit(1); - } - - for (uint32_t i = 0; i < ms_setting.nthreads; i++) { - ms_thread_ctx[i].thd_idx = i; - ms_thread_ctx[i].nconns = ms_setting.nconns / ms_setting.nthreads; - - /** - * If only one server, all the connections in all threads - * connects the same server. For support multi-servers, simple - * distribute thread to server. - */ - ms_thread_ctx[i].srv_idx = i % ms_setting.srv_cnt; - ms_thread_ctx[i].tps_perconn = ms_setting.expected_tps / (int) ms_setting.nconns; - ms_thread_ctx[i].exec_num_perconn = ms_setting.exec_num / ms_setting.nconns; - } - - if (pthread_key_create(&ms_thread_key, NULL)) { - fprintf(stderr, "Can't create pthread keys. Major malfunction!\n"); - exit(1); - } - /* Create threads after we've done all the epoll setup. */ - for (uint32_t i = 0; i < ms_setting.nthreads; i++) { - ms_create_worker(ms_worker_libevent, &ms_thread_ctx[i]); - } -} /* ms_thread_init */ - -/* cleanup some resource of threads when all the threads exit */ -void ms_thread_cleanup() { - for (uint32_t i = 0; i < ms_setting.nthreads; i++) { - pthread_join(ms_thread_ctx[i].pth_id, NULL); - } - if (ms_thread_ctx) { - free(ms_thread_ctx); - } - pthread_key_delete(ms_thread_key); -} /* ms_thread_cleanup */ diff --git a/contrib/bin/memaslap/ms_thread.h b/contrib/bin/memaslap/ms_thread.h deleted file mode 100644 index a0317c696..000000000 --- a/contrib/bin/memaslap/ms_thread.h +++ /dev/null @@ -1,65 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | libmemcached-awesome - C/C++ Client Library for memcached | - +--------------------------------------------------------------------+ - | Redistribution and use in source and binary forms, with or without | - | modification, are permitted under the terms of the BSD license. | - | You should have received a copy of the license in a bundled file | - | named LICENSE; in case you did not receive a copy you can review | - | the terms online at: https://opensource.org/licenses/BSD-3-Clause | - +--------------------------------------------------------------------+ - | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ | - | Copyright (c) 2020 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef MS_THREAD_H -#define MS_THREAD_H - -#include -#include -#include "ms_conn.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/** Time relative to server start. Smaller than time_t on 64-bit systems. */ -typedef unsigned int rel_time_t; - -/* Used to store the context of each thread */ -typedef struct thread_ctx { - uint32_t thd_idx; /* the thread index */ - uint32_t nconns; /* how many connections included by the thread */ - uint32_t srv_idx; /* index of the thread */ - int tps_perconn; /* expected throughput per connection */ - int64_t exec_num_perconn; /* execute number per connection */ - pthread_t pth_id; -} ms_thread_ctx_t; - -/* Used to store the private variables of each thread */ -typedef struct thread { - ms_conn_t *conn; /* conn array to store all the conn in the thread */ - uint32_t nactive_conn; /* how many connects are active */ - - ms_thread_ctx_t *thread_ctx; /* thread context from the caller */ - struct event_base *base; /* libevent handler created by this thread */ - - rel_time_t curr_time; /* current time */ - struct event clock_event; /* clock event to time each one second */ - bool initialized; /* whether clock_event has been initialized */ - - struct timeval startup_time; /* start time of the thread */ -} ms_thread_t; - -/* initialize threads */ -void ms_thread_init(void); - -/* cleanup some resource of threads when all the threads exit */ -void ms_thread_cleanup(void); - -#ifdef __cplusplus -} -#endif - -#endif /* end of MS_THREAD_H */ diff --git a/copyright.html b/copyright.html new file mode 100644 index 000000000..6a5e037fa --- /dev/null +++ b/copyright.html @@ -0,0 +1,156 @@ + + + + + + + Copyright — libmemcached-awesome 1.1.4 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt deleted file mode 100644 index 157f5a9fd..000000000 --- a/docs/CMakeLists.txt +++ /dev/null @@ -1,109 +0,0 @@ -find_package(Sphinx) - -if(NOT SPHINX_EXECUTABLE) - - message(WARNING "The sphinx-build command is required to build documentation.") - -else() - - if(NOT DEFINED SPHINX_OPTIONS) - set(SPHINX_OPTIONS) - endif() - - if(NOT DEFINED SPHINX_THEME) - set(SPHINX_THEME sphinx_rtd_theme) - set(SPHINX_THEME_OPTIONS "'collapse_navigation':False, 'navigation_depth':2, 'titles_only':False, 'includehidden':False") - endif() - - set(SPHINX_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/source") - - # configured documentation tools and intermediate build results - set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/build") - - # Sphinx cache with pickled ReST documents - set(SPHINX_CACHE_DIR "${SPHINX_BUILD_DIR}/_doctrees") - - # HTML output directory - set(SPHINX_HTML_DIR "${SPHINX_BUILD_DIR}/html") - - # MAN output directory - set(SPHINX_MAN_DIR "${SPHINX_BUILD_DIR}/man") - - configure_file("conf.py.in" "${SPHINX_BUILD_DIR}/conf.py" @ONLY) - add_subdirectory(source) - - file(GLOB_RECURSE DOCS_SOURCE - CONFIGURE_DEPENDS - "*.rst") - - if(BUILD_DOCS_HTML) - add_custom_command( - OUTPUT "${SPHINX_HTML_DIR}" - COMMAND - ${SPHINX_EXECUTABLE} - -q -b html - -c "${SPHINX_BUILD_DIR}" - -d "${SPHINX_CACHE_DIR}" - ${SPHINX_OPTIONS} - "${SPHINX_SOURCE_DIR}" - "${SPHINX_HTML_DIR}" - COMMAND - ${CMAKE_COMMAND} -E touch "${SPHINX_HTML_DIR}" - DEPENDS "${DOCS_SOURCE}" conf.py.in - ) - add_custom_target(html ALL DEPENDS "${SPHINX_HTML_DIR}") - - install(DIRECTORY ${SPHINX_HTML_DIR}/ - COMPONENT doc - DESTINATION ${CMAKE_INSTALL_DOCDIR}/html) - endif() - - if(BUILD_DOCS_MAN) - add_custom_command( - OUTPUT ${SPHINX_MAN_DIR} - COMMAND - ${SPHINX_EXECUTABLE} - -q -b man - -c "${SPHINX_BUILD_DIR}" - -d "${SPHINX_CACHE_DIR}" - ${SPHINX_OPTIONS} - "${SPHINX_SOURCE_DIR}" - "${SPHINX_MAN_DIR}" - COMMAND - ${CMAKE_COMMAND} -E touch "${SPHINX_MAN_DIR}" - DEPENDS "${DOCS_SOURCE}" conf.py.in - ) - add_custom_target(man ALL DEPENDS "${SPHINX_MAN_DIR}") - - set(MAN_EXT "") - if(BUILD_DOCS_MANGZ) - find_program(PIGZ pigz) - if(PIGZ) - set(GZIP ${PIGZ}) - else() - find_package(UnixCommands) - endif() - if(GZIP) - set(MAN_EXT ".gz") - add_custom_target(man_gz ALL - COMMAND ${GZIP} -kf - ${SPHINX_MAN_DIR}/*.1 - ${SPHINX_MAN_DIR}/*.3 - DEPENDS ${SPHINX_MAN_DIR} - ) # some shells do not support braced glob patterns - endif() - endif() - - install(DIRECTORY ${SPHINX_MAN_DIR}/ - COMPONENT doc - DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 - FILES_MATCHING PATTERN *.1${MAN_EXT} - ) - install(DIRECTORY ${SPHINX_MAN_DIR}/ - COMPONENT doc - DESTINATION ${CMAKE_INSTALL_MANDIR}/man3 - FILES_MATCHING PATTERN *.3${MAN_EXT} - ) - endif() - -endif() diff --git a/docs/conf.py.in b/docs/conf.py.in deleted file mode 100644 index 690df3583..000000000 --- a/docs/conf.py.in +++ /dev/null @@ -1,236 +0,0 @@ -# -*- coding: utf-8 -*- - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - - -# -- General configuration ----------------------------------------------------- - -#needs_sphinx = '1.0' -extensions = [@SPHINX_EXTENSIONS@] -templates_path = ['_templates'] -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' - -primary_domain = 'cpp' -default_role = 'any' - -project = u'libmemcached-awesome' -version = '@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@' -release = '@PROJECT_VERSION@' - -smartquotes = False -m2r_parse_relative_links = True - -# -- Options for HTML output --------------------------------------------------- - -html_theme = '@SPHINX_THEME@' -html_theme_options = {@SPHINX_THEME_OPTIONS@} -html_domain_indices = False -html_show_sourcelink = False -html_copy_source = False -#manpages_url = 'http://man7.org/linux/man-pages/man{section}/{page}.{section}.html' -manpages_url = 'https://linux.die.net/man/{section}/{page}' - -html_context = { - 'display_github': True, - 'github_user': 'awesomized', - 'github_repo': 'libmemcached', - 'github_version': 'v1.x/docs/source/' -} - -# -- Options for manual page output -------------------------------------------- - -# Skip a separate AUTHOR section -man_authors = [] - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('libhashkit/index' ,'libhashkit' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_create' ,'hashkit_clone' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_create' ,'hashkit_create' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_create' ,'hashkit_free' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_create' ,'hashkit_is_allocated' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_get_distribution_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_get_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_set_custom_distribution_function',u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_set_custom_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_set_distribution_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_function' ,'hashkit_set_function' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_crc32' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_fnv1_32' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_fnv1_64' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_fnv1a_32' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_fnv1a_64' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_functions' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_hsieh' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_jenkins' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_md5' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_functions' ,'hashkit_murmur' ,u'libhashkit Documentation' ,man_authors,3), - ('libhashkit/hashkit_value' ,'hashkit_value' ,u'libhashkit Documentation' ,man_authors,3), - - ('libmemcached' ,'libmemcached' ,u'C/C++ Client Library for memcached' ,man_authors,3), - ('libmemcached/configuration' ,'libmemcached_check_configuration' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/configuration' ,'libmemcached_configuration' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/configuration' ,'memcached' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/examples' ,'libmemcached_examples' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_analyze' ,'memcached_analyze' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_append' ,'memcached_append_by_key' ,u'Appending to or Prepending Data' ,man_authors,3), - ('libmemcached/memcached_append' ,'memcached_append' ,u'Appending to or Prepending Data' ,man_authors,3), - ('libmemcached/memcached_append' ,'memcached_prepend_by_key' ,u'Appending to or Prepending Data' ,man_authors,3), - ('libmemcached/memcached_append' ,'memcached_prepend' ,u'Appending to or Prepending Data' ,man_authors,3), - ('libmemcached/memcached_auto' ,'memcached_auto' ,u'Incrementing and Decrementing Values',man_authors,3), - ('libmemcached/memcached_auto' ,'memcached_decrement' ,u'Incrementing and Decrementing Values',man_authors,3), - ('libmemcached/memcached_auto' ,'memcached_decrement_with_initial' ,u'Incrementing and Decrementing Values',man_authors,3), - ('libmemcached/memcached_auto' ,'memcached_increment' ,u'Incrementing and Decrementing Values',man_authors,3), - ('libmemcached/memcached_auto' ,'memcached_increment_with_initial' ,u'Incrementing and Decrementing Values',man_authors,3), - ('libmemcached/memcached_behavior' ,'memcached_behavior_get' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_behavior' ,'memcached_behavior_set' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_behavior' ,'memcached_behavior' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_callback' ,'memcached_callback_get' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_callback' ,'memcached_callback_set' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_callback' ,'memcached_callback' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_cas' ,'memcached_cas_by_key' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_cas' ,'memcached_cas' ,u'Atomic Compare and Swap' ,man_authors,3), - ('libmemcached/memcached_create' ,'memcached_clone' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_create' ,'memcached_create' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_create' ,'memcached_free' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_create' ,'memcached_servers_reset' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_delete' ,'memcached_delete_by_key' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_delete' ,'memcached_delete' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_dump' ,'memcached_dump' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_exist' ,'memcached_exist_by_key' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_exist' ,'memcached_exist' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_fetch' ,'memcached_fetch' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_flush_buffers' ,'memcached_flush_buffers' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_flush' ,'memcached_flush' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_generate_hash_value','memcached_generate_hash' ,u'Generating hash values directly' ,man_authors,3), - ('libmemcached/memcached_generate_hash_value','memcached_generate_hash_value' ,u'Generating hash values directly' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_fetch_execute' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_fetch_result' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_get_by_key' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_get' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_mget_by_key' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_mget_execute_by_key' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_mget_execute' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_get' ,'memcached_mget' ,u'Retrieving data from the server' ,man_authors,3), - ('libmemcached/memcached_last_error' ,'memcached_last_error_errno' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_last_error' ,'memcached_last_error_message' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_last_error' ,'memcached_last_error' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_memory_allocators' ,'memcached_get_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_memory_allocators' ,'memcached_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_memory_allocators' ,'memcached_set_memory_allocators_context' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_memory_allocators' ,'memcached_set_memory_allocators' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_quit' ,'memcached_quit' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_cas' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_create' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_flags' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_free' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_key_length' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_key_value' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_length' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_st' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_result_st' ,'memcached_result_value' ,u'Working with result sets' ,man_authors,3), - ('libmemcached/memcached_return_t' ,'memcached_return_t' ,u'Return type values ' ,man_authors,3), - ('libmemcached/memcached_sasl' ,'memcached_destroy_sasl_auth_data' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_sasl' ,'memcached_get_sasl_callbacks' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_sasl' ,'memcached_sasl_set_auth_data' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_sasl' ,'memcached_sasl' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_sasl' ,'memcached_set_sasl_callbacks' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_add' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_add_unix_socket' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_count' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_cursor' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_list' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_push' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_server_st' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_servers' ,'memcached_servers' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_server_st' ,'memcached_server_list_append' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_server_st' ,'memcached_server_list_count' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_server_st' ,'memcached_server_list_free' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_server_st' ,'memcached_servers_parse' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_set_encoding_key' ,'memcached_set_encoding_key' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_add_by_key' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_add' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_replace_by_key' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_replace' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_set_by_key' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_set' ,'memcached_set' ,u'Storing and Replacing Data' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stat_execute' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stat_get_keys' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stat_get_value' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stat_servername' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stats' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_stats' ,'memcached_stat' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_strerror' ,'memcached_strerror' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_touch' ,'memcached_touch_by_key' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_touch' ,'memcached_touch' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_user_data' ,'memcached_get_user_data' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_user_data' ,'memcached_set_user_data' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_user_data' ,'memcached_user_data' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_verbosity' ,'memcached_verbosity' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_version' ,'memcached_lib_version' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcached/memcached_version' ,'memcached_version' ,u'libmemcached Documentation' ,man_authors,3), - - ('libmemcachedutil/index' ,'libmemcachedutil' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_behavior_get' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_behavior_set' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_create' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_destroy' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_fetch' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_pop' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_push' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_release' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool_st' ,u'libmemcached Documentation' ,man_authors,3), - ('libmemcachedutil/memcached_pool' ,'memcached_pool' ,u'libmemcached Documentation' ,man_authors,3), - - ('bin/memcapable' , 'memcapable' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memcat' , 'memcat' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memcp' , 'memcp' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memdump' , 'memdump' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memerror' , 'memerror' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memflush' , 'memflush' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memrm' , 'memrm' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memaslap' , 'memaslap' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memslap' , 'memslap' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memstat' , 'memstat' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memexist' , 'memexist' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memparse' , 'memparse' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memping' , 'memping' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memtouch' , 'memtouch' ,u'libmemcached Documentation' , man_authors, 1), - ] - -if '@CLIENT_PREFIX@' != 'mem' : - man_pages.extend([ - ('bin/memcapable' , '@CLIENT_PREFIX@capable' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memcat' , '@CLIENT_PREFIX@cat' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memcp' , '@CLIENT_PREFIX@cp' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memdump' , '@CLIENT_PREFIX@dump' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memerror' , '@CLIENT_PREFIX@error' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memflush' , '@CLIENT_PREFIX@flush' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memrm' , '@CLIENT_PREFIX@rm' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memaslap' , '@CLIENT_PREFIX@aslap' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memslap' , '@CLIENT_PREFIX@slap' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memstat' , '@CLIENT_PREFIX@stat' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memexist' , '@CLIENT_PREFIX@exist' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memparse' , '@CLIENT_PREFIX@parse' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memping' , '@CLIENT_PREFIX@ping' ,u'libmemcached Documentation' , man_authors, 1), - ('bin/memtouch' , '@CLIENT_PREFIX@touch' ,u'libmemcached Documentation' , man_authors, 1), - ]) - -rst_prolog = """ -.. |client_prefix| replace:: @CLIENT_PREFIX@ -.. |libhashkit_version| replace:: @LIBHASHKIT_VERSION_INC@ -.. |libmemcached_version| replace:: @LIBMEMCACHED_VERSION_INC@ -.. |libmemcachedprotocol_version| replace:: @LIBMEMCACHEDPROTOCOL_VERSION_INC@ -.. |libmemcachedutil_version| replace:: @LIBMEMCACHEDUTIL_VERSION_INC@ -""" - -@SPHINX_CONF_APPEND@ diff --git a/docs/gh-pages/publish.sh b/docs/gh-pages/publish.sh deleted file mode 100755 index 218b0073a..000000000 --- a/docs/gh-pages/publish.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -set -eu -cd "$(dirname $0)" - -if test -d pages/.git -then - cd pages - git pull -r - cd .. -else - git clone -b gh-pages github.com:awesomized/libmemcached pages -fi - -mkdir -p build -cd build -cmake -DBUILD_DOCSONLY=true -DBUILD_DOCS_HTML=true ../../.. -make html -rsync -va --delete --exclude=.git/ docs/html/ ../pages/ - -cd ../pages -touch .nojekyll -git add -A -git ci -m "update docs" -git push - diff --git a/docs/source/CMakeLists.txt b/docs/source/CMakeLists.txt deleted file mode 100644 index c783484cf..000000000 --- a/docs/source/CMakeLists.txt +++ /dev/null @@ -1,40 +0,0 @@ -find_program(M2R NAMES m2r m2r-3) - -function(DefaultRstPath RSTFILE_VAR MDFILE) - string(REGEX REPLACE "\\.md$" ".rst" FILEPATH ${MDFILE}) - get_filename_component(FILENAME ${FILEPATH} NAME) - set(${RSTFILE_VAR} "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}" PARENT_SCOPE) -endfunction() - -function(UpdateRstFromMd RSTFILE MDFILE) - if(NOT IS_ABSOLUTE ${MDFILE}) - set(MDFILE ${CMAKE_CURRENT_SOURCE_DIR}/${MDFILE}) - endif() - if (NOT IS_ABSOLUTE ${RSTFILE}) - set(RSTFILE ${CMAKE_CURRENT_SOURCE_DIR}/${RSTFILE}) - endif() - if(${MDFILE} IS_NEWER_THAN ${RSTFILE}) - message("-- Processing ${MDFILE} ...") - execute_process( - COMMAND ${M2R} --overwrite --parse-relative-links ${MDFILE} - RESULTS_VARIABLE M2R_STATUS - ) - if(M2R_STATUS) - message(" Failed to update ${RSTFILE}: ${M2R_STATUS}") - else() - string(REGEX REPLACE "\\.md$" ".rst" FILEPATH ${MDFILE}) - file(RENAME ${FILEPATH} ${RSTFILE} ) - message(" Updated ${RSTFILE}: OK") - endif() - endif() -endfunction() - -if(M2R) - message("-- Checking ChangeLogs, BUGS, etc...") - file(GLOB CHANGELOGS "${CMAKE_SOURCE_DIR}/ChangeLog-*.md") - foreach(CHANGELOG IN LISTS CHANGELOGS) - DefaultRstPath(RESTFILE ${CHANGELOG}) - UpdateRstFromMd(${RESTFILE} ${CHANGELOG}) - endforeach() - UpdateRstFromMd(issues.rst "${CMAKE_SOURCE_DIR}/BUGS.md") -endif() diff --git a/docs/source/ChangeLog-0.rst b/docs/source/ChangeLog-0.rst deleted file mode 100644 index 4f045ac34..000000000 --- a/docs/source/ChangeLog-0.rst +++ /dev/null @@ -1,823 +0,0 @@ - -ChangeLog v0.x -============== - -v 0.53 ------- - -.. - - released 2011-09-27 - - - -* Fix for FreeBSD/OpenBSD and -lm -* Added memcached_exist() -* Fix for memory when using config test. -* CLI gained --quiet - -v 0.52 ------- - -.. - - released 2011-09-12 - - - -* Build fixes for Ubuntu/Suse. -* Fixes for OSX Lion. -* Bug fix for looping back through dns lookups under certain failures. -* Fixes related to dead server failures. - -v 0.51 ------- - -.. - - released 2011-07-21 - - - -* memcached_callback_set() now takes its data argument as const -* Update to tests. -* Fix in parser for port number. - -v 0.50 ------- - -.. - - released 2011-06-20 - - - -* Updates to C++ interface -* Custom free allocators need to now check for value before calling free. -* memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster). -* Fix for stats structure. -* Updates to documentation. -* memcached_fetch_result() now uses the internal result when available (about 25 to 50% faster). - -v 0.49 ------- - -.. - - released 2011-04-14 - - - -* Fix calls to auto methods so that if value is not passed in nothing bad happens. -* New parser calls for generating memcached_st objects. -* New error system. -* New flow control for messages means faster get/set calls. -* Added new documentation system. -* A behavior change has been now made that if you specify a weight for any server, we enable the weight flag and do weight balancing. -* Added MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS to simplify the setting of AUTO REJECT for servers. - -v 0.48 ------- - -.. - - released 2011-03-16 - - - -* Fix memory leak in server parse. -* Move test framework out to be its own library (easier to work with Gearman). - -v 0.47 ------- - -.. - - released 2011-02-24 - - - -* Additional fixes for OpenBSD. -* Bug fix 677609, 456080. -* SIGPIPE fix for Linux send(). -* memcapable can now test ascii or binary based on flags. -* Additional build fixes for SASL. - -v 0.46 ------- - -.. - - released 2011-02-14 - - - -* Fixes a number of corner case bugs. -* Fixes related to OpenBSD. -* Better testing for protocol version. -* Removes special case infinite wait on blocking setup. - -v 0.45 ------- - -.. - - released 2011-02-09 - - - -* Add support for systemtap - -v 0.44 ------- - -.. - - released 2010-09-23 - - - -* Windows bug fixes. -* Hudson port support in test harness. -* Improved portability of test hanrness. -* SASL fixes. - -v 0.43 ------- - -.. - - released 2010-07-28 - - - -* Added --args to memstat so that a greater range of values can be returned. -* Prelimanary support for Windows. -* memcached_stat_execute() merged. - -v 0.42 ------- - -.. - - released 2010-07-06 - - - -* Mistake in libtool caused issue with library version - -v 0.41 ------- - -.. - - released 2010-06-30 - - - -* Added --file for memcat. -* Added limemcached_ping() to libmemcached_util -* Bugfix for some cases where connect would have issues with timeout. -* Wrong value for errno given as error on an IO failure inside of poll. -* Bug fix for issue where multiple interfaces with bad DNS were not being caught. - -v 0.40 ------- - -.. - - released 2010-04-23 - - - -* Placed retry logic in for busted resolvers -* Add an ignore for SIGPIPE to solve OSX issues. -* A couple of fixed for memcached_light server. -* Updated to debug mode to track io_wait - -v 0.39 ------- - -.. - - released 2010-04-06 - - - -* Add support for prefix keys to binary protocol. -* Remove the undocumented call memcached_server_remove(). -* The undocumented call memcached_server_by_key() now returns const. -* memcached_server_error_reset() has been deprecated. -* memcached_server_list() has been deprecated. Use memcached_server_cursor() to walk the servers found in a memcached_st() structure. -* memcached_verbosity() can now be run concurrently with other operations. -* SASL support. -* Fixes memory leak found in EJECT HOSTS. - -v 0.38 ------- - -.. - - released 2010-02-10 - - - -* C++ interface for libhashkit. -* Modified memcached_set_memory_allocators() so that it requires a context pointer. -* memcached_clone() now runs 5 times faster. -* Functions used for callbacks are now given const memcached_st. -* Added MEMCACHED_BEHAVIOR_CORK. -* memslap now creates a configuration file at ~/.memslap.cnf -* memcached_purge() now calls any callbacks registered during get execution. -* Many fixes to memslap. -* Updates for memcapable. -* Compile fixes for OpenBSD. -* Fix for possible recursive decent on IO failure. - -v 0.37 ------- - -.. - - released 2010-01-12 - - - -* Fixed build for libhashkit. -* Fixed install path regression. -* Modified RPM to strict check install. -* Added documentation for memcached_server_cursor(); -* Added memcached_servers_reset(). -* Modified memcached_st to remove dead cursor_server member. - -v 0.36 ------- - -.. - - released 2010-01-07 - - - -* Merged in new memslap utility. -* All of constants.h has been updated to match style (all old identifiers continue to work). -* Added first pass for libhashkit. -* Updated test Framework/extended tests. -* Random read support during replication added. -* Modified use_sort so that the option can be applied to any distribution type. -* We removed the MEMCACHED_BEHAVIOR_KETAMA_COMPAT_MODE added in 0.35. Instead use memcached_behavior_set_distribution(). - -v 0.35 ------- - -.. - - released 2009-11-09 - - - -* Added support for by_key operations for inc/dec methods. -* Added mget test to memslap. -* Support for compatible ketama for SpyMemcached -* Update C++ interface. -* Fix for memcp - -v 0.34 ------- - -.. - - released 2009-10-13 - - - -* Added support for setting behavior flags on a connection pool. -* Don't increment server_failure_counter on normal disconnects. -* Added prototype for a callback based protocol parser (server side) with examples so that you could let your own application speak the memcached protocol -* Updated memcapable to test ASCII protocol. -* Changed behavior so that server can be removed at first sign of failure. -* Added memcached_server_get_last_disconnect() call - -v 0.33 ------- - -.. - - released 2009-09-23 - - - -* Added memcapable to test servers for binary compatibility. -* Updated C++ interface. Added basic support for C++ exceptions. Added multiple constructors the memcached client object. The C++ interface now takes parameters which are C++ types (such as std::string). -* Several bug fixes for binary protocol support. -* Fixed crashing issue with dumping from memcachd server (server internals were changed without documenting change). - -v 0.32 ------- - -.. - - released 2009-09-15 - - - -* Change of behavior where linger is only modified for no-block and then it is set to zero. -* Added Twitter's memcached_server_error() functions. -* Fix for OSX compiles in development builds. -* Updated C++ interface. -* Updated memcached_mget and memcached_mget_by_key to take a size_t as a parameter instead of an unsigned int for number_of_keys. - -v 0.31 ------- - -.. - - released 2009-07-10 - - - -* Added support or HA via replication. -* malloc() removed for server key usage. -* Update build system. -* Added support for memcached_set_memory_allocators(). -* Fixed bug in configure.ac for have_htoll. - -v 0.30 ------- - -.. - - released 2009-06-01 - - - -* Added memcachd_dump command (and framework for memdump tool). -* Realigned all structures to remove padding (and line up important bits for 64bit caches. -* Remove some of sprintf() in storage calls(). -* Removed printf() in stat call for unknown stat member. -* memcached_generate_hash() function added. -* Added tests to make sure all hash functions are stable. - -v 0.29 ------- - -.. - - released 2009-05-19 - - - -* Fixed malloc usage to calloc for spots where we need zero filled memory. -* All code warnings now treated as errors. -* Fixes for debian packaging. -* Added new pooling mechanism. -* MEMCACHED_BEHAVIOR_NO_BLOCK no longer also sets MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. -* Updated generic rpm. - -v 0.28 ------- - -.. - - released 2009-04-15 - - - -* Fixed bug in init sructure (reapplied) -* Fixed bug in get/set by key (nikkhils@gmail.com) - -v 0.27 ------- - -.. - - released 2009-03-30 - - - -* Added new UDP fire-forget mode. -* Reworked performance for mget() to better make use of async protocol -* Cleaned up execution of fetch (just one set of code now) -* Fixed Jenkin's for big endian hosts. -* Updates for memstat to determine network latency. -* Updates for binary protocol. -* Many updates to documentation. - -v 0.26 ------- - -.. - - released 2009-01-29 - - - -* Fix for decrement on hash key -* Fixed assert that was catching bad memset() call in host_reset() -* Fix purge issue for blocked IO which has been stacked. - -v 0.25 ------- - -.. - - released 2008-11-28 - - - -* Jenkins HASH added. -* Update of Murmur hash code -* Support explicit weights (Robey Pointer, Evan Weaver) -* Bugfix for ketama continuum (Robey Pointer) -* New behavior MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY (Robey Pointer) -* Don't ever call stats for weighting servers, because it is unstable. - -v 0.24 ------- - -.. - - released 2008-09-16 - - - -* Cleanup compile warnings. -* Fix issues in partitioning by keys. -* Fixed "fail case" to make sure when calling memcached_clone() no memcached_st is over written. -* New memcached_server_by_key() method for finding a server from a key. -* memcached_server_free() was added for freeing server structures. - -v 0.23 ------- - -.. - - released 2008-09-07 - - - -* Added strings.h header for Solaris 9 -* Solaris 64bit fix. -* Support for weighted Ketama from Yin Chen. -* Fix for Chinese -* Fix for 0 length key to trigger bad key. -* Added behaviors MEMCACHED_BEHAVIOR_SND_TIMEOUT, MEMCACHED_BEHAVIOR_RCV_TIMEOUT -* Support for Binary Protocol added - -v 0.22 ------- - -.. - - released 2008-07-14 - - - -* Fix where master key was no being checked for "bad key" -* Fixed bugs in stats output (thread output was wrong) -* Clarified MEMCACHED_BAD_KEY_PROVIDED is return for bad prefix key. -* Found a bug in Flags return (Jacek Ostrowski) -* Fixed issue with compiling on Visual Studio - -v 0.21 ------- - -.. - - released 2008-05-24 - - - -* Change of char * to const char * for all key based functions. -* New MEMCACHED_CALLBACK_PREFIX_KEY added. You can now create domains for values. -* Fixed bug introducd in last version on memcp -* Fix for death of file io to call shutdown() - -v 0.20 ------- - -.. - - released 2008-05-05 - - - -* New consistent distribution tests. -* Found a memory leak when a server constantly fails. -* Fix in watchpoint macro -* Changed default timeout to 1 second for poll timeouts -* Wheel uses less memory/dynamic allocation for size (no longer limited to 512 hosts by default. -* memslap memory leak fix -* Added Ketama distribution -* Fix assert.h compile problem on CentOS - -v 0.19 ------- - -.. - - released 2008-04-09 - - - -* Documentation fix in libmemcached. -* Fixed bug where sort was always occuring on hosts -* Logic fix in branch prediction (thanks Jay!) -* Read through cached support. -* Fixed for cas by key operation. -* Fix for memcached_server_st list structures to have correct count. -* Added callback MEMCACHED_CALLBACK_DELETE_TRIGGER -* Removed function call in favor of macro (aka cut out some instructions) - -v 0.18 ------- - -.. - - released 2008-03-17 - - - -* Fix plus tests for non-zero value objects and flags. -* MEMCACHED_HASH_MURMUR added for murmur algorithm provided. -* MEMCACHED_BEHAVIOR_RETRY_TIMEOUT added to keep connecting from looping on timeout. -* gcc branch prediction optimizations -* Refactored entire tree to make include files cleaner -* Fixed leaked socket. - -v 0.17 ------- - -.. - - released 2008-02-27 - - - -* MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT added for connect timeout in non-block mode. -* Incompatible change in memcached_behavior_set() api. We now use a uint64_t, instead of a pointer. -* Fix for storage of values for zero. -* memcached_server_cursor() function added to API for cycling through servers. - -v 0.16 ------- - -.. - - released 2008-02-18 - - - -* Work on the UDP protocol -* Added get_by_key, set_by_key tests for C++ API -* Fix for limit_maxbytes to be 64bit in stats -* Added Atom Smasher test (scale baby, scale!) -* Servers are now sorted, meaning that servers are now ordered so that clients with the same lists, will have same distribution. (Idea from Ross McFarland). MEMCACHED_BEHAVIOR_SORT_HOSTS was added to enable this support. -* Added MEMCACHED_BAD_KEY_PROVIDED error for auto, set, and get operations. MEMCACHED_BEHAVIOR_VERIFY_KEY was added to enable this feature. -* More error messages on command line tools. -* Fixed bugs in memcached_cas() operator. -* Fix to loop through interfaces - -v 0.15 ------- - -.. - - released 2008-01-29 - - - -* More work on the C++ API. -* Bug fixes around block corner cases. -* Slight performance increase in both read() and write(). - -v 0.14 ------- - -.. - - released 2008-01-22 - - - -* For for bug found by Evan Weaver where increment() was not returning propper error of value was not found. -* Fix for bad null pointer on flag by Toru Maesaka. -* Refactor of all IO to just pass in the active server -* Problem configuring (PKG_CHECK_MODULES) fixed by removal of "rpath" in support/libmemcached.pc.in (Thanks to Ross McFarland). -* Added memcached_callback_get()/set() -* First prototype of C++ interface -* Updated docs for uint16_t changes in previous release - -v 0.13 ------- - -.. - - released 2008-01-13 - - - -* MEMCACHED_BEHAVIOR_USER_DATA added to store user pointer. -* Fix for failure to connect to invalidate socket. -* Patch from Marc Rossi to add --hash option for memcp, memrm, and memcat. -* Kevin's patch for fixing EOF issues during a read. -* Toru Maesaka patch for stats mismatch -* Fix for when CRC return 0 -* Fixed uint16_t issues around flags. Turns out the documentation on the protocol was wrong. -* Lingering socket fixes for FreeBSD. -* Patches from Kevin Dalley for FreeBSD 4.0 -* Added multi delete functions. -* All get key returns have C style null termination -* If memcached_server_list_append is passed NULLs instead of pointers it returns NULL. -* Added memcached_fetch_execute() method -* Found a bug where memcached_fetch() was not null terminating the result value. -* memcached_behavior() now has the ability to set "buffering" so that data is not automatically flushed. -* Behavior change, buffered commands now return MEMCACHED_BUFFERED - -v 0.12 ------- - -.. - - released 2007-12-11 - - - -* Updates for consistent hashing -* IPV6 support -* Static allocation for hostname (performance) -* Fixed bug where in non-block mode all data might not have been sent on close(). -* Refactor of memcached_get() to use common code. -* Change in value fetch, MEMCACHED_END is now returned when keys are no longer in the pipe. -* Fixed bug where key could be out of range of characters -* Added _by_key() methods to allow partitioning of values to particular servers. -* MEMCACHED_DEFAILT_TIMEOUT is now set to a non -1 value. -* Performance improvements in get operations. - -v 0.11 ------- - -.. - - released 2007-11-26 - - - -* Added option to memcache_behavior_set() so that poll() can be timed out. -* Fixed memory leak in case of using memcached_fetch_result() where no value was returned. -* Bug fixed in memcached_connect() which would cause servers that did not need to be enabled to be enabled (performance issue). -* Rewrote bounds checking code for get calls. -* "make test" now starts its own memcached servers. -* Added Hseih hash (MEMCACHED_HASH_HSIEH), which is showing about 7% performance over standard hash. - -v 0.10 ------- - -.. - - released 2007-11-21 - - - -* Added append binary test. -* Added MEMCACHED_BEHAVIOR_CACHE_LOOKUPS behavior so that you can save on multiple DNS lookups. -* Added CAS support, though this is optional and must be enabled during runtime. -* Added the utility memerror to create human readable error strings from memcached errors (aka convert ints to strings) -* Fixed type in MEMCACHED_HOST_LOOKUP_FAILURE -* Fixed bug where hostname might not be null terminated -* Moved to using gethostbyname_r() on Linux to solve thread safety issue -* Added -rpath support for pkg-config -* Documentation fix for hash setting using memcached_behavior_set() - -v 0.9 ------ - -.. - - released 2007-11-15 - - - -* fix for when no servers are definied. -* different buffers are now kept for different connections to speed up async efforts -* Modified increment/decrement functions to return uint64_t values -* Fixed bug in cases where zero length keys were provided -* Thread cleanup issue in memslap -* No hostname lookup on reconnect -* Fix for flag settings (was doing hex by accident!) -* Support for 1.2.4 server additions "prepend" and "append" added. -* Added memcached_version()... not sure if I will make this public or not. - -v 0.8 ------ - -.. - - released 2007-11-05 - - - -* Adding support for CRC hash method -* Adding support for UNIX sockets -* Added additional HASHing methods of FNV1_64,FNV1A_64, FNV1_32, FNV1A_32 -* Added pkgconfig support (PKG_CHECK_MODULES) -* Fixed conflict with defined type in MySQL -* Added memcached_result_st structure and functions to manipulate it. - -v 0.7 ------ - -.. - - released 2007-10-30 - - - -* Poved to poll() from select() -* Fixes in internal string class for allocation of large numbers of strings. -* memcached_mget() function now sends keys as it parses them instead of building strings as it goes. -* Propper flush now for making sure we get all IO sent even when in non-block mode. -* Added --enable-debug rule for configure -* All asserts() removed (hey this is going into production!) - -v 0.6 ------ - -.. - - released 2007-10-17 - - - -* get value returns are now null terminated (request by Cal Heldenbrand) -* Fixed connections for more hosts then two. -* Rewrite of the read/write IO systems to handle different sorts of host failures. -* Added man pages for all functions and tools -* Raised buffer size for readinng/writing to 16K -* You can now optionally set the socket size for recv/send via memached_behavior_set/get. - -v 0.5 ------ - -.. - - released 2007-10-09 - - - -* Ruby maintainer mentioned TCP_NODELAY patch he had added. Added this to C - library as well. (Eric Hodel drbrain@segment7.net) -* Added support script for set_benchmark -* Updated memslap to allow testing of TCP_NODELAY -* Updated memslap to support --flush (aka dump memcache servers before testing) -* Fixed bug in multiple hosts not being activated -* Added environmental variable MEMCACHED_SERVERS which can be used to set the servers list. -* fixed memcached_stat method (and now memstat works) -* server connect now happens on demand. -* Help for all command line applications - -v 0.4 ------ - -.. - - released 2007-10-03 - - - -* Added buffered IO to write calls for keys -* Added buffered IO for reads -* memstat was broken (bad if/else on connect) -* New non-blocking IO (not default yet). Mucho faster -* Refactor of test system. -* memslap crash solved - -v 0.3 ------ - -.. - - released 2007-10-01 - - - -* Jeff Fisher guppy@techmonkeys.org provided a spec file -* Added "make rpm" around dist file -* Added support for Solaris -* Added support for DTrace -* Fixed read to be recv and write to be send -* Bug fix where memstat would core if no server was found -* Added memslap tool (load generator) -* Numerous bug fixes in library -* Added calls to library for creating host lists (see text cases to understand how to use this). - -v 0.2 ------ - -.. - - released 2007-09-27 - - - -* First public version diff --git a/docs/source/ChangeLog-1.0.rst b/docs/source/ChangeLog-1.0.rst deleted file mode 100644 index e1a808ce2..000000000 --- a/docs/source/ChangeLog-1.0.rst +++ /dev/null @@ -1,226 +0,0 @@ - -ChangeLog v1.0 -============== - -v 1.0.18 --------- - -.. - - released 2014-02-09 - - - -* MEMCACHED_BEHAVIOR_RETRY_TIMEOUT can now be set to zero. -* Numerous bug fixes. - -v 1.0.17 --------- - -.. - - released 2013-04-03 - - - -* Remove c++ namespace that was being exposed (the API should be plug compatible).. -* Fix cases where --servers wasn't behaving the same in all clients. - -v 1.0.16 --------- - -.. - - released 2013-02-01 - - - -* Added support to do two part shutdown of socket. -* Fixes for Fedora 18. -* Fix for binary memcached_touch() - -v 1.0.15 --------- - -.. - - released 2012-12-17 - - - -* Added support for Murmur3 (HASHKIT_HASH_MURMUR3) -* Portability fixes. - -v 1.0.14 --------- - -.. - - released 2012-11-14 - - - -* CLIENT_ERROR fixed to not be treated as a fatal error. -* Compiler fixes for older Ubuntu releases. - -v 1.0.13 --------- - -.. - - released 2012-10-19 - - - -* Fix bug that caused version string to not be exported correctly. - -v 1.0.12 --------- - -.. - - released 2012-10-09 - - - -* Added memcached_result_take_value(). -* Added ax_libmemcached.m4 - -v 1.0.11 --------- - -.. - - released 2012-09-17 - - - -* Removed custom version of memcached. -* Updated hardening rules. -* Fixed a case where the return error from a socket connection differred from that of a TCP/IP socket. - -v 1.0.10 --------- - -.. - - released 2012-07-30 - - - -* --disable-assert has been removed from configure, and --enable-assert has been added in its place. -* Compiling fixes for Clang on OSX Mountain Lion. - -v 1.0.9 -------- - -.. - - released 2012-07-05 - - - -* Faster close on socket. -* Instance allocation is now seperated from server interface. - This should allow for a better preservation of ABI compliance from now on. -* Fix close on exec bug. -* Numerous other bug fixes. - -v 1.0.8 -------- - -.. - - released 2012-05-22 - - - -* Added support for setting options via ENV variable LIBMEMCACHED -* Fix corner case on last used result. - -v 1.0.7 -------- - -.. - - released 2012-04-28 - - - -* Add API call for exist calls. -* Update all license files to be BSD. - -v 1.0.6 -------- - -.. - - released 2012-04-08 - - - -* Fixes for gcc 4.7, lp:961812 -* Fix for restart issue that happens under testing. -* Fix for lp:962815. -* Support for transparent AES encryption. - -v 1.0.5 -------- - -.. - - released 2012-03-14 - - - -* Fixes for OSX. -* Version is now parsed directly in the parser, which makes buffered operations now work with it.. -* memstat has been extended so that it can be used to find the version of the server. -* Update documentation. -* Fixes for compile issues on Debian and Ubuntu - -v 1.0.4 -------- - -.. - - released 2012-01-27 - - - -* Fix for memcached_dump(). -* Additional testing for memcached_stat_execute(). - -v 1.0.3 -------- - -.. - - released 2012-01-09 - - - -* Increased size of sort buffer used during Ketama. -* Added support for new behavior to handle dead servers. -* Overall haul of UDP IO. -* Fixed C compile issue with memcached_exist() -* Numerous bug fixes. -* Clang support for OSX. -* All commands now using vector send support. - -v 1.0.2 -------- - -.. - - released 2011-10-24 - - - -* Dropped libmemcached/memcached_util.h (undocumented header file) -* Added memcached_touch() and memcached_touch_by_key() -* UDP support restructured to toggle on a complete memcached_st structure. - ----- - -See :doc:`ChangeLog-0 <./ChangeLog-0>` for changes prior v1.0. diff --git a/docs/source/ChangeLog-1.1.rst b/docs/source/ChangeLog-1.1.rst deleted file mode 100644 index 6740d695f..000000000 --- a/docs/source/ChangeLog-1.1.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. role:: raw-html-m2r(raw) - :format: html - - -ChangeLog v1.1 -============== - -v 1.1.4 -------- - -.. - - released 2023-03-06 - - - -* Fix `gh #107 `_\ : - macOS: deprecated sasl API (improve detection of ``libsasl2``\ ). -* Fix `gh #131 `_\ : - Consider renaming tools (add ``CLIENT_PREFIX`` build option; default: ``mem``\ ) -* Fix `gh #132 `_\ : - Add build of static library (add ``BUILD_SHARED_LIBS`` build option; default: ``ON``\ ). -* Fix `gh #134 `_\ : - Update client option documentation. -* Fix `gh #136 `_\ : - ``libmemcachedutil`` is underlinked (link against libmemcached). -* Fix `gh php-memcached#531 `_\ : - ``get`` returns random values when lower than default ``OPT_POLL_TIMEOUT`` is set.\ :raw-html-m2r:`
` - **NOTE:** This is a security related fix; more information can be found at: - https://github.com/awesomized/libmemcached/security/advisories/GHSA-wwmh-39wj-fx59 - -v 1.1.3 -------- - -.. - - released 2022-11-09 - - - -* Fix `gh #130 `_ - with `gh #124 `_\ : - Server response count can underflow. - -v 1.1.2 -------- - -.. - - released 2022-08-10 - - - -* Fix handling of negative expiration values, which are somehow allowed by legacy.\ :raw-html-m2r:`
` - See also `gh #125 `_\ , - and `gh #76 `_. -* Fix `gh #122 `_\ : - If libcrypto implementation of AES is used, do not compile internal. -* Fix missing include of :raw-html-m2r:`` in tests. -* Fix warnings with non-SASL builds. -* Fix pthread.h detection. - -v 1.1.1 -------- - -.. - - released 2021-09-16 - - - -* Fix `gh #67 `_\ : - GET returns ``NOTFOUND`` on ``TIMEOUT``. -* Fix `gh #113 `_\ : - Build failure with Catch2 < 2.13.5. -* Add `gh #114 `_\ : - Add possibility to use libcrypto for encryption. -* Add `gh #115 `_\ : - Add ``LIBMEMCACHED_AWESOME`` CPP define. -* Add test for `gh #75 `_\ : - memcached_clone of SASL connection closes random file descriptor. -* Fix `gh #116 `_\ : - Add libmemcachedpotocol-0-0/configure.h guarding ``ssize_t`` typedef. -* Fix `gh #120 `_\ : - libmemcached.pc is missing a ``Requires`` entry for libsasl2. - -v 1.1.0 -------- - -.. - - released 2021-06-23 - - -**Changes from beta3:** - - -* Add ASCII multi get support to bin/memslap. - -See logs from ``beta3``\ , ``beta2``\ , and ``beta1`` for -the full list of changes since the last 1.0 release. - -v 1.1.0-beta3 -------------- - -.. - - released 2021-04-15 - - -**Changes from beta2:** - - -* Fix `gh #108 `_\ : - macOS Big Sur: dtrace does not understand -G switch. -* Add support for IPv6 bracketed syntax in ``memcached_servers_parse``. -* Make ``memcat``\ 's ``--file`` option's argument optional defaulting to ````. -* Fix libmemcachedprotocol's binary ``STAT`` and ``VERSION`` handlers. -* Fix `gh #105 `_\ : - EINTR handled too defensively when polling. - -v 1.1.0-beta2 -------------- - -.. - - released 2020-12-28 - - -**Changes from beta1:** - - -* Fix `gh #103 `_\ : - Build failure on 32-bit. -* Fix `gh #102 `_\ : - Doc build with old sphinx. -* Fix `gh #100 `_\ : - Revert symbolic rename of public header include directories. -* Fix `gh #98 `_\ : - Library SONAMEs and NAME_LINKs differ from 1.0.18. -* Fix `gh #97 `_\ : - Location of cmake files installation directory. -* Fix `gh #96 `_\ : - LIBXXX_VERSION_HEX constants format. - -v 1.1.0-beta1 -------------- - -.. - - released 2020-12-21 - - -**NOTE:**\ :raw-html-m2r:`
` -This is a bug fix release, not a feature release. The minor version number -was incremented due to the following changes: - - -* Ported build system to CMake. -* Ported test suite to Catch2. -* Build requires C++11 compiler support. -* Tests require C++17 compiler support. -* Moved to the Semantic Versioning Specification: https://semver.org -* Moved the project from launchpad to github: - - * Source: https://github.com/awesomized/libmemcached - * Documentation: https://awesomized.github.io/libmemcached - * Continuous Integration: - - * Github: https://github.com/awesomized/libmemcached/actions (Linux, MacOS, Windows **·** amd64) - * Sourcehut: https://builds.sr.ht/~m6w6/libmemcached (FreeBSD, - OpenBSD **·** amd64) - * Build artifacts: https://artifacts.m6w6.name/libmemcached/ rsync://m6w6.name::artifacts/libmemcached/ - - -* Fix build failure due to comparison of incompatible types in bin/memflush and bin/memstat. -* Fix wrong type of memcached_instance_st::server_timeout_counter_query_id from uint32_t to uint64_t. -* Fix memcached_dump(): - returned MEMCACHED_CLIENT_ERROR on request to dump illegal slab id. -* Fix bin/memcapable: - failed with "No hostname was provided" when providing a hostname. -* Fix hashkit/murmur and hashkit/murur3: - undefined behavior on platforms requiring aligned access. -* Fix Memcache::set(): - possible subscription of empty vector. -* Fix libmemcached_util_version_check(). -* Fix ketama/consistent hashing: - crash on reallocation of continuum. -* Fix `gh #90 `_\ : - Build fails on Darwin. -* Fix `gh #83 `_\ : - memcp waits forever if file no found. -* Fix `gh #80 `_\ : - memparse docs. -* Fix `gh #72 `_ - and `gh #47 `_\ : - memcached_return_t docs. -* Fix `gh #62 `_\ : - uint32_t overflow cause busy loop. -* Removed restriction of UDP+IPv6. -* Fix SERVER_ERROR_MEMORY_ALLOCATION_FAILURE: - recognize more strings returned by the server. -* Fix `gh #13 `_\ : - reset continuum counter after freeing them. -* Fix `gh #14 `_ - and `gh #17 `_\ : - SASL: AUTH_CONTINUE was considered a failure and caused IO reset. -* Fix `gh #25 `_\ : - hashkit/murmur3 unavailable. -* Fix missing handling of EAGAIN for non-blocking unix domain socket. -* Fix `gh #35 `_\ : - handling of BEHAVIOR_REMOVE_FAILED_SERVERS. -* Fix `gh #41 `_\ : - ensure stable sort on continuum host key collision. -* Fix `gh #42 `_\ : - MEMCACHED_MAX_BUFFER docs. -* Fix `gh #43 `_\ : - libmemcached_configuration docs. -* Fix `gh #46 `_\ : - clarification on millisecond timeout docs. -* Fix `gh #50 `_\ : - memcached_fetch_result() can return previously returned data. -* Fix `gh #53 `_\ : - stack overflow in memcached_fetch_result(). -* Fix `gh #57 `_\ : - include vs :raw-html-m2r:`` -* Fix `gh #58 `_\ : - more specific error messages when connect() fails. -* Fix `gh #59 `_\ : - bin/memcat: typo in "No servers provied". -* Fix `gh #77 `_\ : - undeclared UINT64_C in ketama.cc. -* Fix `gh #12 `_\ : - never reconnects after connection reset (binary protocol). -* Fix `gh #49 `_\ : - assertion memcached_failed(rc) failed in memcached_send_ascii(). -* Fix `gh #67 `_\ : - get returns NOTFOUND on timeout. -* Fix `gh #76 `_\ : - memcached_touch() crashes when expiration=-1 (ASCII only). -* Fix `gh #23 `_\ : - build fails with bison 2.3. -* Fix memaslap: build fails with newer compiler versions. -* Fix usage of strerror_r() implementations returning pointer to char. -* Fix pipelining commands with memcached >= 1.6. -* Fix memcached_stat_get_value(): buffer overflow. -* Fix memcached_stat(): undefined behavior due to unintialized memcached_return_t. -* Fix SASL tests: requires SASL_PWDB_CONF. -* Fix bin/memaslap to idnentify itself as memaslap instead of memslap. -* Fix bin/memcapable to work with memcached >= 1.6. -* Fix murmur and murmur3 hashes on big endian platforms. -* Fix `gh #82 `_\ , - `gh #64 `_ and - `gh #21 `_\ : - clarify documentation on replication. -* Fix `gh #95 `_\ : - MEMCACHED_CALLBACK_GET_FAILURE and MEMCACHED_BEHAVIOR_BUFFER_REQUESTS -* Fix bin/memcat to output flags if requested with ``--flag``. -* Fix `gh #68 `_\ : - Windows support. - ----- - -See :doc:`ChangeLog-1.0 <./ChangeLog-1.0>` for changes prior v1.1. diff --git a/docs/source/bin/common/env.rst b/docs/source/bin/common/env.rst deleted file mode 100644 index ac1d42e88..000000000 --- a/docs/source/bin/common/env.rst +++ /dev/null @@ -1,7 +0,0 @@ -ENVIRONMENT ------------ - -.. envvar:: MEMCACHED_SERVERS - - Specify a list of servers. - diff --git a/docs/source/bin/common/note_contrib_options.rst b/docs/source/bin/common/note_contrib_options.rst deleted file mode 100644 index 3f8f2ab70..000000000 --- a/docs/source/bin/common/note_contrib_options.rst +++ /dev/null @@ -1,8 +0,0 @@ - -CONTRIBUTED PROGRAM -................... - -This is a contributed program. - -This program doesn't follow the standard flag/option scheme. - diff --git a/docs/source/bin/common/note_program_prefix.rst b/docs/source/bin/common/note_program_prefix.rst deleted file mode 100644 index 86d7099e9..000000000 --- a/docs/source/bin/common/note_program_prefix.rst +++ /dev/null @@ -1,10 +0,0 @@ - -PROGRAM PREFIX -.............. - -The prefix of this program is variable, i.e. it can be configured at build time. - -Usually the client programs of ``libmemcached-awesome`` are prefixed with ``mem``, like ``memcat`` or ``memcp``. - -It can be configured, though, to replace the prefix with something else like ``mc``, in case of that, -the client programs of ``libmemcached-awesome`` would be called ``mccat``, ``mccp``, etc. respectively. diff --git a/docs/source/bin/index.rst b/docs/source/bin/index.rst deleted file mode 100644 index 1c2b11b2a..000000000 --- a/docs/source/bin/index.rst +++ /dev/null @@ -1,37 +0,0 @@ -Client Applications -=================== - -Data Manipulation ------------------ - -.. toctree:: - :titlesonly: - - memexist — Check for the existence of a key - memcat — "cat" data from a server - memcp — "cp" files to a server - memtouch — "touch" a key - memrm – "rm" a key - -Tests and Analysis ------------------- - -.. toctree:: - :titlesonly: - - memaslap - Load testing and benchmarking a server - memslap - Load testing and benchmarking a server - memping – Ping a server - memstat – Gather statistics from a server - memerror — Translate libmemcached error codes - memparse — Parse and validate an option string - memcapable — Check a server's capabilities and compatibility - -Server Administration ---------------------- - -.. toctree:: - :titlesonly: - - memdump — Dump a server's data - memflush — Flush a server (erase all cached data) diff --git a/docs/source/bin/memaslap.rst b/docs/source/bin/memaslap.rst deleted file mode 100644 index 6ac3e21a9..000000000 --- a/docs/source/bin/memaslap.rst +++ /dev/null @@ -1,1014 +0,0 @@ -================================================== -memaslap - Load testing and benchmarking a server -================================================== - -SYNOPSIS --------- - -|client_prefix|\aslap [options] - -.. program:: memaslap - -.. option:: --help -.. option:: --servers - -.. envvar:: MEMCACHED_SERVERS - -DESCRIPTION ------------ - -:program:`memaslap` is a load generation and benchmark tool for memcached -servers. It generates configurable workload such as threads, concurrency, -connections, run time, overwrite, miss rate, key size, value size, get/set -proportion, expected throughput, and so on. Furthermore, it also tests data -verification, expire-time verification, UDP, binary protocol, facebook test, -replication test, multi-get and reconnection, etc. - -Memaslap manages network connections like memcached with -libevent. Each thread of memaslap is bound with a CPU core, all -the threads don't communicate with each other, and there are several socket -connections in each thread. Each connection keeps key size distribution, -value size distribution, and command distribution by itself. - -You can specify servers via the :option:`memaslap --servers` option or via the -environment variable :envvar:`MEMCACHED_SERVERS`. - -FEATURES --------- - -Memslap is developed to for the following purposes: - -Manages network connections with libevent asynchronously. - -Set both TCP and UDP up to use non-blocking IO. - -Improves parallelism: higher performance in multi-threads environments. - -Improves time efficiency: faster processing speed. - -Generates key and value more efficiently; key size distribution and value size distribution are configurable. - -Supports get, multi-get, and set commands; command distribution is configurable. - -Supports controllable miss rate and overwrite rate. - -Supports data and expire-time verification. - -Supports dumping statistic information periodically. - -Supports thousands of TCP connections. - -Supports binary protocol. - -Supports facebook test (set with TCP and multi-get with UDP) and replication test. - -DETAILS -------- - -Effective implementation of network. -____________________________________ - -For memaslap, both TCP and UDP use non-blocking network IO. All -the network events are managed by libevent as memcached. The network module -of memaslap is similar to memcached. Libevent can ensure -memaslap can handle network very efficiently. - -Effective implementation of multi-threads and concurrency -_________________________________________________________ - -Memslap has the similar implementation of multi-threads to -memcached. Memslap creates one or more self-governed threads; -each thread is bound with one CPU core if the system tests setting CPU -core affinity. - -In addition, each thread has a libevent to manage the events of the network; -each thread has one or more self-governed concurrency; and each -concurrency has one or more socket connections. All the concurrent tasks don't -communicate with each other even though they are in the same thread. - -Memslap can create thousands of socket connections, and each -concurrency has tens of socket connections. Each concurrency randomly or -sequentially selects one socket connection from its socket connection pool -to run, so memaslap can ensure each concurrency handles one -socket connection at any given time. Users can specify the number of -concurrency and socket connections of each concurrency according to their -expected workload. - -Effective implementation of generating key and value -____________________________________________________ - -In order to improve time efficiency and space efficiency, -memaslap creates a random characters table with 10M characters. All the -suffixes of keys and values are generated from this random characters table. - -Memslap uses the offset in the character table and the length -of the string to identify a string. It can save much memory. -Each key contains two parts, a prefix and a suffix. The prefix is an -uint64_t, 8 bytes. In order to verify the data set before, -memaslap need to ensure each key is unique, so it uses the prefix to identify -a key. The prefix cannot include illegal characters, such as '\r', '\n', -'\0' and ' '. And memaslap has an algorithm to ensure that. - -Memslap doesn't generate all the objects (key-value pairs) at -the beginning. It only generates enough objects to fill the task window -(default 10K objects) of each concurrency. Each object has the following -basic information, key prefix, key suffix offset in the character table, key -length, value offset in the character table, and value length. - -In the work process, each concurrency sequentially or randomly selects an -object from the window to do set operation or get operation. At the same -time, each concurrency kicks objects out of its window and adds new object -into it. - -Simple but useful task scheduling -_________________________________ - -Memslap uses libevent to schedule all concurrent tasks of -threads, and each concurrency schedules tasks based on the local task -window. Memslap assumes that if each concurrency keeps the same -key distribution, value distribution and commands distribution, from -outside, memaslap keeps all the distribution as a whole. -Each task window includes a lot of objects, each object stores its basic -information, such as key, value, expire time, and so on. At any time, all -the objects in the window keep the same and fixed key and value -distribution. If an object is overwritten, the value of the object will be -updated. Memslap verifies the data or expire-time according to -the object information stored in the task window. - -Libevent selects which concurrency to handle based on a specific network -event. Then the concurrency selects which command (get or set) to operate -based on the command distribution. If it needs to kick out an old object and -add a new object, in order to keep the same key and value distribution, the -new object must have the same key length and value length. - -If memcached server has two cache layers (memory and SSD), running -memaslap with different window sizes can get different cache -miss rates. If memaslap adds enough objects into the windows at -the beginning, and the cache of memcached cannot store all the objects -initialized, then memaslap will get some objects from the second -cache layer. It causes the first cache layer to miss. So the user can -specify the window size to get the expected miss rate of the first cache -layer. - -Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol -________________________________________________________________________________ - -Because each thread is self-governed, memaslap can assign -different threads to handle different memcached servers. This is just one of -the ways in which memaslap tests multiple servers. The only -limitation is that the number of servers cannot be greater than the number -of threads. The other way to test multiple servers is for replication -test. Each concurrency has one socket connection to each memcached server. -For the implementation, memaslap can set some objects to one -memcached server, and get these objects from the other servers. - -By default, Memslap does single get. If the user specifies -multi-get option, memaslap will collect enough get commands and -pack and send the commands together. - -Memslap tests both the ASCII protocol and binary protocol, -but it runs on the ASCII protocol by default. -Memslap by default runs on the TCP protocol, but it also -tests UDP. Because UDP is unreliable, dropped packages and out-of-order -packages may occur. Memslap creates a memory buffer to handle -these problems. Memslap tries to read all the response data of -one command from the server and reorders the response data. If some packages -get lost, the waiting timeout mechanism can ensure half-baked packages will -be discarded and the next command will be sent. - -USAGE ------ - -Below are some usage samples: - -memaslap -s 127.0.0.1:11211 -S 5s - -memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b - -memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2 - -memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k - -memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40 - -memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m - -memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 - -The user must specify one server at least to run memaslap. The -rest of the parameters have default values, as shown below: - -Thread number = 1 Concurrency = 16 - -Run time = 600 seconds Configuration file = NULL - -Key size = 64 Value size = 1024 - -Get/set = 9:1 Window size = 10k - -Execute number = 0 Single get = true - -Multi-get = false Number of sockets of each concurrency = 1 - -Reconnect = false Data verification = false - -Expire-time verification = false ASCII protocol = true - -Binary protocol = false Dumping statistic information periodically = false - -Overwrite proportion = 0% UDP = false - -TCP = true Limit throughput = false - -Facebook test = false Replication test = false - -Key size, value size and command distribution. -______________________________________________ - -All the distributions are read from the configuration file specified by user -with "—cfg_cmd" option. If the user does not specify a configuration file, -memaslap will run with the default distribution (key size = 64, -value size = 1024, get/set = 9:1). For information on how to edit the -configuration file, refer to the "Configuration File" section. - -The minimum key size is 16 bytes; the maximum key size is 250 bytes. The -precision of proportion is 0.001. The proportion of distribution will be -rounded to 3 decimal places. - -The minimum value size is 1 bytes; the maximum value size is 1M bytes. The -precision of proportion is 0.001. The proportion of distribution will be -rounded to 3 decimal places. -Currently, memaslap only tests set and get commands. And it -testss 100% set and 100% get. For 100% get, it will preset some objects to -the server. - -Multi-thread and concurrency -____________________________ - -The high performance of memaslap benefits from the special -schedule of thread and concurrency. It's important to specify the proper -number of them. The default number of threads is 1; the default number of -concurrency is 16. The user can use "—threads" and "--concurrency" to -specify these variables. - -If the system tests setting CPU affinity and the number of threads -specified by the user is greater than 1, memaslap will try to -bind each thread to a different CPU core. So if you want to get the best -performance memaslap, it is better to specify the number of -thread equal to the number of CPU cores. The number of threads specified by -the user can also be less or greater than the number of CPU cores. Because -of the limitation of implementation, the number of concurrencies could be -the multiple of the number of threads. - -1. For 8 CPU cores system - -For example: - ---threads=2 --concurrency=128 - ---threads=8 --concurrency=128 - ---threads=8 --concurrency=256 - ---threads=12 --concurrency=144 - -2. For 16 CPU cores system - -For example: - ---threads=8 --concurrency=128 - ---threads=16 --concurrency=256 - ---threads=16 --concurrency=512 - ---threads=24 --concurrency=288 - -The memaslap performs very well, when -used to test the performance of memcached servers. -Most of the time, the bottleneck is the network or -the server. If for some reason the user wants to -limit the performance of memaslap, there -are two ways to do this: - -Decrease the number of threads and concurrencies. -Use the option "--tps" that memaslap -provides to limit the throughput. This option allows -the user to get the expected throughput. For -example, assume that the maximum throughput is 50 -kops/s for a specific configuration, you can specify -the throughput equal to or less than the maximum -throughput using "--tps" option. - -Window size -___________ - -Most of the time, the user does not need to specify the window size. The -default window size is 10k. For Schooner Memcached, the user can specify -different window sizes to get different cache miss rates based on the test -case. Memslap testss cache miss rate between 0% and 100%. -If you use this utility to test the performance of Schooner Memcached, you -can specify a proper window size to get the expected cache miss rate. The -formula for calculating window size is as follows: - -Assume that the key size is 128 bytes, and the value size is 2048 bytes, and -concurrency=128. - -1. Small cache cache_size=1M, 100% cache miss (all data get from SSD). -win_size=10k - -2. cache_size=4G - -(1). cache miss rate 0% - -win_size=8k - -(2). cache miss rate 5% - -win_size=11k - -3. cache_size=16G - -(1). cache miss rate 0% - -win_size=32k - -(2). cache miss - -rate 5% - -win_size=46k - -The formula for calculating window size for cache miss rate 0%: - -cache_size / concurrency / (key_size + value_size) \* 0.5 - -The formula for calculating window size for cache miss rate 5%: - -cache_size / concurrency / (key_size + value_size) \* 0.7 - -Verification -____________ - -Memslap testss both data verification and expire-time -verification. The user can use "--verify=" or "-v" to specify the proportion -of data verification. In theory, it testss 100% data verification. The -user can use "--exp_verify=" or "-e" to specify the proportion of -expire-time verification. In theory, it testss 100% expire-time -verification. Specify the "--verbose" options to get more detailed error -information. - -For example: --exp_verify=0.01 –verify=0.1 , it means that 1% of the objects -set with expire-time, 10% of the objects gotten will be verified. If the -objects are gotten, memaslap will verify the expire-time and -value. - -multi-servers and multi-config -_______________________________ - -Memslap testss multi-servers based on self-governed thread. -There is a limitation that the number of servers cannot be greater than the -number of threads. Memslap assigns one thread to handle one -server at least. The user can use the "--servers=" or "-s" option to specify -multi-servers. - -For example: - ---servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 --threads=6 --concurrency=36 - -The above command means that there are 6 threads, with each thread having 6 -concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1 -and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2 -(10.1.1.3). - -All the threads and concurrencies in memaslap are self-governed. - -So is memaslap. The user can start up several -memaslap instances. The user can run memaslap on different client -machines to communicate with the same memcached server at the same. It is -recommended that the user start different memaslap on different -machines using the same configuration. - -Run with execute number mode or time mode -_________________________________________ - -The default memaslap runs with time mode. The default run time -is 10 minutes. If it times out, memaslap will exit. Do not -specify both execute number mode and time mode at the same time; just -specify one instead. - -For example: - ---time=30s (It means the test will run 30 seconds.) - ---execute_number=100000 (It means that after running 100000 commands, the test will exit.) - -Dump statistic information periodically. -________________________________________ - -The user can use "--stat_freq=" or "-S" to specify the frequency. - -For example: - ---stat_freq=20s - -Memslap will dump the statistics of the commands (get and set) at the frequency of every 20 -seconds. - -For more information on the format of dumping statistic information, refer to "Format of Output" section. - -Multi-get -_________ - -The user can use "--division=" or "-d" to specify multi-get keys count. -Memslap by default does single get with TCP. Memslap also testss data -verification and expire-time verification for multi-get. - -Memslap testss multi-get with both TCP and UDP. Because of -the different implementation of the ASCII protocol and binary protocol, -there are some differences between the two. For the ASCII protocol, -memaslap sends one "multi-get" to the server once. For the -binary protocol, memaslap sends several single get commands -together as "multi-get" to the server. - -UDP and TCP -___________ - -Memslap testss both UDP and TCP. For TCP, -memaslap does not reconnect the memcached server if socket connections are -lost. If all the socket connections are lost or memcached server crashes, -memaslap will exit. If the user specifies the "--reconnect" -option when socket connections are lost, it will reconnect them. - -User can use "--udp" to enable the UDP feature, but UDP comes with some -limitations: - -UDP cannot set data more than 1400 bytes. - -UDP is not tested by the binary protocol because the binary protocol of -memcached does not tests that. - -UDP doesn't tests reconnection. - -Facebook test -_____________ - -Set data with TCP and multi-get with UDP. Specify the following options: - -"--facebook --division=50" - -If you want to create thousands of TCP connections, specify the - -"--conn_sock=" option. - -For example: --facebook --division=50 --conn_sock=200 - -The above command means that memaslap will do facebook test, -each concurrency has 200 socket TCP connections and one UDP socket. - -Memslap sets objects with the TCP socket, and multi-gets 50 -objects once with the UDP socket. - -If you specify "--division=50", the key size must be less that 25 bytes -because the UDP packet size is 1400 bytes. - -Replication test -________________ - -For replication test, the user must specify at least two memcached servers. -The user can use "—rep_write=" option to enable feature. - -For example: - ---servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2 - -The above command means that there are 2 replication memcached servers, -memaslap will set objects to both server 0 and server 1, get -objects which are set to server 0 before from server 1, and also get objects -which are set to server 1 before from server 0. If server 0 crashes, -memaslap will only get objects from server 1. If server 0 comes -back to life again, memaslap will reconnect server 0. If both -server 0 and server 1 crash, memaslap will exit. - -Supports thousands of TCP connections -_____________________________________ - -Start memaslap with "--conn_sock=" or "-n" to enable this -feature. Make sure that your system can tests opening thousands of files -and creating thousands of sockets. However, this feature does not tests -reconnection if sockets disconnect. - -For example: - ---threads=8 --concurrency=128 --conn_sock=128 - -The above command means that memaslap starts up 8 threads, each -thread has 16 concurrencies, each concurrency has 128 TCP socket -connections, and the total number of TCP socket connections is 128 \* 128 = -16384. - -Supports binary protocol -________________________ - -Start memaslap with "--binary" or "-B" options to enable this -feature. It testss all the above features except UDP, because the latest -memcached 1.3.3 does not implement binary UDP protocol. - -For example: - ---binary - -Since memcached 1.3.3 doesn't implement binary UDP protocol, -memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests -multi-get. If you specify "--division=50" option, it just sends 50 get -commands together as "multi-get" to the server. - -Configuration file ------------------- - -This section describes the format of the configuration file. By default -when no configuration file is specified memaslap reads the default -one located at ~/.memaslap.cnf. - -Below is a sample configuration file: - -.. code-block:: perl - - --------------------------------------------------------------------------- - #comments should start with '#' - #key - #start_len end_len proportion - # - #key length range from start_len to end_len - #start_len must be equal to or greater than 16 - #end_len must be equal to or less than 250 - #start_len must be equal to or greater than end_len - #memaslap will generate keys according to the key range - #proportion: indicates keys generated from one range accounts for the total - generated keys - # - #example1: key range 16~100 accounts for 80% - # key range 101~200 accounts for 10% - # key range 201~250 accounts for 10% - # total should be 1 (0.8+0.1+0.1 = 1) - # - # 16 100 0.8 - # 101 200 0.1 - # 201 249 0.1 - # - #example2: all keys length are 128 bytes - # - # 128 128 1 - key - 128 128 1 - #value - #start_len end_len proportion - # - #value length range from start_len to end_len - #start_len must be equal to or greater than 1 - #end_len must be equal to or less than 1M - #start_len must be equal to or greater than end_len - #memaslap will generate values according to the value range - #proportion: indicates values generated from one range accounts for the - total generated values - # - #example1: value range 1~1000 accounts for 80% - # value range 1001~10000 accounts for 10% - # value range 10001~100000 accounts for 10% - # total should be 1 (0.8+0.1+0.1 = 1) - # - # 1 1000 0.8 - # 1001 10000 0.1 - # 10001 100000 0.1 - # - #example2: all value length are 128 bytes - # - # 128 128 1 - value - 2048 2048 1 - #cmd - #cmd_type cmd_proportion - # - #currently memaslap only testss get and set command. - # - #cmd_type - #set 0 - #get 1 - # - #example: set command accounts for 50% - # get command accounts for 50% - # total should be 1 (0.5+0.5 = 1) - # - # cmd - # 0 0.5 - # 1 0.5 - cmd - 0 0.1 - 1.0 0.9 - -Format of output ----------------- - -At the beginning, memaslap displays some configuration information as follows: - -servers : 127.0.0.1:11211 - -threads count: 1 - -concurrency: 16 - -run time: 20s - -windows size: 10k - -set proportion: set_prop=0.10 - -get proportion: get_prop=0.90 - -Where -_____ - -servers : "servers" - - The servers used by memaslap. - -threads count - - The number of threads memaslap runs with. - -concurrency - - The number of concurrencies memaslap runs with. - -run time - - How long to run memaslap. - -windows size - - The task window size of each concurrency. - -set proportion - - The proportion of set command. - -get proportion - - The proportion of get command. - -The output of dynamic statistics is something like this: - -.. code-block:: perl - - --------------------------------------------------------------------------------------------------------------------------------- - Get Statistics - Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) - Avg(us) Std_dev Geo_dist - Period 5 345826 69165 65.3 0 27 2198 203 - 95.43 177.29 - Global 20 1257935 62896 71.8 0 26 3791 224 - 117.79 192.60 - Set Statistics - - Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) - Avg(us) Std_dev Geo_dist - Period 5 38425 7685 7.3 0 42 628 240 - 88.05 220.21 - Global 20 139780 6989 8.0 0 37 3790 253 - 117.93 224.83 - Total Statistics - - Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us) - Avg(us) Std_dev Geo_dist - Period 5 384252 76850 72.5 0 27 2198 207 - 94.72 181.18 - Global 20 1397720 69886 79.7 0 26 3791 227 - 117.93 195.60 - --------------------------------------------------------------------------------------------------------------------------------- - -Where -_____ - -Get Statistics - - Statistics information of get command - -Set Statistics - - Statistics information of set command - -Total Statistics - - Statistics information of both get and set command - -Period - - Result within a period - -Global - - Accumulated results - -Ops - - Total operations - -TPS - - Throughput, operations/second - -Net - - The rate of network - -Get_miss - - How many objects can't be gotten - -Min - - The minimum response time - -Max - - The maximum response time - -Avg: - - The average response time - -Std_dev - - Standard deviation of response time - -Geo_dist - - Geometric distribution based on natural exponential function - -At the end, memaslap will output something like this: - -.. code-block:: perl - - --------------------------------------------------------------------------------------------------------------------------------- - Get Statistics (1257956 events) - Min: 26 - Max: 3791 - Avg: 224 - Geo: 192.60 - Std: 116.23 - Log2 Dist: - 4: 0 10 84490 215345 - 8: 484890 459823 12543 824 - 12: 31 - - Set Statistics (139782 events) - Min: 37 - Max: 3790 - Avg: 253 - Geo: 224.84 - Std: 116.83 - Log2 Dist: - 4: 0 0 4200 16988 - 8: 50784 65574 2064 167 - 12: 5 - - Total Statistics (1397738 events) - Min: 26 - Max: 3791 - Avg: 227 - Geo: 195.60 - Std: 116.60 - Log2 Dist: - 4: 0 10 88690 232333 - 8: 535674 525397 14607 991 - 12: 36 - - cmd_get: 1257969 - cmd_set: 139785 - get_misses: 0 - verify_misses: 0 - verify_failed: 0 - expired_get: 0 - unexpired_unget: 0 - written_bytes: 242516030 - read_bytes: 1003702556 - object_bytes: 152086080 - packet_disorder: 0 - packet_drop: 0 - udp_timeout: 0 - - Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s - --------------------------------------------------------------------------------------------------------------------------------- - -Where -_____ - -Get Statistics - - Get statistics of response time - -Set Statistics - - Set statistics of response time - -Total Statistics - - Both get and set statistics of response time - -Min - - The accumulated and minimum response time - -Max - - The accumulated and maximum response time - -Avg - - The accumulated and average response time - -Std - - Standard deviation of response time - -Log2 Dist - - Geometric distribution based on logarithm 2 - -cmd_get - - Total get commands done - -cmd_set - - Total set commands done - -get_misses - - How many objects can't be gotten from server - -verify_misses - - How many objects need to verify but can't get them - -verify_failed - - How many objects with insistent value - -expired_get - - How many objects are expired but we get them - -unexpired_unget - - How many objects are unexpired but we can't get them - -written_bytes - - Total written bytes - -read_bytes - - Total read bytes - -object_bytes - - Total object bytes - -packet_disorder - - How many UDP packages are disorder - -packet_drop - - How many UDP packages are lost - -udp_timeout - - How many times UDP time out happen - -Run time - - Total run time - -Ops - - Total operations - -TPS - - Throughput, operations/second - -Net_rate - - The average rate of network - -OPTIONS -------- - --s, --servers= - List one or more servers to connect. Servers count must be less than - threads count. e.g.: --servers=localhost:1234,localhost:11211 - --T, --threads= - Number of threads to startup, better equal to CPU numbers. Default 8. - --c, --concurrency= - Number of concurrency to simulate with load. Default 128. - --n, --conn_sock= - Number of TCP socks per concurrency. Default 1. - --x, --execute_number= - Number of operations(get and set) to execute for the - given test. Default 1000000. - --t, --time= - How long the test to run, suffix: s-seconds, m-minutes, h-hours, - d-days e.g.: --time=2h. - --F, --cfg_cmd= - Load the configure file to get command,key and value distribution list. - --w, --win_size= - Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k. - Default 10k. - --X, --fixed_size= - Fixed length of value. - --v, --verify= - The proportion of date verification, e.g.: --verify=0.01 - --d, --division= - Number of keys to multi-get once. Default 1, means single get. - --S, --stat_freq= - Frequency of dumping statistic information. suffix: s-seconds, - m-minutes, e.g.: --resp_freq=10s. - --e, --exp_verify= - The proportion of objects with expire time, e.g.: --exp_verify=0.01. - Default no object with expire time - --o, --overwrite= - The proportion of objects need overwrite, e.g.: --overwrite=0.01. - Default never overwrite object. - --R, --reconnect - Reconnect tests, when connection is closed it will be reconnected. - --U, --udp - UDP tests, default memaslap uses TCP, TCP port and UDP port of - server must be same. - --a, --facebook - Whether it enables facebook test feature, set with TCP and multi-get with UDP. - --B, --binary - Whether it enables binary protocol. Default with ASCII protocol. - --P, --tps= - Expected throughput, suffix: K, e.g.: --tps=10k. - --p, --rep_write= - The first nth servers can write data, e.g.: --rep_write=2. - --b, --verbose - Whether it outputs detailed information when verification fails. - --h, --help - Display this message and then exit. - --V, --version - Display the version of the application and then exit. - -EXAMPLES --------- - -memaslap -s 127.0.0.1:11211 -S 5s - -memaslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b - -memaslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2 - -memaslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k - -memaslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40 - -memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m - -memaslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2 - -NOTES ------ - -.. include:: common/note_program_prefix.rst -.. include:: common/note_contrib_options.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` :manpage:`libmemcached(3)` diff --git a/docs/source/bin/memcapable.rst b/docs/source/bin/memcapable.rst deleted file mode 100644 index ed93bd1d6..000000000 --- a/docs/source/bin/memcapable.rst +++ /dev/null @@ -1,60 +0,0 @@ -memcapable -========== - -SYNOPSIS --------- - -.. program:: memcapable - -|client_prefix|\capable [options] - -Check a memcached server's capabilities and compatibility. - -DESCRIPTION ------------ - -:program:`memcapable` connects to the specified memcached server and tries to -determine its capabilities by running various commands and verifying the response. - -OPTIONS -------- - -.. option:: -h hostname - - Specify the hostname to connect to. The default is \ *localhost*\ . - -.. option:: -p port - - Specify the port number to connect to. The default is \ *11211*\ . - -.. option:: -c - - :manpage:`abort(3)` when detecting an error from the server. - -.. option:: -v - - Print out the comparison when it detects an error from the server. - -.. option:: -t n - - Set the timeout for an IO operation to/from the server to \ *n*\ seconds. - - -NOTES ------ - -.. include:: common/note_program_prefix.rst -.. include:: common/note_contrib_options.rst - - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - -.. only:: html - - * :doc:`/libmemcached` diff --git a/docs/source/bin/memcat.rst b/docs/source/bin/memcat.rst deleted file mode 100644 index 6bb5ebc80..000000000 --- a/docs/source/bin/memcat.rst +++ /dev/null @@ -1,50 +0,0 @@ -memcat -====== - -SYNOPSIS --------- - -.. program:: memcat - -|client_prefix|\cat [options] key [key...] - -Read and output the value of one key or the values of a set of keys. - -DESCRIPTION ------------ - -:program:`memcat` reads and outputs the value of a single or a set of keys -stored in a :manpage:`memcached(1)` server. - -If any key is not found an error is returned. - -It is similar to the standard UNIX :manpage:`cat(1)` utility. - -OPTIONS -------- - -.. include:: options/common_get.rst -.. include:: options/flags_noarg.rst -.. include:: options/hash.rst -.. include:: options/file_out.rst - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - :manpage:`libmemcached_configuration(3)` - -.. only:: html - - * :doc:`/libmemcached` - * :doc:`/libmemcached/configuration` diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst deleted file mode 100644 index 9106d694c..000000000 --- a/docs/source/bin/memcp.rst +++ /dev/null @@ -1,74 +0,0 @@ -memcp -===== - -SYNOPSIS --------- - -.. program:: memcp - -|client_prefix|\cp [options] \-\-servers - -Copy files to a collection of memcached servers. - -DESCRIPTION ------------ - -:program:`memcp` copies one or more files into :manpage:`memcached(1)` servers. -It is similar to the standard UNIX :manpage:`cp(1)` command. - -The key names will be the names of the files, without any directory path. - -OPTIONS -------- - -.. include:: options/common_set.rst -.. include:: /bin/options/flags_reqarg.rst -.. include:: options/udp.rst - -.. option:: -S|--set - - Issue *SET* command(s). This is the default mode. - See also :option:`-A|--add` and :option:`-R|--replace`. - -.. option:: -A|--add - - Issue *ADD* command(s). - -.. option:: -R|--replace - - Issue *REPLACE* command(s). - -.. option:: -.|--basename - - Use basename of path as key (default). - -.. option:: -+|--relative - - Use relative path (as passed), instead of basename only. - -.. option:: -/|--absolute - - Use absolute path (real path), instead of basename only. - - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - :manpage:`memcached_behavior(3)` - -.. only:: html - - * :doc:`/libmemcached` - * :doc:`/libmemcached/configuration` - * :doc:`/libmemcached/memcached_behavior` diff --git a/docs/source/bin/memdump.rst b/docs/source/bin/memdump.rst deleted file mode 100644 index 7724ad314..000000000 --- a/docs/source/bin/memdump.rst +++ /dev/null @@ -1,45 +0,0 @@ -memdump -======= - -SYNOPSIS --------- - -.. program:: memdump - -|client_prefix|\dump [options] - -Dump a list of keys from a server. - -DESCRIPTION ------------ - -:program:`memdump` dumps a list of "keys" from all servers that -it is told to fetch from. Because memcached does not guarantee to -provide all keys it is not possible to get a complete "dump". - -OPTIONS -------- - -.. include:: options/common_get.rst -.. include:: options/file_out.rst - - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - -.. only:: html - - * :doc:`/libmemcached` - * :doc:`/libmemcached/memcached_dump` diff --git a/docs/source/bin/memerror.rst b/docs/source/bin/memerror.rst deleted file mode 100644 index e00a5b75a..000000000 --- a/docs/source/bin/memerror.rst +++ /dev/null @@ -1,44 +0,0 @@ -memerror -======== - -SYNOPSIS --------- - -.. program:: memerror - -|client_prefix|\error [options] - -Translate a memcached error code into a string. - -DESCRIPTION ------------ - -:program:`memerror` translates an error code from `libmemcached` into a human -readable string. - -OPTIONS -------- - -.. include:: options/all.rst -.. include:: options/common.rst - - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - -.. only:: html - - * :doc:`/libmemcached` - * :doc:`/libmemcached/index_errors` diff --git a/docs/source/bin/memexist.rst b/docs/source/bin/memexist.rst deleted file mode 100644 index 85b7fd083..000000000 --- a/docs/source/bin/memexist.rst +++ /dev/null @@ -1,42 +0,0 @@ -memexist -======== - -SYNOPSIS --------- - -.. program:: memexist - -|client_prefix|\exist [options] - -Check for the existence of a key. - -DESCRIPTION ------------ - -:program:`memexist` checks for the existence of a key within a cluster. - -OPTIONS -------- - -.. include:: options/common_get.rst -.. include:: options/hash.rst - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - -.. only:: html - - * :doc:`/libmemcached` - * :doc:`/libmemcached/memcached_exist` diff --git a/docs/source/bin/memflush.rst b/docs/source/bin/memflush.rst deleted file mode 100644 index dc04ca630..000000000 --- a/docs/source/bin/memflush.rst +++ /dev/null @@ -1,73 +0,0 @@ -memflush -======== - -SYNOPSIS --------- - -|client_prefix|\flush [options] - -.. program:: memflush - -Reset a server or list of servers - -DESCRIPTION ------------ - -:program:`memflush` resets the contents of :manpage:`memcached(1)` servers. - -.. warning:: - - This means that all data in the specified servers will be deleted. - -OPTIONS -------- - -.. include:: options/common_get.rst -.. include:: options/expire.rst - -.. note:: - - Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist. - - Quoting the `memcached protocol documentation`_, it states: - - Its effect is to invalidate all - existing items immediately (by default) or after the expiration - specified. After invalidation none of the items will be returned in - response to a retrieval command (unless it's stored again under the - same key *after* flush_all has invalidated the items). - - The most precise - definition of what flush_all does is the following: it causes all - items whose update time is earlier than the time at which flush_all - was set to be executed to be ignored for retrieval purposes. - - The intent of flush_all with a delay, was that in a setting where you - have a pool of memcached servers, and you need to flush all content, - you have the option of not resetting all memcached servers at the - same time (which could e.g. cause a spike in database load with all - clients suddenly needing to recreate content that would otherwise - have been found in the memcached daemon). - -.. _memcached protocol documentation: https://github.com/memcached/memcached/blob/master/doc/protocol.txt - - -.. include:: common/env.rst - -NOTES ------ - -.. include:: common/note_program_prefix.rst - -SEE ALSO --------- - -.. only:: man - - :manpage:`memcached(1)` - :manpage:`libmemcached(3)` - -.. only:: html - -* :doc:`/libmemcached` -* :doc:`/libmemcached/memcached_flush` diff --git a/docs/source/bin/memparse.rst b/docs/source/bin/memparse.rst deleted file mode 100644 index 4c96aae13..000000000 --- a/docs/source/bin/memparse.rst +++ /dev/null @@ -1,42 +0,0 @@ -memparse -======== - -SYNOPSIS --------- - -.. program:: memparse - -|client_prefix|\parse