moby--moby/pkg
Neil Horman d764d8b166 Ensure that a device mapper task is referenced until task is complete
DeviceMapper tasks in go use SetFinalizer to clean up C construct
counterparts in the C LVM library.  While thats well and good, it relies
heavily on the exact interpretation of when the golang garbage collector
determines that an object is unreachable is subject to reclaimation.
While common sense would assert that for stack variables (which these DM
tasks always are), are unreachable when the stack frame in which they
are declared returns, thats not the case.  According to this:

https://golang.org/pkg/runtime/#SetFinalizer

The garbage collector decides that, if a function calls into a
systemcall (which task.run() always will in LVM), and there are no
subsequent references to the task variable within that stack frame, then
it can be reclaimed.  Those conditions are met in several devmapper.go
routines, and if the garbage collector runs in the middle of a
deviceMapper operation, then the task can be destroyed while the
operation is in progress, leading to crashes, failed operations and
other unpredictable behavior.

The fix is to use the KeepAlive interface:

https://golang.org/pkg/runtime/#KeepAlive

The KeepAlive method is effectively an empy reference that fools the
garbage collector into thinking that a variable is still reachable.  By
adding a call to KeepAlive in the task.run() method, we can ensure that
the garbage collector won't reclaim a task object until its execution
within the deviceMapper C library is complete.

Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
2017-05-24 11:11:23 -04:00
..
aaparser apparmor: make pkg/aaparser work on read-only root 2017-05-18 00:05:13 +10:00
archive Respect tar entries modes when rewriting them on Windows 2017-05-02 11:36:43 +02:00
authorization When authz plugin is disabled, remove from authz middleware chain. 2017-03-22 12:07:39 -07:00
broadcaster
chrootarchive pkg/{chroot,}archive: clean up a few small issues 2017-03-30 16:37:54 +03:00
devicemapper Ensure that a device mapper task is referenced until task is complete 2017-05-24 11:11:23 -04:00
directory Fix filepath.Walk misusage in pkg/directory 2016-05-30 07:40:46 +00:00
discovery Update docker daemon to dockerd 2016-12-27 17:32:15 +08:00
filenotify pkg/file{utils,notify}: don't compare to bool 2017-03-30 16:38:01 +03:00
fileutils Enable a unit test on windows. 2017-04-21 12:31:16 -04:00
fsutils pkg: return directly without ifs where possible 2016-12-13 22:10:11 +02:00
gitutils Allow checking out any ref in gitutils 2017-05-04 14:14:50 -07:00
homedir gcplogs: forcibly set HOME on static UNIX binary 2016-12-29 03:17:26 +00:00
httputils Fix escaped go vet error 2017-01-18 00:13:09 +08:00
idtools pkg: return directly without ifs where possible 2016-12-13 22:10:11 +02:00
ioutils pkg/ioutils: remove unused functions 2017-05-10 08:34:16 -07:00
jsonlog pkg/*: clean up a few issues 2017-03-30 16:50:46 +03:00
jsonmessage Update the stream formatter to display custom unit numbers. 2017-05-11 11:13:11 -07:00
listeners Don't error with empty group 2017-04-27 09:26:21 -07:00
locker fix some typos 2016-12-28 09:43:27 +08:00
longpath
loopback Make pkg/devicemapper and pkg/loopback depend on cgo in build tags 2017-03-29 17:55:42 -07:00
mount Do not remove containers from memory on error 2017-05-05 17:02:04 -04:00
namesgenerator Add Johannes Kepler and Mary Jackson to name generator 2017-03-17 20:36:12 -07:00
parsers Fix building client on OpenBSD 2017-03-26 20:47:18 +00:00
pidfile pkg: return directly without ifs where possible 2016-12-13 22:10:11 +02:00
platform Swap usage of LazyDLL and LoadDLL to LazySystemDLL. 2016-11-22 14:57:11 -08:00
plugingetter plugingetter: Avoid all caps for constant declarations 2017-01-04 10:19:04 -08:00
plugins Merge pull request #32222 from unclejack/small_cleanup 2017-03-30 21:09:39 +02:00
pools pkg/pool: no need for double pointer for sync.Pool 2016-10-20 15:27:38 -07:00
progress Update the stream formatter to display custom unit numbers. 2017-05-11 11:13:11 -07:00
promise
pubsub Revert "use pubsub instead of filenotify to follow json logs" 2016-02-23 21:43:52 -05:00
random
reexec First header should be a top level header 2016-11-22 09:33:21 +08:00
registrar pkg/*: clean up a few issues 2017-03-30 16:50:46 +03:00
signal Move stack dump dir to exec root 2016-11-16 12:55:18 -05:00
stdcopy fix docker logs error handling 2017-02-14 14:38:42 -08:00
streamformatter Update the stream formatter to display custom unit numbers. 2017-05-11 11:13:11 -07:00
stringid Move imageID validation to stringid pkg 2016-12-26 18:53:22 -08:00
stringutils change minor mistake of spelling 2016-12-20 21:05:19 +08:00
symlink Update copyright dates 2017-02-24 19:41:59 +00:00
sysinfo Only show global warnings once 2016-11-30 10:11:42 -08:00
system Do not remove containers from memory on error 2017-05-05 17:02:04 -04:00
tailfile Change reading order of tailfile 2016-11-13 20:08:51 -08:00
tarsum Add support for COPY from previous rootfs 2017-03-23 15:12:15 -07:00
templates Disable HTML escaping for JSON in formatter 2017-05-09 10:16:10 +03:00
term [pkg/term] switch more syscalls to /x/sys/ 2017-05-18 09:02:42 -04:00
testutil Use `cli` for trusted relate command 2017-04-19 14:04:39 +02:00
tlsconfig Use system ca pool from tlsconfig 2016-10-31 14:52:07 -07:00
truncindex Fix non thread-safe Iteration around go-patricia 2017-01-09 17:06:50 +00:00
urlutil pkg/urlutil: don't compare to bool 2017-03-30 16:38:01 +03:00
useragent
README.md

README.md

pkg/ is a collection of utility packages used by the Docker project without being specific to its internals.

Utility packages are kept separate from the docker core codebase to keep it as small and concise as possible. If some utilities grow larger and their APIs stabilize, they may be moved to their own repository under the Docker organization, to facilitate re-use by other projects. However that is not the priority.

The directory pkg is named after the same directory in the camlistore project. Since Brad is a core Go maintainer, we thought it made sense to copy his methods for organizing Go code :) Thanks Brad!

Because utility packages are small and neatly separated from the rest of the codebase, they are a good place to start for aspiring maintainers and contributors. Get in touch if you want to help maintain them!