CSC UNIX System, Spring 2015

Transcription

1 ` CSC UNIX System, Spring 2015 Assignment 2, due by 11:59 on Friday March 6 via gmake turnitin. Dr. Dale E. Parson, The directory, source-file and makefile contents of this project are isomorphic with the runcat2 handout at that we are going over in class. Isomorphic means that they have identical overall form or structure. The individual C source files and makefiles in each project differ with respect to what they accomplish, but the number, location and overall interaction of the makefile-driven buildand-test machinery with the source code is essentially identical in runcat2 and this assignment project. Below is the runcat2 diagram from the above-linked page. test1.ref test2.ref diff test1.out test1.ref > test1.dif test1.dif test2.dif diff test2.out test2.ref > test2.dif test1.out test2.out runcat2 gcc -c -g -I./include runcat2.c -o runcat2.o gcc runcat2.o -L./lib -l runcat2 -o runcat2 runcat2.c runcat2.o include/runcatlib.h lib/libruncat2.a runcatlib/run1cmd.c runcatlib/run1cmd.o /usr/ccs/bin/ar -rv../lib/libruncat2.a run1cmd.o gcc -c -g -I../include run1cmd.c -o run1cmd.o CSC 352, Assignment 2, due March 6, page 1 of 12, Spring 2015

2 I recommend downloading your project ZIP file, unzipping it in your unix directory, looking through it, and then replacing directory and file names in the above diagram with the directory and file names for your project. Make a map of your project. You might also download and unzip the project runcat2.zip to serve as a template. You can find runcat2 in ~parson/unix/runcat2.zip. This project has all of the C source code but is missing the makefiles and reference files for building and testing: cd ~/unix cp ~parson/unix/factor2.problem.zip factor2.problem.zip unzip factor2.problem.zip cd factor2 find. -type f -print./makelib./factorlib/factor.c./include/factorlib.h./testfactor.c Files include/factorlib.h, factorlib/factor.c and testfactor.c define a function for factoring int values into primes and reporting results or error message. Your job is to write two makefiles, one in directory factor2 and the other in subdirectory factor2/factorlib. You can pattern them after the two makefiles in runcat2. Here is what GNU make shows when I run it in my solution to this problem. [:-) ~/.../solution/factor2] gmake clean /bin/rm -f *.o *.class core *.exe *.obj *.pyc /bin/rm -f *.o factor2 *.dif *.out cd./factorlib && make clean /bin/rm -f *.o *.class core *.exe *.obj *.pyc /bin/rm -f *.o../lib/libfactor2.a *.dif *.out [:-) ~/.../solution/factor2] gmake cd./factorlib && make build gcc -c -g -I../include factor.c -o factor.o ar -rv../lib/libfactor2.a factor.o ar: creating../lib/libfactor2.a a - factor.o make factor2 make[1]: Entering directory `/home/kutztown/parson/private/csc352/solution/factor2' gcc -c -g -I./include testfactor.c -o testfactor.o gcc testfactor.o -L./lib -l factor2 -o factor2 make[1]: Leaving directory `/home/kutztown/parson/private/csc352/solution/factor2' [:-) ~/.../solution/factor2] gmake test cd./factorlib && make build make[1]: Nothing to be done for `build'. make factor2 make[1]: Entering directory `/home/kutztown/parson/private/csc352/solution/factor2' make[1]: `factor2' is up to date. make[1]: Leaving directory `/home/kutztown/parson/private/csc352/solution/factor2' /bin/rm -f *.dif CSC 352, Assignment 2, due March 6, page 2 of 12, Spring 2015

3 cd./factorlib && make test make[1]: Nothing to be done for `test'../factor > test1.out 2>&1./factor > test2.out 2>&1./factor > test3.out 2>test3.err.out make: [test] Error 1 (ignored)./factor2 2 oops > test4.out 2> test4.err.out make: [test] Error 1 (ignored) diff test1.out test1.ref > test1.dif diff test2.out test2.ref > test2.dif diff test3.out test3.ref > test3.dif diff test3.err.out test3.err.ref > test3.err.dif diff test4.out test4.ref > test4.dif diff test4.err.out test4.err.ref > test4.err.dif Notice that my makefiles have four test cases. The first two have no data errors, while the last two do. Factoring the values -31, 0, and 1 for primes is undefined, as is the string oops in the last test run. In those cases my C code exits with an exit status of 1, indicating an error. Normally, when a program exits with a non-0 exit code (indicating an error), you want the makefile to stop and report the error. That is what happens by default. However, sometimes you want to run a program with data errors to ensure that the program handles the errors correctly and terminates with a non-0 exit status. That is the case in the last two lines above. In those cases, the line in the makefile that runs the test that you expect to fail must start with a - character. The - tells GNU make to ignore any non-0 exit status because it is expected. Notice in the above test run that some tests redirect standard error output like this 2>&1, thereby sending it to the same output file as standard output. However, test3 and test4 use output redirection > test3.out 2>test3.err.out and > test4.out 2> test4.err.out respectively, creating different output files for standard output and standard error output. Your makefiles should do similar output redirection to two files for test runs that you expect to exit with errors. The C files send normal output to stdout and error messages to stderr. This means that, once you have written the two makefiles, you must use gmake test to run tests and to create.out files for which you have no.ref files to compare using diff. Just look at the.out files to see if they contain correct CSC 352, Assignment 2, due March 6, page 3 of 12, Spring 2015

