One-stop ZFS backup & replication solution
Go to file
Christian Schwarz a6b578b648 rpc/dataconn/stream: Conn: handle concurrent Close calls + goroutine leak fix
* Add Close() in closeState to identify the first closer
* Non-first closers get an error
* Reads and Writes from the Conn get an error if the conn was closed
  during the Read / Write was running
* The first closer starts _separate_ goroutine draining the c.frameReads channel
* The first closer then waits for the goroutine that fills c.frameReads
  to exit

refs 3bfe0c16d0
fixes #174

readFrames would block on `reads <-`
   but only after that would stream.Conn.readFrames close c.waitReadFramesDone
   which was too late because stream.Conn.Close would wait for c.waitReadFramesDone to be closed before draining the channel
                              ^^^^^^ (not frameconn.Conn, that closed successfully)

   195 @ 0x1032ae0 0x1006cab 0x1006c81 0x1006a65 0x15505be 0x155163e 0x1060bc1
           0x15505bd       github.com/zrepl/zrepl/rpc/dataconn/stream.readFrames+0x16d             github.com/zrepl/zrepl/rpc/dataconn/stream/stream.go:220
           0x155163d       github.com/zrepl/zrepl/rpc/dataconn/stream.(*Conn).readFrames+0xbd      github.com/zrepl/zrepl/rpc/dataconn/stream/stream_conn.go:71

   195 @ 0x1032ae0 0x10078c8 0x100789e 0x100758b 0x1552678 0x1557a4b 0x1556aec 0x1060bc1
           0x1552677       github.com/zrepl/zrepl/rpc/dataconn/stream.(*Conn).Close+0x77           github.com/zrepl/zrepl/rpc/dataconn/stream/stream_conn.go:191
           0x1557a4a       github.com/zrepl/zrepl/rpc/dataconn.(*Server).serveConn.func1+0x5a      github.com/zrepl/zrepl/rpc/dataconn/dataconn_server.go:93
           0x1556aeb       github.com/zrepl/zrepl/rpc/dataconn.(*Server).serveConn+0x87b           github.com/zrepl/zrepl/rpc/dataconn/dataconn_server.go:176
2019-09-29 19:05:54 +02:00
.circleci build/circleci: apt update before installing 2019-09-27 21:31:05 +02:00
.github github: Patreon account in FUNDING.yml 2019-09-08 00:49:05 +02:00
build run golangci-lint and apply suggested fixes 2019-03-27 13:12:26 +01:00
cli run golangci-lint and apply suggested fixes 2019-03-27 13:12:26 +01:00
client zrepl status: follow up c4be60c: import screen terminfo 2019-09-27 21:31:05 +02:00
config config: validate presence of port in addresses 2019-09-28 14:25:14 +02:00
daemon snapper + client/status: snapshotting reports 2019-09-27 21:31:00 +02:00
dist dist: add grafana dashboard 2019-03-16 16:12:34 +01:00
docs docs: promote monetary support in changelog 2019-09-29 19:04:53 +02:00
endpoint zfs,endpoint: use zfs destroy batch syntax if available 2019-09-14 13:43:46 +02:00
logger pre- and post-snapshot hooks 2019-09-27 21:25:59 +02:00
platformtest platformtest: dedicated pool per test, Makefile target, maintainer notice 2019-09-29 18:48:44 +02:00
pruning run golangci-lint and apply suggested fixes 2019-03-27 13:12:26 +01:00
replication replication/logic: fix race when reading byte counter pointer for report 2019-09-28 16:16:19 +02:00
rpc rpc/dataconn/stream: Conn: handle concurrent Close calls + goroutine leak fix 2019-09-29 19:05:54 +02:00
tlsconf run golangci-lint and apply suggested fixes 2019-03-27 13:12:26 +01:00
transport transport/local: hard fail, more aggressive connect timeout 2019-09-14 13:43:46 +02:00
util pre- and post-snapshot hooks 2019-09-27 21:25:59 +02:00
version wip floocode backup 2018-08-27 15:22:32 +02:00
zfs add platformtest: infrastructure for ZFS compatiblity testing 2019-09-14 13:43:46 +02:00
.gitignore Rudimentary Makefile specifying requirements for a release 2017-09-30 16:40:39 +02:00
.gitmodules docs: move hugo docs to old directory 2017-11-11 23:25:12 +01:00
.golangci.yml run golangci-lint and apply suggested fixes 2019-03-27 13:12:26 +01:00
.travis.yml include linting in build process 2019-03-27 13:12:26 +01:00
build.Dockerfile build: drop go Dep, switch to modules, support Go 1.13 2019-09-14 13:36:44 +02:00
build.installprotoc.bash build: Linux arm64 support 2019-06-23 15:25:26 +02:00
go.mod config: validate presence of port in addresses 2019-09-28 14:25:14 +02:00
go.sum config: validate presence of port in addresses 2019-09-28 14:25:14 +02:00
lazy.sh build: drop go Dep, switch to modules, support Go 1.13 2019-09-14 13:36:44 +02:00
LICENSE LICENSE + docs: adjust copyright 2018-10-13 17:34:05 +02:00
main.go receiving side: placeholder as simple on|off property 2019-03-20 20:26:30 +01:00
Makefile platformtest: dedicated pool per test, Makefile target, maintainer notice 2019-09-29 18:48:44 +02:00
README.md platformtest: dedicated pool per test, Makefile target, maintainer notice 2019-09-29 18:48:44 +02:00
tools.go build: drop go Dep, switch to modules, support Go 1.13 2019-09-14 13:36:44 +02:00

