COMMON_SOURCES =  slavefuncs.c slavefuncs.h distrenjob.c distrenjob.h

bin_PROGRAMS = distrend distrenslave

distrend_LDADD = @DISTLIBS_LIBS@ @top_builddir@/src/common/libdistrencommon.la @LIST_LIBS@

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

/*

  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. */

/*

  To get getline():

 */

#define _GNU_SOURCE 1

#include "execio.h"

#include "options.h"

#include "distrenjob.h"

#include "protocol.h"

#include "slavefuncs.h"

#include "asprintf.h"

#include <confuse.h>

#include <stdio.h>

#include <stdlib.h>

#include <malloc.h>

#include <unistd.h>

#include <time.h>

#include <sys/stat.h>

#include <string.h>

#include <libxml/xmlmemory.h>

#include <libxml/parser.h>

#include <libxml/tree.h>

#include <libxml/encoding.h>

#include <libxml/xmlwriter.h>

#include <libxml/xmlreader.h>

/* ******************* Structs ************************ */

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; //

  unsigned int highest_jobnum;

  short int hibernate;

  unsigned int timestamp;

  unsigned long int total_render_power;

  unsigned long int total_priority_pieces;

} general_info;

/*

  internally defined funcs's prototypes @TODO: Make all functions nice and proper */

void distrenjob_remove(struct distrenjob *head, struct distrenjob *bj);

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

void distrenjob_enqueue(struct distrenjob *head, struct distrenjob *job);

void mortition(struct distrenjob *head, struct distrenjob *job);

int makeJobDataXML(struct distrenjob *job);

int updateJobListXML(struct distrenjob *head);

int createQueueFromXML(struct distrenjob *head);

int reCreateQueueFromXML(struct distrenjob *head, xmlDocPtr doc, xmlNodePtr current);

void updateGeneralInfo();

void importGeneralInfo();

int updateJobStatsXML(struct distrenjob *job);

/* Global Vars, eliminate 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 ************************* */

/** Dumps all data in RAM to an xml file (such as current jobs, etc) which is parsed by start_data. Remember to invoke this before shutting down! */

int xml_dump()

{

  return 0;

}

/**

   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()

{

}

/** Fill variables after crash / shutdown from XML dumps */

int start_data(struct distrenjob *head, char *datadir)

{

  struct stat buffer;

  if(stat("general_info.xml", &buffer) == 0){

    importGeneralInfo();

    fprintf(stderr,"Parsing XML files and restoring previous state...\n");

    createQueueFromXML(head);

    return 1;

  }

  else{

    fprintf(stderr,"Couldn't find XML dump, starting up fresh.\n");

    general_info.total_finished_jobs = 0;

    general_info.total_frames_rendered = 0;

    general_info.free_clients = 0;

    general_info.highest_jobnum = 0;

    general_info.jobs_in_queue = 0;

    general_info.rendering_clients = 0;

    general_info.hibernate = 0;

    general_info.timestamp = 0;

    // Create the stor directory

    // char *stor;

    // _distren_asprintf(&stor, "%s/stor", datadir);

    // mkdir(stor);

    return 2;

  }

}

/** Finish-Setter: Sets a frame to the "completed" status.*/

void finish_frame(struct distrenjob *head, struct distrenjob *distrenjob, int frame)

{

  distrenjob->frameset[frame].status = FRAMESETSTATUS_DONE;

  distrenjob->total_render_time = distrenjob->total_render_time + (clock() - distrenjob[jobnum].frameset[frame].start_time);

  distrenjob->completed_frames++;

  distrenjob->assigned_frames--;

  general_info.total_frames_rendered++; // Increase total frames var for stats

  updateGeneralInfo();

  updateJobStatsXML(distrenjob);

}

/** "mortition" check to see if a job is actually done by scanning the folder of the job to make sure all frames are present*/

void mortition(struct distrenjob *head, struct distrenjob *job)

{

  short int isJobDone;

  int counter;

  char *path_and_number;

  struct stat buffer;

  isJobDone = 1; // set isJobDone to true

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

    {

      _distren_asprintf(&path_and_number, "stor/job%d/out/%d.%s", job->jobnum, job->frameset[counter].num, job->output_format);

      if(stat(path_and_number, &buffer) == -1)

        {

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

          job->completed_frames--;

          general_info.total_frames_rendered--;

          isJobDone = 0; // if a missing frame is found, set isJobDone to false

        }

    }

  if(isJobDone) // if all frames were accounted for

    {

      distrenjob_remove(head, job);

      distrenjob_free(&job);

      general_info.jobs_in_queue--;

      updateJobListXML(head);

    }

  else{

    job->prev_frame_index = -1; // if the job isn't done, have frame_finder() start from the first frame, allowing it to see the frames that are now unassigned

  }

  updateGeneralInfo();

}

