wiki:Obsolete/MovedToTree/PackageManagement/FileFormat

Version 9 (modified by bonefish, 8 years ago) ( diff )

--

Haiku Package File Format

This document specifies the Haiku Package (HPKG) file format, which was designed for efficient use by Haiku's package file system. It is somewhat inspired by the XAR format (separate TOC and data heap), but aims for greater compactness (no XML for the TOC).

Three stacked format layers can be identified:

  • A generic container format for structured data.
  • An archive format specifying how file system data are stored in the container.
  • A package format, extending the archive format with attributes for package management.

The Data Container Format

A HPKG file consists of four sections:

Header
Identifies the file as HPKG file and provides access to the other sections.
Heap
Contains arbitrary (mostly unstructured) data referenced by the next two sections.
TOC (table of contents)
The main section, containing structured data with references to unstructured data in the heap section.
Package Attributes
A section similar to the TOC. Rather than describing the data contained in the file, it specifies meta data of the package as a whole.

All numbers in the HPKG are stored in big endian format or LEB128 encoding.

The header has the following structure:

struct hpkg_header {
	uint32	magic;
	uint16	header_size;
	uint16	version;
	uint64	total_size;

	// package attributes section
	uint32	attributes_compression;
	uint32	attributes_length_compressed;
	uint32	attributes_length_uncompressed;
	uint32	attributes_strings_length;
	uint32	attributes_strings_count;

	// TOC section
	uint32	toc_compression;
	uint64	toc_length_compressed;
	uint64	toc_length_uncompressed;
	uint64	toc_strings_length;
	uint64	toc_strings_count;
};
magic
The string 'hpkg' (B_HPKG_MAGIC).
header_size
The size of the header.
version
The version of the HPKG format the file conforms to. The current version is 1 (B_HPKG_VERSION).
total_size
The total file size.
attributes_compression
The compression algorithm used for the package attributes section.
attributes_length_compressed
The compressed size of the package attributes section. Equals attributes_length_uncompressed, if the section is not compressed.
attributes_length_uncompressed
The uncompressed size of the package attributes section.
attributes_strings_length
The size of the strings subsection of the package attributes section.
attributes_strings_count
The number of entries in the strings subsection of the package attributes section.
toc_compression
The compression algorithm used for the TOC section.
toc_length_compressed
The compressed size of the TOC section. Equals toc_length_uncompressed, if the section is not compressed.
toc_length_uncompressed
The uncompressed size of the TOC section.
toc_strings_length
The size of the strings subsection of the TOC section.
toc_strings_count
The number of entries in the strings subsection of the TOC section.

TOC

The TOC section contains a list of attribute trees. An attribute has an ID, a data type, and a value, and can have child attributes. E.g.:

  • ATTRIBUTE_ID_SHOPPING_LIST : string : "bakery"
    • ATTRIBUTE_ID_ITEM : string : "rye bread"
    • ATTRIBUTE_ID_ITEM : string : "bread roll"
      • ATTRIBUTE_ID_COUNT : int : 10
    • ATTRIBUTE_ID_ITEM : string : "cookie"
      • ATTRIBUTE_ID_COUNT : int : 5
  • ATTRIBUTE_ID_SHOPPING_LIST : string : "hardware store"
    • ATTRIBUTE_ID_ITEM : string : "hammer"
    • ATTRIBUTE_ID_ITEM : string : "nail"
      • ATTRIBUTE_ID_SIZE : int : 10
      • ATTRIBUTE_ID_COUNT : int : 100

The main TOC section refers to any attribute by its unique ID (see below) and stores the attribute's value, either as a reference into the heap or as inline data.

An optimization exists for shared string attribute values. A string value used by more than one attribute is stored in the strings subsection and is referenced by an index.

Hence the TOC section consists of two subsections:

Strings
A table of commonly used strings.
Main TOC
The attribute trees.

Attribute Data Types

These are the specified data type values for attributes:

0B_HPKG_ATTRIBUTE_TYPE_INVALIDinvalid
1B_HPKG_ATTRIBUTE_TYPE_INTsigned integer
2B_HPKG_ATTRIBUTE_TYPE_UINTunsigned integer
3B_HPKG_ATTRIBUTE_TYPE_STRINGUTF-8 string
4B_HPKG_ATTRIBUTE_TYPE_RAWraw data

Strings

The strings subsections consists of a list of null-terminated UTF-8 strings. The section itself is terminated by a 0 byte.

Each string is implicity assigned the (null-based) index at which the it appears in the list, i.e. the nth string has the index n - 1. The string is referenced by this index in the main TOC subsection.

Main TOC

The main TOC subsection consists of a list of attribute entries terminated by a 0 byte. An attribute entry is stored as:

Attribute tag
An unsigned LEB128 encoded number.
Attribute value
The value of the attribute encoded as described below.
Attribute child list
Only if this attribute is marked to have children: A list of attribute entries terminated by a 0 byte.

The attribute tag encodes four pieces of information:

(encoding << 10) + (hasChildren << 9) + (dataType << 6) + id + 1

encoding
Specifies the encoding of the attribute value as described below.
hasChildren
1, if the attribute has children, 0 otherwise.
dataType
The data type of the attribute (B_HPKG_ATTRIBUTE_TYPE_...).
id
The ID of the attribute (B_HPKG_ATTRIBUTE_ID_...).

Attribute Values

A value of each of the data types can be encoded in different ways, which is defined by the encoding value:

  • B_HPKG_ATTRIBUTE_TYPE_INT and B_HPKG_ATTRIBUTE_TYPE_UINT:
0B_HPKG_ATTRIBUTE_ENCODING_INT_8_BITint8/uint8
1B_HPKG_ATTRIBUTE_ENCODING_INT_16_BITint16/uint16
2B_HPKG_ATTRIBUTE_ENCODING_INT_32_BITint32/uint32
3B_HPKG_ATTRIBUTE_ENCODING_INT_64_BITint64/uint64
  • B_HPKG_ATTRIBUTE_TYPE_STRING:
0B_HPKG_ATTRIBUTE_ENCODING_STRING_INLINEnull-terminated UTF-8 string
1B_HPKG_ATTRIBUTE_ENCODING_STRING_TABLEunsigned LEB128: index into string table
  • B_HPKG_ATTRIBUTE_TYPE_RAW
0B_HPKG_ATTRIBUTE_ENCODING_RAW_INLINEunsigned LEB128: size; followed by raw bytes
1B_HPKG_ATTRIBUTE_ENCODING_RAW_HEAPunsigned LEB128: size; unsigned LEB128: offset into heap

Package Attributes

The package attributes section contains a list of attribute trees, just like the TOC section. The structure of this section follows the TOC, i.e. there's a subsection for shared strings and a subsection that stores a list of attribute entries terminated by a 0 byte. An entry has the same format as the ones in the TOC (only using different attribute IDs).

Section Compression

The TOC and the package attributes section can be compressed. Which compression algorithm is used is specified by the toc_compression respectively the attributes_compression field in the header. The following values are defined:

0B_HPKG_COMPRESSION_NONEno compression
1B_HPKG_COMPRESSION_ZLIBzlib (LZ77) compression

The Archive Format

This section specifies how file system objects (files, directories, symlinks) are stored in a HPKG file. It builds on top of the container format, defining the types of attributes, their order, and allowed values.

E.g. a "bin" directory, containing a symlink and a file:

bin           0  2009-11-13 12:12:09  drwxr-xr-x
  awk         0  2009-11-13 12:11:16  lrwxrwxrwx  -> gawk
  gawk   301699  2009-11-13 12:11:16  -rwxr-xr-x

could be represented by this attribute tree:

  • B_HPKG_ATTRIBUTE_ID_DIR_ENTRY : string : "bin"
    • B_HPKG_ATTRIBUTE_ID_FILE_TYPE : uint : 1 (0x1)
    • B_HPKG_ATTRIBUTE_ID_FILE_MTIME : uint : 1258110729 (0x4afd3f09)
    • B_HPKG_ATTRIBUTE_ID_DIR_ENTRY : string : "awk"
      • B_HPKG_ATTRIBUTE_ID_FILE_TYPE : uint : 2 (0x2)
      • B_HPKG_ATTRIBUTE_ID_FILE_MTIME : uint : 1258110676 (0x4afd3ed4)
      • B_HPKG_ATTRIBUTE_ID_SYMLINK_PATH : string : "gawk"
    • B_HPKG_ATTRIBUTE_ID_DIR_ENTRY : string : "gawk"
      • B_HPKG_ATTRIBUTE_ID_FILE_PERMISSIONS : uint : 493 (0x1ed)
      • B_HPKG_ATTRIBUTE_ID_FILE_MTIME : uint : 1258110676 (0x4afd3ed4)
      • B_HPKG_ATTRIBUTE_ID_DATA : raw : size: 301699, offset: 0
      • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE : string : "BEOS:APP_VERSION"
        • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE_TYPE : uint : 1095782486 (0x41505056)
        • B_HPKG_ATTRIBUTE_ID_DATA : raw : size: 680, offset: 301699
      • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE : string : "BEOS:TYPE"
        • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE_TYPE : uint : 1296649555 (0x4d494d53)
        • B_HPKG_ATTRIBUTE_ID_DATA : raw : size: 35, offset: 302379