4 output. If they do, cp them to their corresponding.ref files and run gmake test again. Eventually your test results should look similar to mine above. Make sure to use diff to compare C program.out files to the expected.ref files. I recommend starting by copying the makefile for runcat2 and editing that, likewise the makefile for the subdirectory with the library.c file. You can do this assignment mostly by changing makefile variables names, directory names, and rewriting the test lines. You can find runcat2 in ~parson/unix/runcat2.zip. Students can compile and run the program by hand to play with it, but ultimately all compilation, archiving (with ar), linking and testing must be driven by the makefile in a manner that uses ar to build a code archive of the compiled library function, and uses gcc to link a final executable as shown by my makefile trace above (gcc testfactor.o -L./lib -l factor -o testfactor). Here is how you can try it by hand in the meantime. -bash-3.00$ gcc -I `pwd`/include testfactor.c factorlib/factor.c -o testfactor -bash-3.00$./testfactor 10 The 2 factors for integer 10 are: 2 5 -bash-3.00$ echo $? # shows exit status 0 PROJECT FILES: factor2/include/factorlib.h 1 #ifndef FACTORLIB_H 2 #define FACTORLIB_H 3 /** 4 factorlib.h 5 Declarations of C functions used in C source code by the IT 6 assignment #3 for CSC 352. Students will write makefiles and tests. 7 Spring 2015 Dr. Dale Parson, CSC 352, UNIX 8 **/ 9 10 /** 11 * Function isdecimalstring returns true if str consists of an optional 12 * "-" character, followed by 1 or more decimal digits, else returing false. 13 * Return value true is actually non-0, false is 0 (this is C, not C++). 14 **/ 15 int isdecimalstring(const char *str); /** 18 * factorstring converts its str parameter into an integer, then 19 * factors that integer into its prime factors. Three conditions are possible: 20 * 1. If the null-character-terminated character sequence to which str 21 * points is not a valid signed decimal string, factorstring sets 22 * *status to FACTOR_ERR_NOT_A_DECIMAL_STRING (a negative constant) 23 * and returns a NULL pointer. factorstring uses isdecimalstring 24 * for this test. 25 * 2. Else if the translated int is <= 1, factorstring returns a 26 * a pointer to a single int (equivalent to a 1-element int array) 27 * with the int value of the string, and sets *status to 28 * FACTOR_ERR_CANNOT_FACTOR (a negative constant) and returns 29 * a pointer to a one-element in [] allocated using malloc(). 30 * The caller must eventually free the return array using free(). CSC 352, Assignment 2, due March 6, page 4 of 12, Spring 2015

5 31 * 3. Otherwise that decimal value is > 1, in which case factorstring 32 * returns an array with the original integer at [0], followed by 33 * all the factors in the remaining array elements [1].. [(*status)-1], 34 * and sets *status to the number of ints in the returned array, >= * The caller must eventually free the return array using free(). 36 **/ 37 int * factorstring(const char *str, int *status); /** See above for the use of these #defined constants. **/ 40 #define FACTOR_ERR_NOT_A_DECIMAL_STRING (-1) 41 #define FACTOR_ERR_CANNOT_FACTOR (-2) #endif factor2/testfactor.c 1 /** 2 testfactor.c is a test driver to test the functions declared 3 in factorlib.h. This example C program is for the makefile/regression 4 testing option of assignment 3 for CSC Spring 2015, Dr. Dale Parson, CSC 352, UNIX 6 **/ 7 8 #include <stdlib.h> /* library with free */ 9 #include <stdio.h> /* library with printf */ 10 #include "factorlib.h" /* declaration for functions being tested */ int main(int argc, char* argv[]) { 13 const int SUCCESS = 0 ; /* Exit status meaning no errors. */ 14 const int BADPARAM = 1 ; /* Exit status for bad int value string */ 15 int exitstatus = SUCCESS ; 16 int i, j ; 17 for (i = 1 ; i < argc ; i++) { /* Loop over command line arguments. */ 18 int status ; 19 int * factor = factorstring(argv[i], &status); 20 if (status == FACTOR_ERR_NOT_A_DECIMAL_STRING) { 21 fprintf(stderr,"error, %s is not a decimal integer, argument %d.\n", 22 argv[i], i); 23 exitstatus = BADPARAM ; 24 } else if (status == FACTOR_ERR_CANNOT_FACTOR) { 25 fprintf(stderr,"error, %d cannot be factored, argument %d.\n", 26 factor[0], i); 27 free(factor); /* Free storage per declaration of factorstring. */ 28 exitstatus = BADPARAM ; 29 } else { 30 printf("the %d factors for integer %d are:\n\t", 31 status-1, factor[0]); 32 for (j = 1 ; j < status ; j++) { 33 printf("%d ", factor[j]); 34 } 35 printf("\n"); 36 free(factor); /* Free storage per declaration of factorstring. */ 37 } 38 } 39 exit(exitstatus); 40 } factor2/ factorlib/factor.c 1 /** CSC 352, Assignment 2, due March 6, page 5 of 12, Spring 2015