/** scans the frames of a job to initialize a job after server */

/* returns 1 if the job is completely done and there are no missing frames */

/* returns 0 if a missing frame is found */

int restoreJobState(struct distrenjob *job)

{

  short int isJobDone;

  int counter;

  char *path_and_number;

  struct stat buffer;

  isJobDone = 1;

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

    {

      _distren_asprintf(&path_and_number, "stor/job%d/out/%d.%s", job->jobnum, job->frameset[counter].num, job->output_format);

      if(stat(path_and_number, &buffer) == 0)

        {

          job->frameset[counter].status = FRAMESETSTATUS_ASSIGNED;

          job->completed_frames++;

        }

      else

        isJobDone = 0;

    }

  return isJobDone;

}

/** creates a structure from starting data, then calls another function to actually add that struct to the queue */

int prepare_distrenjob(struct distrenjob *head, int type, char *name, char *submitter, char *email, int priority, int start_frame, int end_frame, int width, int height)

{

  int counter2;

  int counter;

  int tmp;

  char *path_with_num;

  struct distrenjob *distrenjob;

  tmp = distrenjob_new(&distrenjob);

  if(tmp)

    return 1;

  general_info.highest_jobnum++;

  distrenjob->jobnum = general_info.highest_jobnum;

  distrenjob->type = 1;

  distrenjob->name = name;

  distrenjob->submitter = submitter;

  distrenjob->email = email;

  distrenjob->priority = priority;

  distrenjob->width = width;

  distrenjob->height = height;

  distrenjob->total_frames = (end_frame - start_frame + 1); /* sets the total number of frames in animation for status purposes */

  distrenjob->frameset = malloc(sizeof(struct frameset) * distrenjob->total_frames);

  if(!distrenjob->frameset)

    {

      distrenjob_free(&distrenjob);

      return 1;

    }

  /* prepares all the frames by setting that status to "unassigned" */

  counter2 = start_frame;

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

    distrenjob->frameset[counter].num = counter2;

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

    counter2++;

  }

  _distren_asprintf(&path_with_num, "stor/job%d/out/", distrenjob->jobnum);

  fprintf(stderr, "creating dir '%s'", path_with_num);

  /* add job to queue */

  fprintf(stderr, "\nprepare_distrenjob: attempting makeJobDataXML()\n");

  makeJobDataXML(distrenjob);

  fprintf(stderr, "\nprepare_distrenjob: attempting distrenjob_enqueue()\n");

  distrenjob_enqueue(head, distrenjob);

  general_info.jobs_in_queue++;

  fprintf(stderr, "\nprepare_distrenjob: attempting updateJobListXML()\n");

  updateJobListXML(head);

  fprintf(stderr, "\nprepare_distrenjob: attempting updateGeneralInfo()\n");

  updateGeneralInfo();

  fprintf(stderr, "\nprepare_distrenjob: attempting updateJobStatsXML()\n");

  updateJobStatsXML(distrenjob);

  return 0;

}

/** distrenjob_enqueue: This function adds the job to the queue based on its priority */

void distrenjob_enqueue(struct distrenjob *head, struct distrenjob *job)

{

  struct distrenjob *prev_job = head; // create pointer to previous job

  struct distrenjob *current_job;     // create pointer to current_job (which job is being compared to)

  // iterate through linked list of jobs

  for(current_job = head->next; 1; current_job = current_job->next)

  {

	fprintf(stderr, "enqueue loop iteration\n");

    if(current_job == NULL){ // if it has reached the end of the list, add job there

      prev_job->next = job;

      fprintf(stderr, "adding job at end of queue\n");

      break;

    }

    else if(job->priority < current_job->priority){ // if job's priority is less than current_job's priority, insert job

      prev_job->next = job;                        // keep in mind 1 is the highest priority given to jobs, head has a

      job->next = current_job;                     // priority of zero so it will always be before other jobs

      fprintf(stderr, "adding job before jobname: %s\n", current_job->name);

      break;

    }

    prev_job = current_job;

  } /* for(current_job) */

}

  _distren_asprintf(&tmp, "%d", general_info.timestamp);

  xmlTextWriterWriteAttribute(writer, (xmlChar*)"timestamp", (xmlChar*)tmp);

  general_info.total_priority_pieces = 0;

  counter = 0;

  for(job = head->next; job; job = job->next)

    {

      _distren_asprintf(&tmp, "jobnum%d", counter);

      _distren_asprintf(&tmp2, "%d", job->jobnum);

      xmlTextWriterWriteElement(writer, (xmlChar*)tmp, (xmlChar*)tmp2);

      // this is needed for the new frame finder to work

      general_info.total_priority_pieces = general_info.total_priority_pieces + (11 - job->priority);

      counter++;

    }

  // close elements and end document

  xmlTextWriterEndDocument(writer);

  // free writer and save xml file to disk

  xmlFreeTextWriter(writer);

  return 1;

}

