+/**
+ * @file main.c
+ * @author Sam Moore (20503628) - 2012
+ * @purpose Contains main function, argument handling
+ * NOTE: This file is identical for both the single-threaded and multi-threaded versions of the program
+ */
#include <stdlib.h>
#include <stdio.h>
+#include <time.h>
+#include <signal.h>
#include "nbody.h"
#include "graphics.h"
-unsigned numberOfProcessors;
+// --- Variable definitions --- //
+System universe; // global variable declared in "nbody.h" - The universe of bodies
+Options options; // global variable declared in "nbody.h" - Options passed to program through arguments
-System universe;
-// This is main function. Do not change it.
+// --- Function forward declarations --- //
+void HandleArguments(int argc, char ** argv); //Interprets program arguments and sets up the "options" variable
+void UnsignedArgument(unsigned * i, int argc, char ** argv, unsigned * store); //Helper function to get switch value for unsigned
+void FloatArgument(unsigned * i, int argc, char ** argv, float * store); //Helper function to get switch value for float
+void DisplayStatistics(); //Called on exit of program, displays information about computation time, steps computed, etc
+void Interrupt(int dummy); // Interrupt handler function, called when SIGINT (Ctrl-C) is sent to program
+
+// --- Function implementations --- //
+
+/**
+ * @function main
+ * @purpose The main function. Calls HandleArguments to set up options,
+ * sets up functions to call at exit, starts simulation and graphics loops
+ * @param argc - Number of arguments
+ * @param argv - The argument strings
+ */
int main(int argc, char** argv)
{
- glutInit(&argc, argv);
+ //Set default options values here
+ options.program = argv[0];
+ options.input = NULL;
+ options.output = NULL;
+ options.num_threads = 0;
+ options.num_steps = 0;
+ options.timeout = 0;
+ options.draw_graphics = true;
+ options.print_positions = false;
+ options.verbosity = 0;
- if (argc < 2)
+ //If there are no arguments, print information about usage
+ if (argc == 1)
{
- printf("Please provide the filename, i.e. \'%s bodiesfield.dat\'\n", argv[0]);
+ printf("Usage: %s [OPTIONS] field\n", argv[0]);
+ printf("Controls:\n X - exit\n I, J, K, M - rotate\n W, Z, A, S - move to view"
+ " point\n ./, - zoom in/out\n +/- - scaled zoom in/out\n");
exit(EXIT_SUCCESS);
}
- if (argc == 2)
+
+ //Parse the arguments
+ HandleArguments(argc, argv);
+
+ //Check there is an initial field.
+ if (options.input == NULL)
{
- System_Init(&universe,argv[1]);
- atexit(Universe_Cleanup);
+ fprintf(stderr, "Usage: %s [OPTIONS] field\n", argv[0]);
+ fprintf(stderr, " (You did not provide a file for the initial field of bodies)\n");
+ exit(EXIT_FAILURE);
}
- if (argc == 3)
+
+ signal(SIGINT, Interrupt); //Handle SIGINT signals
+ atexit(Universe_Cleanup); //On exit, cleanup universe (and write positions of bodies to file if supplied).
+ atexit(DisplayStatistics); //On exit, print information about the computations done
+ System_Init(&universe,options.input); //Initialise the universe from the initial field
+
+ //Setup the time of day at which the simulation starts
+ if (gettimeofday(&(options.start_time), NULL) != 0)
{
- numberOfProcessors = atoi(argv[2]);
+ perror("Couldn't get time of day");
+ exit(EXIT_FAILURE);
}
+
+ options.start_clock = clock(); //Get CPU cycles executed before simulation starts
+ Simulation_Run(); // Start the simulation
+ Graphics_Run(argc, argv); //Start the graphics loop
+ exit(EXIT_FAILURE); //Should never get to this line
+}
+
+
+/**
+ * @function HandleArguments
+ * @purpose Fill the "options" variable by parsing command line arguments
+ * @param argc - Number of arguments
+ * @param argv - Argument strings
+ */
+void HandleArguments(int argc, char ** argv)
+{
+ for (unsigned i = 1; i < argc; ++i) //For all arguments
+ {
+ if (argv[i][0] != '-') //If the argument is not a switch value...
+ {
+ //Interpret first non switch as input file, and second as output file.
+ //If there are too many non switch arguments, give an error.
+ if (options.input == NULL)
+ options.input = argv[i];
+ else if (options.output == NULL)
+ options.output = argv[i];
+ else
+ {
+ fprintf(stderr,"Usage: %s [OPTIONS] field [output]\n", argv[0]);
+ fprintf(stderr," (You provided too many file names)\n");
+ exit(EXIT_FAILURE);
+ }
+ continue;
+ }
+ switch (argv[i][1]) //The argument is a switch if we get here
+ {
+ case 'n': //Number of threads switch
+ UnsignedArgument(&i, argc, argv, &(options.num_threads));
+ #ifdef SINGLE_THREADED
+ fprintf(stderr, "Warning: -%c switch has no effect in the single-threaded program.\n", argv[i][1]);
+ options.num_threads = 1;
+ #endif //SINGLE_THREADED
+ break;
+ case 's': //Number of steps switch
+ UnsignedArgument(&i, argc, argv, &(options.num_steps));
+ break;
+ case 't': //Timeout switch (in seconds)
+ UnsignedArgument(&i, argc, argv, &(options.timeout));
+ break;
+ case 'g': //Graphics switch
+ options.draw_graphics = !options.draw_graphics;
+ break;
+ case 'v': //Verbosity switch
+ UnsignedArgument(&i, argc, argv, &(options.verbosity));
+ break;
+
+ default:
+ fprintf(stderr, "Unrecognised switch -%c\n", argv[i][1]);
+ exit(EXIT_FAILURE);
+ break;
+ }
+
+ }
+}
+/**
+ * @function UnsignedArgument
+ * @purpose Helper function to get an unsigned integer following a argument switch
+ * @param i - position in the argument array, will be updated after this function
+ * @param argc - number of arguments
+ * @param argv - argument strings
+ * @param store - pointer to unsigned to store result in
+ */
+void UnsignedArgument(unsigned * i, int argc, char ** argv, unsigned * store)
+{
+ if (*i >= argc-1)
+ {
+ fprintf(stderr,"Supply a positive integer for the -%c switch.\n", argv[*i][1]);
+ exit(EXIT_FAILURE);
+ }
+ int val = atoi(argv[*i+1]);
+ if (val <= 0)
+ {
+ fprintf(stderr,"Supply a positive integer for the -%c switch. %s is invalid.\n", argv[*i][1], argv[*i+1]);
+ exit(EXIT_FAILURE);
+ }
+ *store = val;
+ *i += 1;
+}
+/**
+ * @function FloatArgument
+ * @purpose Helper function to get a float following a argument switch
+ * @param i - position in the argument array, will be updated after this function
+ * @param argc - number of arguments
+ * @param argv - argument strings
+ * @param store - pointer to float to store result in
+ */
+void FloatArgument(unsigned * i, int argc, char ** argv, float * store)
+{
+ if (*i >= argc-1)
+ {
+ fprintf(stderr,"Supply a float for the -%c switch.\n", argv[*i][1]);
+ exit(EXIT_FAILURE);
+ }
+ *store = atof(argv[*i+1]);
+ if (*store == 0.0 && argv[*i+1][0] != '0')
+ {
+ fprintf(stderr,"Supply a float for the -%c switch.\n", argv[*i][1]);
+ exit(EXIT_FAILURE);
+ }
+ *i += 1;
+}
- glutInitDisplayMode(GLUT_SINGLE | GLUT_RGB);
- glutInitWindowSize(WIDTH, HEIGHT);
- glutInitWindowPosition(POSITION_X, POSITION_Y);
- glutCreateWindow("N-Body : Single Threaded");
- glutDisplayFunc(Graphics_Display);
- glutIdleFunc(Graphics_Animate);
- glutKeyboardFunc(Graphics_Keyboard);
- glutReshapeFunc(Graphics_Reshape);
- Graphics_Init();
- printf("Use:\n X - exit\n I, J, K, M - rotate\n W, Z, A, S - move to view"
- " point\n ./, - zoom in/out\n +/- - scaled zoom in/out\n");
+/**
+ * @function Interrupt
+ * @purpose Handle SIGINT signal; quit the program gracefully, so that statistics are still displayed
+ * @param dummy - a dummy
+ */
- glutMainLoop();
-
+void Interrupt(int dummy)
+{
+ QuitProgram(false);
}
+
git.ucc.asn.au / matches / honours.git / blobdiff
UCC git Repository :: git.ucc.asn.au