DistRen Changeset - 45bf3be8fb93 · protofusion repositories

Changeset - 45bf3be8fb93

Parent rev.

Child rev.

[Not reviewed]

default

0 3 1

Nathan Brink (binki) - 16 years ago 2009-08-16 19:52:36
ohnobinki@ohnopublishing.net

initial XML parsing for distrenjob

4 files changed with 200 insertions and 7 deletions:

src/server/Makefile.am

src/server/blendjob.h

src/server/distrend.c

src/server/distrenjob.c

151

0 comments (0 inline, 0 general)

src/server/Makefile.am

➞

Show inline comments

 COMMON_SOURCES =  slavefuncs.c slavefuncs.h blendjob.h
+COMMON_SOURCES =  slavefuncs.c slavefuncs.h distrenjob.c blendjob.h
 bin_PROGRAMS = distrend distrenslave
 distrend_SOURCES = distrend.c ${COMMON_SOURCES}
 distrend_LDADD = @DISTLIBS_LIBS@ @top_builddir@/src/common/libdistrencommon.la
 distrend_CFLAGS = @DISTLIBS_CFLAGS@ -I@top_srcdir@/src/common
 distrenslave_SOURCES = slave.c ${COMMON_SOURCES}
 distrenslave_LDADD = @DISTLIBS_LIBS@ @top_builddir@/src/common/libdistrencommon.la
 distrenslave_CFLAGS = @DISTLIBS_CFLAGS@ -I@top_srcdir@/src/common

src/server/blendjob.h

➞

Show inline comments

 /*
   Copyright 2009 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/>.
 */
 #ifndef _DISTREN_BLENDJOB_H
 #define _DISTREN_BLENDJOB_H
 /**
    This file stores the blendjob and frameset structs and prototypes for some functions to manipulate/use these.
  */
 #include <time.h> /* clock_t */
+#include <time.h> /* clock_t, time_t */
 typedef unsigned int jobnum_t;
 /**
    Stores Blender Job Info
 */
 struct blendjob {
   struct blendjob *next; /*< next will be NULL unless if there is another blendjob */
   char *name;
   char *submitter;
   char *email;
+  char *email; /*< This should be looked up based on the value of submitter, not stored in this struct */
   jobnum_t jobnum;
   int priority;  // 1 is lowest, 10 is highest, 0 means the job is done
-  int percent_done;
+  float percent_done;
   int completed_frames; // number of completed frames for stats/etc
   int assigned_frames; // number of assigned frames (that are not yet completed) for stats/etc
   int total_frames; // how many frames are in the animation for stats/etc (unassigned frames)
   int avg_render_time; // average seconds it took to render a frame
   unsigned int time_remaining; // estimated seconds remaining till render is complete (up to 49, 710 days)
 							   // we can have the client computer convert it into days, hours, etc if they wish to view it
   time_t avg_render_time; // average seconds it took to render a frame
   time_t time_remaining; /*< estimated seconds remaining till render is complete (up to 49, 710 days) */
   struct frameset *frameset;
 };
 /**
    Frameset Structure
 */
 struct frameset {
   int num; /*< frame number to render */
   char slave_name; /*< user that frame is assigned to */
   int status; /*< status of frame, 0= unassigned, 1= taken, 2= done */
   clock_t start_time; /*< time the frame was started */
   int time_to_render; /*< the total seconds it took to render the frame */
 }; /* Frameset array is generated by status_report_generator() */
 /*
 related functions
 */
 /**
    @param distrenjob the address where we will store the pointer of a malloc()ed
    distrenjob struct.
    @param pathtoxml filename/pathname of the xml file to be read into a blendjob struct
  */
 int xml2distrenjob(struct blendjob **distrenjob, char *pathtoxml);
 /**
    support function for xml2distrenjob() to help cleaning up a
    struct blendjob when it is incompletely initialized.
    Also acts as a general-purpose struct distrenjob free()er ;-)
  */
 void distrenjob_free(struct blendjob **distrenjob);
 /**
    initializes an empty, pointless struct distrenjob. This
    DOES run malloc() for you. It could return nonzero on error,
    but there are no errors to have yet (except for nomem). This
    sets all char* to NULL.
  */
 int distrenjob_new(struct blendjob **distrenjob);
 #endif

src/server/distrend.c

➞

Show inline comments

 /*
   Copyright 2009 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. */
  /* Just some notes -- Ethan Zonca
  * ++ Make data availible for other apps to parse
  * Server<==>Client Communication
  * Upload while rendering
  */
 /* XML notes --
+ *
  * First off, is XML in our build environment?
  * Next, what files are we going to have?:
  *  - XML file sent with (.blend/.pov/.lux(xml)/whatever) by distren telling the server what to do
  *  	+ Includes submitter name, filename, emailaddress, etc
  *  - XML file on server storing info on current and finished jobs
  *  - XML file sent by distren when submitting a render to the server
+ *
  *  Overall, we could use XML to make our client/server communication load
  *  a lot lighter, especially if clients are sent customized xml files telling
  *  them what frame(s) to render... although that would be inefficient if rendering
  *  single frames. Maybe not tell it what frames to render in the xml file, the server
  *  can spit out that info.
+ *
  *  Please edit my ramblings if you please,
  *  --ethanzonca
+ *
  */
 #include "execio.h"
 #include "options.h"
 #include "blendjob.h"
 #include "protocol.h"
 #include "slavefuncs.h"
 #include <confuse.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <malloc.h>
 #include <unistd.h> /* getopt */
 #include <time.h>
 /* ******************* Structs ************************ */
 // Stores config info? editmycomment
 struct distrend_config
+{
   cfg_t *mycfg;
   struct options_common *options;
   struct distrend_listen **listens; /*< Null terminated array of structs */
   char *datadir;
 };
 /*
  frame[frame] Status Assignments:
   "NULL" - don't render me
   "0" - canceled
   "1" - unassigned
   "2" - assigned to slave
   "3" - completed by slave and uploaded
  Have a script crawl through each job in the arrays, priority-biased, and assign a frame to each slave.
  Then we will need some sort of watchdog to monitor slaves on the main server to check for stales. Maybe not worry about this for now.
 */
 struct general_info {
   short int jobs_in_queue; //
   unsigned short int free_clients;
   unsigned short int rendering_clients;//
   unsigned short int total_finished_jobs; //
   unsigned int total_frames_rendered; //
 } general_info;
 /*
   internally defined funcs's prototypes
 */
 void status_report_generator(struct blendjob **blendjobs_head);
 void blendjob_remove(struct blendjob **head, struct blendjob *bj);
 struct blendjob *blendjob_get(struct blendjob *head, jobnum_t jobnum);
 /* Global Vars, try to cut down on these */
 jobnum_t jobnum = 0; // The next job number to create in the queue
 int hcfjob; // Highest consecutively finished job
 int highest_jobnum; // The job number of the most recently created job, this is used when creating new jobs
 /* ********************** Functions ************************* */
 /* Functions to stubify */
 /**
    Performs command stored in a client's request.
 */
 int distrend_do()
+{
   return 0;
+}
 /**
    Accepts a client's connection
  */
 void distrend_accept()
+{
+}
 /**
    Frees the action
 */
 void distrend_action_free()
+{
+}
 /**
    Start listening
 */
 void distrend_listen()
+{
+}
 /**
    Stop listening
 */
@@ @@ -395,187 +396,202 @@ void blend_frame_watchdog(struct blendjo @@
   watchdog_forgiveness = 3; /*< hours of forgiveness before frame is re-assigned */
   blendjob_ptr = blendjob_head;
   for(blendjob_ptr = blendjob_head; blendjob_ptr; blendjob_ptr = blendjob_ptr->next)
     /* iterate through jobs */
     for(counter = 0; counter < blendjob_ptr->total_frames; counter ++)
       /* iterate through all frames for this job*/
+      {
         if((blendjob_ptr->frameset[counter].start_time + (watchdog_forgiveness * 3600)) < clock())
           /*
             If frame is not completed within the number of hours specified by watchdog_forgiveness
             Then change the frame status to unassigned
            */
           blendjob_ptr->frameset[counter].status = 0;
+      }
+}
 /**
    Finds a blendjob struct based on the jobnum
    @arg jobnum job number to search for
    @return NULL on job doesn't exist
  */
 struct blendjob *blendjob_get(struct blendjob *head, jobnum_t jobnum)
+{
   struct blendjob *blendjob_ptr;
   /*
     The conditions of the for loop will leave blendjob_ptr at NULL if the end of the list is reached. It will leave it pointing to the correct job if it is found.
    */
   for(blendjob_ptr = head;
       blendjob_ptr
         && blendjob_ptr->jobnum != jobnum;
       blendjob_ptr = blendjob_ptr->next);
   return blendjob_ptr;
+}
 /**
    Removes a blendjob from the blendjob linkelist.
    @arg head a double pointer. the head pointer will have to be changed if blendjob == *head. Thus, make sure that the pointer points to the pointer to the head that all functions use. (I'm going to come back to this and misunderstand myself ;-))
  */
 void blendjob_remove(struct blendjob **head, struct blendjob *bj)
+{
   struct blendjob *previous_blendjob;
   if(bj == *head)
     *head = bj->next;
   else
+    {
       for(previous_blendjob = *head;
         previous_blendjob
           && previous_blendjob->next != bj; /*< stop on the blendjob that comes before bj */
           previous_blendjob = previous_blendjob->next)
 	/* all of the action is in the definition of the for loop itself */;
       /*
 	This removes references to bj from the linked list. I.E., we now skip bj when iterating through the list
        */
       previous_blendjob->next = bj->next;
+    }
   /*
      @lordofwar: the magic deallocation of memory ;-)
    */
   free(bj);
+}
 /* ************************** Main ************************* */
 // Begin non-working framework?
 int distrend_do_config(int argc, char *argv[], struct distrend_config **config)
+{
   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_END()
     };
   struct blendjob *distrenjob;
   int tmp;
   xmlinit();
   /*
    * test xml2distrenjob()
    */
   tmp = xml2distrenjob(&distrenjob, "distrenjob.xml.example");
   if(tmp)
     fprintf(stderr, "xml2distrenjob() returned %d. Try to cd to distren/doc if you want to test out the xml2distrenjob() function. (This will only fix this error if the error is due to an inability of the xml library to access distrenjob.xml.example)\n", tmp);
   else
     fprintf(stderr, "using email ``%s'' for user ``%s'' -- reading in XML files and pulling data from them using libxml2+XPath works!!!\n", distrenjob->email, distrenjob->submitter);
   fprintf(stderr, "%s:%d running config\n", __FILE__, __LINE__);
   *config = malloc(sizeof(struct distrend_config));
   myopts[1].simple_value = &(*config)->datadir;
   options_init(argc, argv, &(*config)->mycfg, myopts, "server", &(*config)->options);
   fprintf(stderr, "using %s as datadir\n", (*config)->datadir);
   xmlcleanup();
   return 0;
+}
 int distrend_config_free(struct distrend_config *config)
+{
   options_free(config->options);
   free(config);
   return 0;
+}
 // End non-working framework?
 int main(int argc, char *argv[])
+{
   /* @TODO: Put some arg-grabbing code here */
   struct blendjob *head;
   int cont;
   struct distrend_listenset *listenset;
   struct distrend_config *config;
   start_data(); // Starts fresh or loads data from xml dump
   enum clientstatus
+  {
     CLIENTSTATUS_UNINITIALIZED = 0,
     CLIENTSTATUS_BUSY = 1,
     CLIENTSTATUS_IDLE = 2
   } clientstatus;
   head = NULL;
   cont = 1;
   distrend_do_config(argc, argv, &config);
   distrend_listen(&listenset, config);
   /* This is called the ``main loop'' */
   while(cont)
+    {
       struct distren_action *action;
       int clientsays; /*< temporary example variable, will be replaced when we can handle messages */
       distrend_accept(&action);
       cont = distrend_do(action);
       /* Make the following code more event-driven */
       status_report_generator(&head);
       blend_frame_watchdog(head);
       struct frameset *frame;
       struct blendjob *job;
       /* If the client is idle, must be modified for climbing through linked list of clients (client->clientnum) */
       if(clientstatus == CLIENTSTATUS_IDLE)
+	{
 	  int returnnum = frame_finder(head, &job, &frame); // Finds a frame to render
 	  if(returnnum)
+	    {
 	      fprintf(stderr,"No frames are available to render at this time. Idling...\n");
 	      sleep(10);
+	    }
 	  else
 	    /* returnnum == 0 */
 	    remotio_send_to_client(frame->num, job->jobnum); // Pseudo-sends data to client
+	}
       /* If the client states that they finished the frame */
       	if(clientsays == DISTREN_REQUEST_DONEFRAME){
       	  clientstatus = CLIENTSTATUS_IDLE; // Sets the client back to idle
       	  finish_frame(head, frame->num); // @TODO: Check that finish_frame really gets the jobnum somehow
+      	}
       distrend_action_free(action);
+    }
   distrend_unlisten(listenset);
   distrend_config_free(config);
   return 0;
+}