// returns 1 if completed successfully, 0 if not

// this reads a list of jobs in the queue before DistRen was shut down

// and then adds the jobs to the queue, as if it were never shut down

int createQueueFromXML(struct distrenjob *head)

{

  xmlDocPtr doc;  // holds xml document in memory

  xmlNodePtr cur; // points to the current xml element node

  // load xml document

  doc = xmlParseFile("job_list.xml");

  if(doc == NULL)

    {

      fprintf(stderr, "createQueueFromXML: document not found\n");

      return 0;

    }

  // have cur point to the root element of the xml document pointed to by doc

  cur = xmlDocGetRootElement(doc);

  if(cur == NULL)

    {

      fprintf(stderr, "createQueueFromXML: document empty\n");

      return 0;

    }

  if(xmlStrcmp(cur->name, (const xmlChar*)"job_list"))

    {

      fprintf(stderr, "createQueueFromXML: incorrect root element (%s)", (char*)cur->name);

    }

  // moves into the children elements of job_list

  cur = cur->xmlChildrenNode;

  reCreateQueueFromXML(head, doc, cur);

  /* scans the list of all jobs that were in queue before DistRen shutdown

  while(cur != NULL)

    {

      tmp = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);

      fprintf(stderr, "adding job: %s", tmp);

      // add job from job number @TODO create function with parameters (struct distrenjob *head, int job_number)

      // LordOfWar calls dibs on above todo

      xmlFree(tmp);

      cur = cur->next; // go to next child element of job_list element

    }*/

  xmlFreeDoc(doc);

  return 1;

}

// inserts jobs at front of queue, starting with the last job in the job_list xml file

// to preserve the order of the queue

int reCreateQueueFromXML(struct distrenjob *head, xmlDocPtr doc, xmlNodePtr current)

{

  struct distrenjob *holder; // holds the job that "was" after head, so that the new struct can be inserted after head

  struct distrenjob *job; // job to be added

  xmlChar *tmp;

  int job_num;

  if(current == NULL) // base case, if element doesn't exist then don't do anything

    return 0;

  // recursively call itself so that the next job in the queue is added to the front before the current one

  reCreateQueueFromXML(head, doc, current->next);

  // now actual work is done, adding the job to the front of the queue

  holder = head->next; // initialize holder

  tmp = xmlNodeListGetString(doc, current->xmlChildrenNode, 1); // get job number

  job_num = atoi((char*)tmp);

  job = createJobFromXML(job_num);

  xmlFree(tmp); // free xml char (that holds the job number)

  // insert job at front of the queue

  head->next = job;

  job->next = holder;

  return 1;

}

/* ************************** Test Functions ************************* */

int printFrameInfo(struct frameset *frame)

{

  char *status;

  status = NULL;

  switch(frame->status)

  {

    case FRAMESETSTATUS_UNASSIGNED:

      _distren_asprintf(&status, "%s", "unassigned");

      break;

    case FRAMESETSTATUS_ASSIGNED:

      _distren_asprintf(&status, "%s", "assigned");

      break;

    case FRAMESETSTATUS_DONE:

      _distren_asprintf(&status, "%s", "completed");

      break;

    case FRAMESETSTATUS_CANCELED:

      _distren_asprintf(&status, "%s", "canceled");

  }

  printf("frame #: %d --> %s\n", frame->num, status);

  return 1;

}

int printJob(struct distrenjob *job)

{

  int counter;

  fprintf(stderr, "frame_num: status\n");

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

    {

      printFrameInfo(&job->frameset[counter]);

    }

  return 1;

}

int printJobInfo(struct distrenjob *job)