GitHub license Language: Go User Docs Donate via PayPal Donate via Liberapay Twitter

zrepl

zrepl is a one-stop ZFS backup & replication solution.

User Documentation

User Documentation can be found at zrepl.github.io.

Bug Reports

  1. If the issue is reproducible, enable debug logging, reproduce and capture the log.
  2. Open an issue on GitHub, with logs pasted as GitHub gists / inline.

Feature Requests

  1. Does you feature request require default values / some kind of configuration? If so, think of an expressive configuration example.
  2. Think of at least one use case that generalizes from your concrete application.
  3. Open an issue on GitHub with example conf & use case attached.

The above does not apply if you already implemented everything. Check out the Coding Workflow section below for details.

Package Maintainer Information

  • Follow the steps in docs/installation.rst -> Compiling from Source and read the Makefile / shell scripts used in this process.
  • Make sure your distro is compatible with the paths in docs/installation.rst.
  • Ship a default config that adheres to your distro's hier and logging system.
  • Ship a service manager file and please try to upstream it to this repository.
    • dist/systemd contains a Systemd unit template.
  • Ship other material provided in ./dist, e.g. in /usr/share/zrepl/.
  • Use make release ZREPL_VERSION='mydistro-1.2.3_1'
    • Your distro's name and any versioning supplemental to zrepl's (e.g. package revision) should be in this string
  • Use make platformtest on a test system to validate that zrepl's abstractions on top of ZFS work with the system ZFS.
  • Make sure you are informed about new zrepl versions, e.g. by subscribing to GitHub's release RSS feed.

Developer Documentation

zrepl is written in Go and uses Go modules to manage dependencies. The documentation is written in ReStructured Text using the Sphinx framework.

To get started, run ./lazy.sh devsetup to easily install build dependencies and read docs/installation.rst -> Compiling from Source.

Overall Architecture

The application architecture is documented as part of the user docs in the Implementation section (docs/content/impl). Make sure to develop an understanding how zrepl is typically used by studying the user docs first.

Project Structure

├── artifacts               # build artifcats generate by make
├── cli                     # wrapper around CLI package cobra
├── client                  # all subcommands that are not `daemon`
├── config                  # config data types (=> package yaml-config)
│   └── samples
├── daemon                  # the implementation of `zrepl daemon` subcommand
│   ├── filters
│   ├── job                 # job implementations
│   ├── logging             # logging outlets + formatters
│   ├── nethelpers
│   ├── prometheus
│   ├── pruner              # pruner implementation
│   ├── snapper             # snapshotter implementation
├── docs                    # sphinx-based documentation
├── dist                    # supplemental material for users & package maintainers
│   ├── **/*.rst            # documentation in reStructuredText
│   ├── sphinxconf
│   │   └── conf.py         # sphinx config (see commit 445a280 why its not in docs/)
│   ├── requirements.txt    # pip3 requirements to build documentation
│   ├── publish.sh          # shell script for automated rendering & deploy to zrepl.github.io repo
│   └── public_git          # checkout of zrepl.github.io managed by above shell script
├── endpoint                # implementation of replication endpoints (=> package replication)
├── logger                  # our own logger package
├── pruning                 # pruning rules (the logic, not the actual execution)
│   └── retentiongrid
├── replication
│   ├── driver              # the driver of the replication logic (status reporting, error handling)
│   ├── logic               # planning & executing replication steps via rpc
|   |   └── pdu             # the generated gRPC & protobuf code used in replication (and endpoints)
│   └── report              # the JSON-serializable report datastructures exposed to the client
├── rpc                     # the hybrid gRPC + ./dataconn RPC client: connects to a remote replication.Endpoint
│   ├── dataconn            # Bulk data-transfer RPC protocol
│   ├── grpcclientidentity  # adaptor to inject package transport's 'client identity' concept into gRPC contexts
│   ├── netadaptor          # adaptor to convert a package transport's Connecter and Listener into net.* primitives
│   ├── transportmux        # TCP connecter and listener used to split control & data traffic
│   └── versionhandshake    # replication protocol version handshake perfomed on newly established connections
├── tlsconf                 # abstraction for Go TLS server + client config
├── transport               # transports implementation
│   ├── fromconfig
│   ├── local
│   ├── ssh
│   ├── tcp
│   └── tls
├── util
├── vendor                  # managed by dep
├── version                 # abstraction for versions (filled during build by Makefile)
└── zfs                     # zfs(8) wrappers

Coding Workflow

  • Open an issue when starting to hack on a new feature
  • Commits should reference the issue they are related to
  • Docs improvements not documenting new features do not require an issue.

Breaking Changes

Backward-incompatible changes must be documented in the git commit message and are listed in docs/changelog.rst.

  • Config-breaking changes must contain a line BREAK CONFIG in the commit message
  • Other breaking changes must contain a line BREAK in the commit message

Glossary & Naming Inconsistencies

In ZFS, dataset refers to the objects filesystem, ZVOL and snapshot.
However, we need a word for filesystem & ZVOL but not a snapshot, bookmark, etc.

Toward the user, the following terminology is used:

  • filesystem: a ZFS filesystem or a ZVOL
  • filesystem version: a ZFS snapshot or a bookmark

Sadly, the zrepl implementation is inconsistent in its use of these words: variables and types are often named dataset when they in fact refer to a filesystem.

There will not be a big refactoring (an attempt was made, but it's destroying too much history without much gain).

However, new contributions & patches should fix naming without further notice in the commit message.