protomsg 0.6.0 → 0.7.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = protomsg
 
-Protocol Message Buffers for C. This gem generates C socket code for reading and writing messages described in the protomsg DSL.
+Protocol Message Buffers for C. This gem generates C socket code for reading and writing messages described in the protomsg DSL. The code is highly optimised and often similar to what you would write by hand manually.
 
 == Overview
 Input for a 'request' message:
@@ -34,7 +34,7 @@ Output is a header file of macros for reading, writing and manipulating request
     write_request
     read_request
 
-The macros generate highly optimised, copy free socket code (using the scatter/gather IO functions readv and writev), and automatically check message sanity, and handle incomplete reads and writes. Message types with many variable length attributes (strings or raw data segments) will benefit more from the generated code than message types primarily made up of fixed length attributes.
+The macros generate highly optimised copy free socket code (using scatter/gather IO functions), and automatically check message sanity and handle incomplete reads and writes. The generated code is often very similar to what you would write by hand, and in some cases is even faster.
 
 == Usage
 Call the protomsg script with the message types input file.
@@ -58,7 +58,7 @@ All message type and attribute names must be valid C identifiers. Valid attribut
     raw     Raw bytes
 
 == Example
-Once you have defined your message types, sending and receiving messages is easy. For example, given the following message type:
+Once you have defined your message types, sending and receiving messages is easy. For example, given the following message type definitions:
 
     # ping_message.protomsg
     ping {
@@ -113,7 +113,7 @@ And the corresponding server could be:
     
         // start a server and wait for a ping message
         create_server_socket(9000, 1, server, error);
-        accept_client(server, client);
+        accept_client(server, client, error);
         read_ping(p, client, error);
         printf("Received ping: %llu, %s\n", get_ping_number(p), get_ping_message(p));
     
@@ -123,7 +123,7 @@ And the corresponding server could be:
         write_response(r, client, error);
     }
 
-It's not necessary to use the included socket helper macros - you can use protomsg's over any socket - but for simple client/server applications like this they help reduce the amount of code required to get something running quickly.
+It's not necessary to use the included socket helper macros - you can use proto messages over any socket - but for simple client/server applications like this they help reduce the amount of code required to get something running quickly.
 
 == Known Issues
-All clients are servers are assumed to be on machines of the same endianess.
+All clients are servers are assumed to be on machines of the same endianess. The simple socket creation macros can't create IP6 sockets as yet. Writev is used to send messages; an error is currently raised when an incomplete write completes, rather than restart the write where it was left off.

data/lib/templates/io.h

@@ -1,23 +1,32 @@
 #define write_<%= @name %>(msg, sock, error) {\
   error = 0;\
-  ssize_t written = writev(sock, (const struct iovec *)msg, <%= variable_attributes.size + 1 %>);\
-  if(written != <%= @name %>_length(msg)){\
+  ssize_t _written = writev(sock, (const struct iovec *)msg, <%= variable_attributes.size + 1 %>);\
+  if(_written != <%= @name %>_length(msg)){\
     error = errno;\
   }\
 }
 
 #define read_<%= @name %>(msg, sock, error) {\
-  msg = (<%= @name %> *) malloc(sizeof(<%= @name %>));\
-  msg->header_length = sizeof(<%= @name %>_header);\
-  msg->header = (<%= @name %>_header *)malloc(sizeof(<%= @name %>_header));\
-  read_struct(sock, msg->header, sizeof(<%= @name %>_header), error);\
+  error = 0;\
+  if(!msg) {\
+    msg = (<%= @name %> *) malloc(sizeof(<%= @name %>));\
+    msg->header_length = sizeof(<%= @name %>_header);\
+    msg->header = (<%= @name %>_header *)malloc(sizeof(<%= @name %>_header));\
+  }\
+  safe_read(sock, msg->header, sizeof(<%= @name %>_header), error);\
   if(!error) {\
-    if(msg->header->_version == PROTO_MESSAGE_VERSION && msg->header->_type == <%= @name.upcase %>_MESSAGE_TYPE) {\
-      <% variable_attributes.each do |attr| %>msg-><%= attr.name %>_length = msg->header-><%= attr.name %>_length;\
-      msg-><%= attr.name %> = malloc(msg->header-><%= attr.name %>_length);\
-      <% end %>readv(sock, (const struct iovec *)msg + 1, <%= variable_attributes.size %>);\
-    } else {\
-      error = INVALID_PROTOMSG_HEADER;\
+    if(msg->header->_version != PROTO_MESSAGE_VERSION) {\
+      error = INVALID_PROTOMSG_VERSION;\
+    } else if(msg->header->_type != <%= @name.upcase %>_MESSAGE_TYPE) {\
+      error = INVALID_MESSAGE_TYPE;\
+    } else {\<% if variable_attributes.size > 0 %>
+      if(msg-><%= variable_attributes.first.name %>)\
+        free(msg-><%= variable_attributes.first.name %>);\
+      msg-><%= variable_attributes.first.name %> = malloc(<%= @name %>_variable_length(msg));\
+      <% variable_attributes.each_with_index do |attr, index| %>msg-><%= attr.name %>_length = msg->header-><%= attr.name %>_length;\<% if index > 0 %>
+      msg-><%= attr.name %> = msg-><%= variable_attributes.first.name %> + <%= variable_attributes[0..index-1].collect {|attr| "msg->header->#{attr.name}_length" }.join(" + ") %>;\<% end %>
+      <% end %>safe_read(sock, msg-><%= variable_attributes.first.name %>, <%= @name %>_variable_length(msg), error);\<% else %>
+      ;\<% end %>
     }\
   }\
 }

