Remove get_chksum to hush warnings

This popped up because Fedora mandates warning-free builds,
and get_chksum triggers a warning because it returns an
unaligned pointer (it is so analigned, static analysis in
the compiler can detect it).

The easiest fix is to remove it altogether. We think it should
be safe, because:

 - The function is not listed in any headers
 - Its counterpart is called "set_checksum", not "set_chksum"
 - PyECLib does not use it

We also hush some doxygen warnings about wrong comments.

Change-Id: Ie5bc736f912706e0ffd507765abd24e7f4761233
This commit is contained in:
Pete Zaitcev 2019-02-12 18:13:01 -06:00
parent 405775cba1
commit 3564b711b4
2 changed files with 5 additions and 18 deletions

View File

@ -250,7 +250,7 @@ int liberasurecode_backend_available(const ec_backend_id_t backend_id) {
*
* @param id - one of the supported backends as
* defined by ec_backend_id_t
* @param ec_args - arguments to the EC backend
* @param args - arguments to the EC backend
* arguments common to all backends
* k - number of data fragments
* m - number of parity fragments
@ -321,7 +321,7 @@ int liberasurecode_instance_create(const ec_backend_id_t id,
/**
* Close a liberasurecode instance
*
* @param liberasurecode descriptor to close
* @param desc - liberasurecode descriptor to close
*/
int liberasurecode_instance_destroy(int desc)
{
@ -529,7 +529,7 @@ int liberasurecode_decode_cleanup(int desc, char *data)
*
* @param desc - liberasurecode descriptor/handle
* from liberasurecode_instance_create()
* @param fragments - erasure encoded fragments (> = k)
* @param available_fragments - erasure encoded fragments (> = k)
* @param num_fragments - number of fragments being passed in
* @param fragment_len - length of each fragment (assume they are the same)
* @param force_metadata_checks - force fragment metadata checks (default: 0)

View File

@ -178,8 +178,8 @@ uint64_t get_fragment_size(char *buf)
* Compute a size aligned to the number of data and the underlying wordsize
* of the EC algorithm.
*
* @param instance, ec_backend_t instance (to extract args)
* @param data_len, integer length of data in bytes
* @param instance - ec_backend_t instance (to extract args)
* @param data_len - integer length of data in bytes
* @return integer data length aligned with wordsize of EC algorithm
*/
int get_aligned_data_size(ec_backend_t instance, int data_len)
@ -487,17 +487,4 @@ inline int set_checksum(ec_checksum_type_t ct, char *buf, int blocksize)
return 0;
}
inline uint32_t* get_chksum(char *buf)
{
fragment_header_t* header = (fragment_header_t*) buf;
assert(NULL != header);
if (header->magic != LIBERASURECODE_FRAG_HEADER_MAGIC) {
log_error("Invalid fragment header (get chksum)!");
return NULL;
}
return (uint32_t *) header->meta.chksum;
}
/* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */