bump version to 0.1.3

See https://cloudlinux.zendesk.com/hc/en-us/articles/12225072530204-yum-update-error-Error-GPG-check-FAILED

.github/workflows/build-macos.yml

@@ -2,9 +2,9 @@ name: build on macOS
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
@@ -30,7 +30,7 @@ jobs:
       run: echo "HOMEBREW_PREFIX=$(brew --prefix)" >> $GITHUB_OUTPUT
 
     - name: patch to libssh
-      run: patch -d libssh -p1 < patch/libssh-0.10.4.patch
+      run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
 
     - name: Configure CMake
       # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.

.github/workflows/build-ubuntu.yml

@@ -2,9 +2,9 @@ name: build on ubuntu
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
@@ -23,10 +23,12 @@ jobs:
         submodules: true
 
     - name: install build dependency
-      run: sudo ./scripts/install-build-deps.sh
+      run: |
+        sudo apt-get update
+        sudo ./scripts/install-build-deps.sh
 
     - name: patch to libssh
-      run: patch -d libssh -p1 < patch/libssh-0.10.4.patch
+      run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
 
     - name: Configure CMake
       # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.

.github/workflows/codeql.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   schedule:
     - cron: '35 11 * * 5'
 
@@ -43,10 +43,12 @@ jobs:
         submodules: true
 
     - name: install build dependency
-      run: sudo ./scripts/install-build-deps.sh
+      run: |
+        sudo apt-get update
+        sudo ./scripts/install-build-deps.sh
 
     - name: patch to libssh
-      run: patch -d libssh -p1 < patch/libssh-0.10.4.patch
+      run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/release.yml

@@ -4,6 +4,7 @@ on:
   push:
     tags:
       - "v*.*.*"
+  workflow_dispatch:
 
 env:
     BUILD_TYPE: Release
@@ -17,17 +18,12 @@ jobs:
           submodules: true
 
       - name: patch to libssh
-        run: patch -d libssh -p1 < patch/libssh-0.10.4.patch
+        run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
 
       # TODO: just building docker does not require packages. fix CMakeLists
       - name: install build dependency
         run: sudo ./scripts/install-build-deps.sh
 
-      - name: Set variables
-        run: |
-          VER=$(cat VERSION)
-          echo "VERSION=$VER" >> $GITHUB_ENV
-
       - name: Configure Cmake
         run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
 
@@ -40,11 +36,43 @@ jobs:
       - name: Retrieve packages from containers
         run: make -C ${{github.workspace}}/build docker-pkg-all
 
+      - name: Copy mscp single binary built inside Alpine
+        run: cp ${{github.workspace}}/build/mscp_alpine-3.17-x86_64.static ${{github.workspace}}/build/mscp.linux.x86.static
+
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
           files: |
-            ${{github.workspace}}/build/mscp_${{env.VERSION}}-ubuntu-20.04-x86_64.deb
-            ${{github.workspace}}/build/mscp_${{env.VERSION}}-ubuntu-22.04-x86_64.deb
-            ${{github.workspace}}/build/mscp_${{env.VERSION}}-centos-8-x86_64.rpm
-            ${{github.workspace}}/build/mscp_${{env.VERSION}}-rocky-8.6-x86_64.rpm
+            ${{github.workspace}}/build/mscp_ubuntu-20.04-x86_64.deb
+            ${{github.workspace}}/build/mscp_ubuntu-22.04-x86_64.deb
+            ${{github.workspace}}/build/mscp_rocky-8.8-x86_64.rpm
+            ${{github.workspace}}/build/mscp_almalinux-8.8-x86_64.rpm
+            ${{github.workspace}}/build/mscp_alpine-3.17-x86_64.static
+            ${{github.workspace}}/build/mscp.linux.x86.static
+
+  source-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: patch to libssh
+        run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
+
+      - name: Set variables
+        run: |
+          VER=$(cat VERSION)
+          echo "VERSION=$VER" >> $GITHUB_ENV
+
+      - name: archive
+        run: |
+          cd ..
+          cp -r mscp mscp-${{env.VERSION}}
+          tar zcvf mscp-${{env.VERSION}}.tar.gz --exclude-vcs mscp-${{env.VERSION}}
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            ${{github.workspace}}/../mscp-${{env.VERSION}}.tar.gz

.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "dev" ]
 
 env:
   BUILD_TYPE: Release
@@ -18,11 +18,13 @@ jobs:
         submodules: true
 
     - name: patch to libssh
-      run: patch -d libssh -p1 < patch/libssh-0.10.4.patch
+      run: patch -d libssh -p1 < patch/libssh-0.10.6-2-g6f1b1e76.patch
 
     # TODO: just building docker does not require libssh. fix CMakeLists
     - name: install build dependency
-      run: sudo ./scripts/install-build-deps.sh
+      run: |
+        sudo apt-get update
+        sudo ./scripts/install-build-deps.sh
 
     - name: configure CMake
       run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

.gitignore

@@ -1,3 +1,11 @@
 build
+html
 compile_commands.json
+CMakeUserPresets.json
 .*.swp
+
+include/mscp_version.h
+
+dist
+*.egg-info
+__pycache__

CMakeLists.txt

@@ -6,51 +6,156 @@ project(mscp
 	VERSION ${MSCP_VERSION}
 	LANGUAGES C)
 
+
+find_package(Git)
+if (Git_FOUND)
+	# based on https://github.com/nocnokneo/cmake-git-versioning-example
+	execute_process(
+		COMMAND	${GIT_EXECUTABLE} describe --tags --dirty --match "v*"
+		OUTPUT_VARIABLE	GIT_DESCRIBE_VERSION
+		RESULT_VARIABLE	GIT_DESCRIBE_ERROR_CODE
+		OUTPUT_STRIP_TRAILING_WHITESPACE)
+	if(NOT GIT_DESCRIBE_ERROR_CODE)
+		set(MSCP_BUILD_VERSION ${GIT_DESCRIBE_VERSION})
+	endif()
+endif()
+
+if (NOT MSCP_BUILD_VERSION)
+	message(STATUS "Failed to determine version via Git. Use VERSION file instead.")
+	set(MSCP_BUILD_VERSION v${MSCP_VERSION})
+endif()
+
+
+include(GNUInstallDirs)
+
 set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -DDEBUG")
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules)
 
-
-# add libssh static library
-add_subdirectory(libssh EXCLUDE_FROM_ALL)
-
 if(APPLE)
 	list(APPEND CMAKE_PREFIX_PATH /usr/local) # intel mac homebrew prefix
 	list(APPEND CMAKE_PREFIX_PATH /opt/homebrew) # arm mac homebrew prefix
 endif() # APPLE
 
 
+option(BUILD_CONAN OFF) # Build mscp with conan
+if(BUILD_CONAN)
+	message(STATUS "Build mscp with conan")
+endif()
+
+option(BUILD_STATIC OFF) # Build mscp with -static LD flag
+if (BUILD_STATIC)
+	message(STATUS "Build mscp with -static LD option")
+	if (NOT BUILD_CONAN)
+		message(WARNING
+			"BUILD_STATIC strongly recommended with BUILD_CONAN option")
+	endif()
+endif()
+
+
+option(INSTALL_EXECUTABLE_ONLY OFF) # do not install libmscp
+
+
+# add libssh static library
+set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
+set(WITH_SERVER OFF)
+set(BUILD_SHARED_LIBS OFF)
+set(WITH_EXAMPLES OFF)
+set(BUILD_STATIC_LIB ON)
+if(BUILD_CONAN)
+	message(STATUS
+		"Disable libssh GSSAPI support because libkrb5 doesn't exist in conan")
+	set(WITH_GSSAPI OFF)
+endif()
+add_subdirectory(libssh EXCLUDE_FROM_ALL)
+
+
+
+# setup mscp compile options
+set(MSCP_COMPILE_OPTS -iquote ${CMAKE_CURRENT_BINARY_DIR}/libssh/include)
+set(MSCP_BUILD_INCLUDE_DIRS
+	${mscp_SOURCE_DIR}/src
+	${CMAKE_CURRENT_BINARY_DIR}/libssh/include)
+
+set(MSCP_LINK_LIBS ssh-static)
+if(BUILD_CONAN)
+	find_package(ZLIB REQUIRED)
+	find_package(OpenSSL REQUIRED)
+	list(APPEND MSCP_LINK_LIBS ZLIB::ZLIB)
+	list(APPEND MSCP_LINK_LIBS OpenSSL::Crypto)
+endif()
+
+
+# generate version header file
+configure_file(
+	${mscp_SOURCE_DIR}/include/mscp_version.h.in
+	${mscp_SOURCE_DIR}/include/mscp_version.h)
+
+
+# libmscp.so
+set(LIBMSCP_SRC
+	src/mscp.c src/ssh.c src/fileops.c src/path.c src/platform.c src/message.c)
+add_library(mscp-shared SHARED ${LIBMSCP_SRC})
+target_include_directories(mscp-shared
+	PUBLIC	$<BUILD_INTERFACE:${mscp_SOURCE_DIR}/include>
+		$<INSTALL_INTERFACE:include>
+	PRIVATE ${MSCP_BUILD_INCLUDE_DIRS})
+target_compile_options(mscp-shared PRIVATE ${MSCP_COMPILE_OPTS})
+target_link_libraries(mscp-shared PRIVATE ${MSCP_LINK_LIBS})
+set_target_properties(mscp-shared
+	PROPERTIES
+	OUTPUT_NAME	mscp
+	PUBLIC_HEADER	${mscp_SOURCE_DIR}/include/mscp.h)
+
+if(!INSTALL_EXECUTABLE_ONLY)
+	install(TARGETS mscp-shared)
+endif()
+
+
+# libmscp.a
+add_library(mscp-static STATIC ${LIBMSCP_SRC})
+target_include_directories(mscp-static
+	PRIVATE ${MSCP_BUILD_INCLUDE_DIRS} ${mscp_SOURCE_DIR}/include)
+target_compile_options(mscp-static PRIVATE ${MSCP_COMPILE_OPTS})
+target_link_libraries(mscp-static PRIVATE ${MSCP_LINK_LIBS})
+set_target_properties(mscp-static
+	PROPERTIES
+	OUTPUT_NAME	mscp)
+
+if(!INSTALL_EXECUTABLE_ONLY)
+	install(TARGETS mscp-static)
+endif()
+
+
 # mscp executable
-add_executable(mscp src/main.c src/platform.c src/ssh.c src/file.c src/pprint.c)
+list(APPEND MSCP_LINK_LIBS m pthread)
 
-set(MSCP_LINK_LIBS m pthread)
-set(MSCP_LINK_DIRS "")
-set(MSCP_COMPILE_OPTS "")
-set(MSCP_INCLUDE_DIRS ${mscp_SOURCE_DIR}/src)
-
-list(APPEND MSCP_COMPILE_OPTS -iquote ${CMAKE_CURRENT_BINARY_DIR}/libssh/include)
-list(APPEND MSCP_INCLUDE_DIRS ${CMAKE_CURRENT_BINARY_DIR}/libssh/include)
-list(APPEND MSCP_LINK_LIBS ssh-static)
-
-find_package(GSSAPI)
-list(APPEND MSCP_LINK_LIBS ${GSSAPI_LIBRARIES})
-
-find_package(OpenSSL)
-list(APPEND MSCP_LINK_LIBS ${OPENSSL_LIBRARIES})
-
-find_package(ZLIB)
-list(APPEND MSCP_LINK_LIBS ${ZLIB_LIBRARIES})
-
-target_compile_definitions(mscp PUBLIC ASYNC_WRITE=1)
-
-target_include_directories(mscp PRIVATE ${MSCP_INCLUDE_DIRS})
-target_link_directories(mscp PRIVATE ${MSCP_LINK_DIRS})
-target_link_libraries(mscp PRIVATE ${MSCP_LINK_LIBS})
+add_executable(mscp src/main.c)
+target_include_directories(mscp
+	PRIVATE ${MSCP_BUILD_INCLUDE_DIRS} ${mscp_SOURCE_DIR}/include)
+target_link_libraries(mscp mscp-static ${MSCP_LINK_LIBS})
+if (BUILD_STATIC)
+	target_link_options(mscp PRIVATE -static)
+endif()
 target_compile_options(mscp PRIVATE ${MSCP_COMPILE_OPTS})
-target_compile_definitions(mscp PUBLIC _VERSION="${PROJECT_VERSION}")
+
 
 install(TARGETS mscp RUNTIME DESTINATION bin)
 
 
+# mscp manpage and document
+configure_file(
+	${mscp_SOURCE_DIR}/doc/mscp.1.in
+	${PROJECT_BINARY_DIR}/mscp.1)
+
+add_custom_target(update-mscp-rst
+	COMMENT "Update doc/mscp.rst from mscp.1.in"
+	WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+	COMMAND
+	pandoc -s -f man mscp.1 -t rst -o ${PROJECT_SOURCE_DIR}/doc/mscp.rst)
+
+install(FILES ${PROJECT_BINARY_DIR}/mscp.1
+	DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
+
 
 # Test
 add_test(NAME	pytest
@@ -63,9 +168,8 @@ enable_testing()
 
 
 # CPACK Rules
-set(CPACK_SET_DESTDIR		true)
-set(CPACK_PROJECT_NAME		${PROJECT_NAME})
-set(CPACK_PROJECT_VERSION	${PROJECT_VERSION})
+#set(CPACK_SET_DESTDIR		true)
+set(CPACK_PACKAGE_NAME		${PROJECT_NAME})
 set(CPACK_PACKAGE_CONTACT	"Ryo Nakamura <upa@haeena.net>")
 set(CPACK_PACKAGE_DESCRIPTION
 	"mscp, copy files over multiple ssh connections")
@@ -85,7 +189,7 @@ if(UNIX AND NOT APPLE) # on linux
 		OUTPUT_VARIABLE DIST_DEP OUTPUT_STRIP_TRAILING_WHITESPACE)
 
 	set(PACKAGE_FILE_NAME
-		${PROJECT_NAME}_${PROJECT_VERSION}-${DIST_NAME}-${DIST_VER}-${ARCH})
+		${PROJECT_NAME}_${DIST_NAME}-${DIST_VER}-${ARCH})
 
 	set(CPACK_DEBIAN_FILE_NAME		${PACKAGE_FILE_NAME}.deb)
 	set(CPACK_DEBIAN_PACKAGE_DEPENDS	${DIST_DEP})
@@ -95,6 +199,7 @@ if(UNIX AND NOT APPLE) # on linux
 	set(CPACK_RPM_PACKAGE_REQUIRES		${DIST_DEP})
 	set(CPACK_RPM_PACKAGE_HOMEPAGE		"https://github.com/upa/mscp")
 	set(CPACK_RPM_PACKAGE_DESCRIPTION	${CPACK_PACKAGE_DESCRIPTION})
+	set(CPACK_RPM_PACKAGE_LICENSE		"GPLv3")
 endif() # on linux
 
 include(CPack)
@@ -104,9 +209,9 @@ include(CPack)
 # Custom targets to build and test mscp in docker containers.
 # foreach(IN ZIP_LISTS) (cmake >= 3.17) can shorten the following lists.
 # However, ubuntu 20.04 has cmake 3.16.3. So this is a roundabout trick.
-list(APPEND DIST_NAMES	ubuntu	ubuntu	centos	rocky)
-list(APPEND DIST_VERS	20.04	22.04	8	8.6)
-list(APPEND DIST_PKGS	deb	deb	rpm	rpm)
+list(APPEND DIST_NAMES	ubuntu	ubuntu	rocky	almalinux	alpine)
+list(APPEND DIST_VERS	20.04	22.04	8.8	8.8		3.17)
+list(APPEND DIST_PKGS	deb	deb	rpm	rpm		static)
 
 list(LENGTH DIST_NAMES _DIST_LISTLEN)
 math(EXPR DIST_LISTLEN "${_DIST_LISTLEN} - 1")
@@ -119,7 +224,7 @@ foreach(x RANGE ${DIST_LISTLEN})
 	set(DOCKER_IMAGE mscp-${DIST_NAME}:${DIST_VER})
 	set(DOCKER_INDEX ${DIST_NAME}-${DIST_VER})
 	set(PKG_FILE_NAME
-		mscp_${PROJECT_VERSION}-${DIST_NAME}-${DIST_VER}-${ARCH}.${DIST_PKG})
+		mscp_${DIST_NAME}-${DIST_VER}-${ARCH}.${DIST_PKG})
 
 	add_custom_target(docker-build-${DOCKER_INDEX}
 		COMMENT "Build mscp in ${DOCKER_IMAGE} container"
@@ -127,11 +232,18 @@ foreach(x RANGE ${DIST_LISTLEN})
 		COMMAND
 		docker build -t ${DOCKER_IMAGE} -f docker/${DOCKER_INDEX}.Dockerfile .)
 
+	add_custom_target(docker-build-${DOCKER_INDEX}-no-cache
+		COMMENT "Build mscp in ${DOCKER_IMAGE} container"
+		WORKING_DIRECTORY ${mscp_SOURCE_DIR}
+		COMMAND
+		docker build --no-cache -t ${DOCKER_IMAGE} -f docker/${DOCKER_INDEX}.Dockerfile .)
+
 	add_custom_target(docker-test-${DOCKER_INDEX}
 		COMMENT "Test mscp in ${DOCKER_IMAGE} container"
 		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 		COMMAND
-		docker run --init --rm ${DOCKER_IMAGE} /mscp/scripts/test-in-container.sh)
+		docker run --init --rm --sysctl net.ipv6.conf.all.disable_ipv6=0
+		${DOCKER_IMAGE} /mscp/scripts/test-in-container.sh)
 
 	add_custom_target(docker-pkg-${DOCKER_INDEX}
 		COMMENT "Retrieve mscp package from ${DOCKER_IMAGE} container"
@@ -140,11 +252,13 @@ foreach(x RANGE ${DIST_LISTLEN})
 		docker run --rm -v ${CMAKE_BINARY_DIR}:/out ${DOCKER_IMAGE}
 		cp /mscp/build/${PKG_FILE_NAME} /out/)
 
-	list(APPEND DOCKER_BUILDS	docker-build-${DOCKER_INDEX})
-	list(APPEND DOCKER_TESTS	docker-test-${DOCKER_INDEX})
-	list(APPEND DOCKER_PKGS		docker-pkg-${DOCKER_INDEX})
+	list(APPEND DOCKER_BUILDS		docker-build-${DOCKER_INDEX})
+	list(APPEND DOCKER_BUILDS_NO_CACHE	docker-build-${DOCKER_INDEX}-no-cache)
+	list(APPEND DOCKER_TESTS		docker-test-${DOCKER_INDEX})
+	list(APPEND DOCKER_PKGS			docker-pkg-${DOCKER_INDEX})
 endforeach()
 
-add_custom_target(docker-build-all	DEPENDS ${DOCKER_BUILDS})
-add_custom_target(docker-test-all	DEPENDS ${DOCKER_TESTS})
-add_custom_target(docker-pkg-all	DEPENDS ${DOCKER_PKGS})
+add_custom_target(docker-build-all		DEPENDS ${DOCKER_BUILDS})
+add_custom_target(docker-build-all-no-cache	DEPENDS ${DOCKER_BUILDS_NO_CACHE})
+add_custom_target(docker-test-all		DEPENDS ${DOCKER_TESTS})
+add_custom_target(docker-pkg-all		DEPENDS ${DOCKER_PKGS})

Doxyfile

@@ -0,0 +1,13 @@
+
+PROJECT_NAME	= libmscp
+
+GENERATE_HTML	= YES
+GENERATE_CHI	= NO
+GENERATE_LATEX	= NO
+GENERATE_RTF	= NO
+GENERATE_MAN	= NO
+
+SOURCE_BROWSER	= YES
+
+INPUT	= src include mscp
+

README.md

