From 2cdc76aebccba88eb4e906eb6189a7a036e251e3 Mon Sep 17 00:00:00 2001 From: Kota Tsuyuzaki Date: Fri, 27 Feb 2015 06:16:30 -0800 Subject: Add shss id to README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e465057..a04f3b3 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,9 @@ typedef enum { EC_BACKEND_NULL = 0, /* "null" */ EC_BACKEND_JERASURE_RS_VAND = 1, /* "jerasure_rs_vand" */ EC_BACKEND_JERASURE_RS_CAUCHY = 2, /* "jerasure_rs_cauchy" */ - EC_BACKEND_FLAT_XOR_HD = 3, /* "flat_xor_hd */ - EC_BACKEND_ISA_L_RS_VAND = 4, /* "isa_l_rs_vand */ + EC_BACKEND_FLAT_XOR_HD = 3, /* "flat_xor_hd" */ + EC_BACKEND_ISA_L_RS_VAND = 4, /* "isa_l_rs_vand" */ + EC_BACKEND_SHSS = 5, /* "shss" */ EC_BACKENDS_MAX, } ec_backend_id_t; -- cgit v1.2.1 From 9722168b5866769f1bf35bf112bca6d454106e2e Mon Sep 17 00:00:00 2001 From: Kota Tsuyuzaki Date: Fri, 27 Feb 2015 07:55:57 -0800 Subject: Update documentation about metadata_adder --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index a04f3b3..0ced36d 100644 --- a/README.md +++ b/README.md @@ -277,7 +277,8 @@ struct fragment_metadata { uint32_t idx; /* 4 */ - uint32_t size; /* 4 */ + uint32_t size; /* 4 (raw data bytes size of each fragment used for encode/fragment_to_string) */ + uint32_t frag_adder_size; /* 4 (extra metadata_adder bytes size of backend specification) */ uint64_t orig_data_size; /* 8 */ uint8_t chksum_type; /* 1 */ uint32_t chksum[LIBERASURECODE_MAX_CHECKSUM_LEN]; /* 16 */ @@ -339,6 +340,18 @@ int liberasurecode_get_aligned_data_size(int desc, uint64_t data_len); * @return minimum data length length, or -error code on error */ int liberasurecode_get_minimum_encode_size(int desc); + +/** + * This will return the fragment size, which is each fragment data + * length the backend will allocate when encoding. + * + * @param desc - liberasurecode descriptor/handle + * from liberasurecode_instance_create() + * @param data_len - original data length in bytes + * + * @return fragment size - sizeof(fragment_header) + size + frag_adder_size + */ +int liberasurecode_get_fragment_size(int desc, int data_len); ``` ---- -- cgit v1.2.1 From dd67555f8425ff5fa3cb9b807224ab5199614394 Mon Sep 17 00:00:00 2001 From: Kota Tsuyuzaki Date: Thu, 5 Mar 2015 13:43:19 +0900 Subject: Rename frag_adder_size This patch renames following variables and functions: - frag_adder_size -> frag_backend_metadata_size - set_fragment_adder_size() -> set_fragment_backend_metadata_size() - get_fragment_adder_size() -> get_fragment_backend_metadata_size() --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0ced36d..0fd1575 100644 --- a/README.md +++ b/README.md @@ -278,7 +278,7 @@ fragment_metadata { uint32_t idx; /* 4 */ uint32_t size; /* 4 (raw data bytes size of each fragment used for encode/fragment_to_string) */ - uint32_t frag_adder_size; /* 4 (extra metadata_adder bytes size of backend specification) */ + uint32_t frag_backend_metadata_size; /* 4 (extra metadata bytes size of backend specification) */ uint64_t orig_data_size; /* 8 */ uint8_t chksum_type; /* 1 */ uint32_t chksum[LIBERASURECODE_MAX_CHECKSUM_LEN]; /* 16 */ @@ -349,7 +349,8 @@ int liberasurecode_get_minimum_encode_size(int desc); * from liberasurecode_instance_create() * @param data_len - original data length in bytes * - * @return fragment size - sizeof(fragment_header) + size + frag_adder_size + * @return fragment size - sizeof(fragment_header) + size + * + frag_backend_metadata_size */ int liberasurecode_get_fragment_size(int desc, int data_len); -- cgit v1.2.1