Attribute IDs

The following attribute IDs are specified by the archive format. Any other attributes will be ignored.

B_HPKG_ATTRIBUTE_ID_DIRECTORY_ENTRY ("dir:entry")

  • Type: string
  • Value: File name of the entry.
  • Allowed Values: Any valid file (not path!) name, save "." and "..".
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_FILE_TYPE: The file type of the entry.
    • B_HPKG_ATTRIBUTE_ID_FILE_PERMISSIONS: The file permissions of the entry.
    • B_HPKG_ATTRIBUTE_ID_FILE_USER: The owning user of the entry.
    • B_HPKG_ATTRIBUTE_ID_FILE_GROUP: The owning group of the entry.
    • B_HPKG_ATTRIBUTE_ID_FILE_ATIME[_NANOS]: The entry's file access time.
    • B_HPKG_ATTRIBUTE_ID_FILE_MTIME[_NANOS]: The entry's file modification time.
    • B_HPKG_ATTRIBUTE_ID_FILE_CRTIME[_NANOS]: The entry's file creation time.
    • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE: An extended file attribute associated with entry.
    • B_HPKG_ATTRIBUTE_ID_DATA: Only if the entry is a file: The file data.
    • B_HPKG_ATTRIBUTE_ID_SYMLINK_PATH: Only if the entry is a symlink: The path the symlink points to.
    • B_HPKG_ATTRIBUTE_ID_DIRECTORY_ENTRY: Only if the entry is a directory: A child entry in that directory.

B_HPKG_ATTRIBUTE_ID_FILE_TYPE ("file:type")

  • Type: uint
  • Value: Type of the entry.
  • Allowed Values:
0B_HPKG_FILE_TYPE_FILEfile
1B_HPKG_FILE_TYPE_DIRECTORYdirectory
2B_HPKG_FILE_TYPE_SYMLINKsymlink
  • Default Value: B_HPKG_FILE_TYPE_FILE
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_PERMISSIONS ("file:permissions")

  • Type: uint
  • Value: File permissions.
  • Allowed Values: Any valid permission mask.
  • Default Value:
    • For files: 0644 (octal).
    • For directories: 0755 (octal).
    • For symlinks: 0777 (octal).
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_USER ("file:user")

  • Type: string
  • Value: Name of the user owning the file.
  • Allowed Values: Any non-empty string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_GROUP ("file:group")

  • Type: string
  • Value: Name of the group owning the file.
  • Allowed Values: Any non-empty string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_ATIME ("file:atime")

  • Type: uint
  • Value: File access time (seconds since the Epoch).
  • Allowed Values: Any value.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_ATIME_NANOS ("file:mtime:nanos")

  • Type: uint
  • Value: The nano seconds fraction of the file access time.
  • Allowed Values: Any value in [0, 999999999].
  • Default Value: 0
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_MTIME ("file:mtime")

  • Type: uint
  • Value: File modified time (seconds since the Epoch).
  • Allowed Values: Any value.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_MTIME_NANOS ("file:mtime:nanos")

  • Type: uint
  • Value: The nano seconds fraction of the file modified time.
  • Allowed Values: Any value in [0, 999999999].
  • Default Value: 0
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_CRTIME ("file:crtime")

  • Type: uint
  • Value: File creation time (seconds since the Epoch).
  • Allowed Values: Any value.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_CRTIM_NANOS ("file:crtime:nanos")

  • Type: uint
  • Value: The nano seconds fraction of the file creation time.
  • Allowed Values: Any value in [0, 999999999].
  • Default Value: 0
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE ("file:attribute")

  • Type: string
  • Value: Name of the extended file attribute.
  • Allowed Values: Any valid attribute name.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE_TYPE: The type of the file attribute.
    • B_HPKG_ATTRIBUTE_ID_DATA: The file attribute data.

