Arranged headers so that CamIO2 now 'compiles' to a static library

build.sh

@@ -16,15 +16,25 @@
 #      http://gcc.gnu.org/ml/gcc-bugs/1998-07/msg00059.html
 #      http://gcc.gnu.org/ml/gcc-bugs/1998-07/msg00128.html
 
-#-std=c11 We use anonymous unions and alligned_alloc
+#-std=c11 We use anonymous unions, anonymous structures and alligned_alloc
 
 set -x
 
-CFLAGS="-Ideps -Ideps -D_XOPEN_SOURCE=700 -D_BSD_SOURCE -std=c11 -Werror -Wall -Wextra -pedantic -Wno-missing-field-initializers"
+INCLUDES="-Ideps -Isrc"
+CFLAGS="-D_XOPEN_SOURCE=700 -D_BSD_SOURCE -std=c11 -Werror -Wall -Wextra -pedantic -Wno-missing-field-initializers -ggdb"
 LINKFLAGS="-lrt"
 #LINKFLAGS="-Ldeps/chaste -lchaste -lrt"
 #CAKECONFIG=$(build/cake/cake-config-chooser)
 CAKECONFIG=cake.conf
-SRC=src/camio2.c
+SRC=src/camio.c
+#TESTS="--begintests  tests/*.c --endtests"
+
+build/cake/cake $SRC\
+    --variant=release\
+    --config=build/cake/$CAKECONFIG\
+    --append-CFLAGS="$INCLUDES $CFLAGS"\
+    --LINKFLAGS="$LINKFLAGS"\
+    --LINKFLAGS="$LINKFLAGS"\
+    --static-library\
+    $TESTS\
 
-build/cake/cake $SRC --config=build/cake/$CAKECONFIG --append-CFLAGS="$CFLAGS"  --LINKFLAGS="$LINKFLAGS"  --LINKFLAGS="$LINKFLAGS" $@ --begintests  tests/*.c --endtests

src/api/api.h

@@ -0,0 +1,147 @@
+/*
+ * CamIO - The Cambridge Input/Output API 
+ * Copyright (c) 2014, All rights reserved.
+ * See LICENSE.txt for full details. 
+ * 
+ *  Created:   Aug 15, 2014
+ *  File name: api.h
+ *  Description:
+ *  <INSERT DESCRIPTION HERE> 
+ */
+
+#ifndef API_H_
+#define API_H_
+
+#include <types/types.h>
+#include <streams/stream_types.h>
+#include <streams/features.h>
+#include <buffers/buffer.h>
+
+
+/**
+ *  Attempt to connect the underlying stream to it’s data source. This may or may not block. If successful, the CamIO stream
+ *  can be read and/or written to. In many cases, the connect operation will return immediately, with a valid stream once
+ *  only. However, this is not guaranteed. Some streams may return multiple valid connection and some streams may take some
+ *  time before they return successfully. Streams can be placed into selectors to facilitate the blocking behaviour
+ *  necessary to wait for these events to happen by listening for the  on connection signal.
+ *  Return values;
+ *  - ENOERROR: Stream was created successfully.
+ *  - ETRYAGAIN: The stream has nothing new to report at this time. No connection has yet happened.
+ *  - ECHECKERROR: The stream creation has failed.
+ */
+camio_error_t camio_connect( camio_connector_t* this, camio_stream_t* stream_o );
+
+/**
+ * Free resources associated with this connector, but not with any of the streams it has created.
+ */
+void camio_connector_destroy(camio_connector_t* this);
+
+
+/**
+ * Create a new CamIO connector of type "type" with the properties requested and otherwise binary arguments. The type and
+ * order of these arguments is stream specific. The camio_connector_o is only valid id ENOERROR is returned.
+ * Returns:
+ * - ENOERROR:  All good. Nothing to see here.
+ * - ENOSTREAM: The stream type is unrecognised
+ * - EBADOPT:   The arguments have an error or are unsupported
+ * - EBADPROP:  The stream supplied in did not match the properties requested.
+ */
+camio_error_t camio_connector_new_bin( camio_connector_t** connector_o, camio_stream_type_t type,
+                                       camio_stream_features_t* properties,  ... );
+
+
+/**
+ * Create a new CamIO connector with with given the URI and properties request. Return a pointer to connection object in
+ * cioconn_o. Cioconn_o is only valid id ENOERROR is returned.
+ * Returns:
+ * - ENOERROR:  All good. Nothing to see here.
+ * - EBADURI:   The URI supplied has a syntax error or is poorly formatted
+ * - ENOSTREAM: The stream type is unrecognised
+ * - EBADOPT:   The URI options have an error or are unsupported
+ * - EBADPROP:  The stream supplied in URI did not match the properties requested.
+ */
+camio_error_t camio_connector_new_uri( camio_connector_t** connector_o, char* uri , camio_stream_features_t* properties );
+
+
+
+
+/**
+ * This function tries to do a read for new data from the CamIO Stream called “this” and returns a read buffer chain pointer
+ * called “buffer_chain_o”. The read call may or may not block. Use a selector to ensure that the stream is ready for
+ * reading. If the stream is empty, (e.g. end of file) or closed (e.g. disconnected) it is valid to return 0 bytes with an
+ * ENOERROR. If buffer_offset is non-zero, the read will try to place data at offset bytes into each buffer. This may fail and
+ * is only supported if the read_to_buff_off feature is supported. You can check for success by comparing
+ * buffer_o->data_start and buffer_o->buffer_start pointers. If the source offset is non-zero, the read will try to retrieve
+ * data from offset bytes from the beginning of the source. This may fail and is only supported if the read_from_src_off
+ * feature is supported by the stream.
+ * Return values:
+ * - ENOERROR:  Completed successfully, buffer_o contains a valid structure.
+ * - ETRYAGAIN: There was no data available at this time, but there might be some more later.
+ * - ENOBUFFS:  The stream could not allocate more buffers for the read. Free some buffers by releasing an outstanding read
+ *              or write transaction.
+ */
+camio_error_t cmaio_read_acquire( camio_stream_t* this,  camio_rd_buffer_t** buffer_chain_o, ch_word buffer_offset,
+                                  ch_word source_offset);
+
+/**
+ * Relinquish resources associated with the given read buffer chain. Streams with the async_arrv feature enabled support
+ * asynchronous update modes. Read_release will check to see if the data in these buffer is still valid. If it is not valid,
+ * it may have been trashed while you were working on it, so any results are invalid! If you are concerned about correctness,
+ * you should a) not use a stream that has async_arrv b) ensure that your software can “roll back” when a corruption is
+ * detected c) copy data and check for validity before proceeding. Some streams have sequencing requirements for buffer
+ * chains. If you try to release an invalid sequence, an EBADSEQ error may be raised.
+ * Return values:
+ * - ENOERROR: All good, please continue
+ * - EINVALID: Your data got trashed, time to recover!
+ * - EBADSEQ:  You cannot release this buffer without releasing previous buffers in the sequence too
+ */
+camio_error_t camio_read_release(camio_stream_t* this, camio_rd_buffer_t* buffer_chain);
+
+
+
+/**
+ * Try to acquire count_io buffers for writing data into. You can hang on to these buffers as long as you like, but beware,
+ * most streams offer a limited number of buffers, some streams can only acquire and release buffers sequentially and some
+ * streams offer only one buffer. If you are using stream association for zero-copy data movement, calling read_aquire has
+ * the effect of calling write_acquire and/or visa-versa. The number of buffers actually reserved will be returned in
+ * count_io. This may be less than the original request. Some streams have sequencing requirements applied to buffer_chains
+ * Returns:
+ *  - ENOERROR: Completed successfully, buffer_o contains a valid structure.
+ *  - ENOSLOTS: The stream could not allocate more slots for the read. Free some slots by releasing a read or write
+ *              transaction.
+ */
+camio_error_t camio_write_aquire(camio_stream_t* this, camio_wr_buffer_t** buffer_chain_o, ch_word* count_io);
+
+
+
+/* Write data described by buffer_chain to the  stream called “this”. Write may or may not block. Use the selector loop
+ * to ensure that the stream is ready for writing. If the dest_offset is non-zero, the write will try to place data starting
+ * at offset bytes from the beginning of the destination. This may fail and is only supported if the write_to_dst_off
+ * feature is supported by the stream. If buffer_offset is non-zero, the write will try to take data from offset bytes into
+ * each buffer. This may fail and is only supported if the write_from_buff feature is supported by the stream.
+ * Returns:
+ * - ENOERROR: Completed successfully.
+ * - TODO XXX: Add more here
+ */
+camio_error_t camio_write_commit(camio_stream_t* this, camio_wr_buffer_t* buffer_chain, ch_word buffer_offset,
+                           ch_word dest_offset);
+
+
+/**
+ * Relinquish resources associated with the given write buffer chain. If you try to release an invalid sequence, an EBADSEQ
+ * error may be raised.
+ * Return values:
+ * - ENOERROR: All good, please continue.
+ * - EBADSEQ:  You cannot release this buffer without releasing previous buffers in the sequence too.
+ */
+camio_error_t camio_write_release(camio_stream_t* this, camio_wr_buffer_t* buffers_chain);
+
+
+/**
+ * Free resources associated with this stream, but not with its connector.
+ */
+void camio_stream_destroy(camio_stream_t* this);
+
+
+
+#endif /* API_H_ */

src/buffers/buffer.h

@@ -14,8 +14,7 @@
 
 #include <time.h>
 #include <sys/time.h>
-#include "../types/stdinclude.h"
-#include "../types/types.h"
+#include <types/types.h>
 
 typedef enum camio_buffer_timestamp_e {
     CIO_BUFFER_TST_NONE,          //No timestamp on this stream

src/camio.c

@@ -0,0 +1,13 @@
+/*
+ * CamIO - The Cambridge Input/Output API 
+ * Copyright (c) 2014, All rights reserved.
+ * See LICENSE.txt for full details. 
+ * 
+ *  Created:   Aug 15, 2014
+ *  File name: camio.c
+ *  Description:
+ *  <INSERT DESCRIPTION HERE> 
+ */
+
+#include "camio.h"
+

src/camio.h

@@ -0,0 +1,17 @@
+/*
+ * CamIO - The Cambridge Input/Output API 
+ * Copyright (c) 2014, All rights reserved.
+ * See LICENSE.txt for full details. 
+ * 
+ *  Created:   Aug 15, 2014
+ *  File name: camio.h
+ *  Description:
+ *  <INSERT DESCRIPTION HERE> 
+ */
+
+#ifndef CAMIO_H_
+#define CAMIO_H_
+
+#include <api/api.h>
+
+#endif /* CAMIO_H_ */

src/streams/connector.h

@@ -12,13 +12,11 @@
 #ifndef CONNECTOR_H_
 #define CONNECTOR_H_
 
-#include "../types/types.h"
+#include <types/types.h>
 #include "features.h"
-#include "stream.h"
-#include "stream_types.h"
 
 /**
- * Every CamIO stream must implement this interface, see function prototypes later for full details
+ * Every CamIO stream must implement this interface, see function prototypes in api.h
  */
 
 typedef struct camio_connector_interface_s{
@@ -47,49 +45,5 @@ typedef struct camio_connector_s {
 } camio_connector_t;
 
 
-/**
- *  Attempt to connect the underlying stream to it’s data source. This may or may not block. If successful, the CamIO stream
- *  can be read and/or written to. In many cases, the connect operation will return immediately, with a valid stream once
- *  only. However, this is not guaranteed. Some streams may return multiple valid connection and some streams may take some
- *  time before they return successfully. Streams can be placed into selectors to facilitate the blocking behaviour
- *  necessary to wait for these events to happen by listening for the  on connection signal.
- *  Return values;
- *  - ENOERROR: Stream was created successfully.
- *  - ETRYAGAIN: The stream has nothing new to report at this time. No connection has yet happened.
- *  - ECHECKERROR: The stream creation has failed.
- */
-camio_error_t camio_connect( camio_connector_t* this, camio_stream_t* stream_o );
-
-/**
- * Free resources associated with this connector, but not with any of the streams it has created.
- */
-void camio_destroy(camio_connector_t* this);
-
-
-/**
- * Create a new CamIO connector of type "type" with the properties requested and otherwise binary arguments. The type and
- * order of these arguments is stream specific. The camio_connector_o is only valid id ENOERROR is returned.
- * Returns:
- * - ENOERROR:  All good. Nothing to see here.
- * - ENOSTREAM: The stream type is unrecognised
- * - EBADOPT:   The arguments have an error or are unsupported
- * - EBADPROP:  The stream supplied in did not match the properties requested.
- */
-camio_error_t camio_connector_new_bin( camio_connector_t** connector, camio_stream_type_t type,
-                                       camio_stream_features_t* properties,  ... );
-
-
-/**
- * Create a new CamIO connector with with given the URI and properties request. Return a pointer to connection object in
- * cioconn_o. Cioconn_o is only valid id ENOERROR is returned.
- * Returns:
- * - ENOERROR:  All good. Nothing to see here.
- * - EBADURI:   The URI supplied has a syntax error or is poorly formatted
- * - ENOSTREAM: The stream type is unrecognised
- * - EBADOPT:   The URI options have an error or are unsupported
- * - EBADPROP:  The stream supplied in URI did not match the properties requested.
- */
-camio_error_t camio_connector_new_uri( camio_connector_t** connector, char* uri , camio_stream_features_t* properties );
-
 
 #endif /* CONNECTOR_H_ */

src/streams/features.h

@@ -12,7 +12,7 @@
 #ifndef FEATURES_H_
 #define FEATURES_H_
 
-#include "../types/types.h"
+#include <types/types.h>
 
 /**
  * Request (req) for stream features. Unless otherwise specified:

src/streams/stream.h

@@ -12,11 +12,11 @@
 #ifndef STREAM_H_
 #define STREAM_H_
 
-#include "../types/types.h"
+#include <types/types.h>
 
 
 /**
- * Every CamIO stream must implement this interface, see function prototypes later for full details
+ * Every CamIO stream must implement this interface, see function prototypes in api.h
  */
 typedef struct camio_stream_interface_s{
     //Read operations
@@ -63,83 +63,5 @@ typedef struct camio_stream_s {
 
 
 
-/**
- * This function tries to do a read for new data from the CamIO Stream called “this” and returns a read buffer chain pointer
- * called “buffer_chain_o”. The read call may or may not block. Use a selector to ensure that the stream is ready for
- * reading. If the stream is empty, (e.g. end of file) or closed (e.g. disconnected) it is valid to return 0 bytes with an
- * ENOERROR. If buffer_offset is non-zero, the read will try to place data at offset bytes into each buffer. This may fail and
- * is only supported if the read_to_buff_off feature is supported. You can check for success by comparing
- * buffer_o->data_start and buffer_o->buffer_start pointers. If the source offset is non-zero, the read will try to retrieve
- * data from offset bytes from the beginning of the source. This may fail and is only supported if the read_from_src_off
- * feature is supported by the stream.
- * Return values:
- * - ENOERROR:  Completed successfully, buffer_o contains a valid structure.
- * - ETRYAGAIN: There was no data available at this time, but there might be some more later.
- * - ENOBUFFS:  The stream could not allocate more buffers for the read. Free some buffers by releasing an outstanding read
- *              or write transaction.
- */
-camio_error_t cmaio_read_acquire( camio_stream_t* this,  camio_rd_buffer_t** buffer_chain_o, ch_word buffer_offset,
-                                  ch_word source_offset);
-
-/**
- * Relinquish resources associated with the given read buffer chain. Streams with the async_arrv feature enabled support
- * asynchronous update modes. Read_release will check to see if the data in these buffer is still valid. If it is not valid,
- * it may have been trashed while you were working on it, so any results are invalid! If you are concerned about correctness,
- * you should a) not use a stream that has async_arrv b) ensure that your software can “roll back” when a corruption is
- * detected c) copy data and check for validity before proceeding. Some streams have sequencing requirements for buffer
- * chains. If you try to release an invalid sequence, an EBADSEQ error may be raised.
- * Return values:
- * - ENOERROR: All good, please continue
- * - EINVALID: Your data got trashed, time to recover!
- * - EBADSEQ:  You cannot release this buffer without releasing previous buffers in the sequence too
- */
-camio_error_t camio_read_release(camio_stream_t* this, camio_rd_buffer_t* buffer_chain);
-
-
-
-/**
- * Try to acquire count_io buffers for writing data into. You can hang on to these buffers as long as you like, but beware,
- * most streams offer a limited number of buffers, some streams can only acquire and release buffers sequentially and some
- * streams offer only one buffer. If you are using stream association for zero-copy data movement, calling read_aquire has
- * the effect of calling write_acquire and/or visa-versa. The number of buffers actually reserved will be returned in
- * count_io. This may be less than the original request. Some streams have sequencing requirements applied to buffer_chains
- * Returns:
- *  - ENOERROR: Completed successfully, buffer_o contains a valid structure.
- *  - ENOSLOTS: The stream could not allocate more slots for the read. Free some slots by releasing a read or write
- *              transaction.
- */
-camio_error_t camio_write_aquire(camio_stream_t* this, camio_wr_buffer_t** buffer_chain_o, ch_word* count_io);
-
-
-
-/* Write data described by buffer_chain to the  stream called “this”. Write may or may not block. Use the selector loop
- * to ensure that the stream is ready for writing. If the dest_offset is non-zero, the write will try to place data starting
- * at offset bytes from the beginning of the destination. This may fail and is only supported if the write_to_dst_off
- * feature is supported by the stream. If buffer_offset is non-zero, the write will try to take data from offset bytes into
- * each buffer. This may fail and is only supported if the write_from_buff feature is supported by the stream.
- * Returns:
- * - ENOERROR: Completed successfully.
- * - TODO XXX: Add more here
- */
-camio_error_t camio_write_commit(camio_stream_t* this, camio_wr_buffer_t* buffer_chain, ch_word buffer_offset,
-                           ch_word dest_offset);
-
-
-/**
- * Relinquish resources associated with the given write buffer chain. If you try to release an invalid sequence, an EBADSEQ
- * error may be raised.
- * Return values:
- * - ENOERROR: All good, please continue.
- * - EBADSEQ:  You cannot release this buffer without releasing previous buffers in the sequence too.
- */
-camio_error_t camio_write_release(camio_stream_t* this, camio_wr_buffer_t* buffers_chain);
-
-
-/**
- * Free resources associated with this stream, but not with its connector.
- */
-void camio_destroy(camio_stream_t* this);
-
-
 
 #endif /* STREAM_H_ */