@@ -1,69 +1,95 @@
-# mscp
+# mscp: multi-threaded scp
 
 [![build on ubuntu](https://github.com/upa/mscp/actions/workflows/build-ubuntu.yml/badge.svg)](https://github.com/upa/mscp/actions/workflows/build-ubuntu.yml) [![build on macOS](https://github.com/upa/mscp/actions/workflows/build-macos.yml/badge.svg)](https://github.com/upa/mscp/actions/workflows/build-macos.yml) [![test](https://github.com/upa/mscp/actions/workflows/test.yml/badge.svg)](https://github.com/upa/mscp/actions/workflows/test.yml)
 
 
-`mscp`, a variant of `scp`, copies files over multiple ssh (SFTP)
-connections. Multiple threads and connections in mscp transfer (1)
-multiple files simultaneously and (2) a large file in parallel. It
-would shorten the waiting time for transferring a lot of/large files
-over networks.
+`mscp`, a variant of `scp`, copies files over multiple SSH (SFTP)
+connections by multiple threads. It enables transferring (1) multiple
+files simultaneously and (2) a large file in parallel, reducing the
+transfer time for a lot of/large files over networks.
 
-You can use `mscp` like `scp`, for example, `mscp
-user@example.com:srcfile /tmp/dstfile`. Remote hosts only need to run
-standard `sshd` supporting the SFTP subsystem, and you need to be able
-to ssh to the hosts (as usual). `mscp` does not require anything else.
+You can use `mscp` like `scp`, for example:
+
+```shell-session
+$ mscp user@example.com:srcfile /tmp/dstfile
+```
+
+Remote hosts only need to run standard `sshd` supporting the SFTP
+subsystem (e.g. openssh-server), and you need to be able to ssh to the
+hosts as usual. `mscp` does not require anything else.
 
 
-Differences from `scp`:
+https://github.com/upa/mscp/assets/184632/19230f57-be7f-4ef0-98dd-cb4c460f570d
 
-- remote glob on remote shell expansion is not supported.
-- remote to remote copy is not supported.
-- `-r` option is not needed.
-- and any other differences I have not implemented and noticed...
+--------------------------------------------------------------------
 
+Differences from `scp` on usage:
+
+- Remote-to-remote copy is not supported.
+- `-r` option is not needed to transfer directories.
+- and any other differences I have not implemented and noticed.
+
+Paper:
+- Ryo Nakamura and Yohei Kuga. 2023. Multi-threaded scp: Easy and Fast File Transfer over SSH. In Practice and Experience in Advanced Research Computing (PEARC '23). Association for Computing Machinery, New York, NY, USA, 320–323. https://doi.org/10.1145/3569951.3597582
 
 ## Install
 
-- homebrew
+- macOS
 
 ```console
 brew install upa/tap/mscp
 ```
 
-- Linux
+- Ubuntu
+```console
+sudo add-apt-repository ppa:upaa/mscp
+sudo apt-get install mscp
+```
 
-Download a package for your environment from [Releases
-page](https://github.com/upa/mscp/releases).
+- Rocky 8.8
+```console
+yum install https://github.com/upa/mscp/releases/latest/download/mscp_rocky-8.8-x86_64.rpm
+```
+
+- Alma 8.8
+```console
+yum install https://github.com/upa/mscp/releases/latest/download/mscp_almalinux-8.8-x86_64.rpm
+```
+
+- Linux with single binary `mscp` (x86_64 only, and not optimal performance)
+```console
+wget https://github.com/upa/mscp/releases/latest/download/mscp.linux.x86.static -O /usr/local/bin/mscp
+chmod 755 /usr/local/bin/mscp
+```
 
 
 ## Build
 
-mscp depends on a patched [libssh](https://www.libssh.org/).  The
+mscp depends on a patched [libssh](https://www.libssh.org/). The
 patch introduces asynchronous SFTP Write, which is derived from
 https://github.com/limes-datentechnik-gmbh/libssh (see [Re: SFTP Write
 async](https://archive.libssh.org/libssh/2020-06/0000004.html)).
 
-Currently macOS and Linux (Ubuntu, CentOS, Rocky) are supported.
+Currently macOS and Linux (Ubuntu, Rocky and Alma) are supported.
 
 ```console
-# 1. clone this repository
+# clone this repository
 git clone https://github.com/upa/mscp.git
 cd mscp
 
-# 2. prepare patched libssh
+# prepare patched libssh
 git submodule update --init
-patch -d libssh -p1 < patch/libssh-0.10.4.patch
+patch -d libssh -p1 < patch/$(git --git-dir=./libssh/.git describe).patch
 
-# 3. install build dependency
+# install build dependency
 bash ./scripts/install-build-deps.sh
 
-# 4. configure mscp
-mkdir build && mv build
+# configure mscp
+mkdir build && cd build
 cmake ..
 
-## in macOS, you may need OPENSSL_ROOT_DIR for cmake:
-cmake .. -DOPENSSL_ROOT_DIR=$(brew --prefix)/opt/openssl@1.1
+# in macOS, you may need OPENSSL_ROOT_DIR for cmake:
+# cmake .. -DOPENSSL_ROOT_DIR=$(brew --prefix)/opt/openssl@1.1
 
 # build
 make
@@ -72,98 +98,11 @@ make
 make install
 ```
 
-## Run
-
-- Usage
-
-```console
-$ mscp
-mscp v0.0.2: copy files over multiple ssh connections
-
-Usage: mscp [vqDCHdh] [-n nr_conns] [-m coremask]
-            [-s min_chunk_sz] [-S max_chunk_sz] [-a nr_ahead]
-            [-l login_name] [-p port] [-i identity_file]
-            [-c cipher_spec] source ... target
-```
-
-- Example: copy an 8GB file on tmpfs over a 100Gbps link
-  - Two Intel Xeon Gold 6130 machines directly connected with Intel E810 100Gbps NICs.
-
-```console
-$ mscp /tmp/test.img 10.0.0.1:/tmp/
-[=====================================================] 100% 8GB/8GB 3.02GB/s 
-```
-
-- `-v` option increments verbose output level.
-
-```console
-$ mscp test 10.0.0.1:
-[=====================================================] 100% 13B/13B 2.41KB/s 
-
-$ mscp -v test 10.0.0.1:
-file test/test.txt (local) -> ./test/test.txt (remote) 9B
-file test/test2/2.txt (local) -> ./test/test2/2.txt (remote) 2B
-file test/1.txt (local) -> ./test/1.txt (remote) 2B
-copy start: test/test.txt
-copy start: test/1.txt
-copy start: test/test2/2.txt
-copy done: test/1.txt
-copy done: test/test2/2.txt
-copy done: test/test.txt
-[=====================================================] 100% 13B/13B 2.51KB/s 
-
-$ mscp -vv -n 4 test 10.0.0.1:
-connecting to 10.0.0.1 for checking destinations...
-file test/test.txt (local) -> ./test/test.txt (remote) 9B
-file test/test2/2.txt (local) -> ./test/test2/2.txt (remote) 2B
-file test/1.txt (local) -> ./test/1.txt (remote) 2B
-connecting to 10.0.0.1 for a copy thread...
-connecting to 10.0.0.1 for a copy thread...
-connecting to 10.0.0.1 for a copy thread...
-connecting to 10.0.0.1 for a copy thread...
-copy start: test/test.txt
-copy start: test/1.txt
-copy start: test/test2/2.txt
-copy done: test/test.txt
-copy done: test/test2/2.txt
-copy done: test/1.txt
-[=====================================================] 100% 13B/13B 3.27KB/s
-```
-
-- Full usage
-
-```console
-$ mscp -h
-mscp v0.0.2: copy files over multiple ssh connections
-
-Usage: mscp [vqDCHdh] [-n nr_conns] [-m coremask]
-            [-s min_chunk_sz] [-S max_chunk_sz] [-a nr_ahead]
-            [-l login_name] [-p port] [-i identity_file]
-            [-c cipher_spec] source ... target
-
-    -n NR_CONNECTIONS  number of connections (default: half of # of cpu cores)
-    -m COREMASK        hex value to specify cores where threads pinned
-    -s MIN_CHUNK_SIZE  min chunk size (default: 64MB)
-    -S MAX_CHUNK_SIZE  max chunk size (default: filesize / nr_conn)
-
-    -a NR_AHEAD        number of inflight SFTP commands (default: 16)
-
-    -v                 increment verbose output level
-    -q                 disable output
-    -D                 dry run
-
-    -l LOGIN_NAME      login name
-    -p PORT            port number
-    -i IDENTITY        identity file for public key authentication
-    -c CIPHER          cipher spec, see `ssh -Q cipher`
-    -C                 enable compression on libssh
-    -H                 disable hostkey check
-    -d                 increment ssh debug output level
-    -h                 print this help
-```
+Source tar balls (`mscp-X.X.X.tar.gz`, not `Source code`) in
+[Releases page](https://github.com/upa/mscp/releases) contains the patched version
+of libssh. So you can start from cmake with it.
 
 
+## Documentation
 
-
-Note: mscp is still under development, and the author is not
-responsible for any accidents due to mscp.
+[manpage](/doc/mscp.rst) is available.

VERSION

@@ -1 +1 @@
-0.0.2
+0.1.3

conanfile.txt

@@ -0,0 +1,7 @@
+[requires]
+zlib/1.2.11
+openssl/1.1.1t
+
+[generators]
+CMakeDeps
+CMakeToolchain

debian/.gitignore

@@ -0,0 +1,11 @@
+
+/.debhelper/
+/*/
+!/tests/
+!/source
+
+/*.log
+/*.substvars
+/*.debhelper
+/files
+/mscp

debian/changelog

@@ -0,0 +1,18 @@
+mscp (0.1.3) UNRELEASED; urgency=medium
+
+  * add -I option for inserting intervals between SSH attempts (issue #7)
+  * add -P option, equivalent to -p (just for compatibility)
+  * update libssh to 0.10.6-2-g6f1b1e76 for security fixes
+  * cleanup warning messages when scanning source files fails
+  * fix wrong destination paths for source paths under '/' (issue #8)
+  * reduce memory footprint for coping many (e.g., over 100k) files (issue #8)
+  * add SPDX-License-Identifer to the source files
+  * add manpage
+
+ -- Ryo Nakamura <upa@haeena.net>  Fri, 12 Jan 2024 22:20:24 +0900
+
+mscp (0.1.2) unstable; urgency=medium
+
+  * Initial release for debian packaging
+
+ -- Ryo Nakamura <upa@haeena.net>  Sun, 10 Dec 2023 21:51:49 +0900

debian/compat

@@ -0,0 +1 @@
+10

debian/control

@@ -0,0 +1,17 @@
+Source: mscp
+Section: net
+Priority: optional
+Maintainer: Ryo Nakamura <upa@haeena.net>
+Build-Depends: debhelper (>= 10~), cmake, zlib1g-dev, libssl-dev, libkrb5-dev
+Homepage: https://github.com/upa/mscp
+Standards-Version: 4.5.0.3
+
+
+Package: mscp
+Architecture: linux-any
+Depends: ${misc:Depends}, ${shlibs:Depends}
+Description: mscp, fast file transfer over multiple SSH connections
+ mscp transfers files over multiple SSH connections. Multiple threads
+ and connections in mscp transfer (1) multiple files simultaneously
+ and (2) a large file in parallel. It would shorten the waiting time
+ for transferring a lot of/large files over networks.

debian/copyright

@@ -0,0 +1,12 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: https://github.com/upa/mscp
+Upstream-Name: mscp
+Upstream-Contact: Ryo Nakamura <upa@haeena.net>
+
+Files: *
+Copyright: Ryo Nakamura
+License: GPL-3
+
+Files: src/list.h
+Copyright: kazutomo@mcs.anl.gov
+License: GPL

debian/rules

@@ -0,0 +1,13 @@
+#!/usr/bin/make -f
+
+%:
+	dh $@
+
+
+override_dh_auto_configure:
+	dh_auto_configure -- \
+		-DINSTALL_EXECUTABLE_ONLY=ON
+
+override_dh_auto_test:
+
+

debian/source/format

@@ -0,0 +1 @@
+3.0 (native)

doc/README.md

@@ -0,0 +1,11 @@
+
+# Document
+
+The base file of documents is `mscp.1.in`. The manpage of mscp and
+`doc/mscp.rst` are generated from `mscp.1.in`.
+
+When `mscp.1.in` is changed, update `doc/mscp.rst` by:
+
+1. `cd build`
+2. `cmake ..`
+3. `make update-mscp-rst`

doc/mscp.1.in

@@ -0,0 +1,316 @@
+.TH MSCP 1 "@MSCP_BUILD_VERSION@" "mscp" "User Commands"
+
+.SH NAME
+mscp \- copy files over multiple SSH connections
+
+.SH SYNOPSIS
+
+.B mscp
+.RB [ \-vqDHdNh ]
+[\c
+.BI \-n \ NR_CONNECTIONS\c
+]
+[\c
+.BI \-m \ COREMASK\c
+]
+[\c
+.BI \-u \ MAX_STARTUPS\c
+]
+[\c
+.BI \-I \ INTERVAL\c
+]
+[\c
+.BI \-s \ MIN_CHUNK_SIZE\c
+]
+[\c
+.BI \-S \ MAX_CHUNK_SIZE\c
+]
+[\c
+.BI \-a \ NR_AHEAD\c
+]
+[\c
+.BI \-b \ BUF_SIZE\c
+]
+[\c
+.BI \-l \ LOGIN_NAME\c
+]
+[\c
+.BR \-p |\c
+.BI \-P \ PORT\c
+]
+[\c
+.BI \-F \ CONFIG\c
+]
+[\c
+.BI \-i \ IDENTITY\c
+]
+[\c
+.BI \-c \ CIPHER\c
+]
+[\c
+.BI \-M \ HMAC\c
+]
+[\c
+.BI \-C \ COMPRESS\c
+]
+.I source ... target
+
+.SH DESCRIPTION
+
+.PP
+.B mscp
+copies files over multiple SSH (SFTP) connections by multiple
+threads. It enables transferring (1) multiple files simultaneously and
+(2) a large file in parallel, reducing the transfer time for a lot
+of/large files over networks.
+
+.PP
+The usage of
+.B mscp
+imitates the
+.B scp
+command of
+.I OpenSSH,
+for example:
+
+.nf
+    $ mscp srcfile user@example.com:dstfile
+.fi
+
+Remote hosts only need to run standard
+.B sshd
+supporting the SFTP subsystem, and users need to be able to
+.B ssh
+to the hosts as usual.
+.B mscp
+does not require anything else.
+
+.PP
+.B mscp
+uses
+.UR https://\:www\:.libssh\:.org
+libssh
+.UE
+as its SSH implementation. Thus, supported SSH features, for example,
+authentication, encryption, and various options in ssh_config, follow
+what
+.I libssh
+supports.
+
+.SH OPTIONS
+.TP
+.B \-n \fINR_CONNECTIONS\fR
+Specifies the number of SSH connections. The default value is
+calculated from the number of CPU cores on the host with the following
+formula: floor(log(nr_cores)*2)+1.
+
+.TP
+.B \-m \fICOREMASK\fR
+Configures CPU cores to be used by the hexadecimal bitmask.  All CPU
+cores are used by default.
+
+.TP
+.B \-u \fIMAX_STARTUPS\fR
+Specifies the number of concurrent outgoing SSH connections.
+.B sshd
+limits the number of simultaneous SSH connection attempts by
+.I MaxStartups
+in
+.I sshd_config.
+The default
+.I MaxStartups
+is 10; thus, we set the default MAX_STARTUPS 8.
+
+.TP
+.B \-I \fIINTERVAL\fR
+Specifies the interval (in seconds) between SSH connection
+attempts. Some firewall products treat SSH connection attempts from a
+single source IP address for a short period as a brute force attack.
+This option inserts intervals between the attempts to avoid being
+determined as an attack. The default value is 0.
+
+.TP
+.B \-s \fIMIN_CHUNK_SIZE\fR
+Specifies the minimum chunk size.
+.B mscp
+divides a file into chunks and copies the chunks in parallel.
+
+.TP
+.B \-S \fIMAX_CHUNK_SIZE\fR
+Specifies the maximum chunk size. The default is file size divided by
+the number of connections.
+
+.TP
+.B \-a \fINR_AHEAD\fR
+Specifies the number of inflight SFTP commands. The default value is
+32.
+
+.TP
+.B \-b \fIBUF_SIZE\fR
+Specifies the buffer size for I/O and transfer over SFTP. The default
+value is 16384. Note that the SSH specification restricts buffer size
+delivered over SSH. Changing this value is not recommended at present.
+
+.TP
+.B \-v
+Increments the verbose output level.
+
+.TP
+.B \-q
+Quiet mode: turns off all outputs.
+
+.TP
+.B \-D
+Dry-run mode: it scans source files to be copied, calculates chunks,
+and resolves destination file paths. Dry-run mode with
+.B -vv
+option enables confirming files to be copied and their destination
+paths.
+
+.TP
+.B \-r
+No effect.
+.B mscp
+copies recursively if a source path is a directory. This option exists
+for just compatibility.
+
+.TP
+.B \-l \fILOGIN_NAME\fR
+Specifies the username to log in on the remote machine as with
+.I ssh(1).
+
+.TP
+.B \-p,\-P \fIPORT\fR
+Specifies the port number to connect to on the remote machine as with
+ssh(1) and scp(1).
+
+.TP
+.B \-F \fICONFIG\fR
+Specifies an alternative per-user ssh configuration file. Note that
+acceptable options in the configuration file are what
+.I libssh
+supports.
+
+.TP
+.B \-i \fIIDENTITY\fR
+Specifies the identity file for public key authentication.
+
+.TP
+.B \-c \fICIPHER\fR
+Selects the cipher to use for encrypting the data transfer. See
+.UR https://\:www\:.libssh\:.org/\:features/
+libssh features
+.UE .
+
+.TP
+.B \-M \fIHMAC\fR
+Specifies MAC hash algorithms. See
+.UR https://\:www\:.libssh\:.org/\:features/
+libssh features
+.UE .
+
+.TP
+.B \-C \fICOMPRESS\fR
+Enables compression: yes, no, zlib, zlib@openssh.com. The default is
+none. See
+.UR https://\:www\:.libssh\:.org/\:features/
+libssh features
+.UE .
+
+.TP
+.B \-H
+Disables hostkey checking.
+
+.TP
+.B \-d
+Increments the ssh debug output level.
+
+.TP
+.B \-N
+Enables Nagle's algorithm. It is disabled by default.
+
+.TP
+.B \-h
+Prints help.
+
+.SH EXIT STATUS
+Exit status is 0 on success,  and >0 if an error occurs.
+
+.SH NOTES
+
+.PP
+.B mscp
+uses glob(3) for globbing pathnames, including matching patterns for
+local and remote paths. However, globbing on the
+.I remote
+side does not work with musl libc (used in Alpine Linux and the
+single-binary version of mscp) because musl libc does not support
+GLOB_ALTDIRFUNC.
+
+.PP
+.B mscp
+does not support remote-to-remote copy, which
+.B scp
+supports.
+
+.SH EXAMPLES
+
+.PP
+Copy a local file to a remote host with different name:
+
+.nf
+    $ mscp ~/src-file 10.0.0.1:copied-file
+.fi
+
+.PP
+Copy a local file and a directory to /tmp at a remote host:
+
+.nf
+    $ mscp ~/src-file dir1 10.0.0.1:/tmp
+.fi
+
+.PP
+In a long fat network, following options might improve performance:
+
+.nf
+    $ mscp -n 64 -m 0xffff -a 64 -c aes128-gcm@openssh.com src 10.0.0.1:
+.fi
+
+.B -n
+increases the number of SSH connections than default,
+.B -m
+pins threads to specific CPU cores,
+.B -a
+increases asynchronous inflight SFTP WRITE/READ commands, and
+.B -c aes128-gcm@openssh.com
+will be faster than the default chacha20-poly1305 cipher, particularly
+on hosts that support AES-NI.
+
+
+
+.SH "SEE ALSO"
+.BR scp (1),
+.BR ssh (1),
+.BR sshd (8).
+
+.SH "PAPER REFERENCE"
+
+
+Ryo Nakamura and Yohei Kuga. 2023. Multi-threaded scp: Easy and Fast
+File Transfer over SSH. In Practice and Experience in Advanced
+Research Computing (PEARC '23). Association for Computing Machinery,
+New York, NY, USA, 320–323.
+.UR https://\:doi\:.org/\:10.1145/\:3569951.3597582
+DOI
+.UE .
+
+
+.SH CONTACT INFROMATION
+.PP
+For pathces, bug reports, or feature requests, please open an issue on
+.UR https://\:github\:.com/\:upa/\:mscp
+GitHub
+.UE .
+
+.SH AUTHORS
+Ryo Nakamura <upa@haeena.net>

doc/mscp.rst

@@ -0,0 +1,210 @@
+====
+MSCP
+====
+
+:Date:   v0.1.2-14-g24617d2
+
+NAME
+====
+
+mscp - copy files over multiple SSH connections
+
+SYNOPSIS
+========
+
+**mscp** [**-vqDHdNh**] [ **-n**\ *NR_CONNECTIONS* ] [
+**-m**\ *COREMASK* ] [ **-u**\ *MAX_STARTUPS* ] [ **-I**\ *INTERVAL* ] [
+**-s**\ *MIN_CHUNK_SIZE* ] [ **-S**\ *MAX_CHUNK_SIZE* ] [
+**-a**\ *NR_AHEAD* ] [ **-b**\ *BUF_SIZE* ] [ **-l**\ *LOGIN_NAME* ] [
+**-p**\ \| **-P**\ *PORT* ] [ **-F**\ *CONFIG* ] [ **-i**\ *IDENTITY* ]
+[ **-c**\ *CIPHER* ] [ **-M**\ *HMAC* ] [ **-C**\ *COMPRESS* ] *source
+... target*
+
+DESCRIPTION
+===========
+
+**mscp** copies files over multiple SSH (SFTP) connections by multiple
+threads. It enables transferring (1) multiple files simultaneously and
+(2) a large file in parallel, reducing the transfer time for a lot
+of/large files over networks.
+
+The usage of **mscp** imitates the **scp** command of *OpenSSH,* for
+example:
+
+::
+
+       $ mscp srcfile user@example.com:dstfile
+
+Remote hosts only need to run standard **sshd** supporting the SFTP
+subsystem, and users need to be able to **ssh** to the hosts as usual.
+**mscp** does not require anything else.
+
+**mscp** uses `libssh <https://www.libssh.org>`__ as its SSH
+implementation. Thus, supported SSH features, for example,
+authentication, encryption, and various options in ssh_config, follow
+what *libssh* supports.
+
+OPTIONS
+=======
+
+**-n NR_CONNECTIONS**
+   Specifies the number of SSH connections. The default value is
+   calculated from the number of CPU cores on the host with the
+   following formula: floor(log(nr_cores)*2)+1.
+
+**-m COREMASK**
+   Configures CPU cores to be used by the hexadecimal bitmask. All CPU
+   cores are used by default.
+
+**-u MAX_STARTUPS**
+   Specifies the number of concurrent outgoing SSH connections. **sshd**
+   limits the number of simultaneous SSH connection attempts by
+   *MaxStartups* in *sshd_config.* The default *MaxStartups* is 10;
+   thus, we set the default MAX_STARTUPS 8.
+
+**-I INTERVAL**
+   Specifies the interval (in seconds) between SSH connection attempts.
+   Some firewall products treat SSH connection attempts from a single
+   source IP address for a short period as a brute force attack. This
+   option inserts intervals between the attempts to avoid being
+   determined as an attack. The default value is 0.
+
+**-s MIN_CHUNK_SIZE**
+   Specifies the minimum chunk size. **mscp** divides a file into chunks
+   and copies the chunks in parallel.
+
+**-S MAX_CHUNK_SIZE**
+   Specifies the maximum chunk size. The default is file size divided by
+   the number of connections.
+
+**-a NR_AHEAD**
+   Specifies the number of inflight SFTP commands. The default value is
+   32.
+
+**-b BUF_SIZE**
+   Specifies the buffer size for I/O and transfer over SFTP. The default
+   value is 16384. Note that the SSH specification restricts buffer size
+   delivered over SSH. Changing this value is not recommended at
+   present.
+
+**-v**
+   Increments the verbose output level.
+
+**-q**
+   Quiet mode: turns off all outputs.
+
+**-D**
+   Dry-run mode: it scans source files to be copied, calculates chunks,
+   and resolves destination file paths. Dry-run mode with **-vv** option
+   enables confirming files to be copied and their destination paths.
+
+**-r**
+   No effect. **mscp** copies recursively if a source path is a
+   directory. This option exists for just compatibility.
+
+**-l LOGIN_NAME**
+   Specifies the username to log in on the remote machine as with
+   *ssh(1).*
+
+**-p,-P PORT**
+   Specifies the port number to connect to on the remote machine as with
+   ssh(1) and scp(1).
+
+**-F CONFIG**
+   Specifies an alternative per-user ssh configuration file. Note that
+   acceptable options in the configuration file are what *libssh*
+   supports.
+
+**-i IDENTITY**
+   Specifies the identity file for public key authentication.
+
+**-c CIPHER**
+   Selects the cipher to use for encrypting the data transfer. See
+   `libssh features <https://www.libssh.org/features/>`__.
+
+**-M HMAC**
+   Specifies MAC hash algorithms. See `libssh
+   features <https://www.libssh.org/features/>`__.
+
+**-C COMPRESS**
+   Enables compression: yes, no, zlib, zlib@openssh.com. The default is
+   none. See `libssh features <https://www.libssh.org/features/>`__.
+
+**-H**
+   Disables hostkey checking.
+
+**-d**
+   Increments the ssh debug output level.
+
+**-N**
+   Enables Nagle's algorithm. It is disabled by default.
+
+**-h**
+   Prints help.
+
+EXIT STATUS
+===========
+
+Exit status is 0 on success, and >0 if an error occurs.
+
+NOTES
+=====
+
+**mscp** uses glob(3) for globbing pathnames, including matching
+patterns for local and remote paths. However, globbing on the *remote*
+side does not work with musl libc (used in Alpine Linux and the
+single-binary version of mscp) because musl libc does not support
+GLOB_ALTDIRFUNC.
+
+**mscp** does not support remote-to-remote copy, which **scp** supports.
+
+EXAMPLES
+========
+
+Copy a local file to a remote host with different name:
+
+::
+
+       $ mscp ~/src-file 10.0.0.1:copied-file
+
+Copy a local file and a directory to /tmp at a remote host:
+
+::
+
+       $ mscp ~/src-file dir1 10.0.0.1:/tmp
+
+In a long fat network, following options might improve performance:
+
+::
+
+       $ mscp -n 64 -m 0xffff -a 64 -c aes128-gcm@openssh.com src 10.0.0.1:
+
+**-n** increases the number of SSH connections than default, **-m** pins
+threads to specific CPU cores, **-a** increases asynchronous inflight
+SFTP WRITE/READ commands, and **-c aes128-gcm@openssh.com** will be
+faster than the default chacha20-poly1305 cipher, particularly on hosts
+that support AES-NI.
+
+SEE ALSO
+========
+
+**scp**\ (1), **ssh**\ (1), **sshd**\ (8).
+
+PAPER REFERENCE
+===============
+
+Ryo Nakamura and Yohei Kuga. 2023. Multi-threaded scp: Easy and Fast
+File Transfer over SSH. In Practice and Experience in Advanced Research
+Computing (PEARC '23). Association for Computing Machinery, New York,
+NY, USA, 320–323. `DOI <https://doi.org/10.1145/3569951.3597582>`__.
+
+CONTACT INFROMATION
+===================
+
+For pathces, bug reports, or feature requests, please open an issue on
+`GitHub <https://github.com/upa/mscp>`__.
+
+AUTHORS
+=======
+
+Ryo Nakamura <upa@haeena.net>

docker/README.md

@@ -8,9 +8,7 @@ docker build -t mscp-ubuntu:20.04 -f docker/ubuntu-20.04.Dockerfile .
 
 docker build -t mscp-ubuntu:22.04 -f docker/ubuntu-22.04.Dockerfile .
 
-docker build -t mscp-centos:8 -f docker/centos-8.Dockerfile .
-
-docker build -t mscp-rocky:8.6 -f docker/rocky-8.6.Dockerfile .
+docker build -t mscp-rocky:8.8 -f docker/rocky-8.Dockerfile .
 ```
 
 Test `mscp` in the containers.
@@ -20,25 +18,20 @@ docker run --init --rm mscp-ubuntu:20.04 /mscp/scripts/test-in-container.sh
 
 docker run --init --rm mscp-ubuntu:22.04 /mscp/scripts/test-in-container.sh
 
-docker run --init --rm mscp-centos:8 /mscp/scripts/test-in-container.sh
-
-docker run --init --rm mscp-rocky:8.6 /mscp/scripts/test-in-container.sh
+docker run --init --rm mscp-rocky:8.9 /mscp/scripts/test-in-container.sh
 ```
 
 Retrieve deb/rpm packages.
 
 ```console
 docker run --rm -v (pwd):/out mscp-ubuntu:20.04 \
-       cp /mscp/build/mscp_0.0.0-ubuntu-20.04-x86_64.deb /out/
+       cp /mscp/build/mscp_ubuntu-20.04-x86_64.deb /out/
 
 docker run --rm -v (pwd):/out mscp-ubuntu:22.04 \
-       cp /mscp/build/mscp_0.0.0-ubuntu-22.04-x86_64.deb /out/
+       cp /mscp/build/mscp_ubuntu-22.04-x86_64.deb /out/
 
-docker run --rm -v (pwd):/out mscp-centos:8 \
-       cp /mscp/build/mscp_0.0.0-centos-8-x86_64.rpm /out/
-
-docker run --rm -v (pwd):/out mscp-rocky:8.6 \
-       cp /mscp/build/mscp_0.0.0-rocky-8.6-x86_64.rpm /out/
+docker run --rm -v (pwd):/out mscp-rocky:8.8 \
+       cp /mscp/build/mscp_rocky-8.8-x86_64.rpm /out/
 ```
 
 I don't know whether these are good way.

docker/almalinux-8.8.Dockerfile

@@ -0,0 +1,39 @@
+FROM almalinux:8.8
+
+# install pytest, sshd for test, and rpm-build
+RUN set -ex && \
+	rpm --import https://repo.almalinux.org/almalinux/RPM-GPG-KEY-AlmaLinux && \
+	yum -y install \
+	python3 python3-pip python3-devel openssh openssh-server openssh-clients rpm-build
+
+RUN python3 -m pip install pytest
+
+
+# preparation for sshd
+RUN  mkdir /var/run/sshd        \
+	&& ssh-keygen -A	\
+        && ssh-keygen -f /root/.ssh/id_rsa -N ""                \
+        && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
+
+
+ARG mscpdir="/mscp"
+
+COPY . ${mscpdir}
+
+# install build dependency
+RUN ${mscpdir}/scripts/install-build-deps.sh
+
+# build
+RUN cd ${mscpdir}			\
+        && rm -rf build			\
+        && cmake -B build		\
+        && cd ${mscpdir}/build          \
+	&& make				\
+	&& cpack -G RPM CPackConfig.cmake \
+	&& rpm -iv *.rpm
+
+# install mscp python module
+RUN cd ${mscpdir}	\
+	&& python3 pysetup.py install --user \
+	&& ldconfig
+

docker/alpine-3.17.Dockerfile

@@ -0,0 +1,40 @@
+FROM alpine:3.17
+
+# Build mscp with conan to create single binary mscp
+
+RUN apk add --no-cache \
+	gcc make cmake python3 py3-pip perl linux-headers libc-dev	\
+	openssh bash python3-dev g++
+
+RUN pip3 install conan pytest
+
+# preparation for sshd
+RUN ssh-keygen -A
+RUN  mkdir /var/run/sshd        \
+        && ssh-keygen -f /root/.ssh/id_rsa -N ""                \
+        && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
+
+
+# Build mscp as a single binary
+RUN conan profile detect --force
+
+ARG mscpdir="/mscp"
+
+COPY . ${mscpdir}
+
+RUN cd ${mscpdir}							\
+	&& rm -rf build							\
+	&& conan install . --output-folder=build --build=missing	\
+	&& cd ${mscpdir}/build						\
+	&& cmake ..							\
+		-DCMAKE_BUILD_TYPE=Release				\
+		-DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake		\
+		-DBUILD_CONAN=ON -DBUILD_STATIC=ON			\
+	&& make								\
+	&& cp mscp /usr/bin/						\
+	&& cp mscp /mscp/build/mscp_alpine-3.17-x86_64.static
+# copy mscp to PKG FILE NAME because this build doesn't use CPACK
+
+# install mscp python module
+RUN cd ${mscpdir}	\
+	&& python3 pysetup.py install --user

docker/centos-8.Dockerfile

@@ -1,36 +0,0 @@
-FROM centos:8
-
-ARG mscpdir="/mscp"
-
-COPY . ${mscpdir}
-
-# from https://stackoverflow.com/questions/70963985/error-failed-to-download-metadata-for-repo-appstream-cannot-prepare-internal
-RUN cd /etc/yum.repos.d/
-RUN sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-*
-RUN sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
-
-# install numpy and pytest, sshd for test, and rpm-build
-RUN set -ex && yum -y update && yum -y install \
-	python3 python3-pip openssh openssh-server openssh-clients rpm-build
-
-RUN python3 -m pip install numpy pytest
-
-
-# preparation for sshd
-RUN  mkdir /var/run/sshd        \
-	&& ssh-keygen -A	\
-        && ssh-keygen -f /root/.ssh/id_rsa -N ""                \
-        && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
-
-# install build dependency
-RUN ${mscpdir}/scripts/install-build-deps.sh
-
-# build
-RUN cd ${mscpdir}			\
-        && rm -rf build			\
-        && cmake -B build 		\
-        && cd ${mscpdir}/build          \
-	&& make				\
-	&& cpack -G RPM CPackConfig.cmake \
-	&& rpm -iv *.rpm
-

docker/rocky-8.8.Dockerfile

@@ -1,14 +1,10 @@
-FROM rockylinux:8.6
+FROM rockylinux:8.8
 
-ARG mscpdir="/mscp"
-
-COPY . ${mscpdir}
-
-# install numpy and pytest, sshd for test, and rpm-build
+# install pytest, sshd for test, and rpm-build
 RUN set -ex && yum -y install \
-	python3 python3-pip openssh openssh-server openssh-clients rpm-build
+	python3 python3-pip python3-devel openssh openssh-server openssh-clients rpm-build
 
-RUN python3 -m pip install numpy pytest
+RUN python3 -m pip install pytest
 
 
 # preparation for sshd
@@ -17,6 +13,10 @@ RUN  mkdir /var/run/sshd        \
         && ssh-keygen -f /root/.ssh/id_rsa -N ""                \
         && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
 
+ARG mscpdir="/mscp"
+
+COPY . ${mscpdir}
+
 # install build dependency
 RUN ${mscpdir}/scripts/install-build-deps.sh
 
@@ -29,3 +29,8 @@ RUN cd ${mscpdir}			\
 	&& cpack -G RPM CPackConfig.cmake \
 	&& rpm -iv *.rpm
 
+# install mscp python module
+RUN cd ${mscpdir}	\
+	&& python3 pysetup.py install --user \
+	&& ldconfig
+

docker/ubuntu-20.04.Dockerfile

@@ -1,18 +1,14 @@
 FROM ubuntu:20.04
 
 ARG DEBIAN_FRONTEND=noninteractive
-ARG mscpdir="/mscp"
-
-COPY . ${mscpdir}
-
 RUN set -ex && apt-get update && apt-get install -y --no-install-recommends \
 	ca-certificates
 
-# install numpy and pytest, and sshd for test
+# install pytest, and sshd for test
 RUN apt-get install -y --no-install-recommends  \
-        python3 python3-pip openssh-server
+        python3 python3-pip python3-dev openssh-server
 
-RUN python3 -m pip install numpy pytest
+RUN python3 -m pip install pytest
 
 
 # preparation for sshd
@@ -21,6 +17,10 @@ RUN  mkdir /var/run/sshd        \
         && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
 
 
+ARG mscpdir="/mscp"
+
+COPY . ${mscpdir}
+
 # install build dependency
 RUN ${mscpdir}/scripts/install-build-deps.sh
 
@@ -33,3 +33,8 @@ RUN cd ${mscpdir}			\
 	&& make				\
 	&& cpack -G DEB CPackConfig.cmake \
 	&& dpkg -i *.deb
+
+# install mscp python module
+RUN cd ${mscpdir}       \
+	&& python3 pysetup.py install --user \
+	&& ldconfig

docker/ubuntu-22.04.Dockerfile

@@ -1,18 +1,14 @@
 FROM ubuntu:22.04
 
 ARG DEBIAN_FRONTEND=noninteractive
-ARG mscpdir="/mscp"
-
-COPY . ${mscpdir}
-
 RUN set -ex && apt-get update && apt-get install -y --no-install-recommends \
 	ca-certificates
 
-# install numpy and pytest, and sshd for test
+# install pytest, and sshd for test
 RUN apt-get install -y --no-install-recommends  \
-        python3 python3-pip openssh-server
+        python3 python3-pip python3-dev openssh-server
 
-RUN python3 -m pip install numpy pytest
+RUN python3 -m pip install pytest
 
 
 # preparation for sshd
@@ -20,6 +16,9 @@ RUN  mkdir /var/run/sshd        \
         && ssh-keygen -f /root/.ssh/id_rsa -N ""                \
         && mv /root/.ssh/id_rsa.pub /root/.ssh/authorized_keys
 
+ARG mscpdir="/mscp"
+
+COPY . ${mscpdir}
 
 # install build dependency
 RUN ${mscpdir}/scripts/install-build-deps.sh
@@ -33,3 +32,9 @@ RUN cd ${mscpdir}			\
 	&& make				\
 	&& cpack -G DEB CPackConfig.cmake \
 	&& dpkg -i *.deb
+
+# install mscp python module
+RUN cd ${mscpdir}	\
+	&& python3 pysetup.py install --user \
+	&& ldconfig
+

examples/.gitignore

@@ -0,0 +1,3 @@
+simple-copy-dest
+*.img
+.ipynb_checkpoints

examples/mscp-example.ipynb

@@ -0,0 +1,226 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "ccda9e3a-35de-43fc-9b6e-02475c763f6b",
+   "metadata": {},
+   "source": [
+    "# mscp python binding example"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 60,
+   "id": "df04d655-a082-47eb-9a1e-154ebc2a5655",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import glob\n",
+    "import time\n",
+    "import os\n",
+    "\n",
+    "import mscp"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 53,
+   "id": "e9ed4519-c3fd-4639-89a5-1c1cdffd9519",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "this_dir = os.getcwd()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "fee75bf8-df40-45f4-81d1-113069c34f13",
+   "metadata": {},
+   "source": [
+    "## Simple copy"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 54,
+   "id": "2b06e6d3-30cc-47be-bd4f-af27eb141c8c",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['../src/ssh.c',\n",
+       " '../src/mscp.c',\n",
+       " '../src/platform.c',\n",
+       " '../src/pymscp.c',\n",
+       " '../src/main.c',\n",
+       " '../src/path.c',\n",
+       " '../src/message.c',\n",
+       " '../src/fileops.c']"
+      ]
+     },
+     "execution_count": 54,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# preparing files to be transferred\n",
+    "c_sources = glob.glob(\"../src/*.c\")\n",
+    "c_sources"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 55,
+   "id": "89bb4558-9472-4d26-9af3-24f426b15edc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# copy files using mscp\n",
+    "dst_dir = this_dir + \"/simple-copy-dest\"\n",
+    "m = mscp.mscp(\"localhost\", mscp.LOCAL2REMOTE)\n",
+    "m.copy(c_sources, dst_dir)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 56,
+   "id": "6daf2c98-8905-4039-b82a-a593df3107fe",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['ssh.c',\n",
+       " 'mscp.c',\n",
+       " 'platform.c',\n",
+       " 'pymscp.c',\n",
+       " 'main.c',\n",
+       " 'path.c',\n",
+       " 'message.c',\n",
+       " 'fileops.c']"
+      ]
+     },
+     "execution_count": 56,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "os.listdir(\"simple-copy-dest\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f4a3869a-878e-43b0-9758-a049eaf8b5bd",
+   "metadata": {},
+   "source": [
+    "## Simple Copy with Python Rich ProgressBar"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 64,
+   "id": "e7cb7cd6-b845-4d26-93ed-aee8ed3983ab",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# make a 256MB file\n",
+    "src = \"example-256MB-src.img\"\n",
+    "with open(src, \"wb\") as f:\n",
+    "    f.seek(128 * 1024 * 1024 -1, 0)\n",
+    "    f.write(b'1')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 69,
+   "id": "878607ed-5c06-4b15-81ac-9845dad0c9c6",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "b700e9fc00464969a22a26300404dc35",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Output()"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/html": [
+       "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"></pre>\n"
+      ],
+      "text/plain": []
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/html": [
+       "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",
+       "</pre>\n"
+      ],
+      "text/plain": [
+       "\n"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "# copy the 256MB file while ploting progress bar using python rich\n",
+    "dst = this_dir + \"/example-256MB-dst.img\"\n",
+    "\n",
+    "kw = {\"nr_threads\": 1, \"nr_ahead\": 1} # slow mscp to watch the progress bar\n",
+    "\n",
+    "m = mscp.mscp(\"localhost\", mscp.LOCAL2REMOTE, **kw)\n",
+    "m.copy(src, dst, nonblock = True)\n",
+    "\n",
+    "# m.stats() returns total bytes to be transferred, bytes transferred (done), and finished (bool).\n",
+    "total, done, finished = m.stats()\n",
+    "with Progress() as progress:\n",
+    "\n",
+    "    task = progress.add_task(f\"[green]Copying {src}\", total = total)\n",
+    "\n",
+    "    while not progress.finished:\n",
+    "        total, done, finished = m.stats()\n",
+    "        progress.update(task, completed = done)\n",
+    "        time.sleep(0.5)\n",
+    "\n",
+    "m.join()\n",
+    "m.cleanup()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

examples/mscp-python.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+"""mscp.py
+
+An example python script running mscp
+"""
+
+import argparse
+import time
+import sys
+
+from rich.progress import Progress
+
+import mscp
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-f", "--from", dest = "fr",
+                        metavar = "REMOTE", default = None,
+                        help = "copy a file from this remote host")
+    parser.add_argument("-t", "--to", metavar = "REMOTE", default = None,
+                        help = "copy a file to this remote host")
+    parser.add_argument("source", help = "path to source file to be copied")
+    parser.add_argument("destination", help = "path of copy destination")
+
+    args = parser.parse_args()
+
+    if args.fr and args.to:
+        print("-f and -t are exclusive", file = sys.stderr)
+        sys.exit(1)
+    elif args.fr:
+        d = mscp.REMOTE2LOCAL
+        remote = args.fr
+    elif args.to:
+        d = mscp.LOCAL2REMOTE
+        remote = args.to
+    else:
+        print("-f or -t must be specified", file = sys.stderr)
+        sys.exit(1)
+
+
+    m = mscp.mscp(remote, d)
+    m.connect()
+    m.add_src_path(args.source)
+    m.set_dst_path(args.destination)
+    m.scan()
+    m.start()
+
+    total, done, finished = m.stats()
+    with Progress() as progress:
+
+        task = progress.add_task("[green]Copying...", total = total)
+
+        while not progress.finished:
+            total, done, finished = m.stats()
+            progress.update(task, completed = done)
+            time.sleep(0.5)
+
+    m.join()
+    m.cleanup()
+
+
+if __name__ == "__main__":
+    main()

include/mscp.h

@@ -0,0 +1,276 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#ifndef _MSCP_H_
+#define _MSCP_H_
+
+/**
+ * @file mscp.h
+ *
+ * @brief mscp library header file.
+ *
+ * @mainpage
+ *
+ * libmscp is a library for multi-threaded scp. Project page is
+ * https://github.com/upa/mscp.
+ *
+ * All public APIs of libmscp are defined in mscp.h. Basic usage of
+ * libmscp is follows:
+ *
+ * 1. create mscp instance with mscp_init()
+ * 2. connect to remote host with mscp_connect()
+ * 3. add path to source files with mscp_add_src_path()
+ * 4. set path to destination with mscp_set_dst_path()
+ * 5. start to scan source files with mscp_scan()
+ * 6. start copy with mscp_start()
+ * 7. wait for copy finished with mscp_join()
+ * 8. cleanup mscp instance with mscp_cleanup() and mscp_free()
+ */
+
+#include <stdbool.h>
+#include <limits.h>
+
+#define MSCP_DIRECTION_L2R	1	/** Indicates local to remote copy */
+#define MSCP_DIRECTION_R2L	2	/** Indicates remote to local copy */
+
+#define MSCP_MAX_COREMASK_STR	64
+
+/**
+ * @struct	mscp_opts
+ * @brief	Structure configuring mscp.
+ */
+struct mscp_opts {
+	int	nr_threads;	/** number of copy threads */
+	int	nr_ahead;	/** number of SFTP commands on-the-fly */
+	size_t	min_chunk_sz;	/** minimum chunk size (default 64MB) */
+	size_t	max_chunk_sz;	/** maximum chunk size (default file size/nr_threads) */
+	size_t	buf_sz;		/** buffer size, default 16k. */
+	char	coremask[MSCP_MAX_COREMASK_STR]; /** hex to specifiy usable cpu cores */
+	int	max_startups;	/** sshd MaxStartups concurrent connections */
+	int     interval;	/** interval between SSH connection attempts */
+
+	int	severity; 	/** messaging severity. set MSCP_SERVERITY_* */
+	int	msg_fd;		/** fd to output message. default STDOUT (0),
+				 * and -1 disables output */
+};
+
+#define MSCP_SSH_MAX_LOGIN_NAME		64
+#define MSCP_SSH_MAX_PORT_STR		32
+#define MSCP_SSH_MAX_IDENTITY_PATH	PATH_MAX
+#define MSCP_SSH_MAX_CIPHER_STR		32
+#define MSCP_SSH_MAX_HMAC_STR		32
+#define MSCP_SSH_MAX_COMP_STR		32 /* yes, no, zlib, zlib@openssh.com, none */
+#define MSCP_SSH_MAX_CCALGO_STR		16
+#define MSCP_SSH_MAX_PASSWORD		128
+#define MSCP_SSH_MAX_PASSPHRASE		128
+
+/**
+ * @struct	mscp_ssh_opts
+ * @brief	Structure configuring SSH connections
+ */
+struct mscp_ssh_opts {
+	/* ssh options */
+	char	login_name[MSCP_SSH_MAX_LOGIN_NAME];	/** ssh username */
+	char	port[MSCP_SSH_MAX_PORT_STR];		/** ssh port */
+	char	config[PATH_MAX];	/** path to ssh_config, default ~/.ssh/config*/
+	char	identity[MSCP_SSH_MAX_IDENTITY_PATH];	/** path to private key */
+	char	cipher[MSCP_SSH_MAX_CIPHER_STR];	/** cipher spec */
+	char	hmac[MSCP_SSH_MAX_HMAC_STR];		/** hmacp spec */
+	char	compress[MSCP_SSH_MAX_COMP_STR];	/** yes, no, zlib@openssh.com */
+	char	ccalgo[MSCP_SSH_MAX_CCALGO_STR];	/** TCP cc algorithm */
+
+	char	password[MSCP_SSH_MAX_PASSWORD];	/** password auth passowrd */
+	char	passphrase[MSCP_SSH_MAX_PASSPHRASE];	/** passphrase for private key */
+
+	int	debug_level;		/** inclirement libssh debug output level */
+	bool	no_hostkey_check;	/** do not check host keys */
+	bool	enable_nagle;		/** enable Nagle's algorithm if true */
+};
+
+/**
+ * @struct	mscp_stats
+ * @brief	Structure to get mscp statistics
+ */
+struct mscp_stats {
+	size_t total;	/** total bytes to be transferred */
+	size_t done;	/** total bytes transferred */
+	bool finished;	/** true when all copy threads finished */
+};
+
+
+/** Structure representing mscp instance */
+struct mscp;
+
+/**
+ * @brief Creates a new mscp instance.
+ *
+ * @param remote_host	remote host for file transer.
+ * @param direction	copy direction, `MSCP_DIRECTION_L2R` or `MSCP_DIRECTION_R2L`
+ * @param o		options for configuring mscp.
+ * @param s		options for configuring ssh connections.
+ *
+ * @retrun 		A new mscp instance or NULL on error.
+ */
+struct mscp *mscp_init(const char *remote_host, int direction,
+		       struct mscp_opts *o, struct mscp_ssh_opts *s);
+
+/**
+ * @brief Connect the first SSH connection. mscp_connect connects to
+ * remote host and initialize a SFTP session over the
+ * connection. mscp_scan() and mscp_start() require mscp_connect()
+ * beforehand.
+ *
+ * @param m	mscp instance.
+ *
+ * @return 	0 on success, < 0 if an error occured.
+ *              mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_connect(struct mscp *m);
+
+/* add a source file path to be copied */
+
+/**
+ * @brief Add a source file path to be copied. The path indicates
+ * either a file or directory. The path can be `user@host:path`
+ * notation.  In this case, `dst_path` for mscp_set_dst_path() must
+ * not contain remote host notation.
+ *
+ * @param m		mscp instance.
+ * @param src_path	source file path to be copied.
+ *
+ * @return 		0 on success, < 0 if an error occured.
+ *              	mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_add_src_path(struct mscp *m, const char *src_path);
+
+/**
+ * @brief Set the destination file path. The path indicates either a
+ * file, directory, or nonexistent path. The path can be
+ * `user@host:path` notation.  In this case, all source paths appended
+ * by mscp_set_src_path() must not contain remote host notation.
+ *
+ * @param m		mscp instance.
+ * @param dst_path	destination path to which source files copied.
+ *
+ * @return 		0 on success, < 0 if an error occured.
+ *              	mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_set_dst_path(struct mscp *m, const char *dst_path);
+
+/* scan source files, resolve destination file paths for all source
+ * files, and calculate chunks for all files. */
+
+/**
+ * @brief Scan source paths and prepare. This function checks all
+ * source files (recursively), resolve paths on the destination side,
+ * and calculate file chunks. This function is non-blocking.
+ *
+ * @param m	mscp instance.
+ *
+ * @return 	0 on success, < 0 if an error occured.
+ *              mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_scan(struct mscp *m);
+
+/**
+ * @brief Join scna thread invoked by mscp_scan(). mscp_join()
+ * involves this, so that mscp_scan_join() should be called when
+ * mscp_scan() is called by mscp_start() is not.
+ *
+ * @param m	mscp instance.
+ * @return	0 on success, < 0 if an error occured.
+ *		mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_scan_join(struct mscp *m);
+
+/**
+ * @brief Start to copy files. mscp_start() returns immediately. You
+ * can get statistics via mscp_get_stats() or messages via pipe set by
+ * mscp_opts.msg_fd or mscp_set_msg_fd(). mscp_stop() cancels mscp
+ * copy threads, and mscp_join() joins the threads.
+ *
+ * @param m	mscp instance.
+ *
+ * @return 	number of threads on success, < 0 if an error occured.
+ *              mscp_get_error() can be used to retrieve error message.
+ *
+ * @see		mscp_join()
+ */
+int mscp_start(struct mscp *m);
+
+
+/**
+ * @brief Stop coping files.
+ *
+ * @param m	mscp instance.
+ */
+void mscp_stop(struct mscp *m);
+
+
+/**
+ * @brief Join copy threads. This function is blocking until all copy
+ * have done.
+ *
+ * @param m	mscp instance.
+ *
+ * @return 	0 on success, < 0 if an error occured.
+ *              mscp_get_error() can be used to retrieve error message.
+ */
+int mscp_join(struct mscp *m);
+
+/**
+ * @brief Get statistics of copy.
+ *
+ * @param m		mscp instance.
+ * @param s[out]	statistics.
+ */
+void mscp_get_stats(struct mscp *m, struct mscp_stats *s);
+
+/**
+ * @brief Cleanup the mscp instance. Before calling mscp_cleanup(),
+ * must call mscp_join(). After mscp_cleanup() called, the mscp
+ * instance can restart from mscp_connect(). Note that do not call
+ * mscp_cleanup() before callign mscp_join(). It causes crash (ToDo:
+ * check status of copy threads and return error when they are
+ * running).
+ *
+ * @param m		mscp instance.
+ */
+void mscp_cleanup(struct mscp *m);
+
+/**
+ * @brief Release the mscp instance.  Note that do not call *
+ mscp_free() before calling mscp_join(). It causes crash (ToDo: check
+ * status of copy threads and return error when they are running).
+ *
+ * @param m		mscp instance.
+ */
+void mscp_free(struct mscp *m);
+
+
+/* messaging with mscp */
+
+/**
+ * @enum	mscp_serverity
+ * @brief 	Filter messages from libmscp with severity level.
+ */
+enum {
+	MSCP_SEVERITY_NONE	= -1,
+	MSCP_SEVERITY_ERR	= 0,
+	MSCP_SEVERITY_WARN	= 1,
+	MSCP_SEVERITY_NOTICE	= 2,
+        MSCP_SEVERITY_INFO	= 3,
+	MSCP_SEVERITY_DEBUG	= 4,
+};
+
+
+
+/**
+ * @brief Get the recent error message from libmscp. Note that this
+ * function is not thread-safe.
+ *
+ * @return 	pointer to the message.
+ */
+const char *mscp_get_error(void);
+
+
+
+#endif /* _MSCP_H_ */

include/mscp_version.h.in

@@ -0,0 +1,8 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#ifndef _MSCP_VERSION_H_
+#define _MSCP_VERSION_H_
+
+#define MSCP_VERSION		"@MSCP_VERSION@"
+#define MSCP_BUILD_VERSION	"@MSCP_BUILD_VERSION@"
+
+#endif /* _MSCP_VERSION_H_ */

mscp/__init__.py

@@ -0,0 +1 @@
+from mscp.mscp import *

mscp/mscp.py

@@ -0,0 +1,187 @@
+
+_retry_import_pymscp = False
+
+try:
+    import pymscp
+except ImportError:
+    _retry_import_pymscp = True
+
+if _retry_import_pymscp:
+    """ libmscp.so is not installed on system library paths. So retry
+    to import libmscp.so installed on the mscp python module
+    directory.
+    """
+    import os
+    import sys
+    import ctypes
+
+    if sys.platform == "linux":
+        libmscp = "libmscp.so"
+    elif sys.platform == "darwin":
+        libmscp = "libmscp.dylib"
+
+    mscp_dir = os.path.dirname(__file__)
+    ctypes.cdll.LoadLibrary("{}/{}".format(mscp_dir, libmscp))
+    import pymscp
+
+
+# inherit static values from pymscp
+LOCAL2REMOTE    = pymscp.LOCAL2REMOTE
+REMOTE2LOCAL    = pymscp.REMOTE2LOCAL
+SEVERITY_NONE   = pymscp.SEVERITY_NONE
+SEVERITY_ERR    = pymscp.SEVERITY_ERR
+SEVERITY_WARN   = pymscp.SEVERITY_WARN
+SEVERITY_NOTICE = pymscp.SEVERITY_NOTICE
+SEVERITY_INFO   = pymscp.SEVERITY_INFO
+SEVERITY_DEBUG  = pymscp.SEVERITY_DEBUG
+
+STATE_INIT      = 0
+STATE_CONNECTED = 1
+STATE_SCANNED   = 2
+STATE_RUNNING   = 3
+STATE_STOPPED   = 4
+STATE_JOINED    = 5
+STATE_CLEANED   = 6
+STATE_RELEASED  = 7
+
+_state_str = {
+    STATE_INIT:      "init",
+    STATE_CONNECTED: "connected",
+    STATE_SCANNED:   "scanned",
+    STATE_RUNNING:   "running",
+    STATE_STOPPED:   "stopped",
+    STATE_JOINED:    "joined",
+    STATE_CLEANED:   "cleaned",
+    STATE_RELEASED:  "released",
+}
+
+
+class mscp:
+
+
+    def __init__(self, remote: str, direction: int, **kwargs):
+        self.remote = remote
+        self.direction = direction
+        kwargs["remote"] = remote
+        kwargs["direction"] = direction
+        self.m = pymscp.mscp_init(**kwargs)
+
+        self.src_paths = []
+        self.dst_path = None
+        self.state = STATE_INIT
+
+    def __str__(self):
+        if not hasattr(self, "state"):
+            # this instance failed on mscp_init
+            return "mscp:{}:init-failed"
+        return "mscp:{}:{}".format(self.remote, self.__state2str())
+
+    def __repr__(self):
+        return "<{}>".format(str(self))
+
+    def __del__(self):
+
+        if not hasattr(self, "state"):
+            return # this instance failed on mscp_init
+
+        if self.state == STATE_RUNNING:
+            self.stop()
+        if self.state == STATE_STOPPED:
+            self.join()
+
+        self.cleanup()
+        self.release()
+
+    def __state2str(self):
+        return _state_str[self.state]
+
+
+    def connect(self):
+        if not (self.state == STATE_INIT or state.state == STATE_CLEANED):
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        pymscp.mscp_connect(m = self.m)
+        self.state = STATE_CONNECTED
+
+    def add_src_path(self, src_path: str):
+        if type(src_path) != str:
+            raise ValueError("src_path must be str: {}".format(src_path))
+        self.src_paths.append(src_path)
+        pymscp.mscp_add_src_path(m = self.m, src_path = src_path)
+
+    def set_dst_path(self, dst_path: str):
+        if type(dst_path) != str:
+            raise ValueError("dst_path must be str: {}".format(dst_path))
+        self.dst_path = dst_path
+        pymscp.mscp_set_dst_path(m = self.m, dst_path = dst_path);
+
+    def scan(self):
+        if self.state == STATE_SCANNED:
+            return
+        if self.state != STATE_CONNECTED:
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        if not self.src_paths:
+            raise RuntimeError("src path list is empty")
+        if self.dst_path == None:
+            raise RuntimeError("dst path is not set")
+
+        pymscp.mscp_scan(m = self.m)
+        self.state = STATE_SCANNED
+
+    def start(self):
+        if self.state != STATE_SCANNED:
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+
+        pymscp.mscp_start(m = self.m)
+        self.state = STATE_RUNNING
+
+    def stop(self):
+        if self.state != STATE_RUNNING:
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        pymscp.mscp_stop(m = self.m)
+        self.state = STATE_STOPPED
+
+    def join(self):
+        if self.state == STATE_JOINED:
+            return
+        if not (self.state == STATE_RUNNING or self.state == STATE_STOPPED):
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        pymscp.mscp_join(m = self.m)
+        self.state = STATE_JOINED
+
+    def stats(self):
+        return pymscp.mscp_get_stats(m = self.m)
+
+    def cleanup(self):
+        if self.state == STATE_RUNNING:
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        pymscp.mscp_cleanup(m = self.m)
+        self.state = STATE_CLEANED
+
+    def release(self):
+        if self.state != STATE_CLEANED:
+            raise RuntimeError("invalid mscp state: {}".format(self.__state2str()))
+        pymscp.mscp_free(m = self.m)
+        self.state = STATE_RELEASED
+
+    # Simple interface: mscp.copy(src, dst)
+    def copy(self, src, dst, nonblock = False):
+        if self.state < STATE_CONNECTED:
+            self.connect()
+
+        if type(src) == list:
+            for path in src:
+                self.add_src_path(path)
+        elif type(src) == str:
+            self.add_src_path(src)
+        else:
+            raise ValueError("src must be str of list: '{}'".format(src))
+
+        self.set_dst_path(dst)
+        
+        self.scan()
+        self.start()
+        if nonblock:
+            return
+
+        self.join()
+        self.cleanup()

patch/README.md

@@ -1,13 +1,5 @@
 
-Patch(es) in this directory introduces `sftp_async_write()` and
+Patches in this directory introduces `sftp_async_write()` and
 `sftp_async_write_end()` to libssh. Those implementations are derived
 from https://github.com/limes-datentechnik-gmbh/libssh. See [Re: SFTP
 Write async](https://archive.libssh.org/libssh/2020-06/0000004.html).
-
-```console
-git clone https://git.libssh.org/projects/libssh.git/ --depth=1 -b libssh-0.10.4
-cd libssh
-git apply ../pathc/libssh-0.10.4.patch
-
-# then build libssh
-```

patch/libssh-0.10.4.patch

@@ -1,41 +1,92 @@
-diff --git a/DefineOptions.cmake b/DefineOptions.cmake
-index 068db988..6db0fc0f 100644
---- a/DefineOptions.cmake
-+++ b/DefineOptions.cmake
-@@ -17,7 +17,7 @@ option(UNIT_TESTING "Build with unit tests" OFF)
- option(CLIENT_TESTING "Build with client tests; requires openssh" OFF)
- option(SERVER_TESTING "Build with server tests; requires openssh and dropbear" OFF)
- option(WITH_BENCHMARKS "Build benchmarks tools" OFF)
--option(WITH_EXAMPLES "Build examples" ON)
-+option(WITH_EXAMPLES "Build examples" OFF)
- option(WITH_NACL "Build with libnacl (curve25519)" ON)
- option(WITH_SYMBOL_VERSIONING "Build with symbol versioning" ON)
- option(WITH_ABI_BREAK "Allow ABI break" OFF)
-@@ -25,6 +25,7 @@ option(WITH_GEX "Enable DH Group exchange mechanisms" ON)
- option(WITH_INSECURE_NONE "Enable insecure none cipher and MAC algorithms (not suitable for production!)" OFF)
- option(FUZZ_TESTING "Build with fuzzer for the server and client (automatically enables none cipher!)" OFF)
- option(PICKY_DEVELOPER "Build with picky developer flags" OFF)
-+option(WITH_STATIC_LIB "Build static library" ON)
+diff --git a/ConfigureChecks.cmake b/ConfigureChecks.cmake
+index 7103f303..c64eb39d 100644
+--- a/ConfigureChecks.cmake
++++ b/ConfigureChecks.cmake
+@@ -258,6 +258,7 @@ if (UNIX)
+     check_library_exists(util forkpty "" HAVE_LIBUTIL)
+     check_function_exists(cfmakeraw HAVE_CFMAKERAW)
+     check_function_exists(__strtoull HAVE___STRTOULL)
++    check_symbol_exists(TCP_CONGESTION "netinet/tcp.h" HAVE_TCP_CONGESTION)
+ endif (UNIX)
  
- if (WITH_ZLIB)
-     set(WITH_LIBZ ON)
-@@ -60,3 +61,7 @@ endif (NOT GLOBAL_CLIENT_CONFIG)
- if (FUZZ_TESTING)
-   set(WITH_INSECURE_NONE ON)
- endif (FUZZ_TESTING)
+ set(LIBSSH_REQUIRED_LIBRARIES ${_REQUIRED_LIBRARIES} CACHE INTERNAL "libssh required system libraries")
+diff --git a/config.h.cmake b/config.h.cmake
+index 1357615b..1e915ead 100644
+--- a/config.h.cmake
++++ b/config.h.cmake
+@@ -237,6 +237,8 @@
+ 
+ #cmakedefine HAVE_GCC_BOUNDED_ATTRIBUTE 1
+ 
++#cmakedefine HAVE_TCP_CONGESTION 1
 +
-+if (WITH_STATIC_LIB)
-+  set(BUILD_STATIC_LIB ON)
-+endif()
+ /* Define to 1 if you want to enable GSSAPI */
+ #cmakedefine WITH_GSSAPI 1
+ 
+diff --git a/include/libssh/buffer.h b/include/libssh/buffer.h
+index a55a1b40..e34e075c 100644
+--- a/include/libssh/buffer.h
++++ b/include/libssh/buffer.h
+@@ -33,6 +33,8 @@ int ssh_buffer_add_u8(ssh_buffer buffer, uint8_t data);
+ int ssh_buffer_add_u16(ssh_buffer buffer, uint16_t data);
+ int ssh_buffer_add_u32(ssh_buffer buffer, uint32_t data);
+ int ssh_buffer_add_u64(ssh_buffer buffer, uint64_t data);
++ssize_t ssh_buffer_add_func(ssh_buffer buffer, ssh_add_func f, size_t max_bytes,
++			    void *userdata);
+ 
+ int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len);
+ 
+diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h
+index 7857a77b..6b4d481c 100644
+--- a/include/libssh/libssh.h
++++ b/include/libssh/libssh.h
+@@ -402,6 +402,7 @@ enum ssh_options_e {
+   SSH_OPTIONS_GSSAPI_AUTH,
+   SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
+   SSH_OPTIONS_NODELAY,
++  SSH_OPTIONS_CCALGO,
+   SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
+   SSH_OPTIONS_PROCESS_CONFIG,
+   SSH_OPTIONS_REKEY_DATA,
+@@ -833,6 +834,7 @@ LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
+ LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
+ 
+ LIBSSH_API ssh_buffer ssh_buffer_new(void);
++LIBSSH_API ssh_buffer ssh_buffer_new_size(uint32_t size, uint32_t headroom);
+ LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
+ #define SSH_BUFFER_FREE(x) \
+     do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
+@@ -843,6 +845,8 @@ LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
+ LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
+ LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message);
+ 
++typedef ssize_t (*ssh_add_func) (void *ptr, size_t max_bytes, void *userdata);
++
+ #ifndef LIBSSH_LEGACY_0_4
+ #include "libssh/legacy.h"
+ #endif
+diff --git a/include/libssh/session.h b/include/libssh/session.h
+index d3e5787c..15183d1b 100644
+--- a/include/libssh/session.h
++++ b/include/libssh/session.h
+@@ -232,6 +232,7 @@ struct ssh_session_struct {
+         int gss_delegate_creds;
+         int flags;
+         int nodelay;
++        char *ccalgo;
+         bool config_processed;
+         uint8_t options_seen[SOC_MAX];
+         uint64_t rekey_data;
 diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
-index c855df8a..1fd1710a 100644
+index c855df8a..0fcdb9b8 100644
 --- a/include/libssh/sftp.h
 +++ b/include/libssh/sftp.h
-@@ -565,6 +565,9 @@ LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_
+@@ -565,6 +565,10 @@ LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_
   */
  LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
  
-+LIBSSH_API int sftp_async_write(sftp_file file, const void *buf, size_t count, uint32_t* id);
++LIBSSH_API ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count,
++				    void *userdata, uint32_t* id);
 +LIBSSH_API int sftp_async_write_end(sftp_file file, uint32_t id, int blocking);
 +
  /**
@@ -57,26 +108,243 @@ index c090fef7..e2f86309 100644
  endif (BUILD_STATIC_LIB)
  
  message(STATUS "Threads_FOUND=${Threads_FOUND}")
+diff --git a/src/buffer.c b/src/buffer.c
+index e0068015..cc0caf35 100644
+--- a/src/buffer.c
++++ b/src/buffer.c
+@@ -141,6 +141,40 @@ struct ssh_buffer_struct *ssh_buffer_new(void)
+     return buf;
+ }
+ 
++/**
++ * @brief Create a new SSH buffer with a specified size and headroom.
++ *
++ * @param[in] len       length for newly initialized SSH buffer.
++ * @param[in] headroom  length for headroom
++ * @return A newly initialized SSH buffer, NULL on error.
++ */
++struct ssh_buffer_struct *ssh_buffer_new_size(uint32_t len, uint32_t headroom)
++{
++    struct ssh_buffer_struct *buf = NULL;
++    int rc;
++
++    if (len < headroom)
++	    return NULL;
++
++    buf = calloc(1, sizeof(struct ssh_buffer_struct));
++    if (buf == NULL) {
++        return NULL;
++    }
++
++    rc = ssh_buffer_allocate_size(buf, len);
++    if (rc != 0) {
++        SAFE_FREE(buf);
++        return NULL;
++    }
++
++    buf->pos += headroom;
++    buf->used += headroom;
++
++    buffer_verify(buf);
++
++    return buf;
++}
++
+ /**
+  * @brief Deallocate a SSH buffer.
+  *
+@@ -328,6 +362,49 @@ int ssh_buffer_add_data(struct ssh_buffer_struct *buffer, const void *data, uint
+     return 0;
+ }
+ 
++/**
++ * @brief Add data at the tail of a buffer by an external function
++ *
++ * @param[in]  buffer    The buffer to add data.
++ *
++ * @param[in]  f         function that adds data to the buffer.
++ *
++ * @param[in]  max_bytes The maximum length of the data to add.
++ *
++ * @return               actual bytes added on success, < 0 on error.
++ */
++ssize_t ssh_buffer_add_func(struct ssh_buffer_struct *buffer, ssh_add_func f,
++			    size_t max_bytes, void *userdata)
++{
++    ssize_t actual;
++
++    if (buffer == NULL) {
++        return -1;
++    }
++
++    buffer_verify(buffer);
++
++    if (buffer->used + max_bytes < max_bytes) {
++        return -1;
++    }
++
++    if (buffer->allocated < (buffer->used + max_bytes)) {
++        if (buffer->pos > 0) {
++            buffer_shift(buffer);
++        }
++        if (realloc_buffer(buffer, buffer->used + max_bytes) < 0) {
++            return -1;
++        }
++    }
++
++    if ((actual = f(buffer->data + buffer->used, max_bytes, userdata)) < 0)
++      return -1;
++
++    buffer->used += actual;
++    buffer_verify(buffer);
++    return actual;
++}
++
+ /**
+  * @brief Ensure the buffer has at least a certain preallocated size.
+  *
+diff --git a/src/connect.c b/src/connect.c
+index 57e37e63..c02397d5 100644
+--- a/src/connect.c
++++ b/src/connect.c
+@@ -156,6 +156,20 @@ static int set_tcp_nodelay(socket_t socket)
+                       sizeof(opt));
+ }
+ 
++static int set_tcp_ccalgo(socket_t socket, const char *ccalgo)
++{
++#ifdef HAVE_TCP_CONGESTION
++	return setsockopt(socket,
++			  IPPROTO_TCP,
++			  TCP_CONGESTION,
++			  (void *)ccalgo,
++			  strlen(ccalgo));
++#else
++	errno = ENOTSUP;
++	return -1;
++#endif
++}
++
+ /**
+  * @internal
+  *
+@@ -256,6 +270,18 @@ socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
+             }
+         }
+ 
++        if (session->opts.ccalgo) {
++	     rc = set_tcp_ccalgo(s, session->opts.ccalgo);
++	     if (rc < 0) {
++		 ssh_set_error(session, SSH_FATAL,
++			       "Failed to set TCP_CONGESTION on socket: %s",
++			       ssh_strerror(errno, err_msg, SSH_ERRNO_MSG_MAX));
++		 ssh_connect_socket_close(s);
++		 s = -1;
++		 continue;
++	     }
++	}
++
+         errno = 0;
+         rc = connect(s, itr->ai_addr, itr->ai_addrlen);
+         if (rc == -1 && (errno != 0) && (errno != EINPROGRESS)) {
+diff --git a/src/options.c b/src/options.c
+index 49aaefa2..9f7360c3 100644
+--- a/src/options.c
++++ b/src/options.c
+@@ -210,6 +210,7 @@ int ssh_options_copy(ssh_session src, ssh_session *dest)
+     new->opts.gss_delegate_creds    = src->opts.gss_delegate_creds;
+     new->opts.flags                 = src->opts.flags;
+     new->opts.nodelay               = src->opts.nodelay;
++    new->opts.ccalgo                = src->opts.ccalgo;
+     new->opts.config_processed      = src->opts.config_processed;
+     new->common.log_verbosity       = src->common.log_verbosity;
+     new->common.callbacks           = src->common.callbacks;
+@@ -450,6 +451,10 @@ int ssh_options_set_algo(ssh_session session,
+  *                Set it to disable Nagle's Algorithm (TCP_NODELAY) on the
+  *                session socket. (int, 0=false)
+  *
++ *              - SSH_OPTIONS_CCALGO
++ *                Set it to specify TCP congestion control algorithm on the
++ *                session socket (Linux only). (int, 0=false)
++ *
+  *              - SSH_OPTIONS_PROCESS_CONFIG
+  *                Set it to false to disable automatic processing of per-user
+  *                and system-wide OpenSSH configuration files. LibSSH
+@@ -1013,6 +1018,20 @@ int ssh_options_set(ssh_session session, enum ssh_options_e type,
+                 session->opts.nodelay = (*x & 0xff) > 0 ? 1 : 0;
+             }
+             break;
++	case SSH_OPTIONS_CCALGO:
++            v = value;
++            if (v == NULL || v[0] == '\0') {
++                ssh_set_error_invalid(session);
++                return -1;
++            } else {
++                SAFE_FREE(session->opts.ccalgo);
++                session->opts.ccalgo = strdup(v);
++                if (session->opts.ccalgo == NULL) {
++                    ssh_set_error_oom(session);
++                    return -1;
++                }
++            }
++            break;
+         case SSH_OPTIONS_PROCESS_CONFIG:
+             if (value == NULL) {
+                 ssh_set_error_invalid(session);
+diff --git a/src/session.c b/src/session.c
+index 6025c133..6b197526 100644
+--- a/src/session.c
++++ b/src/session.c
+@@ -108,6 +108,7 @@ ssh_session ssh_new(void)
+     session->opts.fd = -1;
+     session->opts.compressionlevel = 7;
+     session->opts.nodelay = 0;
++    session->opts.ccalgo = NULL;
+ 
+     session->opts.flags = SSH_OPT_FLAG_PASSWORD_AUTH |
+                           SSH_OPT_FLAG_PUBKEY_AUTH |
 diff --git a/src/sftp.c b/src/sftp.c
-index e01012a8..7b5dc249 100644
+index e01012a8..702623a0 100644
 --- a/src/sftp.c
 +++ b/src/sftp.c
-@@ -2228,6 +2228,102 @@ ssize_t sftp_write(sftp_file file, const void *buf, size_t count) {
+@@ -2228,6 +2228,132 @@ ssize_t sftp_write(sftp_file file, const void *buf, size_t count) {
    return -1; /* not reached */
  }
  
 +/*
-+ * sftp_async_write and sftp_async_write_end are copied from
++ * sftp_async_write is based on and sftp_async_write_end is copied from
 + * https://github.com/limes-datentechnik-gmbh/libssh
++ *
++ * sftp_async_write has some optimizations:
++ * - use ssh_buffer_new_size() to reduce realoc_buffer.
++ * - use ssh_buffer_add_func() to avoid memcpy from read buffer to ssh buffer.
 + */
-+int sftp_async_write(sftp_file file, const void *buf, size_t count, uint32_t* id) {
++ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count, void *userdata,
++			 uint32_t* id) {
 +  sftp_session sftp = file->sftp;
 +  ssh_buffer buffer;
++  uint32_t buf_sz;
++  ssize_t actual;
 +  int len;
 +  int packetlen;
 +  int rc;
 +
-+  buffer = ssh_buffer_new();
++#define HEADROOM 16
++  /* sftp_packet_write() prepends a 5-bytes (uint32_t length and
++   * 1-byte type) header to the head of the payload by
++   * ssh_buffer_prepend_data(). Inserting headroom by
++   * ssh_buffer_new_size() eliminates memcpy for prepending the
++   * header.
++   */
++
++  buf_sz = (HEADROOM + /* for header */
++	    sizeof(uint32_t) + /* id */
++	    ssh_string_len(file->handle) + 4 + /* file->handle */
++	    sizeof(uint64_t) + /* file->offset */
++	    sizeof(uint32_t) + /* count */
++	    count); /* datastring */
++
++  buffer = ssh_buffer_new_size(buf_sz, HEADROOM);
 +  if (buffer == NULL) {
 +    ssh_set_error_oom(sftp->session);
 +    return -1;
@@ -85,17 +353,25 @@ index e01012a8..7b5dc249 100644
 +  *id = sftp_get_new_id(file->sftp);
 +
 +  rc = ssh_buffer_pack(buffer,
-+                       "dSqdP",
++                       "dSqd",
 +                       *id,
 +                       file->handle,
 +                       file->offset,
-+                       count, /* len of datastring */
-+                       (size_t)count, buf);
++                       count); /* len of datastring */
++
 +  if (rc != SSH_OK){
 +    ssh_set_error_oom(sftp->session);
 +    ssh_buffer_free(buffer);
 +    return SSH_ERROR;
 +  }
++
++  actual = ssh_buffer_add_func(buffer, f, count, userdata);
++  if (actual < 0){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++
 +  packetlen=ssh_buffer_get_len(buffer)+5;
 +  len = sftp_packet_write(file->sftp, SSH_FXP_WRITE, buffer);
 +  ssh_buffer_free(buffer);
@@ -109,9 +385,9 @@ index e01012a8..7b5dc249 100644
 +    return SSH_ERROR;
 +  }
 +
-+  file->offset += count;
++  file->offset += actual;
 +
-+  return SSH_OK;
++  return actual;
 +}
 +
 +int sftp_async_write_end(sftp_file file, uint32_t id, int blocking) {

patch/libssh-0.10.6-2-g6f1b1e76.patch

@@ -0,0 +1,442 @@
+diff --git a/ConfigureChecks.cmake b/ConfigureChecks.cmake
+index 9de10225..0f3d20ed 100644
+--- a/ConfigureChecks.cmake
++++ b/ConfigureChecks.cmake
+@@ -258,6 +258,7 @@ if (UNIX)
+     check_library_exists(util forkpty "" HAVE_LIBUTIL)
+     check_function_exists(cfmakeraw HAVE_CFMAKERAW)
+     check_function_exists(__strtoull HAVE___STRTOULL)
++    check_symbol_exists(TCP_CONGESTION "netinet/tcp.h" HAVE_TCP_CONGESTION)
+ endif (UNIX)
+ 
+ set(LIBSSH_REQUIRED_LIBRARIES ${_REQUIRED_LIBRARIES} CACHE INTERNAL "libssh required system libraries")
+diff --git a/config.h.cmake b/config.h.cmake
+index cc83734d..f74cd03b 100644
+--- a/config.h.cmake
++++ b/config.h.cmake
+@@ -237,6 +237,8 @@
+ 
+ #cmakedefine HAVE_GCC_BOUNDED_ATTRIBUTE 1
+ 
++#cmakedefine HAVE_TCP_CONGESTION 1
++
+ /* Define to 1 if you want to enable GSSAPI */
+ #cmakedefine WITH_GSSAPI 1
+ 
+diff --git a/include/libssh/buffer.h b/include/libssh/buffer.h
+index 1fce7b76..b64d1455 100644
+--- a/include/libssh/buffer.h
++++ b/include/libssh/buffer.h
+@@ -37,6 +37,8 @@ int ssh_buffer_add_u8(ssh_buffer buffer, uint8_t data);
+ int ssh_buffer_add_u16(ssh_buffer buffer, uint16_t data);
+ int ssh_buffer_add_u32(ssh_buffer buffer, uint32_t data);
+ int ssh_buffer_add_u64(ssh_buffer buffer, uint64_t data);
++ssize_t ssh_buffer_add_func(ssh_buffer buffer, ssh_add_func f, size_t max_bytes,
++			    void *userdata);
+ 
+ int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len);
+ 
+diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h
+index 669a0a96..b6a93ac7 100644
+--- a/include/libssh/libssh.h
++++ b/include/libssh/libssh.h
+@@ -402,6 +402,7 @@ enum ssh_options_e {
+   SSH_OPTIONS_GSSAPI_AUTH,
+   SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
+   SSH_OPTIONS_NODELAY,
++  SSH_OPTIONS_CCALGO,
+   SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
+   SSH_OPTIONS_PROCESS_CONFIG,
+   SSH_OPTIONS_REKEY_DATA,
+@@ -833,6 +834,7 @@ LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
+ LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
+ 
+ LIBSSH_API ssh_buffer ssh_buffer_new(void);
++LIBSSH_API ssh_buffer ssh_buffer_new_size(uint32_t size, uint32_t headroom);
+ LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
+ #define SSH_BUFFER_FREE(x) \
+     do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
+@@ -843,6 +845,8 @@ LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
+ LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
+ LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message);
+ 
++typedef ssize_t (*ssh_add_func) (void *ptr, size_t max_bytes, void *userdata);
++
+ #ifndef LIBSSH_LEGACY_0_4
+ #include "libssh/legacy.h"
+ #endif
+diff --git a/include/libssh/session.h b/include/libssh/session.h
+index 97936195..e4a7f80c 100644
+--- a/include/libssh/session.h
++++ b/include/libssh/session.h
+@@ -258,6 +258,7 @@ struct ssh_session_struct {
+         int flags;
+         int exp_flags;
+         int nodelay;
++        char *ccalgo;
+         bool config_processed;
+         uint8_t options_seen[SOC_MAX];
+         uint64_t rekey_data;
+diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
+index c713466e..e27fe326 100644
+--- a/include/libssh/sftp.h
++++ b/include/libssh/sftp.h
+@@ -565,6 +565,10 @@ LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_
+  */
+ LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
+ 
++LIBSSH_API ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count,
++				    void *userdata, uint32_t* id);
++LIBSSH_API int sftp_async_write_end(sftp_file file, uint32_t id, int blocking);
++
+ /**
+  * @brief Seek to a specific location in a file.
+  *
+diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
+index 807313b5..86487087 100644
+--- a/src/CMakeLists.txt
++++ b/src/CMakeLists.txt
+@@ -448,6 +448,11 @@ if (BUILD_STATIC_LIB)
+   if (WIN32)
+     target_compile_definitions(ssh-static PUBLIC "LIBSSH_STATIC")
+   endif (WIN32)
++
++  install(TARGETS ssh-static
++	  EXPORT libssh-config
++	  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
++	  COMPONENT libraries)
+ endif (BUILD_STATIC_LIB)
+ 
+ message(STATUS "Threads_FOUND=${Threads_FOUND}")
+diff --git a/src/buffer.c b/src/buffer.c
+index 8991e006..e0414801 100644
+--- a/src/buffer.c
++++ b/src/buffer.c
+@@ -142,6 +142,40 @@ struct ssh_buffer_struct *ssh_buffer_new(void)
+     return buf;
+ }
+ 
++/**
++ * @brief Create a new SSH buffer with a specified size and headroom.
++ *
++ * @param[in] len       length for newly initialized SSH buffer.
++ * @param[in] headroom  length for headroom
++ * @return A newly initialized SSH buffer, NULL on error.
++ */
++struct ssh_buffer_struct *ssh_buffer_new_size(uint32_t len, uint32_t headroom)
++{
++    struct ssh_buffer_struct *buf = NULL;
++    int rc;
++
++    if (len < headroom)
++	    return NULL;
++
++    buf = calloc(1, sizeof(struct ssh_buffer_struct));
++    if (buf == NULL) {
++        return NULL;
++    }
++
++    rc = ssh_buffer_allocate_size(buf, len);
++    if (rc != 0) {
++        SAFE_FREE(buf);
++        return NULL;
++    }
++
++    buf->pos += headroom;
++    buf->used += headroom;
++
++    buffer_verify(buf);
++
++    return buf;
++}
++
+ /**
+  * @brief Deallocate a SSH buffer.
+  *
+@@ -329,6 +363,49 @@ int ssh_buffer_add_data(struct ssh_buffer_struct *buffer, const void *data, uint
+     return 0;
+ }
+ 
++/**
++ * @brief Add data at the tail of a buffer by an external function
++ *
++ * @param[in]  buffer    The buffer to add data.
++ *
++ * @param[in]  f         function that adds data to the buffer.
++ *
++ * @param[in]  max_bytes The maximum length of the data to add.
++ *
++ * @return               actual bytes added on success, < 0 on error.
++ */
++ssize_t ssh_buffer_add_func(struct ssh_buffer_struct *buffer, ssh_add_func f,
++			    size_t max_bytes, void *userdata)
++{
++    ssize_t actual;
++
++    if (buffer == NULL) {
++        return -1;
++    }
++
++    buffer_verify(buffer);
++
++    if (buffer->used + max_bytes < max_bytes) {
++        return -1;
++    }
++
++    if (buffer->allocated < (buffer->used + max_bytes)) {
++        if (buffer->pos > 0) {
++            buffer_shift(buffer);
++        }
++        if (realloc_buffer(buffer, buffer->used + max_bytes) < 0) {
++            return -1;
++        }
++    }
++
++    if ((actual = f(buffer->data + buffer->used, max_bytes, userdata)) < 0)
++      return -1;
++
++    buffer->used += actual;
++    buffer_verify(buffer);
++    return actual;
++}
++
+ /**
+  * @brief Ensure the buffer has at least a certain preallocated size.
+  *
+diff --git a/src/connect.c b/src/connect.c
+index 15cae644..e7520f40 100644
+--- a/src/connect.c
++++ b/src/connect.c
+@@ -156,6 +156,20 @@ static int set_tcp_nodelay(socket_t socket)
+                       sizeof(opt));
+ }
+ 
++static int set_tcp_ccalgo(socket_t socket, const char *ccalgo)
++{
++#ifdef HAVE_TCP_CONGESTION
++	return setsockopt(socket,
++			  IPPROTO_TCP,
++			  TCP_CONGESTION,
++			  (void *)ccalgo,
++			  strlen(ccalgo));
++#else
++	errno = ENOTSUP;
++	return -1;
++#endif
++}
++
+ /**
+  * @internal
+  *
+@@ -256,6 +270,18 @@ socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
+             }
+         }
+ 
++        if (session->opts.ccalgo) {
++	     rc = set_tcp_ccalgo(s, session->opts.ccalgo);
++	     if (rc < 0) {
++		 ssh_set_error(session, SSH_FATAL,
++			       "Failed to set TCP_CONGESTION on socket: %s",
++			       ssh_strerror(errno, err_msg, SSH_ERRNO_MSG_MAX));
++		 ssh_connect_socket_close(s);
++		 s = -1;
++		 continue;
++	     }
++	}
++
+         errno = 0;
+         rc = connect(s, itr->ai_addr, itr->ai_addrlen);
+         if (rc == -1 && (errno != 0) && (errno != EINPROGRESS)) {
+diff --git a/src/options.c b/src/options.c
+index b3ecffe1..fb966fa1 100644
+--- a/src/options.c
++++ b/src/options.c
+@@ -217,6 +217,7 @@ int ssh_options_copy(ssh_session src, ssh_session *dest)
+     new->opts.gss_delegate_creds    = src->opts.gss_delegate_creds;
+     new->opts.flags                 = src->opts.flags;
+     new->opts.nodelay               = src->opts.nodelay;
++    new->opts.ccalgo                = src->opts.ccalgo;
+     new->opts.config_processed      = src->opts.config_processed;
+     new->common.log_verbosity       = src->common.log_verbosity;
+     new->common.callbacks           = src->common.callbacks;
+@@ -458,6 +459,10 @@ int ssh_options_set_algo(ssh_session session,
+  *                Set it to disable Nagle's Algorithm (TCP_NODELAY) on the
+  *                session socket. (int, 0=false)
+  *
++ *              - SSH_OPTIONS_CCALGO
++ *                Set it to specify TCP congestion control algorithm on the
++ *                session socket (Linux only). (int, 0=false)
++ *
+  *              - SSH_OPTIONS_PROCESS_CONFIG
+  *                Set it to false to disable automatic processing of per-user
+  *                and system-wide OpenSSH configuration files. LibSSH
+@@ -1017,6 +1022,20 @@ int ssh_options_set(ssh_session session, enum ssh_options_e type,
+                 session->opts.nodelay = (*x & 0xff) > 0 ? 1 : 0;
+             }
+             break;
++	case SSH_OPTIONS_CCALGO:
++            v = value;
++            if (v == NULL || v[0] == '\0') {
++                ssh_set_error_invalid(session);
++                return -1;
++            } else {
++                SAFE_FREE(session->opts.ccalgo);
++                session->opts.ccalgo = strdup(v);
++                if (session->opts.ccalgo == NULL) {
++                    ssh_set_error_oom(session);
++                    return -1;
++                }
++            }
++            break;
+         case SSH_OPTIONS_PROCESS_CONFIG:
+             if (value == NULL) {
+                 ssh_set_error_invalid(session);
+diff --git a/src/session.c b/src/session.c
+index 8c509699..88602b6a 100644
+--- a/src/session.c
++++ b/src/session.c
+@@ -108,6 +108,7 @@ ssh_session ssh_new(void)
+     session->opts.fd = -1;
+     session->opts.compressionlevel = 7;
+     session->opts.nodelay = 0;
++    session->opts.ccalgo = NULL;
+ 
+     session->opts.flags = SSH_OPT_FLAG_PASSWORD_AUTH |
+                           SSH_OPT_FLAG_PUBKEY_AUTH |
+diff --git a/src/sftp.c b/src/sftp.c
+index e01012a8..702623a0 100644
+--- a/src/sftp.c
++++ b/src/sftp.c
+@@ -2228,6 +2228,132 @@ ssize_t sftp_write(sftp_file file, const void *buf, size_t count) {
+   return -1; /* not reached */
+ }
+ 
++/*
++ * sftp_async_write is based on and sftp_async_write_end is copied from
++ * https://github.com/limes-datentechnik-gmbh/libssh
++ *
++ * sftp_async_write has some optimizations:
++ * - use ssh_buffer_new_size() to reduce realoc_buffer.
++ * - use ssh_buffer_add_func() to avoid memcpy from read buffer to ssh buffer.
++ */
++ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count, void *userdata,
++			 uint32_t* id) {
++  sftp_session sftp = file->sftp;
++  ssh_buffer buffer;
++  uint32_t buf_sz;
++  ssize_t actual;
++  int len;
++  int packetlen;
++  int rc;
++
++#define HEADROOM 16
++  /* sftp_packet_write() prepends a 5-bytes (uint32_t length and
++   * 1-byte type) header to the head of the payload by
++   * ssh_buffer_prepend_data(). Inserting headroom by
++   * ssh_buffer_new_size() eliminates memcpy for prepending the
++   * header.
++   */
++
++  buf_sz = (HEADROOM + /* for header */
++	    sizeof(uint32_t) + /* id */
++	    ssh_string_len(file->handle) + 4 + /* file->handle */
++	    sizeof(uint64_t) + /* file->offset */
++	    sizeof(uint32_t) + /* count */
++	    count); /* datastring */
++
++  buffer = ssh_buffer_new_size(buf_sz, HEADROOM);
++  if (buffer == NULL) {
++    ssh_set_error_oom(sftp->session);
++    return -1;
++  }
++
++  *id = sftp_get_new_id(file->sftp);
++
++  rc = ssh_buffer_pack(buffer,
++                       "dSqd",
++                       *id,
++                       file->handle,
++                       file->offset,
++                       count); /* len of datastring */
++
++  if (rc != SSH_OK){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++
++  actual = ssh_buffer_add_func(buffer, f, count, userdata);
++  if (actual < 0){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++
++  packetlen=ssh_buffer_get_len(buffer)+5;
++  len = sftp_packet_write(file->sftp, SSH_FXP_WRITE, buffer);
++  ssh_buffer_free(buffer);
++  if (len < 0) {
++    return SSH_ERROR;
++  } else  if (len != packetlen) {
++    ssh_set_error(sftp->session, SSH_FATAL,
++      "Could only send %d of %d bytes to remote host!", len, packetlen);
++    SSH_LOG(SSH_LOG_PACKET,
++        "Could not write as much data as expected");
++    return SSH_ERROR;
++  }
++
++  file->offset += actual;
++
++  return actual;
++}
++
++int sftp_async_write_end(sftp_file file, uint32_t id, int blocking) {
++  sftp_session sftp = file->sftp;
++  sftp_message msg = NULL;
++  sftp_status_message status;
++
++  msg = sftp_dequeue(sftp, id);
++  while (msg == NULL) {
++    if (!blocking && ssh_channel_poll(sftp->channel, 0) == 0) {
++      /* we cannot block */
++      return SSH_AGAIN;
++    }
++    if (sftp_read_and_dispatch(sftp) < 0) {
++      /* something nasty has happened */
++      return SSH_ERROR;
++    }
++    msg = sftp_dequeue(sftp, id);
++  }
++
++  switch (msg->packet_type) {
++    case SSH_FXP_STATUS:
++      status = parse_status_msg(msg);
++      sftp_message_free(msg);
++      if (status == NULL) {
++        return SSH_ERROR;
++      }
++      sftp_set_error(sftp, status->status);
++      switch (status->status) {
++        case SSH_FX_OK:
++          status_msg_free(status);
++          return SSH_OK;
++        default:
++          break;
++      }
++      ssh_set_error(sftp->session, SSH_REQUEST_DENIED,
++          "SFTP server: %s", status->errormsg);
++      status_msg_free(status);
++      return SSH_ERROR;
++    default:
++      ssh_set_error(sftp->session, SSH_FATAL,
++          "Received message %d during write!", msg->packet_type);
++      sftp_message_free(msg);
++      return SSH_ERROR;
++  }
++
++  return SSH_ERROR; /* not reached */
++}
++
+ /* Seek to a specific location in a file. */
+ int sftp_seek(sftp_file file, uint32_t new_offset) {
+   if (file == NULL) {

patch/libssh-0.10.6.patch

@@ -0,0 +1,442 @@
+diff --git a/ConfigureChecks.cmake b/ConfigureChecks.cmake
+index 9de10225..0f3d20ed 100644
+--- a/ConfigureChecks.cmake
++++ b/ConfigureChecks.cmake
+@@ -258,6 +258,7 @@ if (UNIX)
+     check_library_exists(util forkpty "" HAVE_LIBUTIL)
+     check_function_exists(cfmakeraw HAVE_CFMAKERAW)
+     check_function_exists(__strtoull HAVE___STRTOULL)
++    check_symbol_exists(TCP_CONGESTION "netinet/tcp.h" HAVE_TCP_CONGESTION)
+ endif (UNIX)
+ 
+ set(LIBSSH_REQUIRED_LIBRARIES ${_REQUIRED_LIBRARIES} CACHE INTERNAL "libssh required system libraries")
+diff --git a/config.h.cmake b/config.h.cmake
+index cc83734d..f74cd03b 100644
+--- a/config.h.cmake
++++ b/config.h.cmake
+@@ -237,6 +237,8 @@
+ 
+ #cmakedefine HAVE_GCC_BOUNDED_ATTRIBUTE 1
+ 
++#cmakedefine HAVE_TCP_CONGESTION 1
++
+ /* Define to 1 if you want to enable GSSAPI */
+ #cmakedefine WITH_GSSAPI 1
+ 
+diff --git a/include/libssh/buffer.h b/include/libssh/buffer.h
+index 1fce7b76..b64d1455 100644
+--- a/include/libssh/buffer.h
++++ b/include/libssh/buffer.h
+@@ -37,6 +37,8 @@ int ssh_buffer_add_u8(ssh_buffer buffer, uint8_t data);
+ int ssh_buffer_add_u16(ssh_buffer buffer, uint16_t data);
+ int ssh_buffer_add_u32(ssh_buffer buffer, uint32_t data);
+ int ssh_buffer_add_u64(ssh_buffer buffer, uint64_t data);
++ssize_t ssh_buffer_add_func(ssh_buffer buffer, ssh_add_func f, size_t max_bytes,
++			    void *userdata);
+ 
+ int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len);
+ 
+diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h
+index 669a0a96..b6a93ac7 100644
+--- a/include/libssh/libssh.h
++++ b/include/libssh/libssh.h
+@@ -402,6 +402,7 @@ enum ssh_options_e {
+   SSH_OPTIONS_GSSAPI_AUTH,
+   SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
+   SSH_OPTIONS_NODELAY,
++  SSH_OPTIONS_CCALGO,
+   SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
+   SSH_OPTIONS_PROCESS_CONFIG,
+   SSH_OPTIONS_REKEY_DATA,
+@@ -833,6 +834,7 @@ LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
+ LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
+ 
+ LIBSSH_API ssh_buffer ssh_buffer_new(void);
++LIBSSH_API ssh_buffer ssh_buffer_new_size(uint32_t size, uint32_t headroom);
+ LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
+ #define SSH_BUFFER_FREE(x) \
+     do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
+@@ -843,6 +845,8 @@ LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
+ LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
+ LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message);
+ 
++typedef ssize_t (*ssh_add_func) (void *ptr, size_t max_bytes, void *userdata);
++
+ #ifndef LIBSSH_LEGACY_0_4
+ #include "libssh/legacy.h"
+ #endif
+diff --git a/include/libssh/session.h b/include/libssh/session.h
+index 97936195..e4a7f80c 100644
+--- a/include/libssh/session.h
++++ b/include/libssh/session.h
+@@ -258,6 +258,7 @@ struct ssh_session_struct {
+         int flags;
+         int exp_flags;
+         int nodelay;
++        char *ccalgo;
+         bool config_processed;
+         uint8_t options_seen[SOC_MAX];
+         uint64_t rekey_data;
+diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
+index c713466e..e27fe326 100644
+--- a/include/libssh/sftp.h
++++ b/include/libssh/sftp.h
+@@ -565,6 +565,10 @@ LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_
+  */
+ LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
+ 
++LIBSSH_API ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count,
++				    void *userdata, uint32_t* id);
++LIBSSH_API int sftp_async_write_end(sftp_file file, uint32_t id, int blocking);
++
+ /**
+  * @brief Seek to a specific location in a file.
+  *
+diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
+index 807313b5..86487087 100644
+--- a/src/CMakeLists.txt
++++ b/src/CMakeLists.txt
+@@ -448,6 +448,11 @@ if (BUILD_STATIC_LIB)
+   if (WIN32)
+     target_compile_definitions(ssh-static PUBLIC "LIBSSH_STATIC")
+   endif (WIN32)
++
++  install(TARGETS ssh-static
++	  EXPORT libssh-config
++	  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
++	  COMPONENT libraries)
+ endif (BUILD_STATIC_LIB)
+ 
+ message(STATUS "Threads_FOUND=${Threads_FOUND}")
+diff --git a/src/buffer.c b/src/buffer.c
+index 8991e006..e0414801 100644
+--- a/src/buffer.c
++++ b/src/buffer.c
+@@ -142,6 +142,40 @@ struct ssh_buffer_struct *ssh_buffer_new(void)
+     return buf;
+ }
+ 
++/**
++ * @brief Create a new SSH buffer with a specified size and headroom.
++ *
++ * @param[in] len       length for newly initialized SSH buffer.
++ * @param[in] headroom  length for headroom
++ * @return A newly initialized SSH buffer, NULL on error.
++ */
++struct ssh_buffer_struct *ssh_buffer_new_size(uint32_t len, uint32_t headroom)
++{
++    struct ssh_buffer_struct *buf = NULL;
++    int rc;
++
++    if (len < headroom)
++	    return NULL;
++
++    buf = calloc(1, sizeof(struct ssh_buffer_struct));
++    if (buf == NULL) {
++        return NULL;
++    }
++
++    rc = ssh_buffer_allocate_size(buf, len);
++    if (rc != 0) {
++        SAFE_FREE(buf);
++        return NULL;
++    }
++
++    buf->pos += headroom;
++    buf->used += headroom;
++
++    buffer_verify(buf);
++
++    return buf;
++}
++
+ /**
+  * @brief Deallocate a SSH buffer.
+  *
+@@ -329,6 +363,49 @@ int ssh_buffer_add_data(struct ssh_buffer_struct *buffer, const void *data, uint
+     return 0;
+ }
+ 
++/**
++ * @brief Add data at the tail of a buffer by an external function
++ *
++ * @param[in]  buffer    The buffer to add data.
++ *
++ * @param[in]  f         function that adds data to the buffer.
++ *
++ * @param[in]  max_bytes The maximum length of the data to add.
++ *
++ * @return               actual bytes added on success, < 0 on error.
++ */
++ssize_t ssh_buffer_add_func(struct ssh_buffer_struct *buffer, ssh_add_func f,
++			    size_t max_bytes, void *userdata)
++{
++    ssize_t actual;
++
++    if (buffer == NULL) {
++        return -1;
++    }
++
++    buffer_verify(buffer);
++
++    if (buffer->used + max_bytes < max_bytes) {
++        return -1;
++    }
++
++    if (buffer->allocated < (buffer->used + max_bytes)) {
++        if (buffer->pos > 0) {
++            buffer_shift(buffer);
++        }
++        if (realloc_buffer(buffer, buffer->used + max_bytes) < 0) {
++            return -1;
++        }
++    }
++
++    if ((actual = f(buffer->data + buffer->used, max_bytes, userdata)) < 0)
++      return -1;
++
++    buffer->used += actual;
++    buffer_verify(buffer);
++    return actual;
++}
++
+ /**
+  * @brief Ensure the buffer has at least a certain preallocated size.
+  *
+diff --git a/src/connect.c b/src/connect.c
+index 15cae644..e7520f40 100644
+--- a/src/connect.c
++++ b/src/connect.c
+@@ -156,6 +156,20 @@ static int set_tcp_nodelay(socket_t socket)
+                       sizeof(opt));
+ }
+ 
++static int set_tcp_ccalgo(socket_t socket, const char *ccalgo)
++{
++#ifdef HAVE_TCP_CONGESTION
++	return setsockopt(socket,
++			  IPPROTO_TCP,
++			  TCP_CONGESTION,
++			  (void *)ccalgo,
++			  strlen(ccalgo));
++#else
++	errno = ENOTSUP;
++	return -1;
++#endif
++}
++
+ /**
+  * @internal
+  *
+@@ -256,6 +270,18 @@ socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
+             }
+         }
+ 
++        if (session->opts.ccalgo) {
++	     rc = set_tcp_ccalgo(s, session->opts.ccalgo);
++	     if (rc < 0) {
++		 ssh_set_error(session, SSH_FATAL,
++			       "Failed to set TCP_CONGESTION on socket: %s",
++			       ssh_strerror(errno, err_msg, SSH_ERRNO_MSG_MAX));
++		 ssh_connect_socket_close(s);
++		 s = -1;
++		 continue;
++	     }
++	}
++
+         errno = 0;
+         rc = connect(s, itr->ai_addr, itr->ai_addrlen);
+         if (rc == -1 && (errno != 0) && (errno != EINPROGRESS)) {
+diff --git a/src/options.c b/src/options.c
+index 38511455..a183605d 100644
+--- a/src/options.c
++++ b/src/options.c
+@@ -217,6 +217,7 @@ int ssh_options_copy(ssh_session src, ssh_session *dest)
+     new->opts.gss_delegate_creds    = src->opts.gss_delegate_creds;
+     new->opts.flags                 = src->opts.flags;
+     new->opts.nodelay               = src->opts.nodelay;
++    new->opts.ccalgo                = src->opts.ccalgo;
+     new->opts.config_processed      = src->opts.config_processed;
+     new->common.log_verbosity       = src->common.log_verbosity;
+     new->common.callbacks           = src->common.callbacks;
+@@ -458,6 +459,10 @@ int ssh_options_set_algo(ssh_session session,
+  *                Set it to disable Nagle's Algorithm (TCP_NODELAY) on the
+  *                session socket. (int, 0=false)
+  *
++ *              - SSH_OPTIONS_CCALGO
++ *                Set it to specify TCP congestion control algorithm on the
++ *                session socket (Linux only). (int, 0=false)
++ *
+  *              - SSH_OPTIONS_PROCESS_CONFIG
+  *                Set it to false to disable automatic processing of per-user
+  *                and system-wide OpenSSH configuration files. LibSSH
+@@ -1023,6 +1028,20 @@ int ssh_options_set(ssh_session session, enum ssh_options_e type,
+                 session->opts.nodelay = (*x & 0xff) > 0 ? 1 : 0;
+             }
+             break;
++	case SSH_OPTIONS_CCALGO:
++            v = value;
++            if (v == NULL || v[0] == '\0') {
++                ssh_set_error_invalid(session);
++                return -1;
++            } else {
++                SAFE_FREE(session->opts.ccalgo);
++                session->opts.ccalgo = strdup(v);
++                if (session->opts.ccalgo == NULL) {
++                    ssh_set_error_oom(session);
++                    return -1;
++                }
++            }
++            break;
+         case SSH_OPTIONS_PROCESS_CONFIG:
+             if (value == NULL) {
+                 ssh_set_error_invalid(session);
+diff --git a/src/session.c b/src/session.c
+index 8c509699..88602b6a 100644
+--- a/src/session.c
++++ b/src/session.c
+@@ -108,6 +108,7 @@ ssh_session ssh_new(void)
+     session->opts.fd = -1;
+     session->opts.compressionlevel = 7;
+     session->opts.nodelay = 0;
++    session->opts.ccalgo = NULL;
+ 
+     session->opts.flags = SSH_OPT_FLAG_PASSWORD_AUTH |
+                           SSH_OPT_FLAG_PUBKEY_AUTH |
+diff --git a/src/sftp.c b/src/sftp.c
+index e01012a8..702623a0 100644
+--- a/src/sftp.c
++++ b/src/sftp.c
+@@ -2228,6 +2228,132 @@ ssize_t sftp_write(sftp_file file, const void *buf, size_t count) {
+   return -1; /* not reached */
+ }
+ 
++/*
++ * sftp_async_write is based on and sftp_async_write_end is copied from
++ * https://github.com/limes-datentechnik-gmbh/libssh
++ *
++ * sftp_async_write has some optimizations:
++ * - use ssh_buffer_new_size() to reduce realoc_buffer.
++ * - use ssh_buffer_add_func() to avoid memcpy from read buffer to ssh buffer.
++ */
++ssize_t sftp_async_write(sftp_file file, ssh_add_func f, size_t count, void *userdata,
++			 uint32_t* id) {
++  sftp_session sftp = file->sftp;
++  ssh_buffer buffer;
++  uint32_t buf_sz;
++  ssize_t actual;
++  int len;
++  int packetlen;
++  int rc;
++
++#define HEADROOM 16
++  /* sftp_packet_write() prepends a 5-bytes (uint32_t length and
++   * 1-byte type) header to the head of the payload by
++   * ssh_buffer_prepend_data(). Inserting headroom by
++   * ssh_buffer_new_size() eliminates memcpy for prepending the
++   * header.
++   */
++
++  buf_sz = (HEADROOM + /* for header */
++	    sizeof(uint32_t) + /* id */
++	    ssh_string_len(file->handle) + 4 + /* file->handle */
++	    sizeof(uint64_t) + /* file->offset */
++	    sizeof(uint32_t) + /* count */
++	    count); /* datastring */
++
++  buffer = ssh_buffer_new_size(buf_sz, HEADROOM);
++  if (buffer == NULL) {
++    ssh_set_error_oom(sftp->session);
++    return -1;
++  }
++
++  *id = sftp_get_new_id(file->sftp);
++
++  rc = ssh_buffer_pack(buffer,
++                       "dSqd",
++                       *id,
++                       file->handle,
++                       file->offset,
++                       count); /* len of datastring */
++
++  if (rc != SSH_OK){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++
++  actual = ssh_buffer_add_func(buffer, f, count, userdata);
++  if (actual < 0){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++
++  packetlen=ssh_buffer_get_len(buffer)+5;
++  len = sftp_packet_write(file->sftp, SSH_FXP_WRITE, buffer);
++  ssh_buffer_free(buffer);
++  if (len < 0) {
++    return SSH_ERROR;
++  } else  if (len != packetlen) {
++    ssh_set_error(sftp->session, SSH_FATAL,
++      "Could only send %d of %d bytes to remote host!", len, packetlen);
++    SSH_LOG(SSH_LOG_PACKET,
++        "Could not write as much data as expected");
++    return SSH_ERROR;
++  }
++
++  file->offset += actual;
++
++  return actual;
++}
++
++int sftp_async_write_end(sftp_file file, uint32_t id, int blocking) {
++  sftp_session sftp = file->sftp;
++  sftp_message msg = NULL;
++  sftp_status_message status;
++
++  msg = sftp_dequeue(sftp, id);
++  while (msg == NULL) {
++    if (!blocking && ssh_channel_poll(sftp->channel, 0) == 0) {
++      /* we cannot block */
++      return SSH_AGAIN;
++    }
++    if (sftp_read_and_dispatch(sftp) < 0) {
++      /* something nasty has happened */
++      return SSH_ERROR;
++    }
++    msg = sftp_dequeue(sftp, id);
++  }
++
++  switch (msg->packet_type) {
++    case SSH_FXP_STATUS:
++      status = parse_status_msg(msg);
++      sftp_message_free(msg);
++      if (status == NULL) {
++        return SSH_ERROR;
++      }
++      sftp_set_error(sftp, status->status);
++      switch (status->status) {
++        case SSH_FX_OK:
++          status_msg_free(status);
++          return SSH_OK;
++        default:
++          break;
++      }
++      ssh_set_error(sftp->session, SSH_REQUEST_DENIED,
++          "SFTP server: %s", status->errormsg);
++      status_msg_free(status);
++      return SSH_ERROR;
++    default:
++      ssh_set_error(sftp->session, SSH_FATAL,
++          "Received message %d during write!", msg->packet_type);
++      sftp_message_free(msg);
++      return SSH_ERROR;
++  }
++
++  return SSH_ERROR; /* not reached */
++}
++
+ /* Seek to a specific location in a file. */
+ int sftp_seek(sftp_file file, uint32_t new_offset) {
+   if (file == NULL) {

patch/libssh-0.9.6.patch

@@ -0,0 +1,164 @@
+diff --git a/DefineOptions.cmake b/DefineOptions.cmake
+index b82a5018..f1f2ab9d 100644
+--- a/DefineOptions.cmake
++++ b/DefineOptions.cmake
+@@ -15,13 +15,14 @@ option(UNIT_TESTING "Build with unit tests" OFF)
+ option(CLIENT_TESTING "Build with client tests; requires openssh" OFF)
+ option(SERVER_TESTING "Build with server tests; requires openssh and dropbear" OFF)
+ option(WITH_BENCHMARKS "Build benchmarks tools" OFF)
+-option(WITH_EXAMPLES "Build examples" ON)
++option(WITH_EXAMPLES "Build examples" OFF)
+ option(WITH_NACL "Build with libnacl (curve25519)" ON)
+ option(WITH_SYMBOL_VERSIONING "Build with symbol versioning" ON)
+ option(WITH_ABI_BREAK "Allow ABI break" OFF)
+ option(WITH_GEX "Enable DH Group exchange mechanisms" ON)
+ option(FUZZ_TESTING "Build with fuzzer for the server" OFF)
+ option(PICKY_DEVELOPER "Build with picky developer flags" OFF)
++option(WITH_STATIC_LIB "Build static library" ON)
+ 
+ if (WITH_ZLIB)
+     set(WITH_LIBZ ON)
+@@ -53,3 +54,7 @@ endif (NOT GLOBAL_BIND_CONFIG)
+ if (NOT GLOBAL_CLIENT_CONFIG)
+   set(GLOBAL_CLIENT_CONFIG "/etc/ssh/ssh_config")
+ endif (NOT GLOBAL_CLIENT_CONFIG)
++
++if (WITH_STATIC_LIB)
++  set(BUILD_STATIC_LIB ON)
++endif()
+diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h
+index 8c14b21d..95ac1d6b 100644
+--- a/include/libssh/sftp.h
++++ b/include/libssh/sftp.h
+@@ -565,6 +565,9 @@ LIBSSH_API int sftp_async_read(sftp_file file, void *data, uint32_t len, uint32_
+  */
+ LIBSSH_API ssize_t sftp_write(sftp_file file, const void *buf, size_t count);
+ 
++LIBSSH_API int sftp_async_write(sftp_file file, const void *buf, size_t count, uint32_t* id);
++LIBSSH_API int sftp_async_write_end(sftp_file file, uint32_t id, int blocking);
++
+ /**
+  * @brief Seek to a specific location in a file.
+  *
+diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
+index a576cf71..303a1c7f 100644
+--- a/src/CMakeLists.txt
++++ b/src/CMakeLists.txt
+@@ -412,6 +412,10 @@ if (BUILD_STATIC_LIB)
+   if (WIN32)
+     target_compile_definitions(ssh-static PUBLIC "LIBSSH_STATIC")
+   endif (WIN32)
++  install(TARGETS ssh-static
++	EXPORT libssh-config
++	LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
++	COMPONENT libraries)
+ endif (BUILD_STATIC_LIB)
+ 
+ message(STATUS "Threads_FOUND=${Threads_FOUND}")
+diff --git a/src/sftp.c b/src/sftp.c
+index a8346040..a4261ec9 100644
+--- a/src/sftp.c
++++ b/src/sftp.c
+@@ -2234,6 +2234,102 @@ ssize_t sftp_write(sftp_file file, const void *buf, size_t count) {
+   return -1; /* not reached */
+ }
+ 
++/*
++ * sftp_async_write and sftp_async_write_end are copied from
++ * https://github.com/limes-datentechnik-gmbh/libssh
++ */
++int sftp_async_write(sftp_file file, const void *buf, size_t count, uint32_t* id) {
++  sftp_session sftp = file->sftp;
++  ssh_buffer buffer;
++  int len;
++  int packetlen;
++  int rc;
++
++  buffer = ssh_buffer_new();
++  if (buffer == NULL) {
++    ssh_set_error_oom(sftp->session);
++    return -1;
++  }
++
++  *id = sftp_get_new_id(file->sftp);
++
++  rc = ssh_buffer_pack(buffer,
++                       "dSqdP",
++                       *id,
++                       file->handle,
++                       file->offset,
++                       count, /* len of datastring */
++                       (size_t)count, buf);
++  if (rc != SSH_OK){
++    ssh_set_error_oom(sftp->session);
++    ssh_buffer_free(buffer);
++    return SSH_ERROR;
++  }
++  packetlen=ssh_buffer_get_len(buffer)+5;
++  len = sftp_packet_write(file->sftp, SSH_FXP_WRITE, buffer);
++  ssh_buffer_free(buffer);
++  if (len < 0) {
++    return SSH_ERROR;
++  } else  if (len != packetlen) {
++    ssh_set_error(sftp->session, SSH_FATAL,
++      "Could only send %d of %d bytes to remote host!", len, packetlen);
++    SSH_LOG(SSH_LOG_PACKET,
++        "Could not write as much data as expected");
++    return SSH_ERROR;
++  }
++
++  file->offset += count;
++
++  return SSH_OK;
++}
++
++int sftp_async_write_end(sftp_file file, uint32_t id, int blocking) {
++  sftp_session sftp = file->sftp;
++  sftp_message msg = NULL;
++  sftp_status_message status;
++
++  msg = sftp_dequeue(sftp, id);
++  while (msg == NULL) {
++    if (!blocking && ssh_channel_poll(sftp->channel, 0) == 0) {
++      /* we cannot block */
++      return SSH_AGAIN;
++    }
++    if (sftp_read_and_dispatch(sftp) < 0) {
++      /* something nasty has happened */
++      return SSH_ERROR;
++    }
++    msg = sftp_dequeue(sftp, id);
++  }
++
++  switch (msg->packet_type) {
++    case SSH_FXP_STATUS:
++      status = parse_status_msg(msg);
++      sftp_message_free(msg);
++      if (status == NULL) {
++        return SSH_ERROR;
++      }
++      sftp_set_error(sftp, status->status);
++      switch (status->status) {
++        case SSH_FX_OK:
++          status_msg_free(status);
++          return SSH_OK;
++        default:
++          break;
++      }
++      ssh_set_error(sftp->session, SSH_REQUEST_DENIED,
++          "SFTP server: %s", status->errormsg);
++      status_msg_free(status);
++      return SSH_ERROR;
++    default:
++      ssh_set_error(sftp->session, SSH_FATAL,
++          "Received message %d during write!", msg->packet_type);
++      sftp_message_free(msg);
++      return SSH_ERROR;
++  }
++
++  return SSH_ERROR; /* not reached */
++}
++
+ /* Seek to a specific location in a file. */
+ int sftp_seek(sftp_file file, uint32_t new_offset) {
+   if (file == NULL) {

pysetup.py

@@ -0,0 +1,37 @@
+from setuptools import setup, Extension, find_packages
+import sys
+import os
+
+mypackage_root_dir = os.path.dirname(__file__)
+with open(os.path.join(mypackage_root_dir, 'VERSION')) as version_file:
+    version = version_file.read().strip()
+
+if sys.platform == "linux":
+    libmscp = "libmscp.so"
+elif sys.platform == "darwin":
+    libmscp = "libmscp.dylib"
+
+data_dir = sys.prefix + "/lib"
+libmscp = "build/" + libmscp
+
+setup(
+    name='mscp',
+    version = version,
+    description = "libmscp python binding",
+    author = "Ryo Nakamura",
+    author_email = "upa@haeena.net",
+    url = "https://github.com/upa/mscp",
+    packages = find_packages("mscp"),
+    package_dir = {"": "mscp"},
+    data_files = [ (data_dir, [libmscp])],
+    py_modules = [ "mscp" ],
+    ext_modules = [
+        Extension(
+            'pymscp',
+            ['src/pymscp.c'],
+            library_dirs = ['build'],
+            libraries = ['mscp'],
+            include_dirs = ['include']
+        )
+    ]
+)

scripts/install-build-deps.sh

@@ -19,7 +19,7 @@ case $platform in
 		apt-get install -y \
 			gcc make cmake zlib1g-dev libssl-dev libkrb5-dev
 		;;
-	Linux-centos* | Linux-rhel* | Linux-rocky*)
+	Linux-centos* | Linux-rhel* | Linux-rocky* | Linux-almalinux)
 		yum install -y \
 			gcc make cmake zlib-devel openssl-devel rpm-build
 		;;

scripts/print-install-deps.sh

@@ -14,10 +14,10 @@ case $release in
 	ubuntu-22.04*)
 		echo "libc6 (>= 2.33), libgssapi-krb5-2 (>= 1.17), libssl3 (>= 3.0.0~~alpha1), zlib1g (>= 1:1.1.4)"
 		;;
-	centos* | rhel* | rocky*)
+	centos* | rhel* | rocky* | almalinux*)
 		echo "glibc crypto-policies krb5-libs openssl-libs libcom_err"
 		;;
 	*)
-		echo "unsupported install dependency: $release"
+		echo "$(basename $0): unsupported install dependency: $release"
 		exit 1
 esac

scripts/test-in-container.sh

@@ -11,7 +11,10 @@ set -x
 # Run sshd
 if [ ! -e /var/run/sshd.pid ]; then
 	/usr/sbin/sshd
+	sleep 1
 fi
 
+ssh-keyscan localhost >> ${HOME}/.ssh/known_hosts
+
 # Run test
 python3 -m pytest ../test -v

src/atomic.h

@@ -1,9 +1,12 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #ifndef _ATOMIC_H_
 #define _ATOMIC_H_
 
 #include <stdlib.h>
+#include <assert.h>
 #include <pthread.h>
-#include <util.h>
+
+#include <message.h>
 
 typedef int refcnt;
 
@@ -18,6 +21,8 @@ static inline refcnt refcnt_dec(refcnt *cnt)
 }
 
 
+/* mutex */
+
 typedef pthread_mutex_t lock;
 
 static inline void lock_init(lock *l)
@@ -28,31 +33,72 @@ static inline void lock_init(lock *l)
 static inline void lock_acquire(lock *l)
 {
 	int ret = pthread_mutex_lock(l);
-	if (ret < 0) {
-		switch (ret) {
-		case EINVAL:
-			pr_err("invalid mutex\n");
-			exit(1);
-		case EDEADLK:
-			pr_err("a deadlock would occur\n");
-			exit(1);
-		}
-	}
+	assert(ret == 0);
 }
 
 static inline void lock_release(lock *l)
 {
 	int ret = pthread_mutex_unlock(l);
-	if (ret < 0) {
-		switch (ret) {
-		case EINVAL:
-			pr_err("invalid mutex\n");
-			exit(1);
-		case EPERM:
-			pr_err("this thread does not hold this mutex\n");
-			exit(1);
-		}
-	}
+	assert(ret == 0);
 }
 
+static inline void lock_release_via_cleanup(void *l)
+{
+	lock_release(l);
+}
+
+#define LOCK_ACQUIRE(l)						\
+	lock_acquire(l);					\
+	pthread_cleanup_push(lock_release_via_cleanup, l)
+
+#define LOCK_RELEASE()				\
+	pthread_cleanup_pop(1)
+
+
+
+/* read/write lock */
+typedef pthread_rwlock_t rwlock;
+
+static inline void rwlock_init(rwlock *rw)
+{
+	pthread_rwlock_init(rw, NULL);
+}
+
+static inline void rwlock_read_acquire(rwlock *rw)
+{
+	int ret = pthread_rwlock_rdlock(rw);
+	assert(ret == 0);
+}
+
+static inline void rwlock_write_acquire(rwlock *rw)
+{
+	int ret = pthread_rwlock_wrlock(rw);
+	assert(ret == 0);
+}
+
+static inline void rwlock_release(rwlock *rw)
+{
+	int ret = pthread_rwlock_unlock(rw);
+	assert(ret == 0);
+}
+
+static inline void rwlock_release_via_cleanup(void *rw)
+{
+	rwlock_release(rw);
+}
+
+#define RWLOCK_READ_ACQUIRE(rw)						\
+	rwlock_read_acquire(rw);					\
+	pthread_cleanup_push(rwlock_release_via_cleanup, rw)
+
+#define RWLOCK_WRITE_ACQUIRE(rw)					\
+	rwlock_write_acquire(rw);					\
+	pthread_cleanup_push(rwlock_release_via_cleanup, rw)
+
+
+#define RWLOCK_RELEASE()			\
+	pthread_cleanup_pop(1)
+
+
+
 #endif /* _ATOMIC_H_ */

src/file.c

@@ -1,960 +0,0 @@
-#include <stdlib.h>
-#include <stdbool.h>
-#include <sys/stat.h>
-#include <dirent.h>
-#include <fcntl.h>
-#include <libgen.h>
-
-#include <ssh.h>
-#include <util.h>
-#include <file.h>
-#include <pprint.h>
-#include <platform.h>
-
-bool file_has_hostname(char *path)
-{
-	char *p;
-
-	p = strchr(path, ':');
-	if (p) {
-		if (p == path || ((p > path) && *(p - 1) == '\\'))
-			return false; /* first byte is colon or escaped colon, skip */
-		else
-			return true;
-	}
-
-	return false;
-}
-
-char *file_find_hostname(char *path)
-{
-	char *dup, *p;
-
-	dup = strdup(path);
-	if (!dup) {
-		pr_err("%s", strerrno());
-		return NULL;
-	}
-
-	p = strchr(dup, ':');
-	if (p) {
-		if (p == dup || ((p > dup) && *(p - 1) == '\\')) {
-			/* first byte is colon or escaped colon, skip */
-			free(dup);
-		} else {
-			/* handle this as remote hostname (with username) */
-			*p = '\0';
-			return dup;
-		}
-	}
-
-	return NULL;
-}
-
-static char *file_find_path(char *path)
-{
-	char *p;
-
-	p = strchr(path, ':');
-	if (p) {
-		if (p == path || ((p > path) && *(p - 1) == '\\')) {
-			/* first byte is colon or escaped colon, skip */
-			return path;
-		} else {
-			return p + 1;
-		}
-	}
-
-	return path;
-}
-
-/* return 1 when path is directory, 0 is not directory, and -1 on error */
-static int file_is_directory(char *path, sftp_session sftp, bool print_error)
-{
-	int ret = 0;
-
-	if (sftp) {
-		char *remote_path = file_find_path(path);
-		sftp_attributes attr;
-
-		char *p = *remote_path == '\0' ? "." : remote_path;
-		attr = sftp_stat(sftp, p);
-		if (!attr) {
-			if (print_error)
-				pr_err("sftp_stat %s: %s\n",
-				       path, sftp_get_ssh_error(sftp));
-			ret = -1;
-		} else if (attr->type == SSH_FILEXFER_TYPE_DIRECTORY)
-			ret = 1;
-		sftp_attributes_free(attr);
-	} else {
-		struct stat statbuf;
-		if (stat(path, &statbuf) < 0) {
-			if (print_error)
-				pr_err("stat %s: %s\n", path, strerrno());
-			ret = -1;
-		} else if (S_ISDIR(statbuf.st_mode))
-			ret = 1;
-	}
-
-	return ret;
-}
-
-/* return 1 when directory exists, 0 not exists, and -1 on error */
-int file_directory_exists(char *path, sftp_session sftp)
-{
-	int ret = 0;
-
-	if (sftp) {
-		sftp_attributes attr;
-		attr = sftp_stat(sftp, path);
-		if (!attr) {
-			if (sftp_get_error(sftp) == SSH_FX_NO_SUCH_PATH ||
-			    sftp_get_error(sftp) == SSH_FX_NO_SUCH_FILE)
-				ret = 0;
-			else {
-				pr_err("%s: %s\n", path, sftp_get_ssh_error(sftp));
-				ret = -1;
-			}
-		} else if (attr->type == SSH_FILEXFER_TYPE_DIRECTORY)
-			ret = 1;
-		sftp_attributes_free(attr);
-	} else {
-		struct stat statbuf;
-		if (stat(path, &statbuf) < 0) {
-			if (errno == ENOENT)
-				ret = 0;
-			else {
-				pr_err("%s: %s\n", path, strerrno());
-				ret = -1;
-			}
-		} else if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
-			ret = 1;
-	}
-
-	return ret;
-}
-
-static struct file *file_alloc(char *src_path, size_t size, bool src_is_remote)
-{
-	struct file *f;
-
-	f = malloc(sizeof(*f));
-	if (!f) {
-		pr_err("%s\n", strerrno());
-		return NULL;
-	}
-	memset(f, 0, sizeof(*f));
-
-	strncpy(f->src_path, src_path, PATH_MAX - 1);
-	f->size = size;
-	f->src_is_remote = src_is_remote;
-	f->dst_is_remote = !src_is_remote;
-	lock_init(&f->lock);
-
-	return f;
-}
-
-static bool check_file_should_skip(char *path)
-{
-	int len = strlen(path);
-	if ((len == 1 && strncmp(path, ".", 1) == 0) ||
-	    (len == 2 && strncmp(path, "..", 2) == 0)) {
-		return true;
-	}
-	return false;
-}
-
-
-/* return -1 when error, 0 when should skip, and 1 when should be copied  */
-static int check_file_tobe_copied(char *path, sftp_session sftp, size_t *size)
-{
-	struct stat statbuf;
-	sftp_attributes attr;
-	int ret = 0;
-
-	if (!sftp) {
-		/* local */
-		if (stat(path, &statbuf) < 0) {
-			pr_err("stat %s: %s\n", path, strerrno());
-			return -1;
-		}
-		if (S_ISREG(statbuf.st_mode)) {
-			*size = statbuf.st_size;
-			return 1;
-		}
-		return 0;
-	}
-
-	/* remote */
-	attr = sftp_stat(sftp, path);
-	if (!attr) {
-		pr_err("sftp_stat %s: %s\n", path, sftp_get_ssh_error(sftp));
-		return -1;
-	}
-	if (attr->type == SSH_FILEXFER_TYPE_REGULAR ||
-	    attr->type == SSH_FILEXFER_TYPE_SYMLINK) {
-		*size = attr->size;
-		ret = 1;
-	}
-
-	sftp_attributes_free(attr);
-
-	return ret;
-}
-
-static int check_pathlen(const char *src, const char *dst)
-{
-	if ((strlen(src) + strlen(dst) + 1) > PATH_MAX) {
-		pr_err("too long path: %s/%s\n", src, dst);
-		return -1;
-	}
-	return 0;
-}
-
-static int file_fill_recursive(struct list_head *file_list,
-			       bool dst_is_remote, sftp_session sftp, char *src_path,
-			       char *rel_path, char *dst_path,
-			       bool dst_should_dir, bool replace_dir_name)
-{
-	char next_src_path[PATH_MAX], next_rel_path[PATH_MAX];
-	struct file *f;
-	size_t size;
-	int ret;
-
-	ret = file_is_directory(src_path, dst_is_remote ? NULL : sftp, true);
-	if (ret < 0)
-		return -1;
-
-	if (ret == 0) {
-		/* src_path is file */
-		ret = check_file_tobe_copied(src_path, dst_is_remote ? NULL : sftp,
-					     &size);
-		if (ret <= 0)
-			return ret; /* error or skip */
-
-		if ((f = file_alloc(src_path, size, !dst_is_remote)) == NULL) {
-			pr_err("%s\n", strerrno());
-			return -1;
-		}
-
-		if (dst_should_dir)
-			snprintf(f->dst_path, PATH_MAX, "%s/%s%s",
-				 dst_path, rel_path, basename(src_path));
-		else
-			snprintf(f->dst_path, PATH_MAX, "%s%s", rel_path, dst_path);
-
-		list_add_tail(&f->list, file_list);
-		pprint2("file %s %s -> %s %s %luB\n",
-			f->src_path, dst_is_remote ? "(local)" : "(remote)",
-			f->dst_path, dst_is_remote ? "(remote)" : "(local)",
-			f->size);
-
-		return 0;
-	}
-
-	/* src_path is directory */
-	if (dst_is_remote) {
-		/* src_path is local directory */
-		struct dirent *de;
-		DIR *dir;
-		if ((dir = opendir(src_path)) == NULL) {
-			pr_err("opendir '%s': %s\n", src_path, strerrno());
-			return -1;
-		}
-		while ((de = readdir(dir)) != NULL) {
-			if (check_file_should_skip(de->d_name))
-				continue;
-			if (check_pathlen(src_path, de->d_name) < 0 ||
-			    check_pathlen(rel_path, basename(src_path)) < 0)
-				return -1;
-
-			snprintf(next_src_path, sizeof(next_src_path),
-				 "%s/%s", src_path, de->d_name);
-			if (replace_dir_name)
-				memset(next_rel_path, 0, sizeof(next_rel_path));
-			else
-				snprintf(next_rel_path, sizeof(next_rel_path),
-					 "%s%s/", rel_path, basename(src_path));
-			ret = file_fill_recursive(file_list, dst_is_remote, sftp,
-						  next_src_path, next_rel_path,
-						  dst_path, dst_should_dir, false);
-			if (ret < 0)
-				return ret;
-		}
-	} else {
-		/* src_path is remote directory */
-		sftp_attributes attr;
-		sftp_dir dir;
-		if ((dir = sftp_opendir(sftp, src_path)) == NULL) {
-			pr_err("sftp_opendir: '%s': %s\n", src_path,
-			       sftp_get_ssh_error(sftp));
-			return -1;
-		}
-		while ((attr = sftp_readdir(sftp, dir)) != NULL) {
-			if (check_file_should_skip(attr->name))
-				continue;
-			if (check_pathlen(src_path, attr->name) < 0 ||
-			    check_pathlen(rel_path, basename(src_path)) < 0)
-				return -1;
-
-			snprintf(next_src_path, sizeof(next_src_path),
-				 "%s/%s", src_path, attr->name);
-			if (replace_dir_name)
-				memset(next_rel_path, 0, sizeof(next_rel_path));
-			else
-				snprintf(next_rel_path, sizeof(next_rel_path),
-					 "%s%s/", rel_path, basename(src_path));
-			ret = file_fill_recursive(file_list, dst_is_remote, sftp,
-						  next_src_path, next_rel_path,
-						  dst_path, dst_should_dir, false);
-			if (ret < 0)
-				return ret;
-		}
-	}
-
-	return 0;
-}
-
-int file_fill(sftp_session sftp, struct list_head *file_list, char **src_array, int cnt,
-	      char *dst)
-{
-	bool dst_is_remote, dst_is_dir, dst_dir_no_exist, dst_should_dir, dst_must_dir;
-	char *dst_path, *src_path;
-	int n, ret;
-
-	dst_path = file_find_path(dst);
-	dst_path = *dst_path == '\0' ? "." : dst_path;
-	dst_is_remote = file_find_hostname(dst) ? true : false;
-	dst_must_dir = cnt > 1 ? true : false;
-
-	if (file_is_directory(dst_path, dst_is_remote ? sftp : NULL, false) > 0)
-		dst_is_dir = true;
-	else
-		dst_is_dir = false;
-	dst_dir_no_exist = !dst_is_dir;
-
-	for (n = 0; n < cnt; n++) {
-		src_path = file_find_path(src_array[n]);
-
-		if (file_is_directory(src_path, dst_is_remote ? NULL : sftp, false) > 0)
-			dst_should_dir = true;
-		else
-			dst_should_dir = false;
-
-		ret = file_fill_recursive(file_list, dst_is_remote, sftp,
-					  src_path, "", dst_path,
-					  dst_should_dir | dst_must_dir | dst_is_dir,
-					  dst_dir_no_exist);
-		if (ret < 0)
-			return ret;
-	}
-
-	return 0;
-}
-
-/* based on
- * https://stackoverflow.com/questions/2336242/recursive-mkdir-system-call-on-unix */
-static int file_dst_prepare(struct file *f, sftp_session sftp)
-{
-	/* XXX: should reflect the permission of the original directory? */
-	mode_t mode =  S_IRWXU | S_IRWXG | S_IRWXO;
-	char path[PATH_MAX];
-	char *p;
-	int ret;
-
-	strncpy(path, f->dst_path, sizeof(path));
-
-	pr_debug("prepare for %s\n", path);
-
-	/* mkdir -p */
-	for (p = strchr(path + 1, '/'); p; p = strchr(p + 1, '/')) {
-		*p = '\0';
-
-		ret = file_directory_exists(path, sftp);
-		pr_debug("check %s ret=%d\n", path, ret);
-		if (ret < -1)
-			return -1;
-		if (ret == 1)
-			goto next;
-
-		pr_debug("mkdir %s\n", path);
-
-		if (sftp) {
-			ret = sftp_mkdir(sftp, path, mode);
-			if (ret < 0 &&
-			    sftp_get_error(sftp) != SSH_FX_FILE_ALREADY_EXISTS) {
-				pr_err("failed to create %s: %s\n",
-				       path, sftp_get_ssh_error(sftp));
-				return -1;
-			}
-		} else {
-			if (mkdir(path, mode) == -1 && errno != EEXIST) {
-				pr_err("failed to create %s: %s\n",
-				       path, strerrno());
-				return -1;
-			}
-		}
-	next:
-		*p = '/';
-	}
-
-	/* open file with O_TRUNC to set file size 0 */
-	mode = O_WRONLY|O_CREAT|O_TRUNC;
-	if (sftp) {
-		sftp_file sf;
-		if ((sf = sftp_open(sftp, f->dst_path, mode, S_IRUSR|S_IWUSR)) == NULL) {
-			pr_err("sftp_open: %s\n", sftp_get_ssh_error(sftp));
-			return -1;
-		}
-		if (sftp_close(sf) < 0) {
-			pr_err("sftp_close: %s\n", sftp_get_ssh_error(sftp));
-			return -1;
-		}
-	} else {
-		int fd;
-		if ((fd = open(f->dst_path, mode, S_IRUSR|S_IWUSR)) < 0) {
-			pr_err("open: %s\n", strerrno());
-			return -1;
-		}
-		if (close(fd) < 0) {
-			pr_err("close: %s\n", strerrno());
-			return -1;
-		}
-	}
-
-	return 0;
-}
-
-
-#ifdef DEBUG
-void file_dump(struct list_head *file_list)
-{
-	struct file *f;
-
-	list_for_each_entry(f, file_list, list) {
-		pr_debug("%s %s -> %s %s %lu-byte\n",
-			 f->src_path, strloc(f->src_is_remote),
-			 f->dst_path, strloc(f->dst_is_remote),
-			 f->size);
-	}
-}
-#endif
-
-
-static void *chunk_alloc(struct file *f)
-{
-	struct chunk *c;
-
-	c = malloc(sizeof(*c));
-	if (!c) {
-		pr_err("%s\n", strerrno());
-		return NULL;
-	}
-	memset(c, 0, sizeof(*c));
-
-	c->f = f;
-	c->off = 0;
-	c->len = 0;
-	refcnt_inc(&f->refcnt);
-	return c;
-}
-
-static int get_page_mask(void)
-{
-	int n;
-	long page_sz = sysconf(_SC_PAGESIZE);
-	size_t page_mask = 0;
-
-	for (n = 0; page_sz > 0; page_sz >>= 1, n++) {
-		page_mask <<= 1;
-		page_mask |= 1;
-	}
-
-	return page_mask >> 1;
-}
-
-int chunk_fill(struct list_head *file_list, struct list_head *chunk_list,
-	       int nr_conn, int min_chunk_sz, int max_chunk_sz)
-{
-	struct chunk *c;
-	struct file *f;
-	size_t page_mask;
-	size_t chunk_sz;
-	size_t size;
-
-	page_mask = get_page_mask();
-
-	list_for_each_entry(f, file_list, list) {
-		if (f->size <= min_chunk_sz)
-			chunk_sz = f->size;
-		else if (max_chunk_sz)
-			chunk_sz = max_chunk_sz;
-		else {
-			chunk_sz = (f->size - (f->size % nr_conn)) / nr_conn;
-			chunk_sz &= ~page_mask; /* align in page_sz */
-			if (chunk_sz <= min_chunk_sz)
-				chunk_sz = min_chunk_sz;
-		}
-
-		pr_debug("%s chunk_sz %lu-byte\n", f->src_path, chunk_sz);
-
-		/* for (size = f->size; size > 0;) does not create a
-		 * file (chunk) when file size is 0. This do {} while
-		 * (size > 0) creates just open/close a 0-byte file.
-		 */
-		size = f->size;
-		do {
-			c = chunk_alloc(f);
-			if (!c)
-				return -1;
-			c->off = f->size - size;
-			c->len = size < chunk_sz ? size : chunk_sz;
-			size -= c->len;
-			list_add_tail(&c->list, chunk_list);
-			pprint4("chunk %s 0x%010lx-0x%010lx %luB\n",
-				c->f->src_path, c->off, c->off + c->len, c->len);
-		} while (size > 0);
-	}
-
-	return 0;
-}
-
-#ifdef DEBUG
-void chunk_dump(struct list_head *chunk_list)
-{
-	struct chunk *c;
-
-	list_for_each_entry(c, chunk_list, list) {
-		pr_debug("%s %s 0x%010lx-0x%010lx %lu-byte\n",
-			 c->f->src_path, strloc(c->f->src_is_remote),
-			 c->off, c->off + c->len, c->len);
-	}
-}
-#endif
-
-
-struct chunk *chunk_acquire(struct list_head *chunk_list)
-{
-	/* under the lock for chunk_list */
-
-	struct list_head *first = chunk_list->next;
-	struct chunk *c = NULL;
-
-	if (list_empty(chunk_list))
-		return NULL; /* list is empty */
-
-	c = list_entry(first, struct chunk, list);
-	list_del(first);
-	return c;
-}
-
-int chunk_prepare(struct chunk *c, sftp_session sftp)
-{
-	struct file *f = c->f;
-	int ret = 0;
-
-	lock_acquire(&f->lock); /* XXX: is always acquiring lock per-chunk heavy? */
-	if (f->state == FILE_STATE_INIT) {
-		if (file_dst_prepare(f, f->dst_is_remote ? sftp : NULL) < 0) {
-			ret = -1;
-			goto out;
-		}
-		f->state = FILE_STATE_OPENED;
-		pprint2("copy start: %s\n", f->src_path);
-	}
-
-out:
-	lock_release(&f->lock);
-	return ret;
-}
-
-static mode_t chunk_get_mode(const char *path, sftp_session sftp)
-{
-	mode_t mode;
-
-	if (sftp) {
-		sftp_attributes attr = sftp_stat(sftp, path);
-		if (!attr) {
-			pr_err("sftp_stat %s: %s\n", path, sftp_get_ssh_error(sftp));
-			return -1;
-		}
-		mode = attr->permissions;
-		sftp_attributes_free(attr);
-	} else {
-		struct stat statbuf;
-		if (stat(path, &statbuf) < 0) {
-			pr_err("stat %s: %s\n", path, strerrno());
-			return -1;
-		}
-		mode = statbuf.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO);
-	}
-	return mode;
-}
-
-static int chunk_set_mode(const char *path, mode_t mode, sftp_session sftp)
-{
-	if (sftp) {
-		if (sftp_chmod(sftp, path, mode) < 0) {
-			pr_err("sftp_chmod %s: %s\n", path, sftp_get_ssh_error(sftp));
-			return -1;
-		}
-	} else {
-		if (chmod(path, mode) < 0) {
-			pr_err("chmod %s: %s\n", path, strerrno());
-			return -1;
-		}
-	}
-
-	return 0;
-}
-
-static int chunk_open_local(const char *path, int flags, mode_t mode, size_t off)
-{
-	int fd;
-
-	fd = open(path, flags, mode);
-	if (fd < 0) {
-		pr_err("open failed for %s: %s\n", path, strerrno());
-		return -1;
-	}
-	if (lseek(fd, off, SEEK_SET) < 0) {
-		pr_err("seek error for %s: %s\n", path, strerrno());
-		close(fd);
-		return -1;
-	}
-
-	return fd;
-}
-
-static sftp_file chunk_open_remote(const char *path, int flags, mode_t mode, size_t off,
-				   sftp_session sftp)
-{
-	sftp_file sf;
-
-	sf = sftp_open(sftp, path, flags, mode);
-
-	if (!sf) {
-		pr_err("sftp_open %s: %s\n", path, sftp_get_ssh_error(sftp));
-		return NULL;
-	}
-
-	if (sftp_seek64(sf, off) < 0) {
-		pr_err("sftp_seek64 %s: %s\n", path, sftp_get_ssh_error(sftp));
-		return NULL;
-	}
-
-	return sf;
-}
-
-/*
- * TODO: handle case when read returns 0 (EOF).
- */
-static int _chunk_copy_local_to_remote(struct chunk *c, int fd, sftp_file sf,
-				       size_t sftp_buf_sz, size_t io_buf_sz,
-				       size_t *counter)
-{
-	ssize_t read_bytes, write_bytes, remaind;
-	char buf[io_buf_sz];
-
-	for (remaind = c->len; remaind > 0;) {
-
-		read_bytes = read(fd, buf, min(remaind, io_buf_sz));
-		if (read_bytes < 0) {
-			pr_err("read: %s\n", strerrno());
-			return -1;
-		}
-
-		write_bytes = sftp_write2(sf, buf, read_bytes, sftp_buf_sz);
-		if (write_bytes < 0) {
-			pr_err("sftp_write: %d\n", sftp_get_error(sf->sftp));
-			return -1;
-		}
-
-		if (write_bytes < read_bytes) {
-			pr_err("failed to write full bytes to %s\n", c->f->dst_path);
-			return -1;
-		}
-
-		*counter += write_bytes;
-		remaind -= write_bytes;
-	}
-
-	return 0;
-}
-
-#define XFER_BUF_SIZE	16384
-
-#ifdef ASYNC_WRITE
-static int _chunk_copy_local_to_remote_async(struct chunk *c, int fd,
-					     sftp_file sf, int nr_ahead, size_t *counter)
-{
-	ssize_t read_bytes, remaind, thrown;
-	char buf[XFER_BUF_SIZE];
-	int idx, ret;
-	struct {
-		uint32_t id;
-		ssize_t  len;
-	} reqs[nr_ahead];
-
-	if (c->len == 0)
-		return 0;
-
-	remaind = thrown = c->len;
-	for (idx = 0; idx < nr_ahead && thrown > 0; idx++) {
-		reqs[idx].len = min(thrown, sizeof(buf));
-		read_bytes = read(fd, buf, reqs[idx].len);
-		if (read_bytes < 0) {
-			pr_err("read: %s\n", strerrno());
-			return -1;
-		}
-		ret = sftp_async_write(sf, buf, reqs[idx].len, &reqs[idx].id);
-		if (ret < 0) {
-			pr_err("sftp_async_write: %d\n", sftp_get_error(sf->sftp));
-			return -1;
-		}
-		thrown -= reqs[idx].len;
-	}
-
-	for (idx = 0; remaind > 0; idx = (idx + 1) % nr_ahead) {
-		ret = sftp_async_write_end(sf, reqs[idx].id, 1);
-		if (ret != SSH_OK) {
-			pr_err("sftp_async_write_end: %d\n", sftp_get_error(sf->sftp));
-			return -1;
-		}
-
-		*counter += reqs[idx].len;
-		remaind -= reqs[idx].len;
-
-		if (remaind <= 0)
-			break;
-
-		if (thrown <= 0)
-			continue;
-
-		reqs[idx].len = min(thrown, sizeof(buf));
-		read_bytes = read(fd, buf, reqs[idx].len);
-		if (read_bytes < 0) {
-			pr_err("read: %s\n", strerrno());
-			return -1;
-		}
-
-		ret = sftp_async_write(sf, buf, reqs[idx].len, &reqs[idx].id);
-		if (ret < 0) {
-			pr_err("sftp_async_write: %d\n", sftp_get_error(sf->sftp));
-			return -1;
-		}
-		thrown -= reqs[idx].len;
-	}
-
-	if (remaind < 0) {
-		pr_err("invalid remaind bytes %ld. last async_write_end bytes %lu. "
-		       "last read bytes %ld\n",
-		       remaind, reqs[idx].len, read_bytes);
-		return -1;
-	}
-
-	return 0;
-}
-#endif
-
-static int _chunk_copy_remote_to_local(struct chunk *c, int fd, sftp_file sf,
-				       int nr_ahead, size_t *counter)
-{
-	ssize_t read_bytes, write_bytes, remaind, thrown;
-	char buf[XFER_BUF_SIZE];
-	int idx;
-	struct {
-		int id;
-		ssize_t len;
-	} reqs[nr_ahead];
-
-	/* TODO: sftp_buf_sz has no effect on remote to local copy. we
-	 * always use 16384 byte buffer pointed by
-	 * https://api.libssh.org/stable/libssh_tutor_sftp.html. The
-	 * larget read length from sftp_async_read is 65536 byte.
-	 * Read sizes larget than 65536 cause a situation where data
-	 * remainds but sftp_async_read returns 0.
-	 */
-
-	if (c->len == 0)
-		return 0;
-
-	remaind = thrown = c->len;
-
-	for (idx = 0; idx < nr_ahead && thrown > 0; idx++) {
-		reqs[idx].len = min(thrown, sizeof(buf));
-		reqs[idx].id = sftp_async_read_begin(sf, reqs[idx].len);
-		if (reqs[idx].id < 0) {
-			pr_err("sftp_async_read_begin: %d\n",
-			       sftp_get_error(sf->sftp));
-			return -1;
-		}
-		thrown -= reqs[idx].len;
-	}
-
-	for (idx = 0; remaind > 0; idx = (idx + 1) % nr_ahead) {
-		read_bytes = sftp_async_read(sf, buf, reqs[idx].len, reqs[idx].id);
-		if (read_bytes == SSH_ERROR) {
-			pr_err("sftp_async_read: %d\n", sftp_get_error(sf->sftp));
-			return -1;
-		}
-
-		if (thrown > 0) {
-			reqs[idx].len = min(thrown, sizeof(buf));
-			reqs[idx].id = sftp_async_read_begin(sf, reqs[idx].len);
-			thrown -= reqs[idx].len;
-		}
-
-		write_bytes = write(fd, buf, read_bytes);
-		if (write_bytes < 0) {
-			pr_err("write: %s\n", strerrno());
-			return -1;
-		}
-
-		if (write_bytes < read_bytes) {
-			pr_err("failed to write full bytes\n");
-			return -1;
-		}
-
-		*counter += write_bytes;
-		remaind -= read_bytes;
-	}
-
-	if (remaind < 0) {
-		pr_err("invalid remaind bytes %ld. last async_read bytes %ld. "
-		       "last write bytes %ld\n",
-		       remaind, read_bytes, write_bytes);
-		return -1;
-	}
-
-	return 0;
-}
-
-static int chunk_copy_local_to_remote(struct chunk *c, sftp_session sftp,
-				      size_t sftp_buf_sz, size_t io_buf_sz,
-				      int nr_ahead, size_t *counter)
-{
-	struct file *f = c->f;
-	sftp_file sf = NULL;
-	mode_t mode;
-	int ret = 0;
-	int fd = 0;
-	int flags;
-
-	flags = O_RDONLY;
-	mode = S_IRUSR;
-	if ((fd = chunk_open_local(f->src_path, flags, mode, c->off)) < 0) {
-		ret = -1;
-		goto out;
-	}
-
-	flags = O_WRONLY;
-	mode = S_IRUSR|S_IWUSR;
-	if (!(sf = chunk_open_remote(f->dst_path, flags, mode, c->off, sftp))) {
-		ret = -1;
-		goto out;
-	}
-
-#ifndef ASYNC_WRITE
-	ret = _chunk_copy_local_to_remote(c, fd, sf, sftp_buf_sz, io_buf_sz,
-						  counter);
-#else
-	ret = _chunk_copy_local_to_remote_async(c, fd, sf, nr_ahead, counter);
-#endif
-	if (ret < 0)
-		goto out;
-
-	if ((mode = chunk_get_mode(f->src_path, NULL)) < 0) {
-		ret = -1;
-		goto out;
-	}
-	if (chunk_set_mode(f->dst_path, mode, sftp) < 0) {
-		ret = -1;
-	}
-
-out:
-	if (fd > 0)
-		close(fd);
-	if (sf)
-		sftp_close(sf);
-	return ret;
-}
-
-static int chunk_copy_remote_to_local(struct chunk *c, sftp_session sftp,
-				      int nr_ahead, size_t *counter)
-{
-	struct file *f = c->f;
-	sftp_file sf = NULL;
-	mode_t mode;
-	int flags;
-	int fd = 0;
-	int ret = 0;
-
-	flags = O_WRONLY;
-	mode = S_IRUSR|S_IWUSR;
-	if ((fd = chunk_open_local(f->dst_path, flags, mode, c->off)) < 0) {
-		ret = -1;
-		goto out;
-	}
-
-	flags = O_RDONLY;
-	mode = S_IRUSR;
-	if (!(sf = chunk_open_remote(f->src_path, flags, mode, c->off, sftp))) {
-		ret = -1;
-		goto out;
-	}
-
-	ret = _chunk_copy_remote_to_local(c, fd, sf, nr_ahead, counter);
-	if (ret< 0)
-		goto out;
-
-out:
-	if (fd > 0)
-		close(fd);
-	if (sf)
-		sftp_close(sf);
-
-	return ret;
-}
-
-
-
-int chunk_copy(struct chunk *c, sftp_session sftp, size_t sftp_buf_sz, size_t io_buf_sz,
-	       int nr_ahead, size_t *counter)
-{
-	struct file *f = c->f;
-	int ret = 0;
-
-	pr_debug("copy %s %s -> %s %s off=0x%010lx\n",
-		 f->src_path, strloc(f->src_is_remote),
-		 f->dst_path, strloc(f->dst_is_remote), c->off);
-
-	pprint4("copy start: chunk %s 0x%010lx-0x%010lx %luB\n",
-		c->f->src_path, c->off, c->off + c->len, c->len);
-
-
-	if (f->dst_is_remote)
-		ret = chunk_copy_local_to_remote(c, sftp, sftp_buf_sz, io_buf_sz,
-						 nr_ahead, counter);
-	else
-		ret = chunk_copy_remote_to_local(c, sftp, nr_ahead, counter);
-
-	if (ret < 0)
-		return ret;
-
-	pr_debug("done %s %s -> %s %s off=0x%010lx\n",
-		 f->src_path, strloc(f->src_is_remote),
-		 f->dst_path, strloc(f->dst_is_remote), c->off);
-
-	pprint4("copy done: chunk %s 0x%010lx-0x%010lx %luB\n",
-		c->f->src_path, c->off, c->off + c->len, c->len);
-
-	if (refcnt_dec(&f->refcnt) == 0) {
-		f->state = FILE_STATE_DONE;
-		pprint2("copy done: %s\n", f->src_path);
-	}
-
-
-	return ret;
-}

src/file.h

@@ -1,84 +0,0 @@
-#ifndef _FILE_H_
-#define _FILE_H_
-
-#include <limits.h>
-#include <pthread.h>
-#include "libssh/libssh.h"
-#include "libssh/sftp.h"
-
-#include <list.h>
-#include <atomic.h>
-
-struct file {
-	struct list_head        list;   /* mscp->file_list */
-
-	char    src_path[PATH_MAX];	/* copy source path */
-	bool    src_is_remote;		/* source is remote */
-	size_t  size;			/* size of this file */
-
-	char    dst_path[PATH_MAX];	/* copy destination path */
-	bool    dst_is_remote;		/* destination is remote */
-
-	int     state;  /* destination file state */
-	lock    lock;   /* mutex to protect state */
-	refcnt  refcnt; /* chunks referencing this file */
-};
-#define FILE_STATE_INIT         0
-#define FILE_STATE_OPENED       1
-#define FILE_STATE_DONE         2
-
-#define strloc(is_remote) is_remote ? "(remote)" : "(local)"
-
-/* Allocating chunk increments refcnt of the associating file.
- * Multiple threads copying files follows:
- *
- * acquire a chunk (inside a global lock)
- *
- * if the file state of the chunk is INIT:
- *     acquire the file lock
- * *         if file state is INIT:
- *             create directory if necessary
- *             open file with O_TRUNC and close.
- *             set file state OPENED.
- *             // only the first thread in the lock open the destination file
- *     release the file lock
- * endif
- *
- * copy the chunk to the destination.
- * decrement the refcnt of the file.
- *
- * if refcnt == 0:
- *     all chunks are copied.
- *     set the file state DONE, print something useful output.
- * endif
- */
-
-struct chunk {
-	struct list_head        list;   /* mscp->chunk_list */
-	struct file *f;
-	size_t  off;    /* offset of this chunk on the file f */
-	size_t  len;    /* length of this chunk */
-	size_t  done;   /* copied bytes for this chunk by a thread */
-};
-
-char *file_find_hostname(char *path);
-bool file_has_hostname(char *path);
-
-int file_fill(sftp_session sftp, struct list_head *file_list, char **src_array, int cnt,
-	      char *dst);
-
-int chunk_fill(struct list_head *file_list, struct list_head *chunk_list,
-	       int nr_conn, int min_chunk_sz, int max_chunk_sz);
-
-struct chunk *chunk_acquire(struct list_head *chunk_list);
-int chunk_prepare(struct chunk *c, sftp_session sftp);
-int chunk_copy(struct chunk *c, sftp_session sftp, size_t sftp_buf_sz, size_t io_buf_sz,
-	       int nr_ahead, size_t *counter);
-
-#ifdef DEBUG
-void file_dump(struct list_head *file_list);
-void chunk_dump(struct list_head *chunk_list);
-#endif
-
-
-#endif /* _FILE_H_ */

src/fileops.c

@@ -0,0 +1,367 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <dirent.h>
+
+#include <fileops.h>
+#include <ssh.h>
+#include <message.h>
+
+
+sftp_session __thread tls_sftp;
+/* tls_sftp is used *_wrapped() functions */
+
+void set_tls_sftp_session(sftp_session sftp)
+{
+	tls_sftp = sftp;
+}
+
+static void sftp_err_to_errno(sftp_session sftp)
+{
+	int sftperr = sftp_get_error(sftp);
+
+	switch (sftperr){
+	case SSH_FX_OK:
+	case SSH_FX_EOF:
+		errno = 0;
+		break;
+	case SSH_FX_NO_SUCH_FILE:
+	case SSH_FX_NO_SUCH_PATH:
+		errno = ENOENT;
+		break;
+	case SSH_FX_PERMISSION_DENIED:
+		errno = EACCES;
+		break;
+	case SSH_FX_FAILURE:
+		errno = EINVAL;
+	case SSH_FX_BAD_MESSAGE:
+		errno = EBADMSG;
+	case SSH_FX_NO_CONNECTION:
+		errno = ENOTCONN;
+		break;
+	case SSH_FX_CONNECTION_LOST:
+		errno = ENETRESET;
+		break;
+	case SSH_FX_OP_UNSUPPORTED:
+		errno = EOPNOTSUPP;
+		break;
+	case SSH_FX_INVALID_HANDLE:
+		errno = EBADF;
+		break;
+	case SSH_FX_FILE_ALREADY_EXISTS:
+		errno = EEXIST;
+		break;
+	case SSH_FX_WRITE_PROTECT:
+		errno = EPERM;
+		break;
+	case SSH_FX_NO_MEDIA:
+		errno = ENODEV;
+		break;
+	default:
+		mpr_warn(stderr, "unkown SSH_FX response %d", sftperr);
+	}
+}
+
+
+MDIR *mscp_opendir(const char *path, sftp_session sftp)
+{
+	MDIR *md;
+
+	if (!(md = malloc(sizeof(*md))))
+		return NULL;
+	memset(md, 0, sizeof(*md));
+
+	if (sftp) {
+		md->remote = sftp_opendir(sftp, path);
+		sftp_err_to_errno(sftp);
+		if (!md->remote) {
+			goto free_out;
+		}
+	} else {
+		md->local = opendir(path);
+		if (!md->local) {
+			goto free_out;
+		}
+	}
+
+	return md;
+
+free_out:
+	free(md);
+	return NULL;
+}
+
+MDIR *mscp_opendir_wrapped(const char *path)
+{
+	return mscp_opendir(path, tls_sftp);
+}
+
+void mscp_closedir(MDIR *md)
+{
+	int ret;
+	if (md->remote)
+		sftp_closedir(md->remote);
+	else
+		closedir(md->local);
+
+	free(md);
+}
+
+
+struct dirent __thread tls_dirent;
+/* tls_dirent contains dirent converted from sftp_attributes returned
+ * from sftp_readdir(). This trick is derived from openssh's
+ * fudge_readdir() */
+
+struct dirent *mscp_readdir(MDIR *md)
+{
+	sftp_attributes attr;
+	struct dirent *ret = NULL;
+	static int inum = 1;
+
+	if (md->remote) {
+		attr = sftp_readdir(md->remote->sftp, md->remote);
+		if (!attr) {
+			sftp_err_to_errno(md->remote->sftp);
+			return NULL;
+		}
+
+		memset(&tls_dirent, 0, sizeof(tls_dirent));
+		strncpy(tls_dirent.d_name, attr->name, sizeof(tls_dirent.d_name) - 1);
+		tls_dirent.d_ino = inum++;
+		if (!inum)
+			inum = 1;
+		ret = &tls_dirent;
+		sftp_attributes_free(attr);
+	} else
+		ret = readdir(md->local);
+
+	return ret;
+}
+
+int mscp_mkdir(const char *path, mode_t mode, sftp_session sftp)
+{
+	int ret;
+
+	if (sftp) {
+		ret = sftp_mkdir(sftp, path, mode);
+		sftp_err_to_errno(sftp);
+	} else
+		ret = mkdir(path, mode);
+
+	if (ret < 0 && errno == EEXIST) {
+		ret = 0;
+	}
+
+	return ret;
+}
+
+
+static void sftp_attr_to_stat(sftp_attributes attr, struct stat *st)
+{
+        memset(st, 0, sizeof(*st));
+	st->st_size	= attr->size;
+	st->st_uid	= attr->uid;
+	st->st_gid	= attr->gid;
+	st->st_mode	= attr->permissions;
+
+	switch (attr->type) {
+	case SSH_FILEXFER_TYPE_REGULAR:
+		st->st_mode |= S_IFREG;
+		break;
+	case SSH_FILEXFER_TYPE_DIRECTORY:
+		st->st_mode |= S_IFDIR;
+		break;
+	case SSH_FILEXFER_TYPE_SYMLINK:
+		st->st_mode |= S_IFLNK;
+		break;
+	case SSH_FILEXFER_TYPE_SPECIAL:
+		st->st_mode |= S_IFCHR; /* or block? */
+		break;
+	case SSH_FILEXFER_TYPE_UNKNOWN:
+		st->st_mode |= S_IFIFO; /* really? */
+		break;
+	default:
+		mpr_warn(stderr, "unkown SSH_FILEXFER_TYPE %d", attr->type);
+	}
+
+	/* ToDo: convert atime, ctime, and mtime */
+}
+
+
+int mscp_stat(const char *path, struct stat *st, sftp_session sftp)
+{
+	sftp_attributes attr;
+	int ret = 0;
+
+	if (sftp) {
+		attr = sftp_stat(sftp, path);
+		sftp_err_to_errno(sftp);
+		if (!attr)
+			return -1;
+
+		sftp_attr_to_stat(attr, st);
+		sftp_attributes_free(attr);
+		ret = 0;
+	} else
+		ret = stat(path, st);
+
+	return ret;
+}
+
+int mscp_stat_wrapped(const char *path, struct stat *st)
+{
+	return mscp_stat(path, st, tls_sftp);
+}
+
+int mscp_lstat(const char *path, struct stat *st, sftp_session sftp)
+{
+	sftp_attributes attr;
+	int ret = 0;
+
+	if (sftp) {
+		attr = sftp_lstat(sftp, path);
+		sftp_err_to_errno(sftp);
+		if (!attr)
+			return -1;
+
+		sftp_attr_to_stat(attr, st);
+		sftp_attributes_free(attr);
+		ret = 0;
+	} else
+		ret = lstat(path, st);
+
+	return ret;
+}
+
+int mscp_lstat_wrapped(const char *path, struct stat *st)
+{
+	return mscp_lstat(path, st, tls_sftp);
+}
+
+
+mf *mscp_open(const char *path, int flags, mode_t mode, sftp_session sftp)
+{
+	mf *f;
+
+	f = malloc(sizeof(*f));
+	if (!f)
+		return NULL;
+	memset(f, 0, sizeof(*f));
+
+	if (sftp) {
+		f->remote = sftp_open(sftp, path, flags, mode);
+		if (!f->remote) {
+			sftp_err_to_errno(sftp);
+			goto free_out;
+		}
+	} else {
+		f->local = open(path, flags, mode);
+		if (f->local < 0)
+			goto free_out;
+	}
+
+	return f;
+
+free_out:
+	free(f);
+	return NULL;
+}
+
+void mscp_close(mf *f)
+{
+	if (f->remote)
+		sftp_close(f->remote);
+	if (f->local > 0)
+		close(f->local);
+	free(f);
+}
+
+off_t mscp_lseek(mf *f, off_t off)
+{
+	off_t ret;
+
+	if (f->remote) {
+		ret = sftp_seek64(f->remote, off);
+		sftp_err_to_errno(f->remote->sftp);
+	} else
+		ret = lseek(f->local, off, SEEK_SET);
+
+	return ret;
+}
+
+int mscp_setstat(const char *path, mode_t mode, size_t size, sftp_session sftp)
+{
+	int ret;
+
+	if (sftp) {
+		struct sftp_attributes_struct attr;
+		memset(&attr, 0, sizeof(attr));
+		attr.permissions = mode;
+		attr.size = size;
+		attr.flags = (SSH_FILEXFER_ATTR_PERMISSIONS|SSH_FILEXFER_ATTR_SIZE);
+		ret = sftp_setstat(sftp, path, &attr);
+		sftp_err_to_errno(sftp);
+	} else {
+		if ((ret = chmod(path, mode)) < 0)
+			return ret;
+		if ((ret = truncate(path, size)) < 0)
+			return ret;
+	}
+
+	return ret;
+}
+
+int mscp_glob(const char *pattern, int flags, glob_t *pglob, sftp_session sftp)
+{
+	int ret;
+	if (sftp) {
+#ifndef GLOB_ALTDIRFUNC
+#define GLOB_NOALTDIRMAGIC INT_MAX
+		/* musl does not implement GLOB_ALTDIRFUNC */
+		pglob->gl_pathc = 1;
+		pglob->gl_pathv = malloc(sizeof(char *));
+		pglob->gl_pathv[0] = strdup(pattern);
+		pglob->gl_offs = GLOB_NOALTDIRMAGIC;
+		return 0;
+#else
+		flags |= GLOB_ALTDIRFUNC;
+		set_tls_sftp_session(sftp);
+#ifdef __APPLE__
+		pglob->gl_opendir = (void *(*)(const char *))mscp_opendir_wrapped;
+		pglob->gl_readdir = (struct dirent *(*)(void *))mscp_readdir;
+		pglob->gl_closedir = (void (*)(void *))mscp_closedir;
+		pglob->gl_lstat = mscp_lstat_wrapped;
+		pglob->gl_stat = mscp_stat_wrapped;
+#elif linux
+		pglob->gl_opendir = (void *(*)(const char *))mscp_opendir_wrapped;
+		pglob->gl_readdir = (void *(*)(void *))mscp_readdir;
+		pglob->gl_closedir = (void (*)(void *))mscp_closedir;
+		pglob->gl_lstat = (int (*)(const char *, void *))mscp_lstat_wrapped;
+		pglob->gl_stat = (int (*)(const char *, void *))mscp_stat_wrapped;
+#else
+#error unsupported platform
+#endif
+#endif
+	}
+
+	ret = glob(pattern, flags, NULL, pglob);
+
+	if (sftp)
+		set_tls_sftp_session(NULL);
+	return ret;
+}
+
+void mscp_globfree(glob_t *pglob)
+{
+#ifndef GLOB_ALTDIRFUNC
+	if (pglob->gl_offs == GLOB_NOALTDIRMAGIC) {
+		free(pglob->gl_pathv[0]);
+		free(pglob->gl_pathv);
+		return;
+	}
+#endif
+	globfree(pglob);
+}

src/fileops.h

@@ -0,0 +1,57 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#include <dirent.h>
+#include <sys/stat.h>
+#include <glob.h>
+
+#include <ssh.h>
+
+void set_tls_sftp_session(sftp_session sftp);
+/* sftp_session set by set_tls_sftp_session is sued in
+ mscp_open_wrapped(), mscp_stat_wrapped(), and
+ mscp_lstat_wrapped(). This _wrapped() functions exist for
+ sftp_glob() */
+
+/* directory operations */
+
+struct mdir_struct {
+	DIR *local;
+	sftp_dir remote;
+};
+typedef struct mdir_struct MDIR;
+
+
+MDIR *mscp_opendir(const char *path, sftp_session sftp);
+MDIR *mscp_opendir_wrapped(const char *path);
+void mscp_closedir(MDIR *md);
+struct dirent *mscp_readdir(MDIR *md);
+
+int mscp_mkdir(const char *path, mode_t mode, sftp_session sftp);
+
+/* stat operations */
+int mscp_stat(const char *path, struct stat *st, sftp_session sftp);
+int mscp_stat_wrapped(const char *path, struct stat *st);
+
+int mscp_lstat(const char *path, struct stat *st, sftp_session sftp);
+int mscp_lstat_wrapped(const char *path, struct stat *st);
+
+
+/* file operations */
+
+struct mf_struct {
+	sftp_file remote;
+	int local;
+};
+typedef struct mf_struct mf;
+
+mf *mscp_open(const char *path, int flags, mode_t mode, sftp_session sftp);
+void mscp_close(mf *f);
+off_t mscp_lseek(mf *f, off_t off);
+
+/* mscp_setstat() involves chmod and truncate. It executes both at
+ * once via a single SFTP command (sftp_setstat()).
+ */
+int mscp_setstat(const char *path, mode_t mode, size_t size, sftp_session sftp);
+
+/* remote glob */
+int mscp_glob(const char *pattern, int flags, glob_t *pglob, sftp_session sftp);
+void mscp_globfree(glob_t *pglob);

src/list.h

@@ -208,6 +208,32 @@ static inline void list_splice(struct list_head *list, struct list_head *head)
 		__list_splice(list, head);
 }
 
+static inline void __list_splice_tail(struct list_head *list,
+				      struct list_head *head)
+{
+	struct list_head *first = list->next;
+	struct list_head *last = list->prev;
+	struct list_head *at = head->prev;
+
+	first->prev = at;
+	at->next = first;
+
+	last->next = head;
+	at->prev = last;
+}
+
+/**
+ * list_splice_tail - join two lists
+ * @list: the new list to add.
+ * @head: the place to add it in the first list.
+ */
+static inline void list_splice_tail(struct list_head *list, struct list_head *head)
+{
+	if (!list_empty(list))
+		__list_splice_tail(list, head);
+}
+
+
 /**
  * list_splice_init - join two lists and reinitialise the emptied list.
  * @list: the new list to add.
@@ -528,5 +554,20 @@ static inline int list_count(struct list_head *head)
 }
 
 
+/**
+ * list_free_f - free items in a list with a function
+ * @head	the heaf for your list.
+ * @f           function that releases an item in the list.
+ */
+static inline void list_free_f(struct list_head *head, void (*f)(struct list_head *))
+{
+	struct list_head *p, *n;
+
+        list_for_each_safe(p, n, head) {
+                list_del(p);
+                f(p);
+        }
+}
+
 #endif
 

src/message.c

@@ -0,0 +1,50 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#include <stdio.h>
+#include <stdarg.h>
+#include <string.h>
+#include <limits.h>
+#include <pthread.h>
+
+#include <util.h>
+#include <message.h>
+
+/* strerror_r wrapper */
+__thread char thread_strerror[128];
+
+/* mscp error message buffer */
+#define MSCP_ERRMSG_SIZE	(PATH_MAX * 2)
+
+static char errmsg[MSCP_ERRMSG_SIZE];
+
+void _mscp_set_error(const char *fmt, ...)
+{
+	va_list va;
+
+	memset(errmsg, 0, sizeof(errmsg));
+	va_start(va, fmt);
+	vsnprintf(errmsg, sizeof(errmsg) - 1, fmt, va);
+	va_end(va);
+}
+
+const char *mscp_get_error()
+{
+	return errmsg;
+}
+
+
+/* message print functions */
+
+static int mprint_severity = MSCP_SEVERITY_WARN;
+
+void mprint_set_severity(int serverity)
+{
+	if (serverity < 0)
+		mprint_severity = -1; /* no print */
+	mprint_severity = serverity;
+}
+
+int mprint_get_severity()
+{
+	return mprint_severity;
+}
+

src/message.h

@@ -0,0 +1,57 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#ifndef _MESSAGE_H_
+#define _MESSAGE_H_
+
+#include <libgen.h>
+#include <stdio.h>
+
+#include <mscp.h>
+
+/* message print. printed messages are passed to application via msg_fd */
+void mprint_set_severity(int severity);
+int mprint_get_severity();
+
+#define mprint(fp, severity, fmt, ...)				\
+	do {							\
+		if (fp && severity <= mprint_get_severity()) {	\
+			fprintf(fp, fmt, ##__VA_ARGS__);	\
+			fflush(fp);				\
+		}						\
+	} while (0)
+
+#define mpr_err(fp, fmt, ...)					\
+	mprint(fp, MSCP_SEVERITY_ERR, fmt, ##__VA_ARGS__)
+#define mpr_warn(fp, fmt, ...)					\
+	mprint(fp, MSCP_SEVERITY_WARN, fmt, ##__VA_ARGS__)
+#define mpr_notice(fp, fmt, ...)				\
+	mprint(fp, MSCP_SEVERITY_NOTICE, fmt, ##__VA_ARGS__)
+#define mpr_info(fp, fmt, ...)					\
+	mprint(fp, MSCP_SEVERITY_INFO, fmt, ##__VA_ARGS__)
+#define mpr_debug(fp, fmt, ...)					\
+	mprint(fp, MSCP_SEVERITY_DEBUG, fmt, ##__VA_ARGS__)
+
+
+/* errorno wrapper */
+extern __thread char thread_strerror[128];
+
+#ifdef _GNU_SOURCE
+/* GNU strerror_r */
+#define strerrno()							\
+	strerror_r(errno, thread_strerror, sizeof(thread_strerror))
+#else
+/* this macro assumes that strerror_r never fails. any good way? */
+#define strerrno()							\
+	(strerror_r(errno, thread_strerror, sizeof(thread_strerror))    \
+	 ? thread_strerror : thread_strerror)
+#endif
+
+
+
+/* error message buffer */
+#define mscp_set_error(fmt, ...)					\
+	_mscp_set_error("%s:%d:%s: " fmt "\0",				\
+			basename(__FILE__), __LINE__, __func__, ##__VA_ARGS__)
+
+void _mscp_set_error(const char *fmt, ...);
+
+#endif /* _MESSAGE_H_ */

src/mscp.c

@@ -0,0 +1,791 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#include <stdbool.h>
+#include <unistd.h>
+#include <math.h>
+#include <pthread.h>
+#include <semaphore.h>
+#include <sys/time.h>
+
+#include <list.h>       
+#include <util.h>       
+#include <ssh.h>                
+#include <path.h>
+#include <fileops.h>
+#include <atomic.h>             
+#include <platform.h>
+#include <message.h>
+#include <mscp.h>
+
+
+struct mscp {
+	char			*remote;	/* remote host (and uername) */
+	int			direction;	/* copy direction */
+	struct mscp_opts	*opts;
+	struct mscp_ssh_opts	*ssh_opts;
+
+	FILE			*msg_fp;	/* writer fd for message pipe */
+
+	int			*cores;		/* usable cpu cores by COREMASK */
+	int			nr_cores;	/* length of array of cores */
+
+	sem_t			*sem;		/* semaphore for concurrent 
+						 * connecting ssh sessions */
+
+	sftp_session		first;		/* first sftp session */
+
+	char 			dst_path[PATH_MAX];
+	struct list_head	src_list;
+	struct list_head	path_list;
+	struct chunk_pool	cp;
+
+	pthread_t		tid_scan;	/* tid for scan thread */
+	int			ret_scan;	/* return code from scan thread */
+
+	size_t			total_bytes;	/* total bytes to be transferred */
+
+	struct list_head	thread_list;
+	rwlock			thread_rwlock;
+};
+
+
+struct mscp_thread {
+	struct list_head	list;	/* mscp->thread_list */
+
+	struct mscp	*m;
+	int		id;
+	sftp_session	sftp;
+	pthread_t	tid;
+	int		cpu;
+	size_t		done;
+	bool		finished;
+	int		ret;
+};
+
+struct src {
+	struct list_head list;	/* mscp->src_list */
+	char *path;
+};
+
+#define DEFAULT_MIN_CHUNK_SZ    (64 << 20)      /* 64MB */
+#define DEFAULT_NR_AHEAD        32
+#define DEFAULT_BUF_SZ          16384
+/* XXX: we use 16384 byte buffer pointed by
+ * https://api.libssh.org/stable/libssh_tutor_sftp.html. The larget
+ * read length from sftp_async_read is 65536 byte. Read sizes larger
+ * than 65536 cause a situation where data remainds but
+ * sftp_async_read returns 0.
+ */
+
+#define DEFAULT_MAX_STARTUPS	8
+
+#define non_null_string(s) (s[0] != '\0')
+
+
+static int expand_coremask(const char *coremask, int **cores, int *nr_cores)
+{
+        int n, *core_list, core_list_len = 0, nr_usable, nr_all;
+        char c[2] = { 'x', '\0' };
+        const char *_coremask;
+        long v, needle;
+        int ncores = nr_cpus();
+
+        /*
+         * This function returns array of usable cores in `cores` and
+         * returns the number of usable cores (array length) through
+         * nr_cores.
+         */
+
+        if (strncmp(coremask, "0x", 2) == 0)
+                _coremask = coremask + 2;
+        else
+                _coremask = coremask;
+
+        core_list = realloc(NULL, sizeof(int) * 64);
+        if (!core_list) {
+                mscp_set_error("failed to realloc: %s", strerrno());
+                return -1;
+        }
+
+        nr_usable = 0;
+        nr_all = 0;
+        for (n = strlen(_coremask) - 1; n >=0; n--) {
+                c[0] = _coremask[n];
+                v = strtol(c, NULL, 16);
+                if (v == LONG_MIN || v == LONG_MAX) {
+                        mscp_set_error("invalid coremask: %s", coremask);
+                        return -1;
+                }
+
+                for (needle = 0x01; needle < 0x10; needle <<= 1) {
+                        nr_all++;
+                        if (nr_all > ncores)
+                                break; /* too long coremask */
+                        if (v & needle) {
+                                nr_usable++;
+                                core_list = realloc(core_list, sizeof(int) * nr_usable);
+                                if (!core_list) {
+                                        mscp_set_error("realloc: %s", strerrno());
+                                        return -1;
+                                }
+                                core_list[nr_usable - 1] = nr_all - 1;
+                        }
+                }
+        }
+
+        if (nr_usable < 1) {
+                mscp_set_error("invalid core mask: %s", coremask);
+                return -1;
+        }
+
+        *cores = core_list;
+        *nr_cores = nr_usable;
+        return 0;
+}
+
+static int default_nr_threads()
+{
+        return (int)(floor(log(nr_cpus()) * 2) + 1);
+}
+
+static int validate_and_set_defaut_params(struct mscp_opts *o)
+{
+	if (o->nr_threads < 0) {
+		mscp_set_error("invalid nr_threads: %d", o->nr_threads);
+		return -1;
+	} else if (o->nr_threads == 0)
+		o->nr_threads = default_nr_threads();
+
+	if (o->nr_ahead < 0) {
+		mscp_set_error("invalid nr_ahead: %d", o->nr_ahead);
+		return -1;
+	} else if (o->nr_ahead == 0)
+		o->nr_ahead = DEFAULT_NR_AHEAD;
+
+	if (o->min_chunk_sz == 0)
+		o->min_chunk_sz = DEFAULT_MIN_CHUNK_SZ;
+	else {
+		if (o->min_chunk_sz < getpagesize() ||
+		    o->min_chunk_sz % getpagesize() != 0) {
+			mscp_set_error("min chunk size must be "
+				       "larget than and multiple of page size %d: %lu",
+				       getpagesize(), o->min_chunk_sz);
+			return -1;
+		}
+	}
+
+	if (o->max_chunk_sz) {
+		if (o->max_chunk_sz < getpagesize() ||
+		    o->max_chunk_sz % getpagesize() != 0) {
+			mscp_set_error("min chunk size must be larget than and "
+				       "multiple of page size %d: %lu",
+				       getpagesize(), o->max_chunk_sz);
+		}
+		if (o->min_chunk_sz > o->max_chunk_sz) {
+			mscp_set_error("smaller max chunk size than "
+				       "min chunk size: %lu < %lu",
+				       o->max_chunk_sz, o->min_chunk_sz);
+			return -1;
+		}
+	}
+
+	if (o->buf_sz == 0)
+		o->buf_sz = DEFAULT_BUF_SZ;
+	else if (o->buf_sz == 0) {
+		mscp_set_error("invalid buf size: %lu", o->buf_sz);
+		return -1;
+	}
+
+	if (o->max_startups == 0)
+		o->max_startups = DEFAULT_MAX_STARTUPS;
+	else if (o->max_startups < 0) {
+		mscp_set_error("invalid max_startups: %d", o->max_startups);
+		return -1;
+	}
+
+	if (o->interval > 0) {
+		/* when the interval is set, establish SSH connections sequentially. */
+		o->max_startups = 1;
+	}
+
+	if (o->msg_fd == 0)
+		o->msg_fd = STDOUT_FILENO;
+
+	return 0;
+}
+
+struct mscp *mscp_init(const char *remote_host, int direction,
+		       struct mscp_opts *o, struct mscp_ssh_opts *s)
+{
+	struct mscp *m;
+	int n;
+
+	if (!remote_host) {
+		mscp_set_error("empty remote host");
+		return NULL;
+	}
+
+	if (!(direction == MSCP_DIRECTION_L2R ||
+	      direction == MSCP_DIRECTION_R2L)) {
+		mscp_set_error("invalid copy direction: %d", direction);
+		return NULL;
+	}
+
+	mprint_set_severity(o->severity);
+
+	if (validate_and_set_defaut_params(o) < 0) {
+		return NULL;
+	}
+
+	m = malloc(sizeof(*m));
+	if (!m) {
+		mscp_set_error("failed to allocate memory: %s", strerrno());
+		return NULL;
+	}
+
+	memset(m, 0, sizeof(*m));
+	INIT_LIST_HEAD(&m->src_list);
+	INIT_LIST_HEAD(&m->path_list);
+	chunk_pool_init(&m->cp);
+
+	INIT_LIST_HEAD(&m->thread_list);
+	rwlock_init(&m->thread_rwlock);
+
+	if ((m->sem = sem_create(o->max_startups)) == NULL) {
+		mscp_set_error("sem_create: %s", strerrno());
+		goto free_out;
+	}
+
+	m->remote = strdup(remote_host);
+	if (!m->remote) {
+		mscp_set_error("failed to allocate memory: %s", strerrno());
+		goto free_out;
+	}
+	m->direction = direction;
+	if (o->msg_fd > -1) {
+		m->msg_fp = fdopen(o->msg_fd, "a");
+		if (!m->msg_fp) {
+			mscp_set_error("fdopen failed: %s", strerrno());
+			goto free_out;
+		}
+	} else
+		m->msg_fp = NULL;
+
+	if (strlen(o->coremask) > 0) {
+		if (expand_coremask(o->coremask, &m->cores, &m->nr_cores) < 0)
+			goto free_out;
+		mpr_notice(m->msg_fp, "usable cpu cores:");
+		for (n = 0; n < m->nr_cores; n++)
+			mpr_notice(m->msg_fp, " %d", m->cores[n]);
+		mpr_notice(m->msg_fp, "\n");
+	}
+
+	m->opts = o;
+	m->ssh_opts = s;
+
+	return m;
+
+free_out:
+	free(m);
+	return NULL;
+}
+
+int mscp_connect(struct mscp *m)
+{
+	m->first = ssh_init_sftp_session(m->remote, m->ssh_opts);
+	if (!m->first)
+		return -1;
+
+	return 0;
+}
+
+int mscp_add_src_path(struct mscp *m, const char *src_path)
+{
+	struct src *s;
+
+	s = malloc(sizeof(*s));
+	if (!s) {
+		mscp_set_error("failed to allocate memory: %s", strerrno());
+		return -1;
+	}
+
+	memset(s, 0, sizeof(*s));
+	s->path = strdup(src_path);
+	if (!s->path) {
+		mscp_set_error("failed to allocate memory: %s", strerrno());
+		free(s);
+		return -1;
+	}
+
+	list_add_tail(&s->list, &m->src_list);
+	return 0;
+}
+
+int mscp_set_dst_path(struct mscp *m, const char *dst_path)
+{
+	if (strlen(dst_path) + 1 >= PATH_MAX) {
+		mscp_set_error("too long dst path: %s", dst_path);
+		return -1;
+	}
+
+	if (!non_null_string(dst_path))
+		strncpy(m->dst_path, ".", 1);
+	else
+		strncpy(m->dst_path, dst_path, PATH_MAX);
+
+	return 0;
+}
+
+static int get_page_mask(void)
+{
+        long page_sz = sysconf(_SC_PAGESIZE);
+        size_t page_mask = 0;
+        int n;
+
+        for (n = 0; page_sz > 0; page_sz >>= 1, n++) {
+                page_mask <<= 1;
+                page_mask |= 1;
+        }
+
+        return page_mask >> 1;
+}
+
+static void mscp_stop_copy_thread(struct mscp *m)
+{
+	struct mscp_thread *t;
+
+	RWLOCK_READ_ACQUIRE(&m->thread_rwlock);
+	list_for_each_entry(t, &m->thread_list, list) {
+		if (!t->finished)
+			pthread_cancel(t->tid);
+	}
+	RWLOCK_RELEASE();
+}
+
+static void mscp_stop_scan_thread(struct mscp *m)
+{
+	if (m->tid_scan)
+		pthread_cancel(m->tid_scan);
+}
+
+void mscp_stop(struct mscp *m)
+{
+	mscp_stop_scan_thread(m);
+	mscp_stop_copy_thread(m);
+}
+
+void *mscp_scan_thread(void *arg)
+{
+	struct mscp *m = arg;
+	sftp_session src_sftp = NULL, dst_sftp = NULL;
+	struct path_resolve_args a;
+	struct list_head tmp;
+	struct path *p;
+	struct src *s;
+	struct stat ss, ds;
+	glob_t pglob;
+	int n;
+	
+	m->ret_scan = 0;
+
+	switch (m->direction) {
+	case MSCP_DIRECTION_L2R:
+		src_sftp = NULL;
+		dst_sftp = m->first;
+		break;
+	case MSCP_DIRECTION_R2L:
+		src_sftp = m->first;
+		dst_sftp = NULL;
+		break;
+	default:
+		mscp_set_error("invalid copy direction: %d", m->direction);
+		goto err_out;
+	}
+
+	/* initialize path_resolve_args */
+	memset(&a, 0, sizeof(a));
+	a.msg_fp = m->msg_fp;
+	a.total_bytes = &m->total_bytes;
+
+	if (list_count(&m->src_list) > 1)
+		a.dst_path_should_dir = true;
+
+	if (mscp_stat(m->dst_path, &ds, dst_sftp) == 0) {
+		if (S_ISDIR(ds.st_mode))
+			a.dst_path_is_dir = true;
+	}
+
+	a.cp = &m->cp;
+	a.nr_conn = m->opts->nr_threads;
+	a.min_chunk_sz = m->opts->min_chunk_sz;
+	a.max_chunk_sz = m->opts->max_chunk_sz;
+	a.chunk_align = get_page_mask();
+
+	mpr_info(m->msg_fp, "start to walk source path(s)\n");
+
+	/* walk a src_path recusively, and resolve path->dst_path for each src */
+	list_for_each_entry(s, &m->src_list, list) {
+		memset(&pglob, 0, sizeof(pglob));
+		if (mscp_glob(s->path, GLOB_NOCHECK, &pglob, src_sftp) < 0) {
+			mscp_set_error("mscp_glob: %s", strerrno());
+			goto err_out;
+		}
+
+		for (n = 0; n < pglob.gl_pathc; n++) {
+			if (mscp_stat(pglob.gl_pathv[n], &ss, src_sftp) < 0) {
+				mscp_set_error("stat: %s %s", s->path, strerrno());
+				goto err_out;
+			}
+
+			if (!a.dst_path_should_dir && pglob.gl_pathc > 1)
+				a.dst_path_should_dir = true; /* we have over 1 src */
+
+			/* set path specific args */
+			a.src_path = pglob.gl_pathv[n];
+			a.dst_path = m->dst_path;
+			a.src_path_is_dir = S_ISDIR(ss.st_mode);
+
+			INIT_LIST_HEAD(&tmp);
+			if (walk_src_path(src_sftp, pglob.gl_pathv[n], &tmp, &a) < 0)
+				goto err_out;
+
+			list_splice_tail(&tmp, m->path_list.prev);
+		}
+		mscp_globfree(&pglob);
+	}
+
+	mpr_info(m->msg_fp, "walk source path(s) done\n");
+	chunk_pool_set_filled(&m->cp);
+	m->ret_scan = 0;
+	return NULL;
+
+err_out:
+	chunk_pool_set_filled(&m->cp);
+	m->ret_scan = -1;
+	return NULL;
+}
+
+int mscp_scan(struct mscp *m)
+{
+	int ret = pthread_create(&m->tid_scan, NULL, mscp_scan_thread, m);
+	if (ret < 0) {
+		mscp_set_error("pthread_create_error: %d", ret);
+		m->tid_scan = 0;
+		mscp_stop(m);
+		return -1;
+	}
+
+	/* We wait for there are over nr_threads chunks to determine
+	 * actual number of threads (and connections), or scan
+	 * finished. If the number of chunks are smaller than
+	 * nr_threads, we adjust nr_threads to the number of chunks.
+	 */
+	while (!chunk_pool_is_filled(&m->cp) &&
+	       chunk_pool_size(&m->cp) < m->opts->nr_threads)
+		usleep(100);
+
+	return 0;
+}
+
+int mscp_scan_join(struct mscp *m)
+{
+	if (m->tid_scan) {
+		pthread_join(m->tid_scan, NULL);
+		m->tid_scan = 0;
+		return m->ret_scan;
+	}
+	return 0;
+}
+
+
+
+static void *mscp_copy_thread(void *arg);
+
+static struct mscp_thread *mscp_copy_thread_spawn(struct mscp *m, int id)
+{
+	struct mscp_thread *t;
+	int ret;
+
+	t = malloc(sizeof(*t));
+	if (!t){
+		mscp_set_error("malloc: %s,", strerrno());
+		return NULL;
+	}
+
+	memset(t, 0, sizeof(*t));
+	t->m = m;
+	t->id = id;
+	if (m->cores == NULL)
+		t->cpu = -1;	/* not pinned to cpu */
+	else
+		t->cpu = m->cores[id % m->nr_cores];
+
+	ret = pthread_create(&t->tid, NULL, mscp_copy_thread, t);
+	if (ret < 0) {
+		mscp_set_error("pthread_create error: %d", ret);
+		free(t);
+		return NULL;
+	}
+
+	return t;
+}
+
+
+int mscp_start(struct mscp *m)
+{
+	struct mscp_thread *t;
+	int n, ret = 0;
+
+	if ((n = chunk_pool_size(&m->cp)) < m->opts->nr_threads) {
+		mpr_notice(m->msg_fp, "we have only %d chunk(s). "
+			   "set number of connections to %d\n", n, n);
+		m->opts->nr_threads = n;
+	}
+
+	for (n = 0; n < m->opts->nr_threads; n++) {
+		t = mscp_copy_thread_spawn(m, n);
+		if (!t) {
+			mpr_err(m->msg_fp, "failed to spawn copy thread\n");
+			break;
+		}
+		RWLOCK_WRITE_ACQUIRE(&m->thread_rwlock);
+		list_add_tail(&t->list, &m->thread_list);
+		RWLOCK_RELEASE();
+        }
+
+	return n;
+}
+
+int mscp_join(struct mscp *m)
+{
+	struct mscp_thread *t;
+	struct path *p;
+	size_t done = 0, nr_copied = 0, nr_tobe_copied = 0;
+	int n, ret = 0;
+
+	/* waiting for scan thread joins... */
+	ret = mscp_scan_join(m);
+
+        /* waiting for copy threads join... */
+	RWLOCK_READ_ACQUIRE(&m->thread_rwlock);
+	list_for_each_entry(t, &m->thread_list, list) {
+		pthread_join(t->tid, NULL);
+		done += t->done;
+		if (t->ret < 0)
+			ret = t->ret;
+		if (t->sftp) {
+			ssh_sftp_close(t->sftp);
+			t->sftp = NULL;
+		}
+	}
+	RWLOCK_RELEASE();
+
+        if (m->first) {
+                ssh_sftp_close(m->first);
+		m->first = NULL;
+	}
+
+	/* count up number of transferred files */
+	list_for_each_entry(p, &m->path_list, list) {
+		nr_tobe_copied++;
+		if (p->state == FILE_STATE_DONE) {
+			nr_copied++;
+		}
+	}
+
+	mpr_notice(m->msg_fp, "%lu/%lu bytes copied for %lu/%lu files\n",
+		   done, m->total_bytes, nr_copied, nr_tobe_copied);
+
+	return ret;
+}
+
+/* copy thread-related functions */
+
+static void wait_for_interval(int interval)
+{
+	_Atomic static long next;
+	struct timeval t;
+	long now;
+
+	gettimeofday(&t, NULL);
+	now = t.tv_sec * 1000000 + t.tv_usec;
+
+	if (next - now > 0)
+		usleep(next - now);
+
+	next = now + interval * 1000000;
+}
+
+static void mscp_copy_thread_cleanup(void *arg)
+{
+        struct mscp_thread *t = arg;
+        t->finished = true;
+}
+
+void *mscp_copy_thread(void *arg)
+{
+	sftp_session src_sftp, dst_sftp;
+	struct mscp_thread *t = arg;
+	struct mscp *m = t->m;
+	struct chunk *c;
+	bool nomore;
+
+        pthread_cleanup_push(mscp_copy_thread_cleanup, t);
+
+        if (t->cpu > -1) {
+                if (set_thread_affinity(pthread_self(), t->cpu) < 0)
+			goto err_out;
+        }
+
+	if (sem_wait(m->sem) < 0) {
+		mscp_set_error("sem_wait: %s", strerrno());
+		mpr_err(m->msg_fp, "%s", mscp_get_error());
+		goto err_out;
+	}
+
+	if (!(nomore = chunk_pool_is_empty(&m->cp))) {
+		if (m->opts->interval > 0)
+			wait_for_interval(m->opts->interval);
+		mpr_notice(m->msg_fp, "thread:%d connecting to %s\n", t->id, m->remote);
+		t->sftp = ssh_init_sftp_session(m->remote, m->ssh_opts);
+	}
+
+	if (sem_post(m->sem) < 0) {
+		mscp_set_error("sem_post: %s", strerrno());
+		mpr_err(m->msg_fp, "%s", mscp_get_error());
+		goto err_out;
+	}
+
+	if (nomore) {
+		mpr_notice(m->msg_fp, "thread:%d no more connections needed\n", t->id);
+		goto out;
+	}
+
+	if (!t->sftp) {
+		mpr_err(m->msg_fp, "thread:%d: %s\n", t->id, mscp_get_error());
+		goto err_out;
+	}
+
+        switch (m->direction) {
+        case MSCP_DIRECTION_L2R:
+                src_sftp = NULL;
+                dst_sftp = t->sftp;
+                break;
+        case MSCP_DIRECTION_R2L:
+                src_sftp = t->sftp;
+                dst_sftp = NULL;
+                break;
+        default:
+                return NULL; /* not reached */
+        }
+
+        while (1) {
+                c = chunk_pool_pop(&m->cp);
+		if (c == CHUNK_POP_WAIT) {
+			usleep(100); /* XXX: hard code */
+			continue;
+		}
+
+                if (!c)
+                        break; /* no more chunks */
+
+		if ((t->ret = copy_chunk(m->msg_fp,
+					 c, src_sftp, dst_sftp, m->opts->nr_ahead,
+					 m->opts->buf_sz, &t->done)) < 0)
+			break;
+        }
+
+        pthread_cleanup_pop(1);
+
+        if (t->ret < 0)
+		mpr_err(m->msg_fp, "thread:%d copy failed: %s 0x%010lx-0x%010lx\n",
+			t->id, c->p->path, c->off, c->off + c->len);
+
+        return NULL;
+
+err_out:
+	t->finished = true;
+	t->ret = -1;
+	return NULL;
+out:
+	t->finished = true;
+	t->ret = 0;
+	return NULL;
+}
+
+
+/* cleanup-related functions */
+
+static void list_free_src(struct list_head *list)
+{
+	struct src *s;
+	s = list_entry(list, typeof(*s), list);
+	free(s->path);
+	free(s);
+}
+
+static void list_free_path(struct list_head *list)
+{
+	struct path *p;
+	p = list_entry(list, typeof(*p), list);
+	free_path(p);
+}
+
+static void list_free_thread(struct list_head *list)
+{
+	struct mscp_thread *t;
+	t = list_entry(list, typeof(*t), list);
+	free(t);
+}
+
+void mscp_cleanup(struct mscp *m)
+{
+        if (m->first) {
+                ssh_sftp_close(m->first);
+		m->first = NULL;
+	}
+
+	list_free_f(&m->src_list, list_free_src);
+	INIT_LIST_HEAD(&m->src_list);
+
+	list_free_f(&m->path_list, list_free_path);
+	INIT_LIST_HEAD(&m->path_list);
+
+	chunk_pool_release(&m->cp);
+	chunk_pool_init(&m->cp);
+
+	RWLOCK_WRITE_ACQUIRE(&m->thread_rwlock);
+	list_free_f(&m->thread_list, list_free_thread);
+	RWLOCK_RELEASE();
+}
+
+void mscp_free(struct mscp *m)
+{
+	mscp_cleanup(m);
+	if (m->remote)
+		free(m->remote);
+	if (m->cores)
+		free(m->cores);
+
+	sem_release(m->sem);
+	free(m);
+}
+
+void mscp_get_stats(struct mscp *m, struct mscp_stats *s)
+{
+	int nr_finished = 0, nr_threads = 0;
+	struct mscp_thread *t;
+
+	s->total = m->total_bytes;
+	s->done = 0;
+
+	RWLOCK_READ_ACQUIRE(&m->thread_rwlock);
+	list_for_each_entry(t, &m->thread_list, list) {
+		nr_threads++;
+		s->done += t->done;
+		if (t->finished)
+			nr_finished++;
+	}
+	RWLOCK_RELEASE();
+
+	s->finished = nr_threads > 0 ? (nr_finished == nr_threads) : false;
+}

src/path.c

@@ -0,0 +1,619 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#include <string.h>
+#include <unistd.h>
+#include <dirent.h>
+#include <sys/stat.h>
+#include <libgen.h>
+#include <assert.h>
+
+#include <ssh.h>
+#include <util.h>
+#include <fileops.h>
+#include <list.h>
+#include <atomic.h>
+#include <path.h>
+#include <message.h>
+
+/* chunk pool operations */
+#define CHUNK_POOL_STATE_FILLING	0
+#define CHUNK_POOL_STATE_FILLED		1
+
+void chunk_pool_init(struct chunk_pool *cp)
+{
+	memset(cp, 0, sizeof(*cp));
+	INIT_LIST_HEAD(&cp->list);
+	lock_init(&cp->lock);
+	cp->state = CHUNK_POOL_STATE_FILLING;
+}
+
+static void chunk_pool_add(struct chunk_pool *cp, struct chunk *c)
+{
+	LOCK_ACQUIRE(&cp->lock);
+	list_add_tail(&c->list, &cp->list);
+	cp->count += 1;
+	LOCK_RELEASE();
+}
+
+void chunk_pool_set_filled(struct chunk_pool *cp)
+{
+	cp->state = CHUNK_POOL_STATE_FILLED;
+}
+
+bool chunk_pool_is_filled(struct chunk_pool *cp)
+{
+	return (cp->state == CHUNK_POOL_STATE_FILLED);
+}
+
+size_t chunk_pool_size(struct chunk_pool *cp)
+{
+	return cp->count;
+}
+
+bool chunk_pool_is_empty(struct chunk_pool *cp)
+{
+	return list_empty(&cp->list);
+}
+
+struct chunk *chunk_pool_pop(struct chunk_pool *cp)
+{
+	struct list_head *first;
+	struct chunk *c = NULL;
+
+	LOCK_ACQUIRE(&cp->lock);
+	first = cp->list.next;
+	if (list_empty(&cp->list)) {
+		if (!chunk_pool_is_filled(cp))
+			c = CHUNK_POP_WAIT;
+		else
+			c = NULL; /* no more chunks */
+	} else {
+		c = list_entry(first, struct chunk, list);
+		list_del(first);
+	}
+	LOCK_RELEASE();
+
+	/* return CHUNK_POP_WAIT would be a rare case, because it
+	 * means copying over SSH is faster than traversing
+	 * local/remote file paths.
+	 */
+
+	return c;
+}
+
+static void chunk_free(struct list_head *list)
+{
+        struct chunk *c;
+        c = list_entry(list, typeof(*c), list);
+        free(c);
+}
+
+void chunk_pool_release(struct chunk_pool *cp)
+{
+	list_free_f(&cp->list, chunk_free);
+}
+
+/* paths of copy source resoltion */
+static char *resolve_dst_path(const char *src_file_path, struct path_resolve_args *a)
+{
+        char copy[PATH_MAX + 1], dst_file_path[PATH_MAX + 1];
+        char *prefix;
+        int offset;
+	int ret;
+
+        strncpy(copy, a->src_path, PATH_MAX);
+        prefix = dirname(copy);
+        if (!prefix) {
+                mscp_set_error("dirname: %s", strerrno());
+                return NULL;
+        }
+
+	offset = strlen(prefix) + 1;
+	if (strlen(prefix) == 1) { /* corner cases */
+		switch (prefix[0]) {
+		case '.':
+			offset = 0;
+			break;
+		case '/':
+			offset = 1;
+			break;
+		}
+	}
+
+        if (!a->src_path_is_dir && !a->dst_path_is_dir) {
+                /* src path is file. dst path is (1) file, or (2) does not exist.
+                 * In the second case, we need to put src under the dst.
+                 */
+                if (a->dst_path_should_dir)
+                        ret = snprintf(dst_file_path, PATH_MAX, "%s/%s",
+				       a->dst_path, a->src_path + offset);
+                else
+                        ret = snprintf(dst_file_path, PATH_MAX, "%s", a->dst_path);
+        }
+
+        /* src is file, and dst is dir */
+        if (!a->src_path_is_dir && a->dst_path_is_dir)
+                ret = snprintf(dst_file_path, PATH_MAX, "%s/%s",
+			       a->dst_path, a->src_path + offset);
+
+        /* both are directory */
+        if (a->src_path_is_dir && a->dst_path_is_dir)
+                ret = snprintf(dst_file_path, PATH_MAX, "%s/%s",
+			       a->dst_path, src_file_path + offset);
+
+        /* dst path does not exist. change dir name to dst_path */
+        if (a->src_path_is_dir && !a->dst_path_is_dir)
+                ret = snprintf(dst_file_path, PATH_MAX, "%s/%s",
+			       a->dst_path, src_file_path + strlen(a->src_path) + 1);
+
+	if (ret >= PATH_MAX) {
+		mpr_warn(a->msg_fp, "Too long path: %s\n", dst_file_path);
+		return NULL;
+	}
+
+        mpr_debug(a->msg_fp, "file: %s -> %s\n", src_file_path, dst_file_path);
+
+        return strndup(dst_file_path, PATH_MAX);
+}
+
+/* chunk preparation */
+static struct chunk *alloc_chunk(struct path *p)
+{
+        struct chunk *c;
+
+        if (!(c = malloc(sizeof(*c)))) {
+                mscp_set_error("malloc %s", strerrno());
+                return NULL;
+        }
+        memset(c, 0, sizeof(*c));
+
+        c->p = p;
+        c->off = 0;
+        c->len = 0;
+        refcnt_inc(&p->refcnt);
+        return c;
+}
+
+static int resolve_chunk(struct path *p, struct path_resolve_args *a)
+{
+        struct chunk *c;
+        size_t chunk_sz;
+        size_t size;
+
+        if (p->size <= a->min_chunk_sz)
+                chunk_sz = p->size;
+        else if (a->max_chunk_sz)
+                chunk_sz = a->max_chunk_sz;
+        else {
+                chunk_sz = (p->size - (p->size % a->nr_conn)) / a->nr_conn;
+                chunk_sz &= ~a->chunk_align; /* align with page_sz */
+                if (chunk_sz <= a->min_chunk_sz)
+                        chunk_sz = a->min_chunk_sz;
+        }
+
+        /* for (size = f->size; size > 0;) does not create a file
+         * (chunk) when file size is 0. This do {} while (size > 0)
+         * creates just open/close a 0-byte file.
+         */
+        size = p->size;
+        do {
+                c = alloc_chunk(p);
+                if (!c)
+                        return -1;
+                c->off = p->size - size;
+                c->len = size < chunk_sz ? size : chunk_sz;
+                size -= c->len;
+                chunk_pool_add(a->cp, c);
+        } while (size > 0);
+
+        return 0;
+}
+
+void free_path(struct path *p)
+{
+	if (p->path)
+		free(p->path);
+	if (p->dst_path)
+		free(p->dst_path);
+	free(p);
+}
+
+static int append_path(sftp_session sftp, const char *path, struct stat st,
+		       struct list_head *path_list, struct path_resolve_args *a)
+{
+	struct path *p;
+
+	if (!(p = malloc(sizeof(*p)))) {
+		mscp_set_error("failed to allocate memory: %s", strerrno());
+		return -1;
+	}
+
+	memset(p, 0, sizeof(*p));
+	INIT_LIST_HEAD(&p->list);
+	p->path = strndup(path, PATH_MAX);
+	if (!p->path)
+		goto free_out;
+	p->size = st.st_size;
+	p->mode = st.st_mode;
+	p->state = FILE_STATE_INIT;
+	lock_init(&p->lock);
+
+	p->dst_path = resolve_dst_path(p->path, a);
+	if (!p->dst_path)
+		goto free_out;
+
+	if (resolve_chunk(p, a) < 0)
+		return -1; /* XXX: do not free path becuase chunk(s)
+			    * was added to chunk pool already */
+
+	list_add_tail(&p->list, path_list);
+	*a->total_bytes += p->size;
+
+	return 0;
+
+free_out:
+	free_path(p);
+	return -1;
+}
+
+static bool check_path_should_skip(const char *path)
+{               
+        int len = strlen(path);
+        if ((len == 1 && strncmp(path, ".", 1) == 0) ||
+            (len == 2 && strncmp(path, "..", 2) == 0)) {
+                return true;
+        }
+        return false; 
+}
+
+static int walk_path_recursive(sftp_session sftp, const char *path,
+			       struct list_head *path_list, struct path_resolve_args *a)
+{
+	char next_path[PATH_MAX + 1];
+	struct dirent *e;
+	struct stat st;
+	MDIR *d;
+	int ret;
+
+	if (mscp_stat(path, &st, sftp) < 0) {
+		mpr_warn(a->msg_fp, "%s: %s\n",  strerrno(), path);
+		return -1;
+	}
+
+	if (S_ISREG(st.st_mode)) {
+		/* this path is regular file. it is to be copied */
+		return append_path(sftp, path, st, path_list, a);
+	}
+
+	if (!S_ISDIR(st.st_mode))
+		return 0; /* not a regular file and not a directory, skip it. */
+
+	/* ok, this path is a directory. walk through it. */
+	if (!(d = mscp_opendir(path, sftp))) {
+		mpr_warn(a->msg_fp, "%s: %s\n", strerrno(), path);
+		return -1;
+	}
+	
+	for (e = mscp_readdir(d); e; e = mscp_readdir(d)) {
+		if (check_path_should_skip(e->d_name))
+			continue;
+		
+		ret = snprintf(next_path, PATH_MAX, "%s/%s", path, e->d_name);
+		if (ret >= PATH_MAX) {
+			mpr_warn(a->msg_fp, "Too long path: %s/%s\n", path, e->d_name);
+			continue;
+		}
+
+		walk_path_recursive(sftp, next_path, path_list, a);
+		/* do not stop even when walk_path_recursive returns
+		 * -1 due to an unreadable file. go to a next file. */
+	}
+
+	mscp_closedir(d);
+
+	return 0;
+}
+
+int walk_src_path(sftp_session src_sftp, const char *src_path,
+		  struct list_head *path_list, struct path_resolve_args *a)
+{
+	return walk_path_recursive(src_sftp, src_path, path_list, a);
+}
+
+void path_dump(struct list_head *path_list)
+{
+	struct path *p;
+
+	list_for_each_entry(p, path_list, list) {
+		printf("src: %s %lu-byte\n", p->path, p->size);
+		printf("dst: %s\n", p->dst_path);
+	}
+}
+	
+
+
+/* based on
+ * https://stackoverflow.com/questions/2336242/recursive-mkdir-system-call-on-unix */
+static int touch_dst_path(struct path *p, sftp_session sftp)
+{
+        /* XXX: should reflect the permission of the original directory? */
+        mode_t mode =  S_IRWXU | S_IRWXG | S_IRWXO;
+	struct stat st;
+        char path[PATH_MAX];
+        char *needle;
+        int ret;
+	mf *f;
+
+        strncpy(path, p->dst_path, sizeof(path));
+
+        /* mkdir -p.
+	 * XXX: this may be slow when dst is the remote side. need speed-up. */
+        for (needle = strchr(path + 1, '/'); needle; needle = strchr(needle + 1, '/')) {
+                *needle = '\0';
+
+		if (mscp_stat(path, &st, sftp) == 0) {
+			if (S_ISDIR(st.st_mode))
+				goto next; /* directory exists. go deeper */
+			else
+				return -1; /* path exists, but not directory. */
+		}
+
+		if (errno == ENOENT) {
+			/* no file on the path. create directory. */
+			if (mscp_mkdir(path, mode, sftp) < 0) {
+				mscp_set_error("mscp_mkdir %s: %s", path, strerrno());
+				return -1;
+			}
+		}
+        next:
+                *needle = '/';
+        }
+
+	/* Do not set O_TRUNC here. Instead, do mscp_setstat() at the
+	 * end. see https://bugzilla.mindrot.org/show_bug.cgi?id=3431 */
+	f = mscp_open(p->dst_path, O_WRONLY|O_CREAT, S_IRUSR|S_IWUSR, sftp);
+	if (!f) {
+		mscp_set_error("mscp_open %s: %s\n", p->dst_path, strerrno());
+		return -1;
+	}
+
+	mscp_close(f);
+
+        return 0;
+}
+
+static int prepare_dst_path(FILE *msg_fp, struct path *p, sftp_session dst_sftp)
+{
+	int ret = 0;
+
+	LOCK_ACQUIRE(&p->lock);
+	if (p->state == FILE_STATE_INIT) {
+		if (touch_dst_path(p, dst_sftp) < 0) {
+			ret = -1;
+			goto out;
+		}
+		p->state = FILE_STATE_OPENED;
+		mpr_info(msg_fp, "copy start: %s\n", p->path);
+	}
+
+out:
+	LOCK_RELEASE();
+	return ret;
+}
+
+
+/* functions for copy */
+
+static ssize_t read_to_buf(void *ptr, size_t len, void *userdata)
+{
+        int fd = *((int *)userdata);
+        return read(fd, ptr, len);
+}
+
+static int copy_chunk_l2r(struct chunk *c, int fd, sftp_file sf,
+			  int nr_ahead, int buf_sz, size_t *counter)
+{
+        ssize_t read_bytes, remaind, thrown;
+        int idx, ret;
+        struct {
+                uint32_t id;
+                ssize_t  len;
+        } reqs[nr_ahead];
+
+        if (c->len == 0)
+                return 0;
+
+        remaind = thrown = c->len;
+        for (idx = 0; idx < nr_ahead && thrown > 0; idx++) {
+                reqs[idx].len = min(thrown, buf_sz);
+                reqs[idx].len = sftp_async_write(sf, read_to_buf, reqs[idx].len, &fd,
+                                                 &reqs[idx].id);
+                if (reqs[idx].len < 0) {
+                        mscp_set_error("sftp_async_write: %s or %s",
+				       sftp_get_ssh_error(sf->sftp), strerrno());
+                        return -1;
+                }
+                thrown -= reqs[idx].len;
+        }
+
+        for (idx = 0; remaind > 0; idx = (idx + 1) % nr_ahead) {
+                ret = sftp_async_write_end(sf, reqs[idx].id, 1);
+                if (ret != SSH_OK) {
+                        mscp_set_error("sftp_async_write_end: %s",
+				       sftp_get_ssh_error(sf->sftp));
+                        return -1;
+                }
+
+                *counter += reqs[idx].len;
+                remaind -= reqs[idx].len;
+
+                if (remaind <= 0)
+                        break;
+
+                if (thrown <= 0)
+                        continue;
+
+                reqs[idx].len = min(thrown, buf_sz);
+                reqs[idx].len = sftp_async_write(sf, read_to_buf, reqs[idx].len, &fd,
+                                                 &reqs[idx].id);
+                if (reqs[idx].len < 0) {
+                        mscp_set_error("sftp_async_write: %s or %s",
+				       sftp_get_ssh_error(sf->sftp), strerrno());
+                        return -1;
+                }
+                thrown -= reqs[idx].len;
+        }
+
+        if (remaind < 0) {
+                mscp_set_error("invalid remaind bytes %ld. "
+			       "last async_write_end bytes %lu.",
+			       remaind, reqs[idx].len);
+                return -1;
+        }
+
+        return 0;
+
+}
+
+static int copy_chunk_r2l(struct chunk *c, sftp_file sf, int fd,
+			  int nr_ahead, int buf_sz, size_t *counter)
+{
+        ssize_t read_bytes, write_bytes, remaind, thrown;
+        char buf[buf_sz];
+        int idx;
+        struct {
+                int id;
+                ssize_t len;
+        } reqs[nr_ahead];
+
+        if (c->len == 0)
+                return 0;
+
+        remaind = thrown = c->len;
+
+        for (idx = 0; idx < nr_ahead && thrown > 0; idx++) {
+                reqs[idx].len = min(thrown, sizeof(buf));
+                reqs[idx].id = sftp_async_read_begin(sf, reqs[idx].len);
+                if (reqs[idx].id < 0) {
+                        mscp_set_error("sftp_async_read_begin: %d",
+				       sftp_get_error(sf->sftp));
+                        return -1;
+                }
+                thrown -= reqs[idx].len;
+        }
+
+        for (idx = 0; remaind > 0; idx = (idx + 1) % nr_ahead) {
+                read_bytes = sftp_async_read(sf, buf, reqs[idx].len, reqs[idx].id);
+                if (read_bytes == SSH_ERROR) {
+                        mscp_set_error("sftp_async_read: %d",
+				       sftp_get_error(sf->sftp));
+                        return -1;
+                }
+
+                if (thrown > 0) {
+                        reqs[idx].len = min(thrown, sizeof(buf));
+                        reqs[idx].id = sftp_async_read_begin(sf, reqs[idx].len);
+                        thrown -= reqs[idx].len;
+                }
+
+                write_bytes = write(fd, buf, read_bytes);
+                if (write_bytes < 0) {
+                        mscp_set_error("write: %s", strerrno());
+                        return -1;
+                }
+
+                if (write_bytes < read_bytes) {
+                        mscp_set_error("failed to write full bytes");
+                        return -1;
+                }
+
+                *counter += write_bytes;
+                remaind -= read_bytes;
+        }
+
+        if (remaind < 0) {
+                mscp_set_error("invalid remaind bytes %ld. last async_read bytes %ld. "
+			       "last write bytes %ld",
+			       remaind, read_bytes, write_bytes);
+                return -1;
+        }
+
+        return 0;
+}
+
+static int _copy_chunk(struct chunk *c, mf *s, mf *d,
+		       int nr_ahead, int buf_sz, size_t *counter)
+{
+	if (s->local && d->remote) /* local to remote copy */
+		return copy_chunk_l2r(c, s->local, d->remote, nr_ahead, buf_sz, counter);
+	else if (s->remote && d->local)  /* remote to local copy */
+		return copy_chunk_r2l(c, s->remote, d->local, nr_ahead, buf_sz, counter);
+
+	assert(false);
+	return -1; /* not reached */
+}
+
+int copy_chunk(FILE *msg_fp, struct chunk *c,
+	       sftp_session src_sftp, sftp_session dst_sftp,
+	       int nr_ahead, int buf_sz, size_t *counter)
+{
+	mode_t mode;
+	int flags;
+	mf *s, *d;
+	int ret;
+
+	assert((src_sftp && !dst_sftp) || (!src_sftp && dst_sftp));
+
+	if (prepare_dst_path(msg_fp, c->p, dst_sftp) < 0)
+		return -1;
+
+	/* open src */
+        flags = O_RDONLY;
+        mode = S_IRUSR;
+	s = mscp_open(c->p->path, flags, mode, src_sftp);
+	if (!s) {
+		mscp_set_error("mscp_open: %s: %s", c->p->path, strerrno());
+		return -1;
+	}
+	if (mscp_lseek(s, c->off) < 0) {
+		mscp_set_error("mscp_lseek: %s: %s", c->p->path, strerrno());
+		return -1;
+	}
+
+	/* open dst */
+        flags = O_WRONLY;
+        mode = S_IRUSR|S_IWUSR;
+	d = mscp_open(c->p->dst_path, flags, mode, dst_sftp);
+	if (!d) {
+		mscp_close(s);
+		mscp_set_error("mscp_open: %s: %s", c->p->dst_path, strerrno());
+		return -1;
+	}
+	if (mscp_lseek(d, c->off) < 0) {
+		mscp_set_error("mscp_lseek: %s: %s", c->p->dst_path, strerrno());
+		return -1;
+	}
+
+	mpr_debug(msg_fp, "copy chunk start: %s 0x%lx-0x%lx\n",
+		  c->p->path, c->off, c->off + c->len);
+
+	ret = _copy_chunk(c, s, d, nr_ahead, buf_sz, counter);
+
+	mpr_debug(msg_fp, "copy chunk done: %s 0x%lx-0x%lx\n",
+		  c->p->path, c->off, c->off + c->len);
+
+
+	mscp_close(d);
+	mscp_close(s);
+	if (ret < 0)
+		return ret;
+
+	if (refcnt_dec(&c->p->refcnt) == 0) {
+		c->p->state = FILE_STATE_DONE;
+		if (mscp_setstat(c->p->dst_path, c->p->mode, c->p->size, dst_sftp) < 0)
+			mpr_err(msg_fp, "failed to chmod and truncate %s: %s\n",
+				c->p->path, strerrno());
+		mpr_info(msg_fp, "copy done: %s\n", c->p->path);
+	}
+
+	return ret;
+}

src/path.h

@@ -0,0 +1,108 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#ifndef _PATH_H_
+#define _PATH_H_
+
+#include <limits.h>
+#include <fcntl.h>
+#include <dirent.h>
+#include <sys/stat.h>
+
+#include <list.h>
+#include <atomic.h>
+#include <ssh.h>
+#include <message.h>
+
+struct path {
+	struct list_head	list;	/* mscp->path_list */
+
+	char	*path;		/* file path */
+	size_t	size;		/* size of file on this path */
+	mode_t	mode;		/* permission */
+
+	char	*dst_path;	/* copy dst path */
+
+	int	state;
+	lock	lock;
+	refcnt	refcnt;
+};
+#define FILE_STATE_INIT         0
+#define FILE_STATE_OPENED       1
+#define FILE_STATE_DONE         2
+
+struct chunk {
+	struct list_head	list;	/* chunk_pool->list */
+
+	struct path *p;
+	size_t	off;	/* offset of this chunk on the file on path p */
+	size_t	len;	/* length of this chunk */
+	size_t	done;	/* copied bytes for this chunk by a thread */
+};
+
+struct chunk_pool {
+        struct list_head        list; /* list of struct chunk */
+	size_t			count;
+        lock                    lock;
+        int                     state;
+};
+
+
+/* initialize chunk pool */
+void chunk_pool_init(struct chunk_pool *cp);
+
+/* acquire a chunk from pool. return value is NULL indicates no more
+ * chunk, GET_CHUNK_WAIT means caller should waits until a chunk is
+ * added, or pointer to chunk.
+ */
+struct chunk *chunk_pool_pop(struct chunk_pool *cp);
+#define CHUNK_POP_WAIT ((void *) -1)
+
+/* set and check fillingchunks to this pool has finished */
+void chunk_pool_set_filled(struct chunk_pool *cp);
+bool chunk_pool_is_filled(struct chunk_pool *cp);
+
+/* return number of chunks in the pool */
+size_t chunk_pool_size(struct chunk_pool *cp);
+
+/* return true if chunk pool is empty (all chunks are already poped) */
+bool chunk_pool_is_empty(struct chunk_pool *cp);
+
+/* free chunks in the chunk_pool */
+void chunk_pool_release(struct chunk_pool *cp);
+
+
+
+struct path_resolve_args {
+        FILE	*msg_fp;
+	size_t	*total_bytes;
+
+        /* args to resolve src path to dst path */
+        const char      *src_path;
+        const char      *dst_path;
+        bool            src_path_is_dir;
+        bool            dst_path_is_dir;
+        bool            dst_path_should_dir;
+
+        /* args to resolve chunks for a path */
+        struct chunk_pool *cp;
+        int             nr_conn;
+        size_t          min_chunk_sz;
+        size_t          max_chunk_sz;
+	size_t		chunk_align;
+};
+
+/* recursivly walk through src_path and fill path_list for each file */
+int walk_src_path(sftp_session src_sftp, const char *src_path,
+		  struct list_head *path_list, struct path_resolve_args *a);
+
+/* free struct path */
+void free_path(struct path *p);
+
+/* copy a chunk. either src_sftp or dst_sftp is not null, and another is null */
+int copy_chunk(FILE *msg_fp, struct chunk *c,
+	       sftp_session src_sftp, sftp_session dst_sftp,
+	       int nr_ahead, int buf_sz, size_t *counter);
+
+/* just print contents. just for debugging */
+void path_dump(struct list_head *path_list);
+
+#endif /* _PATH_H_ */

src/platform.c

@@ -1,15 +1,20 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #ifdef __APPLE__
+#include <stdlib.h>
 #include <sys/types.h>
 #include <sys/sysctl.h>
 #elif linux
 #define _GNU_SOURCE
 #include <sched.h>
+#include <stdlib.h>
 #else
 #error unsupported platform
 #endif
 
 #include <util.h>
 #include <platform.h>
+#include <message.h>
+
 
 #ifdef __APPLE__
 int nr_cpus()
@@ -18,7 +23,7 @@ int nr_cpus()
 	size_t size = sizeof(n);
 
 	if (sysctlbyname("machdep.cpu.core_count", &n, &size, NULL, 0) != 0) {
-		pr_err("failed to get number of cpu cores: %s\n", strerrno());
+		mscp_set_error("failed to get number of cpu cores: %s", strerrno());
 		return -1;
 	}
 
@@ -31,6 +36,38 @@ int set_thread_affinity(pthread_t tid, int core)
 	return 0;
 }
 
+
+static void random_string(char *buf, size_t size)
+{
+        char chars[] = "abcdefhijklmnopqrstuvwxyz1234567890";
+        int n, x;
+
+        for (n = 0; n < size - 1; n++) {
+                x = arc4random() % (sizeof(chars) - 1);
+                buf[n] = chars[x];
+        }
+        buf[size - 1] = '\0';
+}
+
+sem_t *sem_create(int value)
+{
+	char sem_name[30] = "mscp-";
+	sem_t *sem;
+	int n;
+
+        n = strlen(sem_name);
+        random_string(sem_name + n, sizeof(sem_name) - n - 1);
+        if ((sem = sem_open(sem_name, O_CREAT, 600, value)) == SEM_FAILED)
+	    return NULL;
+
+	return sem;
+}
+
+int sem_release(sem_t *sem)
+{
+	return sem_close(sem);
+}
+
 #endif
 
 #ifdef linux
@@ -51,9 +88,31 @@ int set_thread_affinity(pthread_t tid, int core)
 	CPU_SET(core, &target_cpu_set);
 	ret = pthread_setaffinity_np(tid, sizeof(target_cpu_set), &target_cpu_set);
 	if (ret < 0)
-		pr_err("failed to set thread/cpu affinity for core %d: %s",
-		       core, strerrno());
+		mscp_set_error("failed to set thread/cpu affinity for core %d: %s",
+			       core, strerrno());
 	return ret;
 }
+
+sem_t *sem_create(int value)
+{
+	sem_t *sem;
+
+	if ((sem = malloc(sizeof(*sem))) == NULL)
+		return NULL;
+
+	if (sem_init(sem, 0, value) < 0) {
+		free(sem);
+		return NULL;
+	}
+
+	return sem;
+}
+
+int sem_release(sem_t *sem)
+{
+	free(sem);
+	return 0;
+}
+
 #endif
 

src/platform.h

@@ -1,9 +1,22 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #ifndef _PLATFORM_H_
 #define _PLATFORM_H_
 
 #include <pthread.h>
+#include <semaphore.h>
 
-int nr_cpus();
+int nr_cpus(void);
 int set_thread_affinity(pthread_t tid, int core);
 
+/*
+ * macOS does not support sem_init(). macOS (seems to) releases the
+ * named semaphore when associated mscp process finished. In linux,
+ * program (seems to) need to release named semaphore in /dev/shm by
+ * sem_unlink() explicitly. So, using sem_init() (unnamed semaphore)
+ * in linux and using sem_open() (named semaphore) in macOS without
+ * sem_unlink() are reasonable (?).
+ */
+sem_t *sem_create(int value);
+int sem_release(sem_t *sem);
+
 #endif /* _PLATFORM_H_ */

src/pprint.c

@@ -1,27 +0,0 @@
-#include <stdio.h>
-#include <stdarg.h>
-#include <pthread.h>
-
-static int pprint_level = 1;
-
-static pthread_mutex_t pprint_lock = PTHREAD_MUTEX_INITIALIZER;
-
-void pprint_set_level(int level)
-{
-	pprint_level = level;
-}
-
-void pprint(int level, const char *fmt, ...)
-{
-	va_list va;
-
-	if (level <= pprint_level) {
-		pthread_mutex_lock(&pprint_lock);
-		va_start(va, fmt);
-		vfprintf(stdout, fmt, va);
-		fflush(stdout);
-		va_end(va);
-		pthread_mutex_unlock(&pprint_lock);
-	}
-}
-

src/pprint.h

@@ -1,20 +0,0 @@
-#ifndef _PPRINT_H_
-#define _PPRINT_H_
-
-/* progress print functions */
-
-/* level 1: print progress bar only.
- * level 2: print copy start/done messages.
- * level 3: print ssh connection establishment/disconnection.
- * level 4: print chunk information.
- */
-void pprint_set_level(int level);
-void pprint(int level, const char *fmt, ...);
-
-#define pprint1(fmt, ...) pprint(1, "\r\033[K" fmt, ##__VA_ARGS__)
-#define pprint2(fmt, ...) pprint(2, "\r\033[K" fmt, ##__VA_ARGS__)
-#define pprint3(fmt, ...) pprint(3, "\r\033[K" fmt, ##__VA_ARGS__)
-#define pprint4(fmt, ...) pprint(4, "\r\033[K" fmt, ##__VA_ARGS__)
-
-
-#endif /* _PPRRINT_H_ */

src/pymscp.c

@@ -0,0 +1,499 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+#include <errno.h>
+#include <stdio.h>
+#include <string.h>
+#include <mscp.h>
+
+/*
+ * This is a wrapper for python binding of libmscp. setup.py builds
+ * pymscp.c after libmscp was built, and setup.py installs pymscp
+ * modlue and mscp python module (mscp/mscp.py), which is a warpper
+ * for pymscp.
+ */
+
+#define MAX_MSCP_INSTS	64
+
+/* XXX: cut corners */
+struct instance {
+	struct mscp_opts mo;
+	struct mscp_ssh_opts so;
+	struct mscp *m;
+};
+
+struct instance *insts[MAX_MSCP_INSTS];
+
+static int add_instance(struct instance *i)
+{
+	int n;
+	for (n = 0; n < MAX_MSCP_INSTS; n++) {
+		if (insts[n] == NULL) {
+			insts[n] = i;
+			return 0;
+		}
+	}
+
+	return -1; /* full of mscp instances */
+}
+
+static struct instance *get_instance(unsigned long long addr)
+{
+	int n;
+	for (n = 0; n < MAX_MSCP_INSTS; n++) {
+		if (insts[n] == (void *)addr)
+			return insts[n];
+	}
+
+	return NULL;
+}
+
+static struct mscp *get_mscp(unsigned long long addr)
+{
+	struct instance *i = get_instance(addr);
+
+	if (!i)
+		return NULL;
+	return i->m;
+}
+
+static int release_instance(struct instance *i)
+{
+	int n;
+	for (n = 0; n < MAX_MSCP_INSTS; n++) {
+		if (insts[n] == i) {
+			insts[n] = NULL;
+			return 0;
+		}
+	}
+
+	free(i);
+
+	return -1;
+}
+
+
+/* wrapper functions */
+
+static PyObject *wrap_mscp_init(PyObject *self, PyObject *args, PyObject *kw)
+{
+	/*
+	 * Initialize struct mscp with options.  wrap_mscp_init
+	 * receives all the arguments with keywords.
+	 */
+
+	char *remote;
+	char *keywords[] = {
+		"remote",	/* const char * */
+		"direction",	/* int, MSCP_DIRECTION_L2R or MSCP_DIRECTION_R2L */
+
+		/* mscp_opts */
+		"nr_threads", 	/* int */
+		"nr_ahead",	/* int */
+
+		"min_chunk_sz",	/* unsigned long */
+		"max_chunk_sz",	/* unsigned long */
+		"buf_sz",	/* unsigned long */
+
+		"coremask",	/* const char * */
+
+		"max_startups",	/* int */
+		"interval",	/* int */
+		"severity",	/* int, MSCP_SERVERITY_* */
+		"msg_fd",	/* int */
+
+		/*  mscp_ssh_opts */
+		"login_name",	/* const char * */
+		"port",		/* const char * */
+		"config",	/* const char * */
+		"identity",	/* const char * */
+
+		"cipher",	/* const char * */
+		"hmac",		/* const char * */
+		"compress",	/* const char * */
+		"ccalgo",       /* const char * */
+		"password",	/* const char * */
+		"passphrase",	/* const char * */
+
+		"debug_level",	/* int */
+		"no_hostkey_check",	/* bool */
+		"enable_nagle",		/* bool */
+		NULL,
+	};
+	const char *fmt = "si" "|" "ii" "kkk" "s" "iiii" "ssss" "ssssss" "ipp";
+	char *coremask = NULL;
+	char *login_name = NULL, *port = NULL, *config = NULL, *identity = NULL;
+	char *cipher = NULL, *hmac = NULL, *compress = NULL, *ccalgo = NULL;
+	char *password = NULL, *passphrase = NULL;
+
+	struct instance *i;
+	int direction;
+	int ret;
+
+	i = malloc(sizeof(*i));
+	if (!i) {
+		PyErr_Format(PyExc_RuntimeError, strerror(errno));
+		return NULL;
+	}
+
+	memset(i, 0, sizeof(*i));
+	
+	ret = PyArg_ParseTupleAndKeywords(args, kw, fmt, keywords,
+					  &remote,
+					  &direction,
+					  &i->mo.nr_threads,
+					  &i->mo.nr_ahead,
+					  &i->mo.min_chunk_sz,
+					  &i->mo.max_chunk_sz,
+					  &i->mo.buf_sz,
+					  &coremask,
+					  &i->mo.max_startups,
+					  &i->mo.interval,
+					  &i->mo.severity,
+					  &i->mo.msg_fd,
+					  &login_name,
+					  &port,
+					  &config,
+					  &identity,
+					  &cipher,
+					  &hmac,
+					  &compress,
+					  &ccalgo,
+					  &password,
+					  &passphrase,
+					  &i->so.debug_level,
+					  &i->so.no_hostkey_check,
+					  &i->so.enable_nagle);
+		
+	if (!ret)
+		return NULL;
+
+	if (coremask)
+		strncpy(i->mo.coremask, coremask, MSCP_MAX_COREMASK_STR - 1);
+	if (login_name)
+		strncpy(i->so.login_name, login_name, MSCP_SSH_MAX_LOGIN_NAME - 1);
+	if (port)
+		strncpy(i->so.port, port, MSCP_SSH_MAX_PORT_STR - 1);
+	if (config)
+		strncpy(i->so.config, config, PATH_MAX - 1);
+	if (identity)
+		strncpy(i->so.identity, identity, MSCP_SSH_MAX_IDENTITY_PATH - 1);
+	if (cipher)
+		strncpy(i->so.cipher, cipher, MSCP_SSH_MAX_CIPHER_STR - 1);
+	if (hmac)
+		strncpy(i->so.hmac, hmac, MSCP_SSH_MAX_HMAC_STR - 1);
+	if (compress)
+		strncpy(i->so.compress, compress, MSCP_SSH_MAX_COMP_STR - 1);
+	if (ccalgo)
+		strncpy(i->so.ccalgo, ccalgo, MSCP_SSH_MAX_CCALGO_STR - 1);
+	if (password)
+		strncpy(i->so.password, password, MSCP_SSH_MAX_PASSWORD - 1);
+	if (passphrase)
+		strncpy(i->so.passphrase, passphrase, MSCP_SSH_MAX_PASSPHRASE - 1);
+
+	i->m = mscp_init(remote, direction, &i->mo, &i->so);
+	if (!i->m) {
+		PyErr_Format(PyExc_RuntimeError, "%s", mscp_get_error());
+		free(i);
+		return NULL;
+	}
+
+	if (add_instance(i) < 0) {
+		PyErr_Format(PyExc_RuntimeError, "too many mscp isntances");
+		mscp_free(i->m);
+		free(i);
+		return NULL;
+	}
+
+	return Py_BuildValue("K", (unsigned long long)i);
+}
+
+static PyObject *wrap_mscp_connect(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_connect(m) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_add_src_path(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", "src_path", NULL };
+	unsigned long long addr;
+	char *src_path;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "Ks", keywords, &addr, &src_path))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_add_src_path(m, src_path) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_set_dst_path(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", "dst_path", NULL };
+	unsigned long long addr;
+	char *dst_path;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "Ks", keywords, &addr, &dst_path))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_set_dst_path(m, dst_path) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_scan(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_scan(m) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_start(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_start(m) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_stop(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	mscp_stop(m);
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_join(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	if (mscp_join(m) < 0) {
+		PyErr_Format(PyExc_RuntimeError, mscp_get_error());
+		return NULL;
+	}
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_get_stats(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp_stats s;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	mscp_get_stats(m, &s);
+
+	return Py_BuildValue("KKO", s.total, s.done, PyBool_FromLong(s.finished));
+}
+
+static PyObject *wrap_mscp_cleanup(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct mscp *m;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	m = get_mscp(addr);
+	if (!m) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	mscp_cleanup(m);
+
+	return Py_BuildValue("");
+}
+
+static PyObject *wrap_mscp_free(PyObject *self, PyObject *args, PyObject *kw)
+{
+	char *keywords[] = { "m", NULL };
+	unsigned long long addr;
+	struct instance *i;
+
+	if (!PyArg_ParseTupleAndKeywords(args, kw, "K", keywords, &addr))
+		return NULL;
+
+	i = get_instance(addr);
+	if (!i) {
+		PyErr_Format(PyExc_RuntimeError, "invalid mscp instance address");
+		return NULL;
+	}
+
+	mscp_free(i->m);
+	release_instance(i);
+
+	return Py_BuildValue("");
+}
+
+static PyMethodDef pymscpMethods[] = {
+	{
+		"mscp_init", (PyCFunction)wrap_mscp_init,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_connect", (PyCFunction)wrap_mscp_connect,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_add_src_path", (PyCFunction)wrap_mscp_add_src_path,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_set_dst_path", (PyCFunction)wrap_mscp_set_dst_path,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_scan", (PyCFunction)wrap_mscp_scan,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_start", (PyCFunction)wrap_mscp_start,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_stop", (PyCFunction)wrap_mscp_stop,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_join", (PyCFunction)wrap_mscp_join,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_get_stats", (PyCFunction)wrap_mscp_get_stats,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_cleanup", (PyCFunction)wrap_mscp_cleanup,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{
+		"mscp_free", (PyCFunction)wrap_mscp_free,
+		METH_VARARGS | METH_KEYWORDS, NULL
+	},
+	{ NULL, NULL, 0, NULL },
+};
+
+static PyModuleDef pymscpModule = {
+	PyModuleDef_HEAD_INIT, "pymscp", NULL, -1, pymscpMethods,
+};
+
+PyMODINIT_FUNC PyInit_pymscp(void) {
+	PyObject *mod = PyModule_Create(&pymscpModule);
+
+	PyModule_AddIntConstant(mod, "LOCAL2REMOTE",	MSCP_DIRECTION_L2R);
+	PyModule_AddIntConstant(mod, "REMOTE2LOCAL",	MSCP_DIRECTION_R2L);
+	PyModule_AddIntConstant(mod, "SEVERITY_NONE",	MSCP_SEVERITY_NONE);
+	PyModule_AddIntConstant(mod, "SEVERITY_ERR",	MSCP_SEVERITY_ERR);
+	PyModule_AddIntConstant(mod, "SEVERITY_WARN",	MSCP_SEVERITY_WARN);
+	PyModule_AddIntConstant(mod, "SEVERITY_NOTICE",	MSCP_SEVERITY_NOTICE);
+	PyModule_AddIntConstant(mod, "SEVERITY_INFO",	MSCP_SEVERITY_INFO);
+	PyModule_AddIntConstant(mod, "SEVERITY_DEBUG",	MSCP_SEVERITY_DEBUG);
+
+	return mod;
+}
+

src/rename-logic.py

@@ -1,48 +0,0 @@
-#!/usr/bin/env python3
-
-from os.path import dirname, basename, isfile, isdir, exists
-from os import listdir
-import sys
-
-"""
-
-This file simply implements the src_path to dst_path conversion logic
-just for test. file_fill() and file_fill_recursive() in file.c
-implements this logic.
-
-"""
-
-
-def recursive(src, rel_path, dst, dst_should_dir, replace_dir_name):
-    
-    if isfile(src):
-        if dst_should_dir:
-            print("{} => {}/{}{}".format(src, dst, rel_path, basename(src)))
-        else:
-            print("{} => {}{}".format(src, rel_path, dst))
-        return
-        
-    # src is directory
-    for f in listdir(src):
-        next_src = "{}/{}".format(src, f)
-        if replace_dir_name and dst_should_dir:
-            next_rel_path = ""
-        else:
-            next_rel_path = "{}{}/".format(rel_path, basename(src))
-        recursive(next_src, next_rel_path, dst, dst_should_dir, False)
-
-
-def fill_dst(srclist, dst):
-    dst_must_dir = len(srclist) > 1
-    for src in srclist:
-        dst_should_dir = isdir(src) | isdir(dst)
-        replace_dir_name = not isdir(dst)
-        recursive(src, "", dst, dst_should_dir | dst_must_dir, replace_dir_name)
-
-
-def main():
-    if (len(sys.argv) < 2):
-        print("usage: {} source ... target".format(sys.argv[0]))
-    fill_dst(sys.argv[1:len(sys.argv) - 1], sys.argv[len(sys.argv) - 1])
-
-main()

src/ssh.c

@@ -1,56 +1,95 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #include <stdio.h>
 #include <string.h>
 #include <unistd.h>
+#include <stdlib.h>
+
+#include "libssh/callbacks.h"
 
 #include <ssh.h>
 #include <util.h>
+#include <message.h>
 
 static int ssh_verify_known_hosts(ssh_session session);
 
 
-static int ssh_set_opts(ssh_session ssh, struct ssh_opts *opts)
+#define is_specified(s) (strlen(s) > 0)
+
+static int ssh_set_opts(ssh_session ssh, struct mscp_ssh_opts *opts)
 {
-	ssh_set_log_level(opts->debuglevel);
+	ssh_set_log_level(opts->debug_level);
 
-	if (opts->login_name &&
+	if (is_specified(opts->login_name) &&
 	    ssh_options_set(ssh, SSH_OPTIONS_USER, opts->login_name) < 0) {
-		pr_err("failed to set login name\n");
+		mscp_set_error("failed to set login name");
 		return -1;
 	}
 
-	if (opts->port &&
+	if (is_specified(opts->port) &&
 	    ssh_options_set(ssh, SSH_OPTIONS_PORT_STR, opts->port) < 0) {
-		pr_err("failed to set port number\n");
+		mscp_set_error("failed to set port number");
 		return -1;
 	}
 
-	if (opts->identity &&
+	if (is_specified(opts->identity) &&
 	    ssh_options_set(ssh, SSH_OPTIONS_IDENTITY, opts->identity) < 0) {
-		pr_err("failed to set identity\n");
+		mscp_set_error("failed to set identity");
 		return -1;
 	}
 
-	if (opts->cipher) {
+	if (is_specified(opts->cipher)) {
 		if (ssh_options_set(ssh, SSH_OPTIONS_CIPHERS_C_S, opts->cipher) < 0) {
-			pr_err("failed to set cipher client to server\n");
+			mscp_set_error("failed to set cipher for client to server");
 			return -1;
 		}
 		if (ssh_options_set(ssh, SSH_OPTIONS_CIPHERS_S_C, opts->cipher) < 0) {
-			pr_err("failed to set cipher client to server\n");
+			mscp_set_error("failed to set cipher for server to client");
 			return -1;
 		}
 	}
 
-	if (opts->compress &&
-	    ssh_options_set(ssh, SSH_OPTIONS_COMPRESSION, "yes") < 0) {
-		pr_err("failed to enable ssh compression\n");
+	if (is_specified(opts->hmac)) {
+		if (ssh_options_set(ssh, SSH_OPTIONS_HMAC_C_S, opts->hmac) < 0) {
+			mscp_set_error("failed to set hmac for client to server");
+			return -1;
+		}
+		if (ssh_options_set(ssh, SSH_OPTIONS_HMAC_S_C, opts->hmac) < 0) {
+			mscp_set_error("failed to set hmac for server to client");
+			return -1;
+		}
+	}
+
+	if (is_specified(opts->compress) &&
+	    ssh_options_set(ssh, SSH_OPTIONS_COMPRESSION, opts->compress) < 0) {
+		mscp_set_error("failed to enable ssh compression");
+		return -1;
+	}
+
+	if (is_specified(opts->ccalgo) &&
+	    ssh_options_set(ssh, SSH_OPTIONS_CCALGO, opts->ccalgo) < 0) {
+		mscp_set_error("failed to set cclago");
+		return -1;
+	}
+
+	/* if NOT specified to enable Nagle's algorithm, disable it (set TCP_NODELAY) */
+	if (!opts->enable_nagle) {
+		int v = 1;
+		if (ssh_options_set(ssh, SSH_OPTIONS_NODELAY, &v) < 0) {
+			mscp_set_error("failed to set TCP_NODELAY");
+			return -1;
+		}
+	}
+
+	if (is_specified(opts->config) &&
+	    ssh_options_parse_config(ssh, opts->config) < 0) {
+		mscp_set_error("failed to parse ssh_config: %s", opts->config);
 		return -1;
 	}
 
 	return 0;
 }
 
-static int ssh_authenticate(ssh_session ssh, struct ssh_opts *opts)
+static int ssh_authenticate(ssh_session ssh, struct mscp_ssh_opts *opts)
 {
 	int auth_bit_mask;
 	int ret;
@@ -63,46 +102,81 @@ static int ssh_authenticate(ssh_session ssh, struct ssh_opts *opts)
 	auth_bit_mask = ssh_userauth_list(ssh, NULL);
 
 	if (auth_bit_mask & SSH_AUTH_METHOD_NONE &&
-	    ssh_userauth_none(ssh, NULL) == SSH_AUTH_SUCCESS) {
+	    ssh_userauth_none(ssh, NULL) == SSH_AUTH_SUCCESS)
 		return 0;
-	}
 
-	if (auth_bit_mask & SSH_AUTH_METHOD_PUBLICKEY &&
-	    ssh_userauth_publickey_auto(ssh, NULL, NULL) == SSH_AUTH_SUCCESS) {
-		return 0;
+	if (auth_bit_mask & SSH_AUTH_METHOD_PUBLICKEY) {
+		char *p = is_specified(opts->passphrase) ? opts->passphrase : NULL;
+		if (ssh_userauth_publickey_auto(ssh, NULL, p) == SSH_AUTH_SUCCESS)
+			return 0;
 	}
 
 	if (auth_bit_mask & SSH_AUTH_METHOD_PASSWORD) {
-		if (!opts->password) {
-			opts->password = getpass("Password: ");
+		if (!is_specified(opts->password)) {
+			if (ssh_getpass("Password: ", opts->password,
+					MSCP_SSH_MAX_PASSWORD, 0, 0) < 0) {
+				return -1;
+			}
 		}
+
 		if (ssh_userauth_password(ssh, NULL, opts->password) == SSH_AUTH_SUCCESS)
 			return 0;
 	}
 
-	pr_err("authentication failure: %s\n", ssh_get_error(ssh));
 	return -1;
 }
 
-static ssh_session ssh_make_ssh_session(char *sshdst, struct ssh_opts *opts)
+static int ssh_cache_passphrase(const char *prompt, char *buf, size_t len, int echo,
+				int verify, void *userdata)
+{
+	struct mscp_ssh_opts *opts = userdata;
+
+	/* This function is called on the first time for importing
+	 * priv key file with passphrase. It is not called on the
+	 * second time or after because cached passphrase is passed
+	 * to ssh_userauth_publickey_auto(). */
+
+	if (ssh_getpass("Passphrase: ", buf, len, echo, verify) < 0)
+		return -1;
+
+	/* cache the passphrase */
+	if (strlen(buf) > MSCP_SSH_MAX_PASSPHRASE - 1)  {
+		pr_warn("sorry, passphrase is too long to cache...\n");
+		return 0;
+	}
+	strncpy(opts->passphrase, buf, MSCP_SSH_MAX_PASSPHRASE);
+
+	return 0;
+}
+
+static struct ssh_callbacks_struct cb = {
+	.auth_function = ssh_cache_passphrase,
+	.userdata = NULL,
+};
+
+static ssh_session ssh_init_session(const char *sshdst, struct mscp_ssh_opts *opts)
 {
 	ssh_session ssh = ssh_new();
 
+	ssh_callbacks_init(&cb);
+	cb.userdata = opts;
+	ssh_set_callbacks(ssh, &cb);
+
+	if (ssh_options_set(ssh, SSH_OPTIONS_HOST, sshdst) != SSH_OK) {
+		mscp_set_error("failed to set destination host");
+		goto free_out;
+	}
+
 	if (ssh_set_opts(ssh, opts) != 0)
 		goto free_out;
 
-	if (ssh_options_set(ssh, SSH_OPTIONS_HOST, sshdst) != SSH_OK) {
-		pr_err("failed to set destination host\n");
-		goto free_out;
-	}
-
 	if (ssh_connect(ssh) != SSH_OK) {
-		pr_err("failed to connect ssh server: %s\n", ssh_get_error(ssh));
+		mscp_set_error("failed to connect ssh server: %s", ssh_get_error(ssh));
 		goto free_out;
 	}
 
 	if (ssh_authenticate(ssh, opts) != 0) {
-		pr_err("authentication failed: %s\n", ssh_get_error(ssh));
+		mscp_set_error("authentication failed: %s", ssh_get_error(ssh));
 		goto disconnect_out;
 	}
 
@@ -119,10 +193,10 @@ free_out:
 	return NULL;
 }
 
-sftp_session ssh_make_sftp_session(char *sshdst, struct ssh_opts *opts)
+sftp_session ssh_init_sftp_session(const char *sshdst, struct mscp_ssh_opts *opts)
 {
 	sftp_session sftp;
-	ssh_session ssh = ssh_make_ssh_session(sshdst, opts);
+	ssh_session ssh = ssh_init_session(sshdst, opts);
 
 	if (!ssh) {
 		return NULL;
@@ -130,13 +204,14 @@ sftp_session ssh_make_sftp_session(char *sshdst, struct ssh_opts *opts)
 
 	sftp = sftp_new(ssh);
 	if (!sftp) {
-		pr_err("failed to allocate sftp session: %s\n", ssh_get_error(ssh));
+		mscp_set_error("failed to allocate sftp session: %s",
+			       ssh_get_error(ssh));
 		goto err_out;
 	}
 
 	if (sftp_init(sftp) != SSH_OK) {
-		pr_err("failed to initialize sftp session: err code %d\n",
-		       sftp_get_error(sftp));
+		mscp_set_error("failed to initialize sftp session: err code %d",
+			       sftp_get_error(sftp));
 		goto err_out;
 	}
 
@@ -205,7 +280,7 @@ static int ssh_verify_known_hosts(ssh_session session)
 
 	case SSH_KNOWN_HOSTS_UNKNOWN:
 		hexa = ssh_get_hexa(hash, hlen);
-		fprintf(stderr,"The server is unknown. Do you trust the host key?\n");
+		fprintf(stderr, "The server is unknown. Do you trust the host key?\n");
 		fprintf(stderr, "Public key hash: %s\n", hexa);
 		fprintf(stderr, "(yes/no): ");
 		ssh_string_free_char(hexa);
@@ -240,36 +315,10 @@ static int ssh_verify_known_hosts(ssh_session session)
 void ssh_sftp_close(sftp_session sftp)
 {
 	ssh_session ssh = sftp_ssh(sftp);
-	sftp_free(sftp);
+	/* XXX: sftp_free is stuck in ssh_poll_ctx_dopoll() when build type is Release.
+	 * skip sftp_free inappropriately...
+	 */
+	//sftp_free(sftp);
 	ssh_disconnect(ssh);
 	ssh_free(ssh);
 }
-
-
-ssize_t sftp_write2(sftp_file sf, const void *buf, size_t len, size_t sftp_buf_sz)
-{
-	ssize_t ret, nbytes;
-
-	for (nbytes = 0; nbytes < len;) {
-		ret = sftp_write(sf, buf + nbytes,
-				 min(len - nbytes, sftp_buf_sz));
-		if (ret < 0)
-			return ret;
-		nbytes += ret;
-	}
-	return nbytes;
-}
-
-ssize_t sftp_read2(sftp_file sf, void *buf, size_t len, size_t sftp_buf_sz)
-{
-	ssize_t ret, nbytes;
-
-	for (nbytes = 0; nbytes < len;) {
-		ret = sftp_read(sf, buf + nbytes,
-				min(len - nbytes, sftp_buf_sz));
-		if (ret < 0)
-			return ret;
-		nbytes += ret;
-	}
-	return nbytes;
-}

src/ssh.h

@@ -1,3 +1,4 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #ifndef _SSH_H_
 #define _SSH_H_
 
@@ -5,30 +6,15 @@
 #include "libssh/libssh.h"
 #include "libssh/sftp.h"
 
+#include <mscp.h>
 
-struct ssh_opts {
-	char    *login_name;		/* -l */
-	char    *port;			/* -p */
-	char    *identity;		/* -i */
-	char    *cipher;		/* -c */
-	int     compress;		/* -C */
-	int     debuglevel;		/* -v */
-	bool	no_hostkey_check;	/* -H */
-
-	char    *password;		/* filled at the first connecting phase */
-};
-
-/* ssh_make_sftp_session() creates sftp_session. sshdst accpets
+/* ssh_init_sftp_session() creates sftp_session. sshdst accpets
  * user@hostname and hostname notations (by libssh).
  */
-sftp_session ssh_make_sftp_session(char *sshdst, struct ssh_opts *opts);
+sftp_session ssh_init_sftp_session(const char *sshdst, struct mscp_ssh_opts *opts);
 void ssh_sftp_close(sftp_session sftp);
 
 #define sftp_ssh(sftp) (sftp)->session
 #define sftp_get_ssh_error(sftp) ssh_get_error(sftp_ssh(sftp))
 
-/* wrapping multiple sftp_read|write */
-ssize_t sftp_write2(sftp_file sf, const void *buf, size_t len, size_t sftp_buf_sz);
-ssize_t sftp_read2(sftp_file sf, void *buf, size_t len, size_t sftp_buf_sz);
-
 #endif /* _SSH_H_ */

src/util.h

@@ -1,9 +1,11 @@
+/* SPDX-License-Identifier: GPL-3.0-only */
 #ifndef _UTIL_H_
 #define _UTIL_H_
 
 #include <stdio.h>
 #include <string.h>
 #include <errno.h>
+#include <libgen.h>
 
 #define likely(x)       __builtin_expect(!!(x), 1)
 #define unlikely(x)     __builtin_expect(!!(x), 0)
@@ -19,8 +21,8 @@
 				  __func__, ##__VA_ARGS__)
 
 #define pr_err(fmt, ...) fprintf(stderr, "\x1b[1m\x1b[31m"	\
-				 "ERR:%s():\x1b[0m " fmt,	\
-				 __func__, ##__VA_ARGS__)
+				 "ERR:%s:%d:%s():\x1b[0m " fmt,	\
+				 basename(__FILE__), __LINE__, __func__, ##__VA_ARGS__)
 
 #ifdef DEBUG
 #define pr_debug(fmt, ...) fprintf(stderr, "\x1b[1m\x1b[33m"    \
@@ -30,8 +32,6 @@
 #define pr_debug(fmt, ...)
 #endif
 
-#define strerrno() strerror(errno)
-
 
 #define min(a, b) (((a) > (b)) ? (b) : (a))
 #define max(a, b) (((a) > (b)) ? (a) : (b))

test/test_e2e.py

@@ -1,7 +1,11 @@
 
+"""
+test_e2e.py: End-to-End test for mscp executable.
+"""
+
+import platform
 import pytest
-import numpy
-import hashlib
+import getpass
 import os
 
 from subprocess import check_call, CalledProcessError, PIPE
@@ -9,11 +13,15 @@ from util import File, check_same_md5sum
 
 
 def run2ok(args):
-    check_call(list(map(str, args)))
+    cmd = list(map(str, args))
+    print("cmd: {}".format(" ".join(cmd)))
+    check_call(cmd)
 
 def run2ng(args):
+    cmd = list(map(str, args))
+    print("cmd: {}".format(" ".join(cmd)))
     with pytest.raises(CalledProcessError) as e:
-        check_call(list(map(str, args)))
+        check_call(cmd)
 
 
 """ usage test """
@@ -54,11 +62,16 @@ param_single_copy = [
 @pytest.mark.parametrize("src, dst", param_single_copy)
 def test_single_copy(mscp, src_prefix, dst_prefix, src, dst):
     src.make()
-    run2ok([mscp, "-H", src_prefix + src.path, dst_prefix + dst.path])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src.path, dst_prefix + dst.path])
     assert check_same_md5sum(src, dst)
     src.cleanup()
     dst.cleanup()
 
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+def test_failed_to_copy_nonexistent_file(mscp, src_prefix, dst_prefix):
+    src = "nonexistent_src"
+    dst = "nonexistent_dst"
+    run2ng([mscp, "-H", "-vvv", src_prefix + src, dst_prefix + dst])
 
 param_double_copy = [
     (File("src1", size = 1024 * 1024), File("src2", size = 1024 * 1024),
@@ -70,7 +83,7 @@ param_double_copy = [
 def test_double_copy(mscp, src_prefix, dst_prefix, s1, s2, d1, d2):
     s1.make()
     s2.make()
-    run2ok([mscp, "-H", src_prefix + s1.path, src_prefix + s2.path, dst_prefix + "dst"])
+    run2ok([mscp, "-H", "-vvv", src_prefix + s1.path, src_prefix + s2.path, dst_prefix + "dst"])
     assert check_same_md5sum(s1, d1)
     assert check_same_md5sum(s2, d2)
     s1.cleanup()
@@ -78,6 +91,47 @@ def test_double_copy(mscp, src_prefix, dst_prefix, s1, s2, d1, d2):
     d1.cleanup()
     d2.cleanup()
 
+
+remote_v6_prefix = "[::1]:{}/".format(os.getcwd())
+param_remote_v6_prefix = [
+    ("", remote_v6_prefix), (remote_v6_prefix, "")
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_v6_prefix)
+@pytest.mark.parametrize("s1, s2, d1, d2", param_double_copy)
+def test_double_copy_with_ipv6_notation(mscp, src_prefix, dst_prefix, s1, s2, d1, d2):
+    s1.make()
+    s2.make()
+    run2ok([mscp, "-H", "-vvv",
+            src_prefix + s1.path, src_prefix + s2.path, dst_prefix + "dst"])
+    assert check_same_md5sum(s1, d1)
+    assert check_same_md5sum(s2, d2)
+    s1.cleanup()
+    s2.cleanup()
+    d1.cleanup()
+    d2.cleanup()
+
+
+remote_user_v6_prefix = "{}@[::1]:{}/".format(getpass.getuser(), os.getcwd())
+param_remote_user_v6_prefix = [
+    ("", remote_user_v6_prefix), (remote_user_v6_prefix, "")
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_user_v6_prefix)
+@pytest.mark.parametrize("s1, s2, d1, d2", param_double_copy)
+def test_double_copy_with_user_and_ipv6_notation(mscp, src_prefix, dst_prefix,
+                                                 s1, s2, d1, d2):
+    s1.make()
+    s2.make()
+    run2ok([mscp, "-H", "-vvv",
+            src_prefix + s1.path, src_prefix + s2.path, dst_prefix + "dst"])
+    assert check_same_md5sum(s1, d1)
+    assert check_same_md5sum(s2, d2)
+    s1.cleanup()
+    s2.cleanup()
+    d1.cleanup()
+    d2.cleanup()
+
+
+
 param_dir_copy = [
     ( "src_dir", "dst_dir",
         [ File("src_dir/t1", size = 64),
@@ -107,11 +161,11 @@ def test_dir_copy(mscp, src_prefix, dst_prefix, src_dir, dst_dir, src, dst, twic
     for f in src:
         f.make()
 
-    run2ok([mscp, "-H", src_prefix + src_dir, dst_prefix + dst_dir])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src_dir, dst_prefix + dst_dir])
     for sf, df in zip(src, dst):
         assert check_same_md5sum(sf, df)
 
-    run2ok([mscp, "-H", src_prefix + src_dir, dst_prefix + dst_dir])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src_dir, dst_prefix + dst_dir])
     for sf, df in zip(src, twice):
         assert check_same_md5sum(sf, df)
 
@@ -120,35 +174,105 @@ def test_dir_copy(mscp, src_prefix, dst_prefix, src_dir, dst_dir, src, dst, twic
         df.cleanup()
         tf.cleanup()
 
+
+param_dir_copy_single = [
+    ("src_dir", "dst_dir",
+     File("src_dir/t1", size = 1024 * 1024),
+     File("dst_dir/src_dir/t1"),
+     )
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+@pytest.mark.parametrize("src_dir, dst_dir, src, dst", param_dir_copy_single)
+def test_dir_copy_single(mscp, src_prefix, dst_prefix, src_dir, dst_dir, src, dst):
+    src.make()
+    os.mkdir(dst_dir)
+    run2ok([mscp, "-H", "-vvv", src_prefix + src_dir, dst_prefix + dst_dir])
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup()
+
 @pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
 def test_override_single_file(mscp, src_prefix, dst_prefix):
     src = File("src", size = 128).make()
     dst = File("dst", size = 128).make()
     assert not check_same_md5sum(src, dst)
 
-    run2ok([mscp, "-H", src_prefix + src.path, dst_prefix + dst.path])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src.path, dst_prefix + dst.path])
     assert check_same_md5sum(src, dst)
 
     src.cleanup()
     dst.cleanup()
 
+absolute_remote_prefix = "localhost:"
+param_absolute_remote_prefix = [
+    ("", absolute_remote_prefix), (absolute_remote_prefix, "")
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_absolute_remote_prefix)
+def test_copy_file_under_root_to_dir(mscp, src_prefix, dst_prefix):
+    src = File("/mscp-test-src", size = 1024).make()
+    dst = File("/tmp/mscp-test-src")
+
+    run2ok([mscp, "-H", "-vvv", src_prefix + src.path,
+            dst_prefix + os.path.dirname(dst.path)])
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup(preserve_dir = True)
+
+
 @pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
 def test_min_chunk(mscp, src_prefix, dst_prefix):
     src = File("src", size = 16 * 1024).make()
     dst = File("dst")
 
-    run2ok([mscp, "-H", "-s", 8192, src_prefix + src.path, dst_prefix + dst.path])
+    run2ok([mscp, "-H", "-vvv", "-s", 32768, src_prefix + src.path, dst_prefix + dst.path])
     assert check_same_md5sum(src, dst)
 
     src.cleanup()
     dst.cleanup()
 
+
+def is_alpine():
+    if os.path.exists("/etc/os-release"):
+        with open("/etc/os-release", "r") as f:
+            for line in f:
+                if line.strip() == "ID=alpine":
+                    return True
+    return False
+
+param_glob_copy = [
+    (
+        "src*", "dstx",
+        [ File("src1"), File("src2"), File("src3") ],
+        [ File("dstx/src1"), File("dstx/src2"), File("dstx/src3") ],
+    ),
+    (
+        "src*", "dstx",
+        [ File("src1/s1"), File("src2/s2"), File("src3/s3") ],
+        [ File("dstx/s1"), File("dstx/s2"), File("dstx/s3") ],
+    )
+]
+
+@pytest.mark.skipif(is_alpine(),
+                    reason = "musl does not implement glob ALTDIRFUNC")
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+@pytest.mark.parametrize("src_glob_path, dst_path, srcs, dsts", param_glob_copy)
+def test_glob_src_path(mscp, src_prefix, dst_prefix,
+                       src_glob_path, dst_path, srcs, dsts):
+    for src in srcs:
+        src.make(size = 1024 * 1024)
+
+    run2ok([mscp, "-H", "-vvv", src_prefix + src_glob_path, dst_prefix + dst_path])
+    for src, dst in zip(srcs, dsts):
+        assert check_same_md5sum(src, dst)
+        src.cleanup()
+        dst.cleanup()
+
 @pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
 def test_thread_affinity(mscp, src_prefix, dst_prefix):
     src = File("src", size = 64 * 1024).make()
     dst = File("dst")
 
-    run2ok([mscp, "-H", "-n", 4, "-m", "0x01", "-s", 8192, "-S", 65536,
+    run2ok([mscp, "-H", "-vvv", "-n", 4, "-m", "0x01",
             src_prefix + src.path, dst_prefix + dst.path])
     assert check_same_md5sum(src, dst)
 
@@ -160,7 +284,7 @@ def test_cannot_override_file_with_dir(mscp, src_prefix, dst_prefix):
     src = File("src", size = 128).make()
     dst = File("dst").make()
 
-    run2ng([mscp, "-H", src_prefix + src.path, dst_prefix + "dst/src"])
+    run2ng([mscp, "-H", "-vvv", src_prefix + src.path, dst_prefix + "dst/src"])
 
     src.cleanup()
     dst.cleanup()
@@ -169,7 +293,7 @@ def test_cannot_override_file_with_dir(mscp, src_prefix, dst_prefix):
 def test_transfer_zero_bytes(mscp, src_prefix, dst_prefix):
     src = File("src", size = 0).make()
     dst = File("dst")
-    run2ok([mscp, "-H", src_prefix + src.path, dst_prefix + "dst"])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src.path, dst_prefix + "dst"])
     assert os.path.exists("dst")
     src.cleanup()
     dst.cleanup()
@@ -178,7 +302,102 @@ def test_transfer_zero_bytes(mscp, src_prefix, dst_prefix):
 def test_override_dst_having_larger_size(mscp, src_prefix, dst_prefix):
     src = File("src", size = 1024 * 1024).make()
     dst = File("dst", size = 1024 * 1024 * 2).make()
-    run2ok([mscp, "-H", src_prefix + src.path, dst_prefix + "dst"])
+    run2ok([mscp, "-H", "-vvv", src_prefix + src.path, dst_prefix + "dst"])
     assert check_same_md5sum(src, dst)
     src.cleanup()
     dst.cleanup()
+
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+def test_dont_truncate_dst(mscp, src_prefix, dst_prefix):
+    f = File("srcanddst", size = 1024 * 1024 * 128).make()
+    md5_before = f.md5sum()
+    run2ok([mscp, "-H", "-vvv", src_prefix + f.path, dst_prefix + f.path])
+    md5_after = f.md5sum()
+    assert md5_before == md5_after
+    f.cleanup()
+
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+@pytest.mark.parametrize("src, dst", param_single_copy)
+def test_set_port(mscp, src_prefix, dst_prefix, src, dst):
+    src.make()
+    run2ng([mscp, "-H", "-vvv", "-p", 21, src_prefix + src.path, dst_prefix + dst.path])
+    run2ng([mscp, "-H", "-vvv", "-P", 21, src_prefix + src.path, dst_prefix + dst.path])
+    src.cleanup()
+
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+def test_set_conn_interval(mscp, src_prefix, dst_prefix):
+    srcs = []
+    dsts = []
+    for x in range(500):
+        srcs.append(File("src/file{}".format(x), size = 128).make())
+        dsts.append(File("dst/file{}".format(x)))
+    run2ok([mscp, "-H", "-vvv", "-I", 1, src_prefix + "src", dst_prefix + "dst"])
+
+    for src, dst in zip(srcs, dsts):
+        assert check_same_md5sum(src, dst)
+        src.cleanup()
+        dst.cleanup()
+
+compressions = ["yes", "no", "none"]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+@pytest.mark.parametrize("compress", compressions)
+def test_compression(mscp, src_prefix, dst_prefix, compress):
+    src = File("src", size = 1024 * 1024).make()
+    dst = File("dst", size = 1024 * 1024 * 2).make()
+    run2ok([mscp, "-H", "-vvv", "-C", compress, src_prefix + src.path, dst_prefix + "dst"])
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup()
+
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_remote_prefix)
+def test_ccalgo(mscp, src_prefix, dst_prefix):
+    src = File("src", size = 1024 * 1024).make()
+    dst = File("dst").make()
+    if platform.system() == "Darwin":
+        # Darwin does not support TCP_CONGESTION
+        algo = "cubic"
+        run = run2ng
+    elif platform.system() == "Linux":
+        # Linux supports TCP_CONGESTION
+        with open("/proc/sys/net/ipv4/tcp_allowed_congestion_control", "r") as f:
+            algo = f.read().strip().split().pop()
+        run = run2ok
+    run([mscp, "-H", "-vvv", "-g", algo, src_prefix + src.path, dst_prefix + "dst"])
+
+
+testhost = "mscptestlocalhost"
+testhost_prefix = "{}:{}/".format(testhost, os.getcwd()) # use current dir
+param_testhost_prefix = [
+    ("", testhost_prefix), (testhost_prefix, "")
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_testhost_prefix)
+def test_config_ok(mscp, src_prefix, dst_prefix):
+    config = "/tmp/mscp_test_ssh_config"
+    with open(config, "w") as f:
+        f.write("host {}\n".format(testhost))
+        f.write("    hostname localhost\n")
+
+    src = File("src", size = 1024 * 1024).make()
+    dst = File("dst", size = 1024 * 1024 * 2).make()
+    run2ok([mscp, "-H", "-vvv", "-F", config,
+            src_prefix + src.path, dst_prefix + "dst"])
+
+    os.remove(config)
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup()
+
+@pytest.mark.parametrize("src_prefix, dst_prefix", param_testhost_prefix)
+def test_config_ng(mscp, src_prefix, dst_prefix):
+    config = "/tmp/mscp_test_ssh_config"
+    with open(config, "w") as f:
+        f.write("\n") # use empty ssh_config
+
+    src = File("src", size = 1024 * 1024).make()
+    dst = File("dst", size = 1024 * 1024 * 2).make()
+    run2ng([mscp, "-H", "-vvv", "-F", config,
+            src_prefix + src.path, dst_prefix + "dst"])
+
+    os.remove(config)
+    src.cleanup()
+    dst.cleanup()

test/test_python.py

@@ -0,0 +1,131 @@
+
+"""
+test_python.py: Testing libmscp through the mscp python binding.
+"""
+
+import pytest
+import mscp
+import os
+from util import File, check_same_md5sum
+
+def test_create_and_release():
+    m = mscp.mscp("localhost", mscp.LOCAL2REMOTE)
+    m.cleanup()
+
+
+""" copy test """
+
+remote = "localhost"
+remote_prefix = "{}/".format(os.getcwd()) # use current dir
+param_remote_prefix_and_direction = [
+    ("", remote_prefix, mscp.LOCAL2REMOTE), (remote_prefix, "", mscp.REMOTE2LOCAL)
+]
+
+
+param_single_copy = [
+    (File("src", size = 64), File("dst")),
+    (File("src", size = 4096 * 1), File("dst")),
+    (File("src", size = 128 * 1024 * 1024), File("dst")),
+]
+
+@pytest.mark.parametrize("src_prefix, dst_prefix, direction",
+                         param_remote_prefix_and_direction)
+@pytest.mark.parametrize("src, dst", param_single_copy)
+def test_single_copy(src_prefix, dst_prefix, direction, src, dst):
+    src.make()
+    m = mscp.mscp(remote, direction)
+    m.copy(src_prefix + src.path, dst_prefix + dst.path)
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup()
+
+
+param_double_copy = [
+    (File("src1", size = 1024 * 1024), File("src2", size = 1024 * 1024),
+     File("dst/src1"), File("dst/src2")
+     )
+]
+@pytest.mark.parametrize("src_prefix, dst_prefix, direction",
+                         param_remote_prefix_and_direction)
+@pytest.mark.parametrize("s1, s2, d1, d2", param_double_copy)
+def test_double_copy(src_prefix, dst_prefix, direction, s1, s2, d1, d2):
+    s1.make()
+    s2.make()
+    mscp.mscp(remote, direction).copy([src_prefix + s1.path, src_prefix + s2.path],
+                                      dst_prefix + "dst")
+    assert check_same_md5sum(s1, d1)
+    assert check_same_md5sum(s2, d2)
+    s1.cleanup()
+    s2.cleanup()
+    d1.cleanup()
+    d2.cleanup()
+
+    
+param_single_copy = [
+    (File("src", size = 1024 * 1024 * 4), File("dst")),
+]
+
+param_kwargs = [
+    { "nr_threads": 6 },
+    { "nr_ahead": 64 },
+    { "min_chunk_sz": 1 * 1024 * 1024 },
+    { "max_chunk_sz": 64 * 1024 * 1024 },
+    { "coremask": "0x0f" },
+    { "max_startups": 5 },
+    { "severity": mscp.SEVERITY_NONE },
+    { "cipher": "aes128-gcm@openssh.com" },
+    { "compress": "yes" },
+    { "no_hostkey_check": True },
+    { "enable_nagle": True },
+]
+
+@pytest.mark.parametrize("src_prefix, dst_prefix, direction",
+                         param_remote_prefix_and_direction)
+@pytest.mark.parametrize("src, dst", param_single_copy)
+@pytest.mark.parametrize("kw", param_kwargs)
+def test_kwargs(src_prefix, dst_prefix, direction, src, dst, kw):
+    src.make()
+    m = mscp.mscp(remote, direction, **kw)
+    m.copy(src_prefix + src.path, dst_prefix + dst.path)
+    assert check_same_md5sum(src, dst)
+    src.cleanup()
+    dst.cleanup()
+
+def test_login_failed():
+    m = mscp.mscp("asdfasdf@" + remote, mscp.LOCAL2REMOTE)
+    with pytest.raises(RuntimeError) as e:
+        m.connect()
+
+    m = mscp.mscp(remote, mscp.LOCAL2REMOTE, login_name = "asdfadsf")
+    with pytest.raises(RuntimeError) as e:
+        m.connect()
+
+    m = mscp.mscp(remote, mscp.LOCAL2REMOTE, port = "65534")
+    with pytest.raises(RuntimeError) as e:
+        m.connect()
+
+def test_get_stat_before_copy_start():
+    m = mscp.mscp("localhost", mscp.LOCAL2REMOTE)
+    m.connect()
+    (total, done, finished) = m.stats()
+    assert total == 0 and done == 0
+
+
+param_invalid_kwargs = [
+    { "nr_threads": -1 },
+    { "nr_ahead": -1 },
+    { "min_chunk_sz": 1 },
+    { "max_chunk_sz": 1 },
+    { "coremask": "xxxxx" },
+    { "max_startups": -1 },
+    { "cipher": "invalid" },
+    { "hmac": "invalid"},
+    { "compress": "invalid"},
+    { "ccalgo": "invalid"},
+]
+
+@pytest.mark.parametrize("kw", param_invalid_kwargs)
+def test_invalid_options(kw):
+    with pytest.raises(RuntimeError) as e:
+        m = mscp.mscp("localhost", mscp.LOCAL2REMOTE, **kw)
+        m.connect()

test/util.py

@@ -1,6 +1,5 @@
 
 import hashlib
-import numpy
 import os
 
 
@@ -17,10 +16,16 @@ class File():
         self.content = content
         self.perm = perm
 
+    def __repr__(self):
+        return "<file:{} {}-bytes>".format(self.path, self.size)
+
     def __str__(self):
         return self.path
 
-    def make(self):
+    def make(self, size = None):
+        if size:
+            self.size = size
+
         d = os.path.dirname(self.path)
         if d:
             os.makedirs(d, exist_ok = True)
@@ -39,10 +44,12 @@ class File():
 
     def make_content_random(self):
         with open(self.path, "wb") as f:
-            f.write(numpy.random.bytes(self.size))
+            f.write(os.urandom(self.size))
 
-    def cleanup(self):
+    def cleanup(self, preserve_dir = False):
         os.remove(self.path)
+        if preserve_dir:
+            return
         tmp = os.path.dirname(self.path)
         while tmp and not tmp in [".", "/"]:
             if len(os.listdir(tmp)) == 0: