/* * Copyright (C) 2013 Colin Walters * * SPDX-License-Identifier: LGPL-2.0+ * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ #pragma once #include "ostree-core.h" G_BEGIN_DECLS /* Arbitrarily chosen */ #define OSTREE_STATIC_DELTA_PART_MAX_SIZE_BYTES (16*1024*1024) /* 1 byte for object type, 32 bytes for checksum */ #define OSTREE_STATIC_DELTA_OBJTYPE_CSUM_LEN 33 #define OSTREE_SUMMARY_STATIC_DELTAS "ostree.static-deltas" /** * OSTREE_STATIC_DELTA_PART_PAYLOAD_FORMAT_V0: * * y compression type (0: none, 'x': lzma) * --- * a(uuu) modes * aa(ayay) xattrs * ay raw data source * ay operations */ #define OSTREE_STATIC_DELTA_PART_PAYLOAD_FORMAT_V0 "(a(uuu)aa(ayay)ayay)" /** * OSTREE_STATIC_DELTA_META_ENTRY_FORMAT: * * u: version (non-canonical endian) * ay checksum * guint64 size: Total size of delta (sum of parts) (non-canonical endian) * guint64 usize: Uncompressed size of resulting objects on disk (non-canonical endian) * ARRAY[(guint8 objtype, csum object)] * * The checksum is of the delta payload, and each entry in the array * represents an OSTree object which will be created by the deltapart. */ #define OSTREE_STATIC_DELTA_META_ENTRY_FORMAT "(uayttay)" /** * OSTREE_STATIC_DELTA_FALLBACK_FORMAT: * * y: objtype * ay: checksum * t: compressed size (non-canonical endian) * t: uncompressed size (non-canonical endian) * * Object to fetch invididually; includes compressed/uncompressed size. */ #define OSTREE_STATIC_DELTA_FALLBACK_FORMAT "(yaytt)" /** * OSTREE_STATIC_DELTA_SUPERBLOCK_FORMAT: * * A .delta object is a custom binary format. It has the following high * level form: * * delta-descriptor: * metadata: a{sv} * t: timestamp (big endian) * from: ay checksum * to: ay checksum * commit: new commit object * ARRAY[(csum from, csum to)]: ay * ARRAY[delta-meta-entry] * array[fallback] * * The metadata would include things like a version number, as well as * extended verification data like a GPG signature. * * The second array is an array of delta objects that should be * fetched and applied before this one. This is a fairly generic * recursion mechanism that would potentially allow saving significant * storage space on the server. * * The heart of the static delta: the array of delta parts. * * Finally, we have the fallback array, which is the set of objects to * fetch individually - the compiler determined it wasn't worth * duplicating the space. */ #define OSTREE_STATIC_DELTA_SUPERBLOCK_FORMAT "(a{sv}tayay" OSTREE_COMMIT_GVARIANT_STRING "aya" OSTREE_STATIC_DELTA_META_ENTRY_FORMAT "a" OSTREE_STATIC_DELTA_FALLBACK_FORMAT ")" /** * OSTREE_STATIC_DELTA_SIGNED_FORMAT * * magic: t magic number, 8 bytes for alignment * superblock: ay delta supeblock variant * signatures: a{sv} * * The signed static delta starts with the 'OSTSGNDT' magic number followed by * the array of bytes containing the superblock used for the signature. * * Then, the signatures array contains the signatures of the superblock. A * signature has the following form: * type: signature key * signature: variant depending on type used */ #define OSTREE_STATIC_DELTA_SIGNED_FORMAT "(taya{sv})" #define OSTREE_STATIC_DELTA_SIGNED_MAGIC 0x4F535453474E4454 /* OSTSGNDT */ typedef enum { OSTREE_STATIC_DELTA_OPEN_FLAGS_NONE = 0, OSTREE_STATIC_DELTA_OPEN_FLAGS_SKIP_CHECKSUM = (1 << 0), OSTREE_STATIC_DELTA_OPEN_FLAGS_VARIANT_TRUSTED = (1 << 1) } OstreeStaticDeltaOpenFlags; typedef enum { OSTREE_STATIC_DELTA_OP_OPEN_SPLICE_AND_CLOSE = 'S', OSTREE_STATIC_DELTA_OP_OPEN = 'o', OSTREE_STATIC_DELTA_OP_WRITE = 'w', OSTREE_STATIC_DELTA_OP_SET_READ_SOURCE = 'r', OSTREE_STATIC_DELTA_OP_UNSET_READ_SOURCE = 'R', OSTREE_STATIC_DELTA_OP_CLOSE = 'c', OSTREE_STATIC_DELTA_OP_BSPATCH = 'B' } OstreeStaticDeltaOpCode; #define OSTREE_STATIC_DELTA_N_OPS 7 gboolean _ostree_static_delta_part_open (GInputStream *part_in, GBytes *inline_part_bytes, OstreeStaticDeltaOpenFlags flags, const char *expected_checksum, GVariant **out_part, GCancellable *cancellable, GError **error); typedef struct { guint n_ops_executed[OSTREE_STATIC_DELTA_N_OPS]; } OstreeDeltaExecuteStats; gboolean _ostree_static_delta_part_execute (OstreeRepo *repo, GVariant *header, GVariant *part_payload, gboolean stats_only, OstreeDeltaExecuteStats *stats, GCancellable *cancellable, GError **error); void _ostree_static_delta_part_execute_async (OstreeRepo *repo, GVariant *header, GVariant *part_payload, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean _ostree_static_delta_part_execute_finish (OstreeRepo *repo, GAsyncResult *result, GError **error); gboolean _ostree_static_delta_parse_checksum_array (GVariant *array, guint8 **out_checksums_array, guint *out_n_checksums, GError **error); gboolean _ostree_repo_static_delta_part_have_all_objects (OstreeRepo *repo, GVariant *checksum_array, gboolean *out_have_all, GCancellable *cancellable, GError **error); typedef struct { char *checksum; guint64 size; GPtrArray *basenames; } OstreeDeltaContentSizeNames; void _ostree_delta_content_sizenames_free (gpointer v); gboolean _ostree_delta_compute_similar_objects (OstreeRepo *repo, GVariant *from_commit, GVariant *to_commit, GHashTable *new_reachable_regfile_content, guint similarity_percent_threshold, GHashTable **out_modified_regfile_content, GCancellable *cancellable, GError **error); gboolean _ostree_repo_static_delta_query_exists (OstreeRepo *repo, const char *delta_id, gboolean *out_exists, GCancellable *cancellable, GError **error); GVariant * _ostree_repo_static_delta_superblock_digest (OstreeRepo *repo, const char *from, const char *to, GCancellable *cancellable, GError **error); gboolean _ostree_repo_static_delta_dump (OstreeRepo *repo, const char *delta_id, GCancellable *cancellable, GError **error); gboolean _ostree_repo_static_delta_delete (OstreeRepo *repo, const char *delta_id, GCancellable *cancellable, GError **error); gboolean _ostree_repo_static_delta_reindex (OstreeRepo *repo, const char *opt_to_commit, GCancellable *cancellable, GError **error); /* Used for static deltas which due to a historical mistake are * inconsistent endian. * * https://bugzilla.gnome.org/show_bug.cgi?id=762515 */ static inline guint32 maybe_swap_endian_u32 (gboolean swap, guint32 v) { if (!swap) return v; return GUINT32_SWAP_LE_BE (v); } static inline guint64 maybe_swap_endian_u64 (gboolean swap, guint64 v) { if (!swap) return v; return GUINT64_SWAP_LE_BE (v); } typedef enum { OSTREE_DELTA_ENDIAN_BIG, OSTREE_DELTA_ENDIAN_LITTLE, OSTREE_DELTA_ENDIAN_INVALID } OstreeDeltaEndianness; OstreeDeltaEndianness _ostree_delta_get_endianness (GVariant *superblock, gboolean *out_was_heuristic); gboolean _ostree_delta_needs_byteswap (GVariant *superblock); G_END_DECLS