DistRen Changeset - 7c0e60f07a51 · protofusion repositories

Changeset - 7c0e60f07a51

Parent rev.

Child rev.

[Not reviewed]

default

0 11 0

Nathan Brink (binki) - 15 years ago 2010-07-25 17:23:16
ohnobinki@ohnopublishing.net

Server and client will connect and send DISTREN_REQUEST_VERSION packets immediately.

11 files changed with 212 insertions and 54 deletions:

doc/architecture.txt

src/client/libdistren.c

src/client/libdistren.h

src/client/libdistren_request.c

src/common/protocol.h

src/common/request.c

src/common/request.h

src/server/distrend.c

src/server/listen.c

src/server/listen.h

src/server/tabletennis.c

0 comments (0 inline, 0 general)

doc/architecture.txt

➞

Show inline comments

 Concepts:
 - trust: The first model of distren will assume that is can trust all other servers it associates
     with. This removes a great deal of potential complication and yet this should be addressed
     in a later revision of this document.
 - server: A process that accepts jobs, manages rendering processes, and talks to other servers
   - server identification: each server must be given a unique, alphanumeric identifier.
       It may make sense to have a server on a machine named after a domain name by which the
       server may be accessed. There doesn't need to be such an association, though. This document
       assumes that a server's name shall also remain constant (anything else would complicate...).
       If a new URL schema would be used, I suppose that distren://<servername>/ might identify a
       distren server.
 - job: Represents a collection of renderings that must be unbundled, rendered, and bundled together again.
   - job identification: A server shall internally assign numeric job identifiers. It must only
       make sure that it never issues the same numeric job identifier to multiple jobs. To allow
       multiple servers to share jobs with eachother (which is the the whole point of distren),
       a job shall be refered to by prefixing the job a server identification. For example,
       distren://<servername>/<jobid>
   - job packaging: Currently, the most creative way of dealing with jobs I have at the moment is
       storing all of the data necessary to render the job in a tarball. This tarball can be
       treated as a directory of a normal filesystem. A job's directory would contain at least one
       file called ``distrenjob.xml'' which provides information necessary to render the job. This
       will be an XML file rather than a rigidly defined binary format because XML supports
       arbitrary data storage out of the box. This should allow different rendering backends to
       store the extra information that is specific to that backend.
   - post-render rebundling: Again, to make things simpler, the server where a job is rendered
       shall be responsible for collecting the individual completed frames and collecting them
       into a tarball. This tarball may be called for using a client. This tarball is a bundle
       of completed frames and will exclude the seed tarball.
 - frame: Represents a distinct, and hopefully small, unit of work that a renderer backend can perform.
   - frame identification: Like a job numeral is useless without a qualifying servername, a
       frame's identification number would be useless without an accompanying job identifier. The
       numeric value of a frame identification value must be unique to that job. There are no
       restrictions of ordering of frame numbers except that they are not to be negative. There
       need be no sequencing of frame numbers either. Thus, a frame identification URL would look
       like distren://<servername>/<jobid>/frame/<frameid>
   - size: A frame hopefully represents a smaller unit of work in terms of the rendering
       back-end's capabilities. For example, POV-Ray's CLI can initiate and carry out the rendering
       of an entire animation. But distren would hopefully be able to provide a clean method for
       rendering each individual frame and bringing the resulting set of files back to the user
       in a much shorter time than a single computer could on its own. Many smaller and distinct
       is key to a project being benefited by distren.
   - dependencies: One cannot escape from frame's completion potentially requiring the completion
       of another. Thus, each frame's record must explicitly list the URLs of frames that need to
       be completed prior to the said frame. For a server to complete a frame dependent on other
       frames, those other frames must be transfered to the first server and made available.
   - packaging: To render a single frame and move it about somewhere is normally trivial. However,
       one frame or rendering unit of a given backend may produce multiple files. For this reason
       and for further uniformity and simplification, the data files representing one frame shall
       be transferred using the tarball format.
 - client: A distren client is able to submit, query state of, and download completed frames of
       jobs registered in a server.
   - servers: A server, though having many more functions, shall be able to also perform the list
       of actions a client may perform.
 - user: A user is an entity which is given access to a distren server.
 - file: There are different uses of files above and distributed rendering requires file distribution.
   - file identification: Every file mentioned above was at least in the context of a job. Thus,
       file identification numbers shall be assigned in the context of a job identification number.
       They shall, however, be numeric.
       distren://<servername>/<jobid>/file/<fileid>

src/client/libdistren.c

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink, Ethan Zonca, Matt Orlando
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 /*
   Implementation of distren_* functions from distren.h excluding distren_job_* functions.
  */
 #include "common/config.h"
 #include "common/options.h"
 #include "common/protocol.h"
 #include "common/remoteio.h"
 #include "common/request.h"
 #include "libdistren.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 /**
  * Handle common cleanup actions for distren_init().
  */
 static void distren_init_cleanup(distren_t distren);
 int distren_init(distren_t *handle)
+{
   int tmp;
   struct distren_request *req;
   void *data;
   if(!handle)
     return 1;
   *handle = malloc(sizeof(struct distren));
   if(!*handle)
     return 1;
   memset(*handle, 0, sizeof(struct distren));
   /* now the environment is ready for general use */
   if(_distren_getoptions(*handle))
+    {
       fprintf(stderr, "error getting configuration\n");
-      distren_free(*handle);
+      distren_init_cleanup(*handle);
       return 1;
+    }
   tmp = remoteio_open_server(&(*handle)->rem,
 			     (*handle)->options->remoteio,
 			     (remoteio_read_handle_func_t)&libdistren_remoteio_read_handle,
 			     *handle,
 			     (remoteio_close_handle_func_t)&libdistren_remoteio_close_handle,
 			     (*handle)->server);
   if(tmp)
+    {
       fprintf(stderr, "error: unable to connect to server\n");
       (*handle)->rem = NULL;
       distren_free(*handle);
       distren_init_cleanup(*handle);
       return 1;
+    }
   multiio_poll((*handle)->multiio, 2000);
   multiio_poll((*handle)->multiio, 2000);
   multiio_poll((*handle)->multiio, 2000);
   /* send off a DISTREN_REQUEST_VERSION to the server */
   tmp = distren_request_version(&req, &data, DISTREN_SERVERTYPE_CLIENT, PACKAGE_STRING);
   if(tmp)
+    {
       fprintf(stderr, "error: unable to allocate request");
       distren_init_cleanup(*handle);
       return 1;
+    }
   distren_request_send((*handle)->rem, req, data);
   distren_request_free_with_data(req, data);
   while((*handle)->rem
 	&& (*handle)->state == DISTREN_STATE_VERSION)
       multiio_poll((*handle)->multiio, 500);
   if(!(*handle)->rem)
+    {
       distren_init_cleanup(*handle);
       return 1;
+    }
   return 0;
+}
 static void distren_init_cleanup(distren_t distren)
+{
   if(distren->rem)
     remoteio_close(distren->rem);
   distren->rem = NULL;
   distren_free(distren);
+}
 /**
  * @todo Stub
  */
 int distren_submit_file(distren_t handle, distren_job_t *job, const char *filename)
+{
   return 1;
+}
 int distren_free(distren_t handle)
+{
   if(handle->rem)
     remoteio_close(handle->rem);
   free(handle);
   return 0;
+}

src/client/libdistren.h

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink, Ethan Zonca, Matt Orlando
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 #ifndef LIBDISTREN_H_
 #define LIBDISTREN_H_ 1
 /*
   Private definitions for libdistren.
  */
 #include "distren.h"
 #include "common/multiio.h"
 #include "common/options.h"
 #include "common/remoteio.h"
 #include <stdint.h>
 enum distren_state
+  {
     /**
      * client is waiting for a VERSION packet from the server.
      */
     DISTREN_STATE_VERSION,
     /**
      * We are waiting to be authenticated.
      */
     DISTREN_STATE_AUTH,
     DISTREN_STATE_NORMAL,
     DISTREN_STATE_UPLOADING,
   };
 struct distren
+{
   struct options_common *options;
   char *server;
   /* if rem is NULL, we're not connected to the server */
   enum distren_state state;
   /*
    * If rem is NULL, we're not connected to the server. This is the
    * way to detect a communication error.
    */
   struct remoteio *rem;
   /*
    * for libdistren_remoteio_read_handle(): determine whether or not
    * we've passed through the server's hacky MOTD
    */
   short done_ad;
   /*
    * The servertype bitmask of the remote server.
    */
   uint32_t servertype;
   /* something on which to call multiio_poll() ;-) */
   multiio_context_t multiio;
 };
 struct distren_job
+{
   char *joburi;
 };
 /*
   functions
 */
 /**
    Avoid poluting the public namespace until we fix visibility.
  */
 #define _malloc _distren_malloc
 /**
    All of libdistren should use this rather than malloc.h's malloc.
  */
 void *_malloc(distren_t distren, size_t size);
 /**
    Avoid poluting the public namespace until we fix visibility.
  */
 #define _free _distren_free
 /**
    All of libdisren should use this instead of malloc.h's free()
 */
 void _free(distren_t distren, void *tofree);
 /**
  * Sets up the distren handle with information garnered from
  * configuration files, etc. Uses the environment variable
  * DISTREN_CONFIG or the built-in default config file location.
+ *
  * Also initializes multiio.
  */
 int _distren_getoptions(distren_t handle);
 /**
  * Unsets-up the distren handle with options loadable from a config file.
+ *
  * Also unloads multiio.
  */
 int _distren_loseoptions(distren_t handle);
 /**
  * Handle newly read data.
+ *
  * Matches remoteio_read_handle_func_t
  */
 size_t libdistren_remoteio_read_handle(struct remoteio *rem, void *garbage, void *buf, size_t len, distren_t distren);
 /**
  * React to a remoteio-based connection closing.
+ *
  * Matches remoteio_close_handle_func_t
  */
 void libdistren_remoteio_close_handle(void *garbage, distren_t distren);
 #endif

