Installation Instructions

*************************

Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,

   This file is free documentation; the Free Software Foundation gives

unlimited permission to copy, distribute and modify it.

Basic Installation

==================

   Briefly, the shell commands `./configure; make; make install' should

configure, build, and install this package.  The following

more-detailed instructions are generic; see the `README' file for

instructions specific to this package.

   The `configure' shell script attempts to guess correct values for

various system-dependent variables used during compilation.  It uses

those values to create a `Makefile' in each directory of the package.

It may also create one or more `.h' files containing system-dependent

definitions.  Finally, it creates a shell script `config.status' that

you can run in the future to recreate the current configuration, and a

file `config.log' containing compiler output (useful mainly for

debugging `configure').

   It can also use an optional file (typically called `config.cache'

and enabled with `--cache-file=config.cache' or simply `-C') that saves

the results of its tests to speed up reconfiguring.  Caching is

disabled by default to prevent problems with accidental use of stale

cache files.

   If you need to do unusual things to compile the package, please try

to figure out how `configure' could check whether to do them, and mail

diffs or instructions to the address given in the `README' so they can

be considered for the next release.  If you are using the cache, and at

some point `config.cache' contains results you don't want to keep, you

may remove or edit it.

   The file `configure.ac' (or `configure.in') is used to create

`configure' by a program called `autoconf'.  You need `configure.ac' if

you want to change it or regenerate `configure' using a newer version

of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type

     `./configure' to configure the package for your system.

     Running `configure' might take a while.  While running, it prints

     some messages telling which features it is checking for.

  2. Type `make' to compile the package.

may have to build one architecture at a time and combine the results

using the `lipo' tool if you have problems.

Installation Names

==================

   By default, `make install' installs the package's commands under

`/usr/local/bin', include files under `/usr/local/include', etc.  You

can specify an installation prefix other than `/usr/local' by giving

`configure' the option `--prefix=PREFIX'.

   You can specify separate installation prefixes for

architecture-specific files and architecture-independent files.  If you

pass the option `--exec-prefix=PREFIX' to `configure', the package uses

PREFIX as the prefix for installing programs and libraries.

Documentation and other data files still use the regular prefix.

   In addition, if you use an unusual directory layout you can give

options like `--bindir=DIR' to specify different values for particular

kinds of files.  Run `configure --help' for a list of the directories

you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed

with an extra prefix or suffix on their names by giving `configure' the

option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features

=================

   Some packages pay attention to `--enable-FEATURE' options to

`configure', where FEATURE indicates an optional part of the package.

They may also pay attention to `--with-PACKAGE' options, where PACKAGE

is something like `gnu-as' or `x' (for the X Window System).  The

`README' should mention any `--enable-' and `--with-' options that the

package recognizes.

   For packages that use the X Window System, `configure' can usually

find the X include and library files automatically, but if it doesn't,

you can use the `configure' options `--x-includes=DIR' and

`--x-libraries=DIR' to specify their locations.

Particular systems

==================

   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU

CC is not installed, it is recommended to use the following options in

order to use an ANSI C compiler:

and if that doesn't work, install pre-built binaries of GCC for HP-UX.

   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot

parse its `<wchar.h>' header file.  The option `-nodtk' can be used as

a workaround.  If GNU CC is not installed, it is therefore recommended

to try

     ./configure CC="cc"

and if that doesn't work, try

     ./configure CC="cc -nodtk"

Specifying the System Type

==========================

   There may be some features `configure' cannot figure out

automatically, but needs to determine by the type of machine the package

will run on.  Usually, assuming the package is built to be run on the

_same_ architectures, `configure' can figure that out, but if it prints

a message saying it cannot guess the machine type, give it the

`--build=TYPE' option.  TYPE can either be a short name for the system

type, such as `sun4', or a canonical name which has the form:

     CPU-COMPANY-SYSTEM

where SYSTEM can have one of these forms:

   See the file `config.sub' for the possible values of each field.  If

`config.sub' isn't included in this package, then this package doesn't

need to know the machine type.

   If you are _building_ compiler tools for cross-compiling, you should

use the option `--target=TYPE' to select the type of system they will

produce code for.

   If you want to _use_ a cross compiler, that generates code for a

platform different from the build platform, you should specify the

"host" platform (i.e., that on which the generated programs will

eventually be run) with `--host=TYPE'.

Sharing Defaults

================

   If you want to set default values for `configure' scripts to share,

you can create a site shell script called `config.site' that gives

default values for variables like `CC', `cache_file', and `prefix'.

`configure' looks for `PREFIX/share/config.site' if it exists, then

`PREFIX/etc/config.site' if it exists.  Or, you can set the

`CONFIG_SITE' environment variable to the location of the site script.

A warning: not all `configure' scripts look for a site script.

Defining Variables

==================

   Variables not defined in a site shell script can be set in the

environment passed to `configure'.  However, some packages may run

configure again during the build, and the customized values of these

variables may be lost.  In order to avoid this problem, you should set

them in the `configure' command line, using `VAR=value'.  For example:

     ./configure CC=/usr/local2/bin/gcc

causes the specified `gcc' to be used as the C compiler (unless it is

overridden in the site shell script).

Unfortunately, this technique does not work for `CONFIG_SHELL' due to

an Autoconf bug.  Until the bug is fixed you can use this workaround:

     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash

`configure' Invocation

======================

   `configure' recognizes the following options to control how it

      }

      prev_job = current_job;

    }

  }

  updateJobListXML(head);

  makeJobDataXML(job); // because priority is changed

}

/**

  Frame Finder: matches your computer up with a lovely frame to render, starts looking at oldest job first

  @TODO: We must return both jobnum and framenum

  @TODO: Add calls in main()

  @return 0 success, other: error

*/

int find_jobframe(struct distrenjob *head, struct distrenjob **job, struct frameset **frame)

{

  if(general_info.hibernate)

    return 1;

  unsigned int frame_counter;

  short int your_job_type;

  unsigned short int found;

  struct distrenjob *distrenjob_ptr;

  your_job_type = 0;

  found = 0;

  /* iterate through jobs from first to last */

  for(distrenjob_ptr = head->next; (!found && distrenjob_ptr) && !distrenjob_ptr->hibernate; distrenjob_ptr = distrenjob_ptr->next)

    for(frame_counter = (distrenjob_ptr->prev_frame_index + 1); !found && frame_counter < distrenjob_ptr->total_frames; frame_counter ++)

      if(distrenjob_ptr->frameset[frame_counter].status == FRAMESETSTATUS_UNASSIGNED) // jobframe found

	{

	  found = 1;

	  your_job_type = distrenjob_ptr->type;

	  distrenjob_ptr->frameset[frame_counter].status = FRAMESETSTATUS_ASSIGNED;

	  distrenjob_ptr->frameset[frame_counter].start_time = clock();

	  distrenjob_ptr->assigned_frames++;

	  distrenjob_ptr->prev_frame_index = frame_counter;

	  updateJobStatsXML(distrenjob_ptr);

	}

  if(!found)

    {

      fprintf(stderr, "No more jobs to render\n");

      sleep(1); /*< @todo eliminate the need for this line*/

      return 1;

    }

  *job = distrenjob_ptr;

  *frame = &distrenjob_ptr->frameset[frame_counter];

  return 0;

}

/** Checks for dead, latent, or stale slaves */

void frame_watchdog(struct distrenjob *distrenjob_head)

{

  struct distrenjob *distrenjob_ptr;

  unsigned int counter;

  for(distrenjob_ptr = distrenjob_head->next; distrenjob_ptr; distrenjob_ptr = distrenjob_ptr->next)

  /* iterate through jobs */

  {

    /* if the job has been started, checks by seeing if either to first or second frame has been started */

    if(distrenjob_ptr->frameset[0].status != FRAMESETSTATUS_UNASSIGNED || distrenjob_ptr->frameset[1].status != FRAMESETSTATUS_UNASSIGNED)

      /* iterate through all frames for this job: */

      for(counter = 0; counter < distrenjob_ptr->total_frames; counter ++)

	    /*watchdog_forgiveness = seconds of forgiveness before frame is re-assigned: */

        if((distrenjob_ptr->frameset[counter].start_time + distrenjob_ptr->watchdog_forgiveness) < clock())

        {

            /*

            If frame is not completed within the number of seconds specified by watchdog_forgiveness

            Then change the frame status to unassigned

            */

            distrenjob_ptr->frameset[counter].status = FRAMESETSTATUS_UNASSIGNED;

            distrenjob_ptr->assigned_frames--;

        }

    updateJobStatsXML(distrenjob_ptr);

  }

}

/**

   Finds a distrenjob struct based on the jobnum

   @arg jobnum job number to search for

   @return NULL on job doesn't exist

 */

struct distrenjob *distrenjob_get(struct distrenjob *head, jobnum_t jobnum)