{

  fprintf(stderr, "type: %d\n", job->type);

  fprintf(stderr, "name: %s\n", job->email);

  fprintf(stderr, "submitter: %s\n", job->submitter);

  fprintf(stderr, "e-mail: %s\n", job->email);

  fprintf(stderr, "priority: %d\n", job->priority);

  fprintf(stderr, "completed: %d\n", job->completed_frames);

  fprintf(stderr, "assigned: %d\n", job->assigned_frames);

  fprintf(stderr, "total: %d\n", job->total_frames);

  fprintf(stderr, "watchdog: %d\n", job->watchdog_forgiveness);

  fprintf(stderr, "hibernate: %d\n", job->hibernate);

  fprintf(stderr, "prev_frame: %d\n", job->prev_frame_index);

  fprintf(stderr, "render power: %ld\n", job->assigned_render_power);

  return 1;

}

int printAllJobnums(struct distrenjob *head)

{

  struct distrenjob *current_job;

  int total_jobs;

  fprintf(stderr, "job numbers in the order they will be processed:\n");

  total_jobs = 0;

  for(current_job = head->next; current_job; current_job = current_job->next)

    {

      fprintf(stderr, "%d: %s\n", current_job->jobnum, current_job->name);

      total_jobs++;

    }

  fprintf(stderr, "\n%d jobs in queue\n\n", total_jobs);

  return 1;

}

/* ************************** Main ************************* */

int main(int argc, char *argv[])

{

  /* Argument-parser */

  int counter;

  int test; // Interactive test mode if 1

  struct distrenjob head;

  int cont;

  struct distrend_config *config;

  enum clientstatus

  {

    CLIENTSTATUS_UNINITIALIZED = 0,

    CLIENTSTATUS_BUSY = 1,

    CLIENTSTATUS_IDLE = 2

  } clientstatus;

  // initialize general_info struct, this should be done by start_data()

  general_info.jobs_in_queue = 0;

  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;

  general_info.timestamp = 0;

  general_info.total_render_power = 0;

  general_info.total_priority_pieces = 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));

  distrend_do_config(argc, argv, &config);

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

  // pre-loaded jobs for testing

  prepare_distrenjob(&head, 1, "awesome", "LordOfWar", "onlylordofwar@gmail.com", 8, 1, 100, 640, 480);

  prepare_distrenjob(&head, 1, "hamburger", "Ohnobinki", "ohnobinki@ohnopublishing.net", 3, 1, 50, 1280, 720);

  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 \tPrint general info\n");

    fprintf(stderr, "\t8 \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:

      general_info.total_render_power++;

      if(!find_jobframe_again(&head, -1, 1, &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);

      fprintf(stderr, "\nHeight: ");                   scanf("%d", &height);

      prepare_distrenjob(&head, type, name, submitter, email, priority, start_frame, end_frame, width, height);

      break;

    case 5:

      fprintf(stderr, "\nJob number: ");

      scanf("%d", &jobnum);

      distrenjob_remove(&head, distrenjob_get(&head, jobnum));

      break;

    case 6:

      printAllJobnums(&head);

      break;

    case 7:

      fprintf(stderr, "\nHighest job number: %d", general_info.highest_jobnum);

      fprintf(stderr, "\nJobs in queue: %d", general_info.jobs_in_queue);

      fprintf(stderr, "\nTotal frames rendered: %d", general_info.total_frames_rendered);

      fprintf(stderr, "\nTimestamp: %d", general_info.timestamp);

      fprintf(stderr, "\nTotal priority pieces: %ld", general_info.total_priority_pieces);

      fprintf(stderr, "\nTotal render power: %ld\n", general_info.total_render_power);

      break;

    case 8:

      fprintf(stderr,"Goodbye.\n");

      return 0;

    default:

      fprintf(stderr, "Invalid input, please try again.\n");

    }

  }

  /* This is called the "main loop" */

  while(cont)

    {

      struct distren_action *action;

      int clientsays = 0; /*< 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 */

      frame_watchdog(&head);

      struct frameset *frame;

      struct distrenjob *job;

      /* If the client is idle, must be modified for climbing through linked list of clients (client->clientnum) */

      if(clientstatus == CLIENTSTATUS_IDLE)

	{

	  int returnnum = find_jobframe(&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

	    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, job, frame->num); // @TODO: Make sure this actually works.

      	}

      distrend_action_free(action);

    }

  distrend_config_free(config);

  xmlcleanup();

  return 0;

}