src/client/libdistren_request.c

➞

Show inline comments

 /*
  * Copyright 2010 Nathan Phillip Brink
+ *
  * This file is a part of DistRen.
+ *
  * DistRen is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * DistRen is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
  */
 #include "common/config.h"
 #include "libdistren.h"
 #include "common/protocol.h"
 #include "common/remoteio.h"
 #include "common/request.h"
 static void handle_ping(struct remoteio *rem, struct distren_request *req, void *req_data);
-static void handle_version(struct remoteio *rem, struct distren_request *req, void *req_data);
+static void handle_version(distren_t distren, struct distren_request *req, void *req_data);
 static void handle_disconnect(distren_t distren, struct remoteio *rem, struct distren_request *req, void *req_data);
 size_t libdistren_remoteio_read_handle(struct remoteio *rem, void *garbage, void *buf, size_t len, distren_t distren)
+{
   size_t to_return;
   size_t last_len;
   short err;
   struct distren_request *req;
   void *req_data;
   to_return = 0;
   while(!distren->done_ad)
+    {
       if(!len)
 	return to_return;
       putchar(*(char *)buf);
       if(*(char *)buf == '\n')
 	distren->done_ad = 1;
       len --;
       to_return ++;
       buf ++;
+    }
   /* hack to get into the loop at all ;-) */
   last_len = 1;
   while(last_len)
+    {
       last_len = distren_request_handle(NULL, buf, len, &req, &req_data, &err);
       if(err)
+	{
 	  remoteio_close(rem);
 	  return to_return;
+	}
       if(!last_len)
 	return to_return;
       switch((enum distren_request_type)req->type)
+	{
 	case DISTREN_REQUEST_PING:
 	  handle_ping(rem, req, req_data);
 	  break;
 	case DISTREN_REQUEST_VERSION:
-	  handle_version(rem, req, req_data);
+	  handle_version(distren, req, req_data);
 	  break;
 	case DISTREN_REQUEST_DISCONNECT:
 	  handle_disconnect(distren, rem, req, req_data);
 	  break;
 	default:
 	  /*
 	   * we don't implement everything because we don't need to do
 	   * so. But, we should complain when we get something we
 	   * don't recognize because... server protocols change
 	   * ;-). Oh, and when I'm first writing this, this
 	   * block will be hit a lot ;-).
 	   */
 	  fprintf(stderr, "Unrecognized request type: %lu\n", (unsigned long)req->type);
 	  break;
+	}
       distren_request_free(req);
       buf += last_len;
       len -= last_len;
+    }
   return to_return;
+}
 void libdistren_remoteio_close_handle(void *garbage, distren_t distren)
+{
   distren->rem = NULL;
+}
 /* handlers */
 static void handle_ping(struct remoteio *rem, struct distren_request *req, void *req_data)
+{
   struct distren_request *pong_req;
   void *pong_req_data;
   distren_request_poing(&pong_req, &pong_req_data, 0, req_data, req->len);
   distren_request_send(rem, pong_req, pong_req_data);
   distren_request_free_with_data(pong_req, pong_req_data);
+}
-static void handle_version(struct remoteio *rem, struct distren_request *req, void *req_data)
+static void handle_version(distren_t distren, struct distren_request *req, void *req_data)
+{
   static const char *package_string = PACKAGE_STRING;
   size_t counter;
   struct distren_request_version version;
   int tmp;
   fprintf(stderr, "info: connected to a server running ");
   for(counter = 0; counter < req->len; counter ++)
     putc(((char *)req_data)[counter], stderr);
   putc('\n', stderr);
   tmp = distren_request_parse_version(req, req_data, &version);
   if(tmp)
+    {
       fprintf(stderr, "error: Invalid DISTREN_REQUEST_VERSION, disconnecting from server\n");
       /*
        * our remoteio_close handler sets distren->rem to NULL, thus we
        * don't need to return an error code.
        */
       remoteio_close(distren->rem);
       return;
+    }
   distren->servertype = version.servertype;
   distren->state = DISTREN_STATE_AUTH;
   /* am I supposed to respond here? ;-) */
   fprintf(stderr, "info: connected to a server running %s\n", version.package_string);
   if(version.servertype & DISTREN_SERVERTYPE_CLIENT)
     fprintf(stderr, "\tis a client\n");
   if(version.servertype & DISTREN_SERVERTYPE_SUBMIT)
     fprintf(stderr, "\taccepts frame submissions\n");
   if(version.servertype & DISTREN_SERVERTYPE_RENDER)
     fprintf(stderr, "\trenders frames\n");
   if(version.servertype & DISTREN_SERVERTYPE_DISTRIBUTE)
     fprintf(stderr, "\thandles file distribution\n");
+}
 static void handle_disconnect(distren_t distren, struct remoteio *rem, struct distren_request *req, void *req_data)
+{
   size_t tmp;
   fputs("warning: The server has disconnected us because ``", stderr);
   tmp = fwrite(req_data, 1, req->len, stderr);
   fputs("''\n", stderr);
   remoteio_close(distren->rem);
+}

src/common/protocol.h

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 #ifndef DISTREN_PROTOCOL_H
 #define DISTREN_PROTOCOL_H
 #include <stddef.h>
 #include <stdint.h>
 /**
  * Server types:
+ *
  * It is assumed that any client has at least the functionality of a
  * normal client (i.e., accepts all of the REQUIRED requests). These
  * bitmask values add to the types of requests one may make to a
  * server. After first connecting to a server or receiving a
  * connection, a client shall send a DISTREN_REQUEST_VERSION packet
  * describing its version.
  */
 #define DISTREN_SERVERTYPE_SUBMIT (0x1)
 #define DISTREN_SERVERTYPE_DISTRIBUTE (0x2)
 #define DISTREN_SERVERTYPE_RENDER (0x4)
 #define DISTREN_SERVERTYPE_CLIENT (0x8)
 /**
  * This file defines the constants and structs that distren clients
  * and server use to converse.
  */
 /**
  * List of request types and metadata.
  */
 enum distren_request_type
+  {
     /**
      * identifies the version of software being used by the sender and
      * tells if it is a client or server. Sends PACKAGE_STRING as well
      * as informing the other server what type of server this is.
+     *
      * DATA: struct distren_request followed by PACKAGE_STRING. The length of PACKAGE_STRING must be no longer than 32 bytes.
+     *
      * REQUIRED: ALL
     */
     DISTREN_REQUEST_VERSION = 1,
     /**
      * DATA: up to 32 bytes of a PING cookie
+     *
      * REQUIRED: ALL
      */
     DISTREN_REQUEST_PING = 2,
     /**
      * DATA: up to 32 bytes copied from a received PING cookie
+     *
      * REQUIRED: ALL
      */
     DISTREN_REQUEST_PONG = 3,
     /**
      * The data is the a reason describing why the one end is
      * disconnecting. The other end should respectfully close()
      * the socket or the sender will timeout shortly.
+     *
      * DATA: A string describing the reason for the connection's
      * termination.
+     *
      * REQUIRED: ALL
      */
     DISTREN_REQUEST_DISCONNECT = 4,
     /**
      * DATA: struct distren_request_submit
+     *
      * REQUIRED: DISTREN_SERVERTYPE_SUBMIT
      */
     DISTREN_REQUEST_SUBMIT = 5,
     /**
      * Inform the other party about a job.
+     *
      * DATA: struct distren_request_jobinfo
+     *
      * REQUIRED: ALL
      */
     DISTREN_REQUEST_JOBINFO = 6,
     /**
      * Request a DISTREN_REQUEST_JOBINFO
+     *
      * DATA: struct distren_request_jobinfo_get
+     *
      * REQUIRED: DISTREN_SERVERTYPE_SUBMIT, DISTREN_SERVERTYPE_DISTRIBUTE
      */
     DISTREN_REQUEST_JOBINFO_GET = 7,
     /**
      * Command the other party to render a frame
+     *
      * DATA: struct distren_request_frame_render
+     *
      * REQUIRED: DISTREN_SERVERTYPE_RENDER
      */
     DISTREN_REQUEST_FRAME_RENDER = 8,
     /**
      * Inform the receiver of the sender's state, such as frames being
      * rendered or jobs that need to be completed.
+     *
      * DATA: struct distren_request_status
+     *
      * REQUIRED: DISTREN_SERVERTYPE_RENDER, DISTREN_SERVERTYPE_DISTRIBUTE, DISTREN_SERVERTYPE_CLIENT
      */
     DISTREN_REQUEST_STATUS = 9,
     /**
      * Request that the receiver send a DISTREN_REQUEST_FRAME_STATUS
      * packet. No data because the sending party might not beforehand
      * know what frames/jobs the receiving server is managing.
+     *
      * DATA: (none)
+     *
      * REQUIRED: DISTREN_SERVERTYPE_RENDER
      */
     DISTREN_REQUEST_STATUS_GET = 10,
     /**
      * Allow a client to upload a job tarball over a remoteio line.  A
      * client that wants to do this must take care not to overbuffer
      * his sendqueue so as to be able to respond to PING packets in
      * time. A server receiving such a message will want to write the
      * file as directly to disk as possible to avoid bagging a server
      * down in swap.
+     *
      * It is potential that if a server is DISTREN_SERVERTYPE_SUBMIT
      * but not also DISTREN_SERVERTYPE_DISTRIBUTE, that this request
      * would be relayed by the DISTREN_SERVERTYPE_SUBMIT server to a
      * DISTREN_SERVERTYPE_DISTRIBUTE server so that other clients can
      * obtain the file from the distribution server. In this case, the
      * file's URL is already known.
+     *
      * Of course, having this sort of functionality at all is where
      * the nasty security issues start coming into play :-D.
+     *
      * DATA: struct distren_request_file_post followed by a maximum of 131072 bytes (128kB).
+     *
      * REQUIRED: DISTREN_SERVERTYPE_SUBMIT, DISTREN_SERVERTYPE_DISTRIBUTE
      */
     DISTREN_REQUEST_FILE_POST = 11,
     /**
      * Request information about obtaining a file (such as a
      * cURL-compatible URL) based on a distren file URL.
+     *
      * DATA: struct distren_request_file_find
+     *
      * REQUIRED: DISTREN_SERVERTYPE_DISTRIBUTE
      */
     DISTREN_REQUEST_FILE_FIND = 12,
     /**
      * Provide information about obtaining a file (such as a URL).
+     *
      * DATA: struct distren_request_file
+     *
      * REQUIRED: DISTREN_SERVERTYPE_DISTRIBUTE
      */
     DISTREN_REQUEST_FILE = 13,
   };
 struct distren_request