src/server/distrenjob.c

➞

Show inline comments

@@ new file 100644 @@
 /*
   Copyright 2009 Nathan Phillip Brink <ohnobinki@ohnopublishing.net>
   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 "blendjob.h"
 #include "slavefuncs.h"
 #include "asprintf.h"
 #include <libxml/tree.h>
 #include <libxml/parser.h>
 void distrenjob_free(struct blendjob **distrenjob)
+{
   struct blendjob *dj;
   dj = *distrenjob;
   xmlFree(dj->name);
   xmlFree(dj->submitter);
   xmlFree(dj->email);
   free(dj);
   *distrenjob = NULL;
+}
 int distrenjob_new(struct blendjob **distrenjob)
+{
   struct blendjob *dj;
   dj = malloc(sizeof(struct blendjob));
   if(!dj)
+    {
       /* try to catch code that doesn't respect return values
        faster: */
       *distrenjob = NULL;
       return 1;
+    }
   *distrenjob = dj;
   dj->next = NULL;
   dj->name = (char *)NULL;
   dj->submitter = (char *)NULL;
   dj->email = (char *)NULL;
   dj->jobnum = 0; /*< @todo there should be a central jobnum allocator and a way to save the maximum jobnumber allocated */
   dj->priority = 0;
   dj->percent_done = 0;
   dj->completed_frames = 0;
   dj->assigned_frames = 0;
   dj->avg_render_time = 0;
   dj->time_remaining = (unsigned int)-1;
   dj->frameset = (struct frameset *)NULL; /*< @todo does frameset need to be initialized here? */
   return 0;
+}
 /**
    writes struct from xml
 */
 int xml2distrenjob(struct blendjob **distrenjob, char *pathtoxml)
+{
   struct blendjob *dj;
   xmlDocPtr xmldoc;
   xmlNodePtr xmlnode;
   xmlChar *xmlchar;
   xmlXPathContextPtr xmlxpathcontext;
   int tmp;
   if(distrenjob_new(distrenjob))
     return 1;
   dj = *distrenjob;
   xmldoc = xmlReadFile(pathtoxml, NULL, XML_PARSE_PEDANTIC);
   if(!xmldoc)
+    {
       /**
 	 @todo are we able to depend on libxml2's printed errors or
 	 channel them into syslog output (eventually)? Currently,
 	 this error is repetitious of a libxml2 error printed on stderr
 	 for us.
        */
       fprintf(stderr, "error reading XML file ``%s''\n", pathtoxml);
       distrenjob_free(distrenjob);
       return 2;
+    }
   xmlxpathcontext = xmlXPathNewContext(xmldoc);
   xmlnode = xml_quickxpath(xmlxpathcontext, (xmlChar *)"/distren/job");
   if(!xmlnode)
+    {
       distrenjob_free(distrenjob);
       return 3;
+    }
   /*< @todo should we use xmlChar everywhere too? */
   dj->name = (char *)xmlGetProp(xmlnode, (xmlChar *)"name");
   if(!dj->name)
+    {
       distrenjob_free(distrenjob);
       return 4;
+    }
   /*< @todo validation needs to be done on usernames. e.g., currently, they shouldn't contain the '"' char  */
   dj->submitter = (char *)xmlGetProp(xmlnode, (xmlChar *)"submitter");
   if(!dj->submitter)
+    {
       distrenjob_free(distrenjob);
       return 5;
+    }
   tmp = _distren_asprintf((char **)&xmlchar, "/distren/submitters/submitter[attribute::name=\"%s\"]", dj->submitter);
   if(tmp <= 0
      || !xmlchar)
+    {
       fprintf(stderr, "error using _distren_asprintf\n");
       distrenjob_free(distrenjob);
       return 6;
+    }
   xmlnode = xml_quickxpath(xmlxpathcontext, xmlchar);
   free(xmlchar);
   dj->email = (char *)xmlGetProp(xmlnode, (xmlChar *)"email");
   if(!dj->email)
+    {
       fprintf(stderr, "error getting email for user ``%s'' from ``%s''\n",
 	      dj->submitter, pathtoxml);
       distrenjob_free(distrenjob);
       return 7;
+    }
   xmlXPathFreeContext(xmlxpathcontext);
   xmlFreeDoc(xmldoc);
   return 0;
+}

0 comments (0 inline, 0 general)