ostree/src/libostree
Mathnerd314 23049bbd01 core: Add OSTREE_OBJECT_TYPE_COMMIT_META
This is cleaner than the loose_path_with_suffix approach

Closes: #359
Approved by: cgwalters
2016-06-22 16:10:01 +00:00
..
README-gpg pull: Verify commits with gpg signatures from detached metadata 2013-09-29 14:49:47 -04:00
README.md core: Associate branches with remotes, move trigger runs into checkout 2012-04-03 23:46:34 -04:00
bupsplit.c core: Import bup's "rollsum" code, add a test case 2014-02-04 10:12:56 -05:00
bupsplit.h core: Import bup's "rollsum" code, add a test case 2014-02-04 10:12:56 -05:00
libostree.sym libostree.sym: Fix test-symbols 2016-06-20 22:59:27 +00:00
ostree-1.pc.in Install a shared library 2013-07-26 19:25:07 -04:00
ostree-async-progress.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-async-progress.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-autocleanups.h build: Allow ostree to use g_autoptr on its types internally 2016-05-17 21:13:20 +00:00
ostree-bootconfig-parser.c bootconfig: Add ostree_bootconfig_parser_write_at 2015-12-19 08:24:51 -05:00
ostree-bootconfig-parser.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-bootloader-grub2.c lib: Use g_file_enumerator_iterate() if available, with fallback 2016-06-21 18:24:17 +00:00
ostree-bootloader-grub2.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-bootloader-syslinux.c libglnx porting: Port "load utf8 file" contents API callers 2016-05-30 11:33:28 +00:00
ostree-bootloader-syslinux.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-bootloader-uboot.c libglnx porting: Port "load utf8 file" contents API callers 2016-05-30 11:33:28 +00:00
ostree-bootloader-uboot.h libostree: Make OstreeBootloader private 2013-09-15 20:26:13 -04:00
ostree-bootloader.c Remove unnecessary #include "libgsystem.h" 2015-05-06 22:07:11 -04:00
ostree-bootloader.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-chain-input-stream.c Remove unnecessary #include "libgsystem.h" 2015-05-06 22:07:11 -04:00
ostree-chain-input-stream.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-checksum-input-stream.c Remove unnecessary #include "libgsystem.h" 2015-05-06 22:07:11 -04:00
ostree-checksum-input-stream.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-cmdprivate.c Add support for ostree static-delta delete 2016-04-08 13:42:43 +00:00
ostree-cmdprivate.h Add support for ostree static-delta delete 2016-04-08 13:42:43 +00:00
ostree-core-private.h core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-core.c core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-core.h core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-deployment-private.h docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-deployment.c admin: Add an `unlock` command, and libostree API 2016-03-23 11:09:09 -04:00
ostree-deployment.h admin: Add an `unlock` command, and libostree API 2016-03-23 11:09:09 -04:00
ostree-diff.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-diff.h docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-dummy-enumtypes.c build: Don't run glib-mkenums if there's nothing to do 2016-05-12 17:15:50 +00:00
ostree-dummy-enumtypes.h build: Don't run glib-mkenums if there's nothing to do 2016-05-12 17:15:50 +00:00
ostree-enumtypes.c.template Make enum generation private by default, export stub symbol 2016-05-12 17:15:50 +00:00
ostree-enumtypes.h.template Make enum generation private by default, export stub symbol 2016-05-12 17:15:50 +00:00
ostree-fetcher.c pull: Ensure we always process queue only from main thread 2016-06-17 18:19:23 +00:00
ostree-fetcher.h fetcher: Lazily create tmp directory 2015-12-19 09:21:22 -05:00
ostree-gpg-verifier.c lib: Use g_file_enumerator_iterate() if available, with fallback 2016-06-21 18:24:17 +00:00
ostree-gpg-verifier.h repo: Factor out setting up a GPG verifier 2016-05-27 11:20:00 +00:00
ostree-gpg-verify-result-private.h libotutil: Establish a place for GPG utilities 2015-05-01 10:20:34 -04:00
ostree-gpg-verify-result.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-gpg-verify-result.h repo: Factor out the check of gpg result to a separate function 2016-05-27 11:20:00 +00:00
ostree-kernel-args.c libglnx porting: gs_free -> g_autofree 2016-03-18 12:08:19 -04:00
ostree-kernel-args.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-libarchive-input-stream.c Remove unnecessary #include "libgsystem.h" 2015-05-06 22:07:11 -04:00
ostree-libarchive-input-stream.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-linuxfsutil.c lib: Port some manual close() cleanups to be glnx_fd_close 2016-06-13 14:58:55 +00:00
ostree-linuxfsutil.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-lzma-common.c static-delta: Handle LZMA_BUF_ERROR returned by zlib 2015-10-10 10:27:17 -04:00
ostree-lzma-common.h deltas: Link to liblzma, add internal API to use it 2014-04-29 10:59:57 -04:00
ostree-lzma-compressor.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-lzma-compressor.h deltas: Link to liblzma, add internal API to use it 2014-04-29 10:59:57 -04:00
ostree-lzma-decompressor.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-lzma-decompressor.h deltas: Link to liblzma, add internal API to use it 2014-04-29 10:59:57 -04:00
ostree-metalink.c small cleanups 2016-04-08 18:43:18 +00:00
ostree-metalink.h pull: Stop using GMainLoop 2015-08-13 22:02:00 -04:00
ostree-mutable-tree.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-mutable-tree.h docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-repo-checkout.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-commit.c core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-repo-file-enumerator.c Remove unnecessary #include "libgsystem.h" 2015-05-06 22:07:11 -04:00
ostree-repo-file-enumerator.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-repo-file.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-file.h lib: Remove ostree_repo_file_make_empty_tree 2016-04-17 13:52:07 +00:00
ostree-repo-libarchive.c lib: Use g_file_enumerator_iterate() if available, with fallback 2016-06-21 18:24:17 +00:00
ostree-repo-private.h core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-prune.c Add cache_dir_fd to OstreeRepo 2016-04-14 15:55:08 +00:00
ostree-repo-pull.c core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-repo-refs.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-static-delta-compilation-analysis.c libglnx porting: gs_transfer_out_value -> g_steal_pointer 2016-03-18 12:08:19 -04:00
ostree-repo-static-delta-compilation.c libglnx porting: Port away from gs_file_ensure_directory() 2016-05-30 11:33:28 +00:00
ostree-repo-static-delta-core.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-static-delta-private.h Add support for ostree static-delta delete 2016-04-08 13:42:43 +00:00
ostree-repo-static-delta-processing.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo-traverse.c core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-repo.c core: Add OSTREE_OBJECT_TYPE_COMMIT_META 2016-06-22 16:10:01 +00:00
ostree-repo.h core: Use OSTREE_SHA256_STRING_LEN instead of 64 2016-06-22 16:10:01 +00:00
ostree-rollsum.c rollsum: Fix assertion for CRC matches 2015-08-25 09:26:22 -04:00
ostree-rollsum.h Add bsdiff support to deltas 2015-03-03 12:16:17 -05:00
ostree-sepolicy.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-sepolicy.h OstreeSePolicy: add ostree_sepolicy_get_csum() 2016-03-25 15:28:29 +00:00
ostree-sysroot-cleanup.c lib: Use g_file_enumerator_iterate() if available, with fallback 2016-06-21 18:24:17 +00:00
ostree-sysroot-deploy.c lib: Use sd_journal directly (optionally) 2016-06-21 18:24:17 +00:00
ostree-sysroot-private.h docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-sysroot-upgrader.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-sysroot-upgrader.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-sysroot.c docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-sysroot.h admin: Add an `unlock` command, and libostree API 2016-03-23 11:09:09 -04:00
ostree-tls-cert-interaction.c libostree: Make OstreeTlsCertInteraction explicitly private 2014-06-09 14:04:53 -04:00
ostree-tls-cert-interaction.h libostree: Make OstreeTlsCertInteraction explicitly private 2014-06-09 14:04:53 -04:00
ostree-types.h lib: Introduce versioned symbols 2016-03-01 21:45:26 -05:00
ostree-varint.c syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree-varint.h syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
ostree.h libostree: Add g_autoptr() support for the public types 2016-05-17 21:13:19 +00:00

README.md

Repository design

At the heart of OSTree is the repository. It's very similar to git, with the idea of content-addressed storage. However, OSTree is designed to store operating system binaries, not source code. There are several consequences to this. The key difference as compared to git is that the OSTree definition of "content" includes key Unix metadata such as owner uid/gid, as well as all extended attributes.

Essentially OSTree is designed so that if two files have the same OSTree checksum, it's safe to replace them with a hard link. This fundamental design means that an OSTree repository imposes negligible overhead. In contrast, a git repository stores copies of zlib-compressed data.

Key differences versus git

  • As mentioned above, extended attributes and owner uid/gid are versioned
  • Optimized for Unix hardlinks between repository and checkout
  • SHA256 instead of SHA1
  • Support for empty directories

Binary files

While this is still in planning, I plan to heavily optimize OSTree for versioning ELF operating systems. In industry jargon, this would be "content-aware storage".

Trimming history

OSTree will also be optimized to trim intermediate history; in theory one can regenerate binaries from corresponding (git) source code, so we don't need to keep all possible builds over time.

MILESTONE 1

  • Basic pack files (like git)

MILESTONE 2

  • Store checksums as ay
  • Drop version/metadata from tree/dirmeta objects
  • Add index size to superindex, pack size to index
    • So pull can calculate how much we need to download
  • Split pack files into metadata/data
  • pull: Extract all we can from each packfile one at a time, then delete it
  • Restructure repository so that links can be generated as a cache; i.e. objects/raw, pack files are now the canonical
  • For files, checksum combination of metadata variant + raw data
    • i.e. there is only OSTREE_OBJECT_TYPE_FILE (again)

MILESTONE 3

  • Drop archive/raw distinction - archive repositories always generate packfiles per commit
  • Include git packv4 ideas:
    • metadata packfiles have string dictionary (tree filenames and checksums)
    • data packfiles match up similar objects
  • Rolling checksums for partitioning large files? Kernel debuginfo
  • Improved pack clustering
    • file fingerprinting?
  • ELF-x86 aware deltas

git: http://git-scm.com/ Venti: http://plan9.bell-labs.com/magic/man2html/6/venti Elephant FS: http://www.hpl.hp.com/personal/Alistair_Veitch/papers/elephant-hotos/index.html

Compression

xdelta: http://xdelta.org/ Bsdiff: http://www.daemonology.net/bsdiff/ xz: http://tukaani.org/xz/