Split helpers.h include for backward compatibility

Users of liberasurecode <= 1.0.7 used alloc/free helpers
(which they shouldn't have).  This change is to make sure
we are still able to those older revs of programs and they
work with newer liberasurecode.

Makefile.am

@@ -18,6 +18,7 @@ thisinclude_HEADERS = \
 	include/erasurecode/erasurecode.h \
 	include/erasurecode/erasurecode_backend.h \
 	include/erasurecode/erasurecode_helpers.h \
+	include/erasurecode/erasurecode_helpers_ext.h \
 	include/erasurecode/erasurecode_log.h \
 	include/erasurecode/erasurecode_preprocessing.h \
 	include/erasurecode/erasurecode_postprocessing.h \
@@ -32,11 +33,13 @@ thisinclude_HEADERS = \
 
 install-exec-hook:
 	-(cd $(DESTDIR)$(includedir) && \
-	   rm erasurecode.h erasurecode_version.h \
-	      erasurecode_stdinc.h config_liberasurecode.h && \
+	   rm -f erasurecode.h erasurecode_version.h \
+	         erasurecode_stdinc.h erasurecode_helpers.h \
+	         config_liberasurecode.h && \
 	   $(LN_S) liberasurecode/erasurecode.h && \
 	   $(LN_S) liberasurecode/erasurecode_version.h && \
 	   $(LN_S) liberasurecode/erasurecode_stdinc.h && \
+	   $(LN_S) liberasurecode/erasurecode_helpers.h && \
 	   $(LN_S) liberasurecode/config_liberasurecode.h)
 
 test: check

include/erasurecode/erasurecode_helpers.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014, Kevin Greenan, Tushar Gohda, All rights reserved
+ * Copyright 2014, Kevin Greenan, Tushar Gohad, All rights reserved
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -29,7 +29,6 @@
 #ifndef _ERASURECODE_HELPERS_H_
 #define _ERASURECODE_HELPERS_H_
 
-#include "erasurecode_backend.h"
 #include "erasurecode_stdinc.h"
 
 /* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
@@ -85,48 +84,12 @@ int convert_idx_list_to_bitvalues(
     return n;
 }
 
-static inline
-void init_fragment_header(char *buf)
-{
-    fragment_header_t *header = (fragment_header_t *) buf;
-
-    header->magic = LIBERASURECODE_FRAG_HEADER_MAGIC;
-}
-
 /* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
 
 void *alloc_zeroed_buffer(int size);
 void *alloc_and_set_buffer(int size, int value);
 void *check_and_free_buffer(void *buf);
-char *alloc_fragment_buffer(int size);
-int free_fragment_buffer(char *buf);
 void *get_aligned_buffer16(int size);
-int get_aligned_data_size(ec_backend_t instance, int data_len);
-char *get_data_ptr_from_fragment(char *buf);
-int get_data_ptr_array_from_fragments(char **data_array, char **fragments,
-        int num_fragments);
-int get_fragment_ptr_array_from_data(char **frag_array, char **data,
-        int num_data);
-char *get_fragment_ptr_from_data_novalidate(char *buf);
-char *get_fragment_ptr_from_data(char *buf);
-uint64_t get_fragment_size(char *buf);
-int set_fragment_idx(char *buf, int idx);
-int get_fragment_idx(char *buf);
-int set_fragment_payload_size(char *buf, int size);
-int get_fragment_payload_size(char *buf);
-int set_fragment_backend_metadata_size(char *buf, int size);
-int get_fragment_backend_metadata_size(char *buf);
-int get_fragment_buffer_size(char *buf);
-int set_orig_data_size(char *buf, int orig_data_size);
-int get_orig_data_size(char *buf);
-int set_checksum(ec_checksum_type_t ct, char *buf, int blocksize);
-int get_checksum(char *buf); //TODO implement this
-int set_libec_version(char *fragment);
-int get_libec_version(char *fragment, uint32_t *ver);
-int set_backend_id(char *buf, ec_backend_id_t id);
-int get_backend_id(char *buf, ec_backend_id_t *id);
-int set_backend_version(char *buf, uint32_t version);
-int get_backend_version(char *buf, uint32_t *version);
 
 /* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
 

include/erasurecode/erasurecode_helpers_ext.h

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2014, Kevin Greenan, Tushar Gohad, All rights reserved
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice, this
+ * list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY
+ * THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+ * EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * liberasurecode proprocssing helpers header
+ *
+ * vi: set noai tw=79 ts=4 sw=4:
+ */
+
+#ifndef _ERASURECODE_HELPERS_EXT_H_
+#define _ERASURECODE_HELPERS_EXT_H_
+
+#include "erasurecode_backend.h"
+#include "erasurecode_helpers.h"
+
+/* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
+
+static inline
+void init_fragment_header(char *buf)
+{
+    fragment_header_t *header = (fragment_header_t *) buf;
+
+    header->magic = LIBERASURECODE_FRAG_HEADER_MAGIC;
+}
+
+/* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
+
+char *alloc_fragment_buffer(int size);
+int free_fragment_buffer(char *buf);
+int get_aligned_data_size(ec_backend_t instance, int data_len);
+char *get_data_ptr_from_fragment(char *buf);
+int get_data_ptr_array_from_fragments(char **data_array, char **fragments,
+        int num_fragments);
+int get_fragment_ptr_array_from_data(char **frag_array, char **data,
+        int num_data);
+char *get_fragment_ptr_from_data_novalidate(char *buf);
+char *get_fragment_ptr_from_data(char *buf);
+uint64_t get_fragment_size(char *buf);
+int set_fragment_idx(char *buf, int idx);
+int get_fragment_idx(char *buf);
+int set_fragment_payload_size(char *buf, int size);
+int get_fragment_payload_size(char *buf);
+int set_fragment_backend_metadata_size(char *buf, int size);
+int get_fragment_backend_metadata_size(char *buf);
+int get_fragment_buffer_size(char *buf);
+int set_orig_data_size(char *buf, int orig_data_size);
+int get_orig_data_size(char *buf);
+int set_checksum(ec_checksum_type_t ct, char *buf, int blocksize);
+int get_checksum(char *buf); //TODO implement this
+int set_libec_version(char *fragment);
+int get_libec_version(char *fragment, uint32_t *ver);
+int set_backend_id(char *buf, ec_backend_id_t id);
+int get_backend_id(char *buf, ec_backend_id_t *id);
+int set_backend_version(char *buf, uint32_t version);
+int get_backend_version(char *buf, uint32_t *version);
+
+/* ==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~==~=*=~== */
+
+#endif  // _ERASURECODE_HELPERS_EXT_H_
+

src/backends/isa-l/isa_l_rs_vand.c

@@ -33,6 +33,7 @@
 #include "erasurecode.h"
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 
 #define ISA_L_RS_VAND_LIB_MAJOR 2
 #define ISA_L_RS_VAND_LIB_MINOR 13

src/backends/jerasure/jerasure_rs_cauchy.c

@@ -32,6 +32,7 @@
 #include "erasurecode.h"
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 
 #define JERASURE_RS_CAUCHY_LIB_MAJOR 2
 #define JERASURE_RS_CAUCHY_LIB_MINOR 0

src/backends/jerasure/jerasure_rs_vand.c

@@ -32,6 +32,7 @@
 #include "erasurecode.h"
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 
 #define JERASURE_RS_VAND_LIB_MAJOR 2
 #define JERASURE_RS_VAND_LIB_MINOR 0

src/backends/rs_vand/liberasurecode_rs_vand.c

@@ -30,6 +30,7 @@
 #include "erasurecode.h"
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 
 #define LIBERASURECODE_RS_VAND_LIB_MAJOR 1
 #define LIBERASURECODE_RS_VAND_LIB_MINOR 0

src/backends/shss/shss.c

@@ -34,6 +34,7 @@
 
 #include "erasurecode.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_backend.h"
 
 /* Forward declarations */

src/erasurecode.c

@@ -30,6 +30,7 @@
 #include "erasurecode.h"
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_preprocessing.h"
 #include "erasurecode_postprocessing.h"
 #include "erasurecode_stdinc.h"

src/erasurecode_helpers.c

@@ -30,6 +30,7 @@
 #include <stdarg.h>
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_stdinc.h"
 #include "erasurecode_version.h"
 

src/erasurecode_postprocessing.c

@@ -28,6 +28,7 @@
 
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_stdinc.h"
 
 void add_fragment_metadata(ec_backend_t be, char *fragment,

src/erasurecode_preprocessing.c

@@ -28,6 +28,7 @@
 
 #include "erasurecode_backend.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_log.h"
 #include "erasurecode_preprocessing.h"
 #include "erasurecode_stdinc.h"

test/libec_slap.c

@@ -42,6 +42,7 @@
 #include <assert.h>
 #include "erasurecode.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "builtin/xor_codes/test_xor_hd_code.h"
 
 struct frag_array_set {

test/liberasurecode_test.c

@@ -30,6 +30,7 @@
 #include <stdbool.h>
 #include "erasurecode.h"
 #include "erasurecode_helpers.h"
+#include "erasurecode_helpers_ext.h"
 #include "erasurecode_preprocessing.h"
 #include "erasurecode_backend.h"
 #include "alg_sig.h"