+{
   uint32_t magic;
   /* the length of the data associated with the packet excluding the header */
   uint32_t len;
   /** treat type as an enum distren_request_type using casting */
   uint32_t /* enum distren_request_type */ type;
 };
 #define DISTREN_REQUEST_VERSION_PACKAGE_STRING_LEN (32)
 /**
  * A DISTREN_REQUEST_VERSION is started with a bitmask specification
  * of the DISTREN_SERVERTYPE_* values.
  */
 struct distren_request_version
+{
   uint32_t servertype;
   /* + 1 is for terminating NULL */
   char package_string[DISTREN_REQUEST_VERSION_PACKAGE_STRING_LEN + 1];
 };
 /**
  * initializes and allocates request
  */
 int distren_request_new(struct distren_request **req, uint32_t len, enum distren_request_type type);
 struct remoteio;
 /**
    Takes a struct distren_request and its associated data, allocates
    a new block of data to hold the whole packet, and packets the req
    header and data together.
    @param rem A remoteio handle to ship this packet off to
    @param req Something you initialized with distren_request_new(). You are responsible for distren_request_free()ing this yourself.
    @param data A chunk of data the size of req->len. You are responsible for free()ing this yourself.
    @return 0 on success and 1 on failure.
  */
 int distren_request_send(struct remoteio *rem, struct distren_request *req, void *data);
 /**
  * initializes and allocates request based on raw input data
  * which includes the headers of the request.
+ *
  * @return 0 on success, 1 on failure
  */
 int distren_request_new_fromdata(struct distren_request **req, void *data, size_t len);
 /**
  * Parses requests in a way suitable to be called from a
  * remoteio_read_handle_func_t.
+ *
  * If this function returns non-zero, you should handle the request
  * and then call this function again (after shortening len and
  * incrementing buf, of course).
+ *
  * @param expectlen A pointer to a state variable that, if not NULL, can speed up this function. If you want to use this, you must set the variable to 0 before the first call and preserve the variable.
  * @param buf the input buffer.
  * @param len the length of buf.
  * @param req a pointer to where we should set NULL if we don't have a full request or where we store the address of a newly allocated request. You should call distren_request_free() on this.
  * @param req_data a pointer to where the request data pointer should be stored. This will just be set to a pointer in buf, so don't free() this.
  * @param err this will be set to 0 if there is no error and to 1 if there is an error and the connection should be closed. You must check this.
  * @return number of bytes that we have used from buf and that should be marked used.
  */
 size_t distren_request_handle(size_t *expectlen,
 			      void *buf,
 			      size_t len,
 			      struct distren_request **req,
 			      void **req_data,
 			      short *err);
 /**
  * frees request
  */
 int distren_request_free(struct distren_request *req);
 /**
  * An implementation of remoteio_read_handle_func_t for use with remoteio.
+ *
  * To use this handler, first initialize a struct distren_request_remoteio_data.
  * (to be continued... or not...? ;-) )
  */
 /* size_t distren_request_remoteio_handle(struct remoteio *rem, void *generic_data, void *buf, size_t len, void *data); */
 #endif

src/common/request.c

➞

Show inline comments

 /*
  * Copyright 2010 Nathan Phillip Brink
+ *
  * This file is a part of DistRen.
+ *
  * DistRen is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * DistRen is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
  */
 #include "common/config.h"
 #include "common/protocol.h"
 #include <stdlib.h>
 #include <string.h>
 int distren_request_free_with_data(struct distren_request *req, void *data)
+{
   free(data);
   return distren_request_free(req);
+}
 int distren_request_version(struct distren_request **req, void **data, uint32_t servertype, const char *package_string)
+{
   struct distren_request_version *version;
   distren_request_new(req, sizeof(struct distren_request_version), DISTREN_REQUEST_VERSION);
   version = malloc(sizeof(struct distren_request_version));
   if(!version || !*req)
+    {
       free(version);
       if(*req)
 	distren_request_free(*req);
       return 1;
+    }
   memset(version, 0, sizeof(struct distren_request_version));
   version->servertype = servertype;
   strncpy(version->package_string, package_string, DISTREN_REQUEST_VERSION_PACKAGE_STRING_LEN);
   *data = version;
   return 0;
+}
 int distren_request_parse_version(struct distren_request *req, void *data, struct distren_request_version *version)
+{
   if(req->len < sizeof(struct distren_request_version))
     return 1;
   memcpy(version, data, sizeof(struct distren_request_version));
   /* there is space for another '\0' */
   version->package_string[DISTREN_REQUEST_VERSION_PACKAGE_STRING_LEN] = '\0';
   return 0;
+}
 int distren_request_poing(struct distren_request **req, void **data, short is_ping, const void *poing_cookie, size_t poing_data_len)
+{
   enum distren_request_type type;
   if(is_ping)
     type = DISTREN_REQUEST_PING;
   else
     type = DISTREN_REQUEST_PONG;
   distren_request_new(req, poing_data_len, type);
   (*data) = malloc(poing_data_len);
   memcpy(*data, poing_cookie, poing_data_len);
   return 0;
+}

src/common/request.h

➞

Show inline comments

 /*
  * Copyright 2010 Nathan Phillip Brink
+ *
  * This file is a part of DistRen.
+ *
  * DistRen is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * DistRen is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
  */
 #ifndef _DISTREN_REQUEST_H
 #define _DISTREN_REQUEST_H
 #include "common/protocol.h"
 /**
  * @file functions to initialize various requests that the server and
  * client may both use.
  */
 /**
  * Free any request made with one of the functions below
  */
 int distren_request_free_with_data(struct distren_request *req, void *data);
 /**
  * Initialize a VERSION request.
+ *
  * @param req pointer to where the poitner to the new req should be stored..
  * @param data pointer to where the newly allocated data's address should go.
  * @param servertype the ORing of different DISTREN_SERVERTYPE_* constants.
  * @param package_string the PACKAGE_STRING constant.
  */
 int distren_request_version(struct distren_request **req, void **data, uint32_t servertype, const char *package_string);
 /**
  * Parses a DISTREN_REQUEST_VERSION packet.
+ *
  * @param req the request to parse.
  * @param data the request's data.
  * @param version where the result should be stored.
  * @return 0 on success, 1 if the packet is invalid (if the length of package_version is longer than 32-bytes, for example).
  */
 int distren_request_parse_version(struct distren_request *req, void *data, struct distren_request_version *version);
 /**
  * Initialize a PING or PONG request.
+ *
  * @param data a place to allocate storage for the data associated with this request
  * @param is_ping 1 if this is a DISTREN_REQUEST_PING or 0 if this is a DISTREN_REQUEST_PONG
  * @param poing_cookie chocolate chip, chocolate chunk, or oatmeal chocolate chip
  * @param poing_data_len bytes in the poing_cookie
  * @return the length of the data allocated for this request
  */
 uint32_t distren_request_poing(struct distren_request **req, void **data, short is_ping, const void *poing_cookie, size_t poing_data_len);
 #endif /* _DISTREN_REQUEST_H */

src/server/distrend.c

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink, Ethan Zonca, Matthew Orlando
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 /* This file contains the code which both processes (renders) jobs as a slave, and the code which distributes frames to slaves after receiving them from the client portion of the codebase. */
 #include "common/config.h"
 #include "distrenjob.h"
 #include "listen.h"
 #include "slavefuncs.h"
 #include "mysql.h"
 #include "common/asprintf.h"
 #include "common/execio.h"
 #include "common/options.h"
 #include "common/protocol.h"
 #include "common/request.h"
 #include <confuse.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <time.h>
 #include <unistd.h>
 #include <libxml/encoding.h>
 #include <libxml/parser.h>
 #include <libxml/tree.h>
 #include <libxml/xmlmemory.h>
 #include <libxml/xmlreader.h>
 #include <libxml/xmlwriter.h>
 /* ******************* Structs ************************ */
 struct general_info