{

  struct distrenjob *distrenjob_ptr;

  /*

    The conditions of the for loop will leave distrenjob_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(distrenjob_ptr = head;

      distrenjob_ptr

  general_info.free_clients = 0;

  general_info.rendering_clients = 0;

  general_info.total_finished_jobs = 0;

  general_info.total_frames_rendered = 0;

  general_info.highest_jobnum = 0;

  general_info.hibernate = 0;

  int command;

  jobnum_t jobnum;

  struct distrenjob *tmp_job;

  struct frameset *tmp_frame;

  int type;

  char *name;

  char *submitter;

  char *email;

  int priority;

  int width;

  int height;

  int start_frame;

  int end_frame;

  size_t read_buf;

  head.priority = 0; // make head have the highest priority

  xmlinit();

  test = 0;

  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;

	}

    }

  cont = 1;

  memset(&head, '\0', sizeof(struct distrenjob));

  //start_data(&head); // Starts fresh or loads data from xml dump. Should we grab the return?

  distrend_do_config(argc, argv, &config);

  while(test == 1)

  {

    fprintf(stderr, "Welcome to DistRen Alpha Interactive Test Mode\n\n");

    fprintf(stderr, "\t1 \tPrint all frames in a job\n");

    fprintf(stderr, "\t2 \tExamine certain job\n");

    fprintf(stderr, "\t3 \tGet a frame to render\n");

    fprintf(stderr, "\t4 \tAdd a job\n");

    fprintf(stderr, "\t5 \tDelete a job\n");

    fprintf(stderr, "\t6 \tPrint jobnums in queue\n");

    fprintf(stderr, "\t7 \tQuit\n");

    scanf("%d", &command);

    switch(command)

    {

    case 1:

      fprintf(stderr, "Job number: ");

      scanf("%d", &jobnum);

      printJob(distrenjob_get(&head, jobnum));

      break;

    case 2:

      fprintf(stderr, "Job number: ");

      scanf("%d", &jobnum);

      printJobInfo(distrenjob_get(&head, jobnum));

      break;

    case 3:

      if(find_jobframe(&head, &tmp_job, &tmp_frame))

      {

    	  fprintf(stderr, "frame was found, details below\n");

          fprintf(stderr, "Job#:%d\n", tmp_job->jobnum);

          fprintf(stderr, "Frame#:%d\n", tmp_frame->num);

      }

      break;

    case 4:

      name = NULL;

      submitter = NULL;

      email = NULL;

      fprintf(stderr, "\nType: \n\t 1 \t blender\n\t 2 \t povray\n"); scanf("%d", &type);

      fprintf(stderr, "\nName: ");        scanf("\n"); getline(&name, &read_buf, stdin);

      fprintf(stderr, "\nSubmitter: ");                getline(&submitter, &read_buf, stdin);

      fprintf(stderr, "\nEmail: ");                    getline(&email, &read_buf, stdin);

      fprintf(stderr, "\nPriority: ");                 scanf("%d", &priority);

      fprintf(stderr, "\nStart frame: ");              scanf("%d", &start_frame);

      fprintf(stderr, "\nEnd frame: ");                scanf("%d", &end_frame);

      fprintf(stderr, "\nWidth: ");                    scanf("%d", &width);

#include "distrenjob.h"

#include "slavefuncs.h"

#include "asprintf.h"

#include <libxml/tree.h>

#include <libxml/parser.h>

void distrenjob_free(struct distrenjob **distrenjob)

{

  struct distrenjob *dj;

  dj = *distrenjob;

  xmlFree(dj->name);

  xmlFree(dj->submitter);

  xmlFree(dj->email);

  free(dj->frameset);

  free(dj);

  *distrenjob = NULL;

}

int distrenjob_new(struct distrenjob **distrenjob)

{

  struct distrenjob *dj;

  dj = malloc(sizeof(struct distrenjob));

  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->width = 0;

  dj->height = 0;

  dj->completed_frames = 0;

  dj->assigned_frames = 0;

  dj->total_render_time = 0;

  dj->hibernate = 0;

  dj->watchdog_forgiveness = 3600; // initialize watchdog forgiveness at 1 hour

  dj->frameset = (struct frameset *)NULL; /*< @todo does frameset need to be initialized here? */

  return 0;

}

/**

   writes struct from xml

*/

int xml2distrenjob(struct distrenjob **distrenjob, char *pathtoxml)

{

  struct distrenjob *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;

    }