/* 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 . */ /* 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 "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 #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* ******************* 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_ping(struct general_info *geninfo, struct distrend_client *client, size_t req_len, 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); distrend_listen_handler_add(general_info.config->listens, DISTREN_REQUEST_PING, &distrend_handle_ping); int slaveKey = 0; // Remotio should set me on a per-slave basis /* Main Loop */ general_info.config->die = 0; while(!general_info.config->die) { int clientrequest = 0; /*< temporary example variable, will be replaced when we can handle messages */ multiio_poll(multiio); /* distrend_accept(general_info.config->listens); */ /* Run the watchdog, @TODO: like every 10 mins or something */ frame_watchdog(general_info.conn); struct frameset frame; struct distrenjob *job; distrenjob_new(&job); memset(&frame, '\0', sizeof(frame)); /** If client requests work */ if(clientrequest == DISTREN_REQUEST_GETWORK) { int returnnum = find_jobframe(general_info.conn, slaveKey, &job->jobnum, &frame.num); // Finds a frame to render @FIXME: Slavenum :D if(returnnum); /* No work on server */ else remotio_send_to_client(frame.num, job->jobnum); // Pseudo-sends data to client } /* If the client states that they finished the frame */ else if(clientrequest == DISTREN_REQUEST_DONEFRAME) { clientstatus = CLIENTSTATUS_IDLE; // Sets the client back to idle finish_frame(general_info.conn, 0, job->jobnum, frame.num); // @TODO: Make sure this actually works. } distrenjob_free(&job); } 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) { char *tmp_str; char fixedbuf[32]; struct distren_request *newreq; if(client->state != DISTREND_CLIENT_PREVERSION) { distrend_send_disconnect(client, "You have already sent the VERSION command."); } if(strlen(PACKAGE_STRING) == req_len && !strncmp(PACKAGE_STRING, req_data, req_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. */ 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. */ 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); distrend_send_disconnect(client, tmp_str); } return 0; } int distrend_handle_ping(struct general_info *geninfo, struct distrend_client *client, size_t req_len, void *req_data) { struct distren_request *pong_req; 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); distrend_client_write_request(client, pong_req, req_data); distren_request_free(pong_req); 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); } break; case 0: test = 0; break; default: fprintf(stderr, "Invalid input, please try again.\n"); break; } } return 0; }