+{
   struct distrenjob head;
   distrend_mysql_conn_t conn;
   struct distrend_config *config;
   struct
+  {
     /** general_info.xml */
     char *geninfo;
   } files;
   int jobs_in_queue;
   unsigned int free_clients;
   unsigned int rendering_clients;
   unsigned int total_finished_jobs;
   unsigned int total_frames_rendered;
   unsigned int highest_jobnum;
   int hibernate;
   time_t timestamp;
   unsigned long total_render_power;
   unsigned long total_priority_pieces;
 };
 /* *********************************************
    Function Prototypes
    ********************************************* */
 /* ************General Functions************* */
 int distrend_do();
 int distrend_do_config(int argc, char *argv[], struct distrend_config **config, multiio_context_t multiio);
 int distrend_config_free(struct distrend_config *config);
 int distrend_handle_request(struct distrend_listens *listens, struct distrend_client *client, struct distren_request *req, void *reqdata, struct general_info *geninfo);
 /**
    client request handlers
  */
-int distrend_handle_version(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data);
+int distrend_handle_version(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data);
 /* **************XML Functions**************** */
 void update_general_info(struct general_info *geninfo);
 int import_general_info(struct general_info *general_info);
 int update_xml_joblist(struct general_info *geninfo);
 /* **************Test Functions**************** */
 int interactiveTest(int test, multiio_context_t multiio, struct general_info *general_info);
 /* **************** Main ********************* */
 int main(int argc, char *argv[])
+{
   /* Parse arguments */
   int counter;
   int test = 0; /*< Interactive mode if 1 */
   int tmp;
   struct general_info general_info;
   multiio_context_t multiio;
   enum clientstatus
+  {
     CLIENTSTATUS_UNINITIALIZED = 0,
     CLIENTSTATUS_BUSY = 1,
     CLIENTSTATUS_IDLE = 2
   } clientstatus;
   clientstatus = CLIENTSTATUS_UNINITIALIZED;
   // xmlinit();
   for(counter = 0; counter < argc; counter ++)
+    {
       if(strcmp(argv[counter], "-h") == 0)
+      {
     	  fprintf(stderr, "Usage: distrend [option] \nStarts the distrend server\n\t-h\tshow this help\n\t-t\tlaunches queue testing interface \n");
 	  return 2;
+      }
       else if(strcmp(argv[counter], "-t") == 0)
+      {
     	  fprintf(stderr, "Entering into test mode...\n\n");
     	  test = 1;
+      }
+    }
   multiio = multiio_context_new();
   if(distrend_do_config(argc, argv, &general_info.config, multiio))
     return 1;
   /** preset paths */
   _distren_asprintf(&general_info.files.geninfo, "%s/general_info.xml",
 		    general_info.config->datadir);
   /** MySQL Connection */
   fprintf(stderr,"Connecting to mysql...\n");
   if(mysqlConnect(&general_info.conn,
 		  general_info.config->mysql_user,
 		  general_info.config->mysql_host,
 		  general_info.config->mysql_pass,
 		  general_info.config->mysql_database) )
+    {
       fprintf(stderr, "%s:%d: mysqlConnect() failed\n", __FILE__, __LINE__);
       fprintf(stderr, "don't test mysql stuff\n");
       interactiveTest(test, multiio, &general_info);
       return 1;
+    }
   fprintf(stderr,"Finished connecting!\n");
   /** Execute test function */
   interactiveTest(test, multiio, &general_info);
   general_info.config->listens = distrend_listens_new(multiio, &general_info, general_info.config->options);
   if(!general_info.config->listens)
+    {
       fprintf(stderr, "error initializing listens\n");
       return 1;
+    }
   remoteio_generic_data_set(general_info.config->options->remoteio, general_info.config->listens);
   for(counter = 0; general_info.config->listen_ports[counter]; counter ++)
+    {
       tmp = distrend_listen_add(general_info.config->listens, general_info.config->listen_ports[counter]);
       if(tmp)
+	{
 	  fprintf(stderr, "Error listening on port %d\n", general_info.config->listen_ports[counter]);
 	  return 1;
+	}
+    }
   distrend_listen_handler_add(general_info.config->listens, DISTREN_REQUEST_VERSION, &distrend_handle_version);
   /* Main Loop */
   general_info.config->die = 0;
   while(!general_info.config->die)
+    {
       multiio_poll(multiio, 15000);
       tabletennis_serve(general_info.config->listens->tabletennis);
       /* Run the watchdog, @TODO: like every 10 mins or something */
       frame_watchdog(general_info.conn);
+    }
   distrend_listen_free(general_info.config->listens);
   distrend_config_free(general_info.config);
   xmlcleanup();
   /** free() paths */
   free(general_info.files.geninfo);
   mysqlDisconnect(general_info.conn);
   return 0;
+}
 /* ********************** Functions ************************* */
-int distrend_handle_version(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data)
+int distrend_handle_version(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data)
+{
   char *tmp_str;
-  char fixedbuf[32];
+  struct distren_request_version version;
   struct distren_request *newreq;
   if(distren_request_parse_version(req, req_data, &version))
+    {
       distrend_send_disconnect(client, "Invalid DISTREN_REQUEST_VERSION packet.");
       return 1;
+    }
   if(client->state != DISTREND_CLIENT_PREVERSION)
+    {
       distrend_send_disconnect(client, "You have already sent the VERSION command.");
       return 1;
+    }
   if(strlen(PACKAGE_STRING) == req_len
      && !strncmp(PACKAGE_STRING, req_data, req_len))
   if(!strncmp(PACKAGE_STRING, version.package_string, DISTREN_REQUEST_VERSION_PACKAGE_STRING_LEN))
+    {
       /**
 	 The client and I claim to be of the same version of distren :-D
 	 Now we will mark the client as valid.
 	 We won't increment his time to live, though, because it shouldn't take
 	 him that long to auth.
        * The client and I claim to be of the same version of distren :-D
        * Now we will mark the client as valid.
+       *
        * We won't increment his time to live, though, because it shouldn't take
        * him that long to auth.
       */
       client->state = DISTREND_CLIENT_PREAUTH;
       distren_request_new(&newreq, strlen(PACKAGE_STRING), DISTREN_REQUEST_VERSION);
       distrend_client_write_request(client, newreq, PACKAGE_STRING);
       distren_request_free(newreq);
+    }
   else
+    {
       /**
 	 The client claims to be of a different version of distren.
 	 Now we will just send a disconnect packet and disconnect the client.
        * The client claims to be of a different version of distren.
        * Now we will just send a disconnect packet and disconnect the client.
       */
       strncpy(fixedbuf, req_data, 31);
       fixedbuf[31] = '\0';
       if(req_len < 31)
 	fixedbuf[req_len] = '\0';
       _distren_asprintf(&tmp_str, "You have tried to connect to a %s server when your client claims to be running %s. Bye ;-)\n", PACKAGE_STRING, fixedbuf);
       _distren_asprintf(&tmp_str, "You have tried to connect to a %s server when your client claims to be running %s. Bye ;-)\n", PACKAGE_STRING, version.package_string);
       if(tmp_str)
+	{
       distrend_send_disconnect(client, tmp_str);
 	  free(tmp_str);
+	}
       else
 	distrend_send_disconnect(client, "Invalid PACKAGE_VERSION :-|.");
       return 1;
+    }
   return 0;
+}
 /**
    Performs command stored in a client's request. @TODO: Fill stub
 */
 int distrend_do()
+{
   return 0;
+}
 /* Grabs config info from confs */
 int distrend_do_config(int argc, char *argv[], struct distrend_config **config, multiio_context_t multiio)
+{
   unsigned int counter;
   cfg_opt_t myopts_listen[] =
+    {
       CFG_SIMPLE_STR("type", NULL),
       CFG_SIMPLE_STR("path", NULL),
       CFG_SIMPLE_INT("port", NULL),
       CFG_END()
     };
   cfg_opt_t myopts[] =
+    {
       CFG_SEC("listen",  /* this must be imported into struct listens (which must still be declared) */
           myopts_listen,
           CFGF_MULTI),
       CFG_SIMPLE_STR("datadir", NULL),
       CFG_STR_LIST("render_types", NULL, CFGF_NONE),
       CFG_SIMPLE_STR("mysql_user", NULL),
       CFG_SIMPLE_STR("mysql_host", NULL),
       CFG_SIMPLE_STR("mysql_pass", NULL),
       CFG_SIMPLE_STR("mysql_database", NULL),
       CFG_END()
     };
   cfg_t *cfg_listen;
   fprintf(stderr, "%s:%d: running config\n", __FILE__, __LINE__);
   *config = malloc(sizeof(struct distrend_config));
   myopts[1].simple_value = &(*config)->datadir;
   myopts[3].simple_value = &(*config)->mysql_user;
   myopts[4].simple_value = &(*config)->mysql_host;
   myopts[5].simple_value = &(*config)->mysql_pass;
   myopts[6].simple_value = &(*config)->mysql_database;
   if(options_init(argc, argv, &(*config)->mycfg, myopts, "daemon", &(*config)->options, multiio))
     return 1;
   /**
      grab listen blocks:
    */
   (*config)->listen_ports = malloc(sizeof(int) * (cfg_size((*config)->mycfg, "listen") + 1));
   for(counter = 0; counter < cfg_size((*config)->mycfg, "listen"); counter ++)
+    {
       cfg_listen = cfg_getnsec((*config)->mycfg, "listen", counter);
       (*config)->listen_ports[counter] = cfg_getint(cfg_listen, "port");
+    }
   (*config)->listen_ports[counter] = 0;
   fprintf(stderr, "using %s as datadir\n", (*config)->datadir);
   return 0;
+}
 int distrend_config_free(struct distrend_config *config)