data/lib/templates/lengths.h

@@ -1,2 +1,3 @@
 <% variable_attributes.each do |attr| %>#define <%= @name %>_<%= attr.name %>_length(msg) (msg-><%= attr.name %>_length)
-<% end %>#define <%= @name %>_length(msg) (msg->header_length <%= variable_attributes.size > 0 ? ("+ " + variable_attributes.collect {|attr| "msg->#{attr.name}_length"}.join(" + ")) : '' %>)
+<% end %>#define <%= @name %>_length(msg) (msg->header_length <%= variable_attributes.size > 0 ? ("+ " + variable_attributes.collect {|attr| "msg->#{attr.name}_length"}.join(" + ")) : '' %>)<% if variable_attributes.size > 0 %>
+#define <%= @name %>_variable_length(msg) (<%= variable_attributes.collect {|attr| "msg->#{attr.name}_length"}.join(" + ")%>)<% end %>

data/lib/templates/memory.h

@@ -11,3 +11,8 @@
   free(msg->header);\
   free(msg);\
 }
+
+#define free_<%= @name %>_structure(msg) {\
+  free(msg->header);\
+  free(msg);\
+}

data/lib/templates/protomsg.h

@@ -8,14 +8,15 @@
 #ifndef __protomsg__
 #define __protomsg__
 
-#define PROTO_MESSAGE_VERSION   1
-#define INVALID_PROTOMSG_HEADER 1
+#define PROTO_MESSAGE_VERSION     1
+#define INVALID_PROTOMSG_VERSION  1
+#define INVALID_MESSAGE_TYPE      2
 
-#define read_struct(sock, structure, size, error) {\
+#define safe_read(sock, buffer, size, error) {\
   error = 0;\
   ssize_t _bytes_read = 0, _bytes_total = 0;\
   while(_bytes_total < size) {\
-    _bytes_read = read(sock, structure + _bytes_total, size - _bytes_total);\
+    _bytes_read = read(sock, buffer + _bytes_total, size - _bytes_total);\
     if(_bytes_read != -1) {\
       _bytes_total += _bytes_read;\
     } else {\
@@ -28,35 +29,47 @@
 #define create_server_socket(port, queue, sock, error) {\
   error = 0;\
   sock = socket(AF_INET, SOCK_STREAM, 0);\
-  struct sockaddr_in _servaddr;\
-  memset(&_servaddr, 0, sizeof(_servaddr));\
-  _servaddr.sin_family      = AF_INET;\
-  _servaddr.sin_addr.s_addr = htonl(INADDR_ANY);\
-  _servaddr.sin_port        = htons(port);\
-  error = bind(sock, (const struct sockaddr *)&_servaddr, sizeof(_servaddr));\
-  if(error) {\
+  if(sock == -1) {\
     error = errno;\
   } else {\
-    error = listen(sock, queue);\
+    struct sockaddr_in _servaddr;\
+    memset(&_servaddr, 0, sizeof(_servaddr));\
+    _servaddr.sin_family      = AF_INET;\
+    _servaddr.sin_addr.s_addr = htonl(INADDR_ANY);\
+    _servaddr.sin_port        = htons(port);\
+    error = bind(sock, (const struct sockaddr *)&_servaddr, sizeof(_servaddr));\
     if(error) {\
       error = errno;\
+    } else {\
+      error = listen(sock, queue);\
+      if(error) {\
+        error = errno;\
+      }\
     }\
   }\
 }
 
-#define accept_client(sock, client) {\
+#define accept_client(sock, client, error) {\
   client = accept(sock, NULL, NULL);\
+  if(client == -1)\
+    error = errno;\
 }
 
 #define connect_to_server(address, port, sock, error) {\
   error = 0;\
   sock = socket(AF_INET, SOCK_STREAM, 0);\
-  struct sockaddr _servaddr;\
-  socklen_t _servaddr_length;\
-  get_socket_addr_from_hostname(address, _servaddr, _servaddr_length, error);\
-  if(!error) {\
-    ((struct sockaddr_in *) &_servaddr)->sin_port = htons(port);\
-    error = connect(sock, (struct sockaddr *) &_servaddr, sizeof(_servaddr));\
+  if(sock == -1) {\
+    error = errno;\
+  } else {\
+    struct sockaddr _servaddr;\
+    socklen_t _servaddr_length;\
+    get_socket_addr_from_hostname(address, _servaddr, _servaddr_length, error);\
+    if(!error) {\
+      ((struct sockaddr_in *) &_servaddr)->sin_port = htons(port);\
+      if(connect(sock, (struct sockaddr *) &_servaddr, sizeof(_servaddr))) {\
+        error = errno;\
+      }\
+    }\
   }\
 }
 

data/lib/templates/setters/string_setter.h

@@ -1,4 +1,4 @@
 #define set_<%= @message_type.name %>_<%= @name %>(msg, val) {\
   msg-><%= @name %> = val;\
-  msg-><%= @name %>_length = msg->header-><%= @name %>_length = (val) ? (strlen(val) + 1) : 0;\
+  msg-><%= @name %>_length = msg->header-><%= @name %>_length = ((val) ? (strlen(val) + 1) : 0);\
 }

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Will Cannings