6 2 factor.c 3 Functions declared in factorlib.h. See factorlib.h. 4 Spring 2015 Dr. Dale Parson, CSC 352, UNIX 5 **/ 6 7 #include <ctype.h> /* library with isdigit */ 8 #include <string.h> /* library with strlen */ 9 #include <stdlib.h> /* library with atoi, malloc etc. */ 10 #include "factorlib.h" /* declaration for run1cmd */ int 13 isdecimalstring(const char *str) { 14 int allok ; 15 if (*str == '-') { /* skip over optional minus sign for now */ 16 str++ ; 17 } 18 allok = (strlen(str) > 0); /* There must be at least 1 char. */ 19 while (allok && (*str!= '\0')) { 20 /* While no problem found and not at terminating null. */ 21 allok = isdigit(*str); /* This is a digit. */ 22 str++ ; /* Next character. */ 23 } 24 return allok ; 25 } int * factorstring(const char *str, int *status) { 28 int * result ; 29 if (! isdecimalstring(str)) { 30 *status = FACTOR_ERR_NOT_A_DECIMAL_STRING ; 31 result = NULL ; 32 } else { 33 int arraycount = 1 ; 34 result = malloc(sizeof(int)); 35 result[0] = atoi(str); 36 if (result[0] <= 1) { 37 *status = FACTOR_ERR_CANNOT_FACTOR ; 38 } else { 39 int todo = result[0] ; 40 while (todo > 1) { 41 int rem = todo % 2 ; /* Remainder of division by 2. */ 42 if (rem == 0) { 43 arraycount++ ; 44 result = realloc(result, arraycount * sizeof(int)); 45 result[arraycount-1] = 2 ; 46 todo = todo / 2 ; 47 } else { 48 int f ; 49 for (f = 3 ; f <= todo ; f += 2) { 50 rem = todo % f ; 51 if (rem == 0) { 52 arraycount++ ; 53 result = realloc(result, arraycount * sizeof(int)); 54 result[arraycount-1] = f ; 55 todo = todo / f ; 56 if (todo == 1) { 57 break ; 58 } 59 f = 1 ; /* Restart the loop at f = 3. */ CSC 352, Assignment 2, due March 6, page 6 of 12, Spring 2015

7 60 } 61 } 62 } 63 } 64 *status = arraycount ; 65 } 66 } 67 return result ; 68 } factor2/makelib 1 # makelib for package factor2 in CSC 352 UNIX 2 # The common make declarations for all makefiles in this 3 # two-directory project go into this makelib. 4 # Spring, 2015, Dr. Dale Parson 5 6 # := assignment is expanded immediately 7 # = assignment is expanded recursively when actually needed, 8 # meaning that = expansion can use make variables before they are defined CFILES := $(wildcard *.c) 11 OBJFILES := $(subst.c,.o,$(cfiles)) 12 CFLAGS := -c ifeq ($(DEBUG),1) 15 CFLAGS += -g 16 endif 17 AR = ar %.o : %.c 20 gcc $(CFLAGS) $< -o $@ subclean: FORCE 23 /bin/rm -f *.o *.class $(JARFILE) core *.exe *.obj *.pyc clean: FORCE FORCE: # Following are need for "gmake turnitin" to work STUDENT := $(shell /bin/basename $$HOME) 32 WORKDIR := $(shell /bin/basename `pwd`) turnitin: clean Do you really want to send $(TARGET) to Professor Parson? Hit Enter to continue, control-c to abort. keyboard 40 /bin/bash -c "cd.. ; /bin/chmod 700. ; \ 41 /bin/tar cvf./$(target)_$(student).tar $(WORKDIR) ; \ 42 /bin/gzip./$(target)_$(student).tar ; \ 43 /bin/chmod 666./$(TARGET)_$(STUDENT).tar.gz ; \ 44 /bin/mv./$(target)_$(student).tar.gz ~parson/incoming" CSC 352, Assignment 2, due March 6, page 7 of 12, Spring 2015