B_HPKG_ATTRIBUTE_ID_FILE_ATTRIBUTE_TYPE ("file:attribute:type")

  • Type: uint
  • Value: Type of the file attribute.
  • Allowed Values: Any value in [0, 0xffffffff].
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_DATA ("data")

  • Type: data
  • Value: Raw data of a file or attribute.
  • Allowed Values: Any value, if uncompressed, otherwise see below.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_DATA_COMPRESSION: The compression algorithm used for storing the data.
    • B_HPKG_ATTRIBUTE_ID_DATA_SIZE: The size of the uncompressed data.
    • B_HPKG_ATTRIBUTE_ID_DATA_CHUNK_SIZE: The size of an uncompressed data chunk.

B_HPKG_ATTRIBUTE_ID_DATA_COMPRESSION ("data:compression")

  • Type: uint
  • Value: ID of the data compression algorithm.
  • Allowed Values:
0B_HPKG_COMPRESSION_NONEno compression
1B_HPKG_COMPRESSION_ZLIBzlib (LZ77) compression
  • Default Value: B_HPKG_COMPRESSION_NONE
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_DATA_SIZE ("data:size")

  • Type: uint
  • Value: Size of the uncompressed data.
  • Allowed Values:: Any value.
  • Default Value: Size of the compressed data.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_DATA_CHUNK_SIZE ("data:chunk_size")

  • Type: uint
  • Value: Size of an uncompressed data chunk.
  • Allowed Values:: Any value.
  • Default Value:
    • If not compressed: 0
    • If B_HPKG_COMPRESSION_ZLIB compressed: 64 * 1024
  • Child Attributes: none
  • Type: string
  • Value: The path the symlink refers to.
  • Allowed Values:: Any valid symlink path.
  • Default Value:: Empty string.
  • Child Attributes: none

TOC Attributes

The TOC can directly contain any number of attributes of the B_HPKG_ATTRIBUTE_ID_DIRECTORY_ENTRY type, which in turn contain descendant attributes as specified in the previous section. Any other attributes are ignored.

Data Compression

Data referred to by an B_HPKG_ATTRIBUTE_ID_DATA attribute will be the raw data, if uncompressed. If compressed, the data have a special format, that allows for fast random access.

B_HPKG_COMPRESSION_ZLIB

The original data are split into equally sized chunks and compressed individually. The compressed data chunks are stored (in order) without padding, preceded by an uint64 array specifying the relative offsets of the compressed data of each chunk. The offsets are relative to the first byte following the offset array. Since the first chunk is always at offset 0, its array element is omitted. Therefore uncompressed data split into n chunks will have n - 1 offset array elements.

The size of the compressed chunks is implied by the offset differences (respectively for the last chunk the difference to the total size). A compressed chunk is always shorter than the uncompressed chunk. If the chunk data couldn't be compressed, the data are stored uncompressed and the size of the stored chunk will be equal to the uncompressed chunk size.

The Package Format

This section specifies how informative package attributes (package-name, version, provides, requires, ...) are stored in a HPKG file. It builds on top of the container format, defining the types of attributes, their order, and allowed values.

E.g. a ".PackageInfo" file, containing a package description that is being converted into a package file:

name		mypackage
version		0.7.2-1
architecture	x86
summary		"is a very nice package"
description	"has lots of cool features\nand is written in MyC++"
vendor		"Me, Myself & I, Inc."
packager	"me@test.com"
copyrights	{ "(C) 2009-2011, Me, Myself & I, Inc." }
licenses	{ "Me, Myself & I Commercial License"; "MIT" }
provides {
	cmd:me
	lib:libmyself = 0.7
}
requires {
	haiku >= r1
	wget
}

could be represented by this attribute tree:

  • B_HPKG_ATTRIBUTE_ID_PACKAGE_NAME : string : "mypackage"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR : string : "0"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MINOR : string : "7"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MICRO : string : "2"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_RELEASE : uint : 1
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_ARCHITECTURE : uint : 1
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_SUMMARY : string : "is a very nice package"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_DESCRIPTION : string : "has lots of cool features\nand is written in MyC++"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_VENDOR : string : "Me, Myself & I, Inc."
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_PACKAGER : string : "me@test.com"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_COPYRIGHT : string : "(C) 2009-2011, Me, Myself & I, Inc."
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_LICENSE : string : "Me, Myself & I Commercial License"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_LICENSE : string : "MIT"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES : string : "cmd:me"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES_TYPE : uint : 2
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES : string : "lib:libmyself"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES_TYPE : uint : 1
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR : string : "0"
      • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MINOR : string : "7"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_REQUIRES : string : "haiku"
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_OPERATOR : uint : 4
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR : string : "r1"
  • B_HPKG_ATTRIBUTE_ID_PACKAGE_REQUIRES : string : "wget"