+{
   distrend_listen_free(config->listens);
   options_free(config->options);
   free(config->listen_ports);
   free(config);
   return 0;
+}
 /* ************************** XML Functions ************************* */
 // writes the general_info.xml file which is a copy of the general_info structure
 // except that it doesn't hold free_clients and rendering_clients
 void update_general_info(struct general_info *geninfo)
+{
   xmlTextWriterPtr writer;
   char *tmp;
   writer = xmlNewTextWriterFilename(geninfo->files.geninfo, 0);
   xmlTextWriterStartDocument(writer, NULL, "utf-8", NULL);
   xmlTextWriterStartElement(writer, (xmlChar*)"general_info");
   _distren_asprintf(&tmp, "%d", geninfo->jobs_in_queue);
   xmlTextWriterWriteElement(writer, (xmlChar*)"jobs_in_queue", (xmlChar*)tmp);
   free(tmp);
   _distren_asprintf(&tmp, "%d", geninfo->total_finished_jobs);
   xmlTextWriterWriteElement(writer, (xmlChar*)"total_finished_jobs", (xmlChar*)tmp);
   free(tmp);
   _distren_asprintf(&tmp, "%d", geninfo->total_frames_rendered);
   xmlTextWriterWriteElement(writer, (xmlChar*)"total_frames_rendered", (xmlChar*)tmp);
   free(tmp);
   _distren_asprintf(&tmp, "%d", geninfo->highest_jobnum);
   xmlTextWriterWriteElement(writer, (xmlChar*)"highest_jobnum", (xmlChar*)tmp);
   free(tmp);
   xmlTextWriterEndDocument(writer);
   xmlFreeTextWriter(writer);
+}
 /**
    Reads general state information from general_info.xml
    into the general_info structure.
 */
 int import_general_info(struct general_info *general_info)
+{
   xmlDocPtr doc;
   xmlNodePtr cur;
   doc = xmlParseFile(general_info->files.geninfo);
   cur = xmlDocGetRootElement(doc);
   if (xmlStrcmp(cur->name, (xmlChar*)"general_info"))
+    {
       fprintf(stderr, "xml document is wrong type");
       xmlFreeDoc(doc);
       return 1;
+    }
   cur = cur->xmlChildrenNode;
   general_info->jobs_in_queue = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));
   cur = cur->next;
   general_info->total_finished_jobs = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));
   cur = cur->next;
   general_info->total_frames_rendered = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));
   cur = cur->next;
   general_info->highest_jobnum = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));
   general_info->hibernate = 0;
   general_info->free_clients = 0;
   general_info->rendering_clients = 0;
   general_info->timestamp = 0;
   general_info->total_render_power = 0;
   general_info->total_priority_pieces = 0;
   xmlFreeDoc(doc);
   return 0;
+}
 /**
    updates job_list.xml which lists all the jobs in the queue
    @return 0 means success
 */
 // @QUERY: Likely obselete (don't remove at request of ohnobinki)
 int update_xml_joblist(struct general_info *geninfo)
+{
   struct distrenjob *job;
   xmlTextWriterPtr writer;
   char *tmp;
   int counter;
   /**
      update timestamp
   */
   geninfo->timestamp ++;
   if(geninfo->timestamp > 65530)
     geninfo->timestamp = 0;
   _distren_asprintf(&tmp, "%s/job_list.xml",
                     geninfo->config->datadir);
   writer = xmlNewTextWriterFilename(tmp, 0);
   free(tmp);
   xmlTextWriterStartDocument(writer, NULL, "utf-8", NULL);
   /**
      create root element job_list
   */
   xmlTextWriterStartElement(writer, (xmlChar*)"job_list");
   _distren_asprintf(&tmp, "%d", geninfo->timestamp);
   xmlTextWriterWriteAttribute(writer, (xmlChar*)"timestamp", (xmlChar*)tmp);
   free(tmp);
   geninfo->total_priority_pieces = 0;
   counter = 0;
   for(job = geninfo->head.next; job; job = job->next)
+    {
       _distren_asprintf(&tmp, "%d", job->jobnum);
       xmlTextWriterWriteElement(writer, (xmlChar*)"jobnum", (xmlChar*)tmp);
       free(tmp);
       /**
         this is needed for the new frame finder to work
         Why the random constant numeral 11? --ohnobinki
       */
       geninfo->total_priority_pieces = geninfo->total_priority_pieces + job->priority;
       counter++;
+    }
   xmlTextWriterEndElement(writer);
   /**
      close elements and end document
   */
   xmlTextWriterEndDocument(writer);
   /**
      free writer and save xml file to disk
   */
   xmlFreeTextWriter(writer);
   return 0;
+}
 /* ************************** Test Functions ************************* */
 /** Interactive test for the queuing system */
 /* @QUEUE: Test uses methods not present in C code using mysql web-based system */
 int interactiveTest(int test, multiio_context_t multiio, struct general_info *geninfo)
+{
   int command;
   int32_t slaveKey = 1;
   jobnum_t jobKey = 0;
   int32_t frameNum = 0;
   int32_t newPriority = 0;
   int tmp = 0;
   fprintf(stderr,"Hello!\n");
   while(test == 1)
+   {
      fprintf(stderr, "Welcome to DistRen Alpha Interactive Test Mode\n\n");
      fprintf(stderr, "\t1 \tGet a frame to render\n");
      fprintf(stderr, "\t2 \tChange job priority\n");
      fprintf(stderr, "\t3 \tSet frame finished\n");
      fprintf(stderr, "\t4 \tSet frame started\n");
      fprintf(stderr, "\t5 \tStart listener\n");
      fprintf(stderr, "\t0 \tQuit\n");
      scanf("%d", &command);
      switch(command)
+     {
      case 1:
        fprintf(stderr,"Slave Key: ");
        scanf("%d", &slaveKey);
        fprintf(stderr, "Got frame: ");
        if(find_jobframe(geninfo->conn, slaveKey, &jobKey, &frameNum))
          fprintf(stderr,"No frames available to render!\n");
        else if(jobKey == -1)
          fprintf(stderr,"Slave %d has no render power!", slaveKey);
        else
          fprintf(stderr, "jobKey: %d, frameNum: %d\n",jobKey,frameNum);
        break;
      case 2:
        fprintf(stderr,"Job key: ");
        scanf("%d", &tmp);
        jobKey = tmp;
        fprintf(stderr,"New priority: ");
        scanf("%d", &tmp);
        newPriority = tmp;
        change_job_priority(geninfo->conn, jobKey, newPriority);
        fprintf(stderr,"Changed!");
        break;
      case 3:
        fprintf(stderr,"Slave Key: ");
        scanf("%d", &tmp);
        slaveKey = tmp;
        fprintf(stderr,"Job Key: ");
        scanf("%d", &tmp);
        jobKey = tmp;
        fprintf(stderr,"Frame Number: ");
        scanf("%d", &tmp);
        frameNum = tmp;
        finish_frame(geninfo->conn, slaveKey, jobKey, frameNum);
        fprintf(stderr,"Finished Frame!\n");
        break;
      case 4:
        fprintf(stderr,"Slave Key: ");
        scanf("%d", &tmp);
        slaveKey = tmp;
        fprintf(stderr,"Job Key: ");
        scanf("%d", &tmp);
        jobKey = tmp;
        fprintf(stderr,"Frame Number: ");
        scanf("%d", &tmp);
        frameNum = tmp;
        start_frame(geninfo->conn, slaveKey, jobKey, frameNum);
        fprintf(stderr,"Started Frame!\n");
        break;
      case 5:
        while(1)
+	 {
 	   multiio_poll(multiio, 15000);
 	   tabletennis_serve(geninfo->config->listens->tabletennis);
+	 }
        break;
      case 0:
        test = 0;
        break;
      default:
        fprintf(stderr, "Invalid input, please try again.\n");
        break;
+     }
+   }
   return 0;
+}

src/server/listen.c

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "common/config.h"
 #include "listen.h"
 #include "common/protocol.h"
 #include "common/remoteio.h"
 #include "common/request.h"
 #include <errno.h>
 #include <list.h>
 #include <netinet/in.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <sys/types.h>
 #include <poll.h>
 #include <sys/socket.h>
 #include <unistd.h>
 /* local */
 struct distrend_request_handler_info
+{
   enum distren_request_type request_type;
   distrend_handle_request_func_t handler;
 };
 struct distrend_client *distrend_client_new(struct distrend_listens *listens,
 					    enum distrend_client_state state,
 					    struct remoteio *rem);
 int distrend_client_free(struct distrend_client *client);
 int distrend_dispatch_request(struct distrend_listens *listens, struct remoteio *rem, struct distrend_client *client, struct distren_request *req, void *reqdata);
 struct distrend_polled_sock *distrend_polled_sock_get_by_offset(struct distrend_listens *listens, size_t pollfds_offset);
 static size_t distrend_listen_read_handle(struct remoteio *rem, struct distrend_listens *listens, void *buf, size_t len, struct distrend_client *client);
 static void distrend_listen_remoteio_handle_close(struct distrend_listens *listens, struct distrend_client *client);
 int listen_handle_accept(multiio_context_t multiio,
 			 int fd,
 			 short revent,
 			 struct distrend_listens *listens,
 			 int *port);
 int listen_handle_error(multiio_context_t multiio,
 			int fd,
 			short revent,
 			struct distrend_listens *listens,
 			int *port);
 /*** TO BE MOVED TO REMOTEIO */
 int listen_handle_existence(multiio_context_t multiio,
 			    int fd,
 			    short revent,
 			    struct distrend_listens *listens,
 			    struct distrend_client *client);
 struct distrend_listens *distrend_listens_new(multiio_context_t multiio,
 					      struct general_info *geninfo,
 					      struct options_common *opts)