Attribute IDs

The following attribute IDs are specified by the package format. Any other attributes will be rejected.

B_HPKG_ATTRIBUTE_ID_PACKAGE_NAME ("package:name")

  • Type: string
  • Value: Name of the package.
  • Allowed Values: Any name composed of <alphanum_underline> (i.e. [a-zA-Z0-9_]).
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_SUMMARY ("package:summary")

  • Type: string
  • Value: Short description of the package.
  • Allowed Values: Any single-lined string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_DESCRIPTION ("package:description")

  • Type: string
  • Value: Long description of the package.
  • Allowed Values: Any string (may contain multiple lines).
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_VENDOR ("package:vendor")

  • Type: string
  • Value: Name of the person/organization that is publishing this package.
  • Allowed Values: Any single-lined string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_PACKAGER ("package:packager")

  • Type: string
  • Value: E-Mail of person that created this package.
  • Allowed Values: Any single-lined string, but e-mail preferred.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_FLAGS ("package:flags")

  • Type: uint
  • Value: Set of boolean flags applying to package.
  • Allowed Values: Any combination of the following.
1B_PACKAGE_FLAG_APPROVE_LICENSEthis package's license requires approval (i.e. must be shown to and acknowledged by user before installation)
2B_PACKAGE_FLAG_SYSTEM_PACKAGEthis is a system package (i.e. lives under /boot/system)
  • Default Value: 0.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_ARCHITECTURE ("package:architecture")

  • Type: uint
  • Value: System architecture this package was built for.
  • Allowed Values:
0B_PACKAGE_ARCHITECTURE_ANYthis package doesn't depend on the system architecture
1B_PACKAGE_ARCHITECTURE_X86x86, 32-bit, built with gcc4
2B_PACKAGE_ARCHITECTURE_X86_GCC2x86, 32-bit, built with gcc2
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR ("package:version.major")

  • Type: string
  • Value: Major (first) part of package version.
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MINOR: The minor part of the package version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MICRO: The micro part of the package version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_PRE_RELEASE: The pre-release part of the package version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_RELEASE: The release part of the package version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MINOR ("package:version.minor")

  • Type: string
  • Value: Minor (second) part of package version.
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MICRO ("package:version.micro")

  • Type: string
  • Value: Micro (third) part of package version.
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_PRE_RELEASE ("package:version.prerelease")

  • Type: string
  • Value: Pre-release (fourth) part of package version. Typically something like "alpha1", "beta2", "rc3".
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>, but not starting with a digit.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_RELEASE ("package:version.release")

  • Type: string
  • Value: Release (fifth) part of package version.
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_COPYRIGHT ("package:copyright")

  • Type: string
  • Value: Copyright applying to the software contained in this package.
  • Allowed Values: Any (preferably single-lined) string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_LICENSE ("package:license")

  • Type: string
  • Value: Name of license applying to the software contained in this package.
  • Allowed Values: Any single-lined string.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_URL ("package:url")

  • Type: string
  • Value: URL of the packaged software's project home page.
  • Allowed Values: A regular URL or an email-like named URL (e.g. "Project Foo <http://foo.example.com>").
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_SOURCE_URL ("package:source-url")

  • Type: string
  • Value: URL of the packaged software's source code or build instructions.
  • Allowed Values: A regular URL or an email-like named URL (e.g. "Project Foo <http://foo.example.com>").
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES ("package:provides")

  • Type: string
  • Value: Name of a (optionally typed) entity that is being provided by this package.
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes: none
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_TYPE: The resolvable type as int.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR: The major part of the resolvable version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES_COMPATIBLE: The major part of the resolvable compatible version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES_TYPE ("package:provides.type")

  • Type: uint
  • Value: Type of resolvable.
  • Allowed Values:
0B_PACKAGE_RESOLVABLE_TYPE_DEFAULTthis resolvable isn't typed ()
1B_PACKAGE_RESOLVABLE_TYPE_LIBRARYthis resolvable represents a library ('lib:')
2B_PACKAGE_RESOLVABLE_TYPE_COMMANDthis resolvable represents a console command ('cmd:')
3B_PACKAGE_RESOLVABLE_TYPE_APPLICATIONthis resolvable represents an application ('app:')
4B_PACKAGE_RESOLVABLE_TYPE_ADD_ONthis resolvable represents an add-on ('add-on:')
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_PROVIDES_COMPATIBLE ("package:provides.compatible")

  • Type: string
  • Value: Major (first) part of the resolvable compatible version, structurally identical to B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR.
  • Allowed Values: Any single-lined string, composed of <alphanum_underline>.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MINOR: The minor part of the resolvable compatible version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MICRO: The micro part of the resolvable compatible version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_PRE_RELEASE: The pre-release part of the resolvable compatible version.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_RELEASE: The release part of the resolvable compatible version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_REQUIRES ("package:requires")

  • Type: string
  • Value: Name of an entity that is required by this package (and hopefully being provided by another).
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_OPERATOR: The resolvable operator as int.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR: The major part of the resolvable version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_SUPPLEMENTS ("package:supplements")

  • Type: string
  • Value: Name of an entity that is supplemented by this package (i.e. this package will automatically be selected for installation if the supplemented resolvables are already installed).
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_OPERATOR: The resolvable operator as int.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR: The major part of the resolvable version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_CONFLICTS ("package:conflicts")

  • Type: string
  • Value: Name of an entity that this package conflicts with (i.e. only one of both can be installed at any time).
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_OPERATOR: The resolvable operator as int.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR: The major part of the resolvable version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_FRESHENS ("package:freshens")

  • Type: string
  • Value: Name of an entity that is being freshened by this package (i.e. this package will patch one or more files of the package that provide this resolvable).
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes:
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_RESOLVABLE_OPERATOR: The resolvable operator as int.
    • B_HPKG_ATTRIBUTE_ID_PACKAGE_VERSION_MAJOR: The major part of the resolvable version.

B_HPKG_ATTRIBUTE_ID_PACKAGE_REPLACES ("package:replaces")

  • Type: string
  • Value: Name of an entity that is being replaced by this package (used if the name of a package changes, or if a package has been split).
  • Allowed Values: Any string matching [ <alphanum-underline> ':' ] <alphanum_underline>.
  • Child Attributes: none

B_HPKG_ATTRIBUTE_ID_PACKAGE_CHECKSUM ("package:checksum")

  • Type: string
  • Value: SHA256-chechsum of this package, in hexdump format. N.B.: this attribute can only be found in package repository files, not in package files.
  • Allowed Values: 64-bytes of hexdump.
  • Child Attributes: none

Haiku Package Repository Format

Very similar to the package format, there's a Haiku Package Repository (HPKR) file format. Such a file contains informative attributes about the package repository and package attributes for all packages contained in the repository. However, this format does not contain any files.

Two stacked format layers can be identified:

  • A generic container format for structured data.
  • A package format, extending the archive format with attributes for package management.

The Data Container Format

A HPKR file consists of three sections:

Header
Identifies the file as HPKR file and provides access to the other sections.
Repository Info
A section containing an archived BMessage of a BRepositoryInfo object.
Package Attributes
A section just like the package attributes section of the HPKG, only that this section contains the package attributes of all the packages contained in the repository (not just one).

Header

The header has the following structure:

struct hpkg_repo_header {
	uint32	magic;
	uint16	header_size;
	uint16	version;
	uint64	total_size;

	// repository info section
	uint32	info_compression;
	uint32	info_length_compressed;
	uint32	info_length_uncompressed;

	// package attributes section
	uint32	packages_compression;
	uint64	packages_length_compressed;
	uint64	packages_length_uncompressed;
	uint64	packages_strings_length;
	uint64	packages_strings_count;
};
magic
The string 'hpkr' (B_HPKG_REPO_MAGIC).
header_size
The size of the header.
version
The version of the HPKR format the file conforms to. The current version is 1 (B_HPKG_REPO_VERSION).
total_size
The total file size.
info_compression
The compression algorithm used for the repository info section.
info_length_compressed
The compressed size of the repository info section. Equals info_length_uncompressed, if the section is not compressed.
info_length_uncompressed
The uncompressed size of the repository info section.
packages_compression
The compression algorithm used for the package attributes section.
packages_length_compressed
The compressed size of the package attributes section. Equals attributes_length_uncompressed, if the section is not compressed.
packages_length_uncompressed
The uncompressed size of the package attributes section.
packages_strings_length
The size of the strings subsection of the package attributes section.
packages_strings_count
The number of entries in the strings subsection of the package attributes section.
Note: See TracWiki for help on using the wiki.