+{
   struct distrend_listens *listens;
   listens = malloc(sizeof(struct distrend_listens));
   if(!listens)
     return NULL;
   listens->request_handlers = list_init();
   if(!listens->request_handlers)
+    {
       free(listens);
       return NULL;
+    }
   listens->options = opts;
   listens->geninfo = geninfo;
   /* multiio */
   listens->multiio = multiio;
   /* tabletennis */
   listens->tabletennis = tabletennis_new(listens, 32, 16);
   /* This type is used for accepting connections with accept() */
   multiio_socket_type_register(multiio, &listens->socket_type);
   multiio_event_handler_register(multiio,
 				 listens->socket_type,
 				 POLLERR | POLLHUP | POLLNVAL,
 				 (multiio_event_handler_func_t)&listen_handle_error,
 				 listens);
   multiio_event_handler_register(multiio,
 				 listens->socket_type,
 				 POLLIN,
 				 (multiio_event_handler_func_t)&listen_handle_accept,
 				 listens);
   return listens;
+}
 int distrend_listen_add(struct distrend_listens *listens, int port)
+{
   int tmp;
   int fd;
   int *saved_port;
   struct sockaddr_in6 sockaddr =
+    {
       .sin6_family = AF_INET6,
       .sin6_port = 0,
       .sin6_flowinfo = 0,
       .sin6_addr = IN6ADDR_ANY_INIT,
       .sin6_scope_id = 0
     };
   sockaddr.sin6_port = htons(port);
   fd = socket(AF_INET6, SOCK_STREAM, 0);
   tmp = bind(fd, (struct sockaddr *)&sockaddr, sizeof(sockaddr));
   if(tmp == -1)
+    {
       perror("bind");
       close(fd);
       return 1;
+    }
   tmp = listen(fd, 1);
   if(tmp == -1)
+    {
       perror("listen");
       close(fd);
       return 1;
+    }
   saved_port = malloc(sizeof(int));
   if(!saved_port)
+    {
       perror("malloc");
       close(fd);
       return 1;
+    }
   *saved_port = port;
   tmp = multiio_socket_add(listens->multiio, fd, listens->socket_type, saved_port, POLLIN);
   if(tmp)
+    {
       close(fd);
       return 1;
+    }
   /**
    * @todo perhaps we'll someday want the ability to unlisten()? :-p
    * Then we have to store the fd somewheres so that we can call
    * multiio_socket_del() on it. So far, however, that functionality
    * isn't needed.
    */
   return 0;
+}
 int listen_handle_error(multiio_context_t multiio,
 			int fd,
 			short revent,
 			struct distrend_listens *listens,
 			int *port)
+{
   fprintf(stderr, "Port %d experienced an error or is closed. Closing it.\n", *port);
   multiio_socket_del(listens->multiio, fd);
   close(fd);
   free(port);
   return 0;
+}
 /**
  * an important thing to handle
+ *
  * @deprecated to be replaced with table_tennis
  */
 int listen_handle_existence(multiio_context_t multiio,
 			    int fd,
 			    short revent,
 			    struct distrend_listens *listens,
 			    struct distrend_client *client)
+{
   /**
    * handle dead/closed sockets here!
    */
   fprintf(stderr, __FILE__ ":%d: handle dead/closed sockets here!\n", __LINE__);
   /**
    * Manage timing-out clients.
    */
   if(time(NULL) > client->cleanup_time)
     switch(client->state)
+      {
       case DISTREND_CLIENT_PREVERSION:
 	distrend_send_disconnect(client, "You have failed to present version information in a timely manner. Cya :-p");
 	break;
       case DISTREND_CLIENT_PREAUTH:
 	distrend_send_disconnect(client, "You have failed to present authentication information in a timely manner. Cya ;-)");
 	break;
       case DISTREND_CLIENT_GOOD:
 	/*
 	 * pings should be managed with two queues sharing this struct:
 	 *   struct pingpong_queue { struct distrend_client *client; time_t ping_time };
+	 *
 	 * - queue to_ping: contains queue of clients to send pings to
 	 *   with the client whose ping time is earliest at the front
+	 *
 	 * - queue to_be_ponged: contains a queue of clients to clean up
 	 *   if they haven't recieved pongs. client with earliest cleanup
 	 *   time is at the front. If a PONG packet is received in time, the
 	 *   cleanup_time is bumped but the queue is left alone. When the
 	 *   queue's element is encountered, cleanup_time is checked and then
 	 *   the client is readded to the to_ping queue.
+	 *
 	 * Each queue shall be eaten as time passes and continue forever
 	 * in circularity.
+	 *
 	 * data structures.
 	 * fun.
 	 * impossible to explain in text.
 	 * easy to think up.
 	 * impossible to determine the workings of existing ones.
 	 * and... when you need them, screenshot utilities just aren't available :-/.
 	 */
 	distrend_send_disconnect(client, "Ping timeout :-p");
 	break;
       case DISTREND_CLIENT_BAD:
 	fprintf(stderr, __FILE__ ":%d: aaarrrrgh!\n :-D\n", __LINE__);
 	break;
       default:
 	break;
+      }
   return 0;
+}
 struct distrend_accept_client_proc_data
+{
   struct distrend_listens *listens;
   time_t current_time;
 };
 /**
  * Handle new connections.
  */
 int listen_handle_accept(multiio_context_t multiio,
 			 int fd,
 			 short revent,
 			 struct distrend_listens *listens,
 			 int *port)
    //int distrend_accept(struct distrend_listens *listens)//, struct distrend_clientset *clients, distrend_handle_request_t handlereq, void *handlereqdata)
+ {
    struct distrend_client *newclient;
    int newclientsock;
    struct remoteio *rem;
    struct distren_request *req;
    void *data;
    newclientsock = accept(fd, (struct sockaddr *)NULL, (socklen_t *)NULL);
    /* used to call int distrend_client_add(struct distrend_listens *listens, int sock, DISTREND_CLIENT_PREVERSION)*/
    newclient = distrend_client_new(listens, DISTREND_CLIENT_PREVERSION, NULL);
    if(remoteio_open_socket(&rem, listens->options->remoteio, (remoteio_read_handle_func_t)&distrend_listen_read_handle, newclient, (remoteio_close_handle_func_t)&distrend_listen_remoteio_handle_close, newclientsock))
+     {
        fprintf(stderr, "error allocating/adding client struct\n");
        return 1;
+     }
    newclient->rem = rem;
    fprintf(stderr, "accepted new connection; fd=%d\n", newclientsock);
    /* tabletennis */
    tabletennis_add_client(listens->tabletennis, newclient);
    /**
     * For those using netcat/telnet to debug their internets.
     */
  #ifndef PACKAGE_URL
  #define PACKAGE_URL "http://ohnopub.net/distren/"
  #endif
  #define DISTREN_GREETING PACKAGE_STRING " " PACKAGE_URL " : Nathan Phillip Brink && Ethan Michael Zonca\n"
    /* using sizeof() - 1 because the sizeof() includes a NULL byte we want to ignore. */
    remoteio_write(newclient->rem, DISTREN_GREETING, sizeof(DISTREN_GREETING) - 1);
    /* send a DISTREN_REQUEST_VERSION immediately as per protocol */
    distren_request_version(&req, &data,
 			   DISTREN_SERVERTYPE_SUBMIT
 			   | DISTREN_SERVERTYPE_DISTRIBUTE
 			   | DISTREN_SERVERTYPE_RENDER,
 			   PACKAGE_STRING);
    distren_request_send(rem, req, data);
    distren_request_free_with_data(req, data);
    /*
    list_mvfront(listens->clients);
    newclient = list_curr(listens->clients);
    while(newclient)
+     {
        if(newclient->state == DISTREND_CLIENT_DEAD)
+	 {
 	   distrend_listen_poll_deletefd(listens, &newclient->sock);
 	   distrend_client_free(newclient);
 	   list_remove_curr(listens->clients);
 	   fprintf(stderr, "removed dead connection\n");
+	 }
        list_mvnext(listens->clients);
    *//* provide for termination of this loop *//*
        if(newclient == list_curr(listens->clients))
 	 newclient = NULL;
        else
 	 newclient = list_curr(listens->clients);
+     }
 					       */
    return 0;
+ }
  /**
   * Handle read events from remoteio, remoteio_read_handle_func_t.
+  *
   * This func requires that someone called remoteio_generic_data_set(remoteio_opts, listens);
+  *
   * @param client the client associated with this remoteio instance.
   */
 size_t distrend_listen_read_handle(struct remoteio *rem, struct distrend_listens *listens, void *buf, size_t len, struct distrend_client *client)
+ {
    struct distren_request *req;
    void *reqdata;
    size_t used_len;
    used_len = 0;
    /**
     * Manage input, etc.
     */
    if(client->expectlen == 0)
+     {
        /* search out header from input so far */
        if(len > sizeof(struct distren_request))
+	 {
 	   if(distren_request_new_fromdata(&req, buf, len))
+	     {
 	       fprintf(stderr, "Error handling data from client (magic likely did not match), closing connection\n");
 	       /*
 		* yes, this is safe and legal... because of hackishness
 		* in remoteio_close() ;-)
 		*/
 	      remoteio_close(rem);
 	      return 1;
+	    }
 	  client->expectlen = req->len + sizeof(struct distren_request);
 	  distren_request_free(req);
+	}
+    }
   if(client->expectlen
      && len >= client->expectlen)
+    {
       if(distren_request_new_fromdata(&req, buf, len))
+	{
 	  if(client->state == DISTREND_CLIENT_PREAUTH)
 	    remoteio_close(rem);
 	  else
 	    distrend_send_disconnect(client, "Protocol error.");
 	  return 1;
+	}
       /*
        * this really shouldn't happen... reparsing the same data with
        * distren_request_new_fromdata() a second time shouldn't yeild
        * a different req->len than it did before.
        */
       if(len - sizeof(struct distren_request) < req->len)
+	{
 	  fprintf(stderr, "Unexpected error handling some data from client\n");
 	  distren_request_free(req);
 	  /* but we should pay homage to W3C if the impossible happens */
 	  distrend_send_disconnect(client, "HTTP/1.1 503 Internal Server Error");
 	  return 1;
+	}
       reqdata = malloc(req->len);
       if(!reqdata)
+	{
 	  fprintf(stderr, "OOM\n");
 	  distren_request_free(req);
 	  return 1;
+	}
       memcpy(reqdata, ((void *)buf) + sizeof(struct distren_request), req->len);
       client->expectlen = 0;
       used_len = sizeof(struct distren_request) + req->len;
       distrend_dispatch_request(listens, rem, client, req, reqdata);
       free(reqdata);
       distren_request_free(req);
       /* I actually just used recursion in non-LISP code! :-D */
       return used_len + distrend_listen_read_handle(rem, listens, buf + req->len, len - req->len, client);
+    }
   return used_len;
+}
 /**
  * Handle cleaning up after remoteio_close() has been called. This includes cleaning up the struct distrend_client and stuffs
  */
 void distrend_listen_remoteio_handle_close(struct distrend_listens *listens, struct distrend_client *client)
+{
   /*
    * remoteio handles removing itself from multiio for us. We just
    * have to clean up tabletennis and the struct itself.
    */
   tabletennis_del_client(listens->tabletennis, client);
   free(client);
+}
 int distrend_listen_free(struct distrend_listens *listens)
+{
   tabletennis_free(listens->tabletennis);
   fprintf(stderr, "%s:%d: I am a stub that needn't be implemented 'til later\n", __FILE__, __LINE__);
   return 1;
+}
 /**
    This is probably just NOT a placeholder for remotio
 */
 void remotio_send_to_client(struct distrend_client *client, const char *msg, size_t len)
+{
     fprintf(stderr, "%s:%d: STUB I should queue data for writing to a client.... or should I? :-p\n", __FILE__, __LINE__);
+}
 /**
  * Allocates and initializes a struct distrend_client.
+ *
+ *
  */
 struct distrend_client *distrend_client_new(struct distrend_listens *listens, enum distrend_client_state state, struct remoteio *rem)
+{
   struct distrend_client *client;
   client = malloc(sizeof(struct distrend_client));
   if(!client)
+    {
       fprintf(stderr, "OOM\n");
       return NULL;
+    }
   client->state = state;
   client->cleanup_time = time(NULL) + DISTREND_LISTEN_AUTHTIME;
   client->inlen = 0;
   client->expectlen = 0;
   client->rem = rem;
   return client;
+}
 int distrend_client_write_request(struct distrend_client *client, const struct distren_request *req, const void *data)
+{
   char *towrite;
   int ret;
   size_t msglen;
   msglen = sizeof(struct distren_request) + req->len;
   towrite = malloc(msglen);
   if(!towrite)
+    {
       fprintf(stderr, "OOM\n");
       return 1;
+    }
   memcpy(towrite, req, sizeof(struct distren_request));
   memcpy(towrite + sizeof(struct distren_request), data, req->len);
   ret = remoteio_write(client->rem, towrite, msglen);
   free(towrite);
   return ret;
+}
 /*
 int distrend_client_read(struct distrend_client *client, char **toread, size_t *lenread)
+{
   struct distrend_packet *packet;
   *lenread = 0;
   *toread = NULL;
   if(q_empty(client->inmsgs))
     return 1;
   packet = q_dequeue(client->inmsgs);
   *lenread = packet->len;
   *toread = packet->data;
   free(packet);
   return 0;
+}
 */
 int distrend_send_disconnect(struct distrend_client *client, const char *quit_msg)
+{
   struct distren_request *req;
   distren_request_new(&req, strlen(quit_msg), DISTREN_REQUEST_DISCONNECT);
   distrend_client_write_request(client, req, quit_msg);
   distren_request_free(req);
   client->state = DISTREND_CLIENT_BAD;
   client->cleanup_time = time(NULL) + DISTREND_LISTEN_DISCONNECT_GRACE;
   return 0;
+}
 int distrend_listen_handler_add(struct distrend_listens *listens, enum distren_request_type type, distrend_handle_request_func_t handler)
+{
   struct distrend_request_handler_info *handler_info;
   handler_info = malloc(sizeof(struct distrend_request_handler_info));
   if(!handler_info)
     return 1;
   handler_info->request_type = type;
   handler_info->handler = handler;
   list_insert_after(listens->request_handlers, handler_info, 0);
   return 0;
+}
 struct distrend_dispatch_request_data
+{
   struct general_info *geninfo;
   struct distrend_client *client;
   struct distren_request *req;
   void *req_data;
 };
 /**
    traversal function for distrend_dispatch_request().
  */
 int _distrend_dispatch_request_trav(struct distrend_dispatch_request_data *data, struct distrend_request_handler_info *handler_info)
+{
   if(handler_info->request_type == data->req->type)
-    (*handler_info->handler)(data->geninfo, data->client, data->req->len, data->req_data);
     (*handler_info->handler)(data->geninfo, data->client, data->req, data->req_data);
   return TRUE;
+}
 /**
    helper for distrend_listen_read_handle() which looks up the correct
    request handler and handles handing the the request to the
    handler. :-p
 */
 int distrend_dispatch_request(struct distrend_listens *listens, struct remoteio *rem, struct distrend_client *client, struct distren_request *req, void *reqdata)
+{
   struct distrend_dispatch_request_data data;
   data.geninfo = listens->geninfo;
   data.client = client;
   data.req = req;
   data.req_data = reqdata;
   list_traverse(listens->request_handlers, &data, (list_traverse_func_t)&_distrend_dispatch_request_trav, LIST_FRNT | LIST_SAVE);
   return 0;
+}

src/server/listen.h

➞

Show inline comments

 /*
   Copyright 2010 Nathan Phillip Brink
   This file is a part of DistRen.
   DistRen is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
   DistRen is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
   You should have received a copy of the GNU Affero General Public License
   along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
 */
 /**
    @file listen provides the ability to set up a listening socket
    through multiio's poll() interface. This means that if the listen()-ish
    libc calls we use are incompatible with windows, we don't have to
    throw ifdefs all throughout src/common. We just put that code in the
    only place that needs it: in src/server.
  */
 struct general_info;
 struct distrend_listens;
 struct distrend_client;
 #ifndef _DISTREN_LISTEN_H
 #define _DISTREN_LISTEN_H
 #include "distrend.h"
 #include "tabletennis.h"
 #include "common/options.h"
 #include "common/multiio.h"
 #include "common/protocol.h"
 #include "common/remoteio.h"
 #include <queue.h>
 #include <time.h>
 /**
    How long a client has after connecting to send
    authentication information before his connection is cleaned
    up.
  */
 #define DISTREND_LISTEN_AUTHTIME 32
 /**
    How long a client has when in DISTREND_CLIENT_BAD before
    his connection is dropped. This grace time is intended so that
    the client will actually see his disconnect message instead of
    just having his connection reset.
  */
 #define DISTREND_LISTEN_DISCONNECT_GRACE 8
 enum distrend_client_state
+  {
     /**
        The client hasn't yet given us its version.
      */
     DISTREND_CLIENT_PREVERSION,
     /**
        We don't yet know the client. It may only use authentication
        commands.
      */
     DISTREND_CLIENT_PREAUTH,
     /**
        The client is authenticated, etc.
      */
     DISTREND_CLIENT_GOOD,
     /**
        The client is queued to be disconnected. (This state exists
        so that the client at least has a chance to recieve its
        disconnect message/error before being dumped).
      */
     DISTREND_CLIENT_BAD,
   };
 struct distrend_listens
+{
   /* of type (struct distrend_request_handler_info) */
   list_t request_handlers;
   /* the data to pass on to all request handlers */
   struct general_info *geninfo;
   /* the distrend config */
   struct options_common *options;
   tabletennis_t tabletennis;
   /* of type (struct distrend_client)  (multiio stores a pointer per socket, we'll store each strut distrend_client as that pointer instead of using this list) */
   /* list_t clients; */
   /* the multiio context the listening interface should use/initialize */
   multiio_context_t multiio;
   /*
    * the socket type reserved for us, i.e., the listen()/accept()
    * socket type whose events we handle.
   */
   multiio_socket_type_t socket_type;
 };
 /**
    The information necessary to recieve data from and send data
    to a client.
  */
 struct distrend_client
+{
   enum distrend_client_state state;
   /**
      The absolute time at which this client's entry in the client list will be
      expired, closed, and marked as dead so that it may be cleaned up. This is
      used to implement ping timeouts (if state == DISTREND_CLIENT_GOOD) and
      disconnect message grace time (if state == DISTREND_CLIENT_BAD).
    */
   time_t cleanup_time;
   size_t inlen; /*< number of bytes waiting to be processed */
   size_t expectlen; /*< number of bytes that inlen has to be for a complete request to be had, 0 when waiting on header */
   struct tabletennis_client tabletennis_client;
   /**
    * Yes, even though the remoteio will have a void *pointer to this
    * struct, we need a reverse pointer for something like
    * distrend_client_write() to work.
    */
   struct remoteio *rem;
 };
 /**
    A function signature that may be registered as a client
    request handler.
    @param client the client that sent the request
    @param len the length of the message in bytes
    @param data the message received from the client
    @param client the client that sent the request.
    @param req the distren request header.
    @param data the message received from the client.
  */
-typedef int(*distrend_handle_request_func_t)(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data);
+typedef int(*distrend_handle_request_func_t)(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data);
 /**
    Initializes the listens member of struct distrend_config.
    @param multiio the multiio context in which we should register a new socket type and insert records for clients who connect.
    @param geninfo general info to apss to the request handler.
    @return Must be free()d with distrend_listen_free();
 */
 struct distrend_listens *distrend_listens_new(multiio_context_t multiio, struct general_info *geninfo, struct options_common *opts);
 /**
    Adds a socket and configures it to listen().
    @param listens The handle for this set of listens, obtained via distrend_listen_init().
  */
 int distrend_listen_add(struct distrend_listens *listens, int port);
 /**
  * Register a request handler with the listener.
+ *
  * @param config distrend's configuration
  * @param type the request type for which this handler should be called
  * @param handler the handler to call when a request of type type is received.
  */
 int distrend_listen_handler_add(struct distrend_listens *listens, enum distren_request_type type, distrend_handle_request_func_t handler);
 /**
  * cleans listening sockets/frees main struct. Unnecessary for a working server, currently a stub.
  */
 int distrend_listen_free(struct distrend_listens *listens);
 /**
    writes request to client.
    @param client client to write to
    @param req the request struct. caller must free this.
    @param data the data of the request which is req->len bytes long. caller must free this.
  */
 int distrend_client_write_request(struct distrend_client *client, const struct distren_request *req, const void *data);
 /**
    This is probably just NOT a placeholder for remotio
 */
 void remotio_send_to_client();
 /**
  * Queue a DISTREN_REQUEST_DISCONNECT and prepare a client
  * to be disconnected.
  */
 int distrend_send_disconnect(struct distrend_client *client, const char *quit_msg);
 #endif

src/server/tabletennis.c

➞

Show inline comments

 /*
  * Copyright 2010 Nathan Phillip Brink
+ *
  * This file is a part of DistRen.
+ *
  * DistRen is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * DistRen is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with DistRen.  If not, see <http://www.gnu.org/licenses/>.
  */
 #include "common/config.h"
 #include "distrend.h"
 #include "listen.h"
 #include "tabletennis.h"
 #include "common/request.h"
 #include "common/protocol.h"
 #include <queue.h>
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 struct tabletennis
+{
   unsigned int ping_interval;
   unsigned int pong_time;
   /* of type (struct distrend_client *) */
   queue_t clients_to_ping;
   /* of type (struct distrend_client *) */
   queue_t clients_need_pong;
   struct timespec time_last_check;
 };
 static int tabletennis_pong_request_handle(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data);
 static int tabletennis_ping_request_handle(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data);
 static int tabletennis_pong_request_handle(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data);
 static int tabletennis_ping_request_handle(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data);
 tabletennis_t tabletennis_new(struct distrend_listens *listens, unsigned int ping_interval, unsigned int pong_time)
+{
   tabletennis_t tabletennis;
   tabletennis = malloc(sizeof(struct tabletennis));
   tabletennis->ping_interval = ping_interval;
   tabletennis->pong_time = pong_time;
   tabletennis->clients_to_ping = q_init();
   tabletennis->clients_need_pong = q_init();
   clock_gettime(CLOCK_MONOTONIC, &tabletennis->time_last_check);
   distrend_listen_handler_add(listens, DISTREN_REQUEST_PING, &tabletennis_ping_request_handle);
   distrend_listen_handler_add(listens, DISTREN_REQUEST_PONG, &tabletennis_pong_request_handle);
   return tabletennis;
+}
 int tabletennis_add_client(tabletennis_t tabletennis, struct distrend_client *client)
+{
   client->tabletennis_client.state = TABLETENNIS_NEED_PING;
   client->tabletennis_client.time_next_check = tabletennis->time_last_check.tv_sec
     + tabletennis->ping_interval;
   q_enqueue(tabletennis->clients_to_ping, client, 0);
   return 0;
+}
 int tabletennis_serve(tabletennis_t tabletennis)
+{
   struct timespec time_now;
   struct distrend_client *client;
   time_t time_next_check;
   struct distren_request *req;
   void *req_data;
   clock_gettime(CLOCK_MONOTONIC, &time_now);
   time_next_check = time_now.tv_sec + tabletennis->pong_time;
   for(client = q_front(tabletennis->clients_to_ping);
       client && client->tabletennis_client.time_next_check < time_now.tv_sec;
       client = q_front(tabletennis->clients_to_ping))
+    {
       q_dequeue(tabletennis->clients_to_ping);
       /* use time_next_check as the ping data */
       distren_request_poing(&req, &req_data, 1, &time_next_check, sizeof(time_next_check));
       distrend_client_write_request(client, req, req_data);
       distren_request_free_with_data(req, req_data);
       client->tabletennis_client.state = TABLETENNIS_NEED_PONG;
       client->tabletennis_client.time_next_check = time_next_check;
       q_enqueue(tabletennis->clients_need_pong, client, 0);
+    }
   time_next_check = time_now.tv_sec + tabletennis->ping_interval;
   for(client = q_front(tabletennis->clients_need_pong);
       client && client->tabletennis_client.time_next_check < time_now.tv_sec;
       client = q_front(tabletennis->clients_need_pong))
+    {
       q_dequeue(tabletennis->clients_need_pong);
       if(client->tabletennis_client.state == TABLETENNIS_NEED_PONG)
+	{
 	  distrend_send_disconnect(client, "You failed to respond to a PING packet after some seconds!");
 	  client->tabletennis_client.state = TABLETENNIS_DELINQUENT;
+	}
       else /* state must be TABLETENNIS_HAS_PONG */
+	{
 	  client->tabletennis_client.time_next_check = time_next_check;
 	  client->tabletennis_client.state = TABLETENNIS_NEED_PING;
 	  q_enqueue(tabletennis->clients_to_ping, client, 0);
+	}
+    }
   /* for tabletennis_add_client() */
   memcpy(&tabletennis->time_last_check, &time_now, sizeof(struct timespec));
   return 0;
+}
 /**
  * helper for tabletennis_del_client() which just looks for a
  * particular pointer in the queue (a.k.a., list).
  */
 static int tabletennis_del_client_traverse(void *trav_data, void *client)
+{
   if(trav_data == client)
     return FALSE;
   return TRUE;
+}
 int tabletennis_del_client(tabletennis_t tabletennis, struct distrend_client *client)
+{
   list_t thelist;
   thelist = NULL;
   switch(client->tabletennis_client.state)
+    {
     case TABLETENNIS_NEED_PING:
       thelist = tabletennis->clients_to_ping;
       break;
     case TABLETENNIS_NEED_PONG:
     case TABLETENNIS_HAS_PONG:
       thelist = tabletennis->clients_need_pong;
       break;
     case TABLETENNIS_DELINQUENT:
       thelist = NULL;
       break;
+    }
   if(!thelist)
     return 0;
   list_traverse(thelist, (void *)client, (list_traverse_func_t)&tabletennis_del_client_traverse,
 		LIST_FORW | LIST_FRNT | LIST_SAVE);
   if(list_curr(thelist) == client)
     list_remove_curr(thelist);
   return 0;
+}
 void tabletennis_free(tabletennis_t tabletennis)
+{
   q_free(tabletennis->clients_to_ping, LIST_NODEALLOC);
   q_free(tabletennis->clients_need_pong, LIST_NODEALLOC);
   free(tabletennis);
+}
 /* implementations of locals */
 /**
  * Handles a DISTREN_REQUEST_PING from a client.
+ *
  * @todo throttling?
  */
-static int tabletennis_ping_request_handle(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data)
+static int tabletennis_ping_request_handle(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data)
+{
   struct distren_request *pong_req;
-  if(req_len > 32)
+  if(req->len > 32)
     distrend_send_disconnect(client, "You have tried to send a PING packet with a length longer than 32 bytes.");
   /**
       respond to the client using the data he sent in his PONG
       command.
    */
-  distren_request_new(&pong_req, req_len, DISTREN_REQUEST_PONG);
+  distren_request_new(&pong_req, req->len, DISTREN_REQUEST_PONG);
   distrend_client_write_request(client, pong_req, req_data);
   distren_request_free(pong_req);
   return 0;
+}
-static int tabletennis_pong_request_handle(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data)
+static int tabletennis_pong_request_handle(struct general_info *geninfo, struct distrend_client *client, struct distren_request *req, void *req_data)
+{
   fprintf(stderr, "got pong\n");
   /*
    * The only place that sends PINGs from distrend is
    * tabletennis_serve() and it uses
    * client->tabletennis_client.time_next_check as the cookie.
    */
   if(client->tabletennis_client.state == TABLETENNIS_NEED_PONG
-     && req_len == sizeof(client->tabletennis_client.time_next_check)
+     && req->len == sizeof(client->tabletennis_client.time_next_check)
      && !memcmp(req_data, &client->tabletennis_client.time_next_check, sizeof(client->tabletennis_client.time_next_check)))
+    {
       /* valid match */
       client->tabletennis_client.state = TABLETENNIS_HAS_PONG;
       return 0;
+    }
   /* no match or invalid state */
   distrend_send_disconnect(client, "You tried to send a PONG packet without first receiving a PING packet.");
   return 0;
+}

0 comments (0 inline, 0 general)