INTRODUCTION

This assignment has been developed to provide students with a quality experience of the design and operational decisions made by persons developing an Operating  System. However, it also incorporates the real world (i.e., advanced academia       and/or industry) conditions of managing a larger scale project as well as reading   code during the grading component of each phase.

The simulator project will be run in at least four phases. Each of these phases will be specified in this document although some small changes may be made as the  project progresses. The Instructor is open to changes recommended by students  as long as the entire project, including grading, is completed on or before 19        November 2020 (course term end).

Development requirements

•  The simulator must be programmed and written completely in the C programming language, and run in the Linux environment

•  The make operation must compile all files with gcc (i.e., as opposed to g++); the make file must be structured in the same form as the Instructors’ provided file

•  All programs are required to use a make file with the -f switch followed by a make file name (NOT makefile)

•  All program files must be compiled with the -Wall switch, the -std=c99 switch, and the -pedantic switch

•  The make file names are the project or program names with a _mf appended, and are used as follows: make -fmyprog_mf

•   Students are also required to demonstrate effective modularity by breaking   the various functions out into appropriately organized files. More information about programming standards and operations is provided later in this           document as well is in the project rubric.

CALENDAR/SCHEDULE OF ASSIGNMENTS

Mon, 10 Jan: Sim01 assigned in Week 1 folder

Thu, 27 Jan: Sim01 program due in Week 1 folder (~3 weeks)

Mon, 31 Jan: Sim02 assigned in Week 4 folder

Thu, 3 Feb: Sim01 grading due in Week 4 folder

Thu, 17 Feb: Sim02 program due in Week 4 folder (~3 weeks)

Mon, 21 Feb: Sim03 program assigned in Week 7 folder

Thu, 24 Feb: Sim02 grading due in Week 7 folder

Thu, 24 Mar: Sim03 program due in Week 7 folder (3+ Weeks)

Mon, 28 Mar: Sim04 program assigned in Week 11 folder

Thu, 31 Mar: Sim03 grading due in Week 11 folder

Thu, 21 Apr: Sim04 program due in Week 11 folder (3+ Weeks)

Thu, 28 Apr: Sim04 grading due in Week 15 folder

{29 Apr: Last day of classes}

The schedule above is provided to help make assignments and due dates clear. Make sure each assignment is correctly turned in to the right place by the right time; loss of some or all credit may occur for incorrect assignment preparation  and/or uploading management.

Also note that due to time limitations, it is unlikely that any deadlines will be changed.

Posting of Simulator Code to repositories (e.g., github, Bitbucket, SourceForge, etc.)

This project has the potential to be a very powerful representation of your best      work and you SHOULD show it off to potential employers. However, according to    NAU policy and the policies for this course, sharing this code with other students is a violation of academic integrity. And it should be noted that depending on the       circumstances, there is a fair chance you could be charged with an academic         integrity violation even after leaving this class. That would be bad since the           potential sanctions would be more significant at the University level.

Another issue is the fact that you are given virtually all of the code for the first      assignment which is used for all of the others. Representing this code as your own is plagiarism, and potentially, fraud.

So how do you handle this since you would like to show your project to potential employers? Here are acceptable ways to handle this:

1. When showing off your code, make it clear inside the code files as well as in the presentation of the code that the file I/O operations were developed by   me. You do not have my permission to represent it as your own code. While I do provide you with the code, I (and your potential employers) expect the  credit for development of the code to be given to the appropriate party. Just do that. No harm, no foul. If you actually create the file access code on your own and it is distinctively different from mine, then it is yours and you         should represent it as such. Again, no harm, no foul.

2. As for posting the code, you should set it to private status and note in your resume that it will be provided to potential employers on request. They are fine with that. If you are in the process of being interviewed or your           potential employer is interested enough in your work to request to see the  code, open it up for a brief time (three or four days, but no longer than a    week). I am not just okay with that, I will be proud that you did it.

3. Finally, when you graduate, the University does not have as much authority over you and your education anymore so you COULD uncover this code.       However, when you graduate, you will be a professional who follows a clear code of conduct in whatever discipline or industry you pursue. It would still  not be right for you to set other students up for potential academic integrity violations at that point (This HAS happened). I would ask that you continue  to keep it set to private except for those moments in your career where you wish to show it off. At that point, it is your call.

GENERAL PROGRAMMING AND DEVELOPMENT EXPECTATIONS

Specific rubrics will be provided for grading each program. However, the following are general expectations of programmers in this 400-level course:

- since students will have an overview of all of the programs, be sure to  consider the subsequent phases as the first programs are developed; an  overlying strategy from the beginning will significantly support extending and/or expanding each program

- students may work with any number of fellow students to develop the             program design, related data structures, algorithmic actions, and so on for each phase. Students who do work together must note which students with whom     they worked in the upload text on BlackBoard Learn; this is for the students’ protection

- that said, once a student begins coding each phase, s/he may not discuss or   work with anyone (other than the Instructor or identified TAs) on the                development, coding, and/or debugging process. Strategy(s) may still be          discussed but without specific Instructor permission, no student may view or be involved with the code of another. It will be a good idea to make sure a high-    quality design has been developed prior to beginning the coding process

- all programs must be eminently readable, meaning any reasonably competent programmer should be able to sit down, look at the code, and know how it        works in a few minutes. This does not mean a large number of comments are    necessary; the code itself should read clearly. Refer to the Programming           Standards document for best practices and requirements; this document will be used as the final reference during the grading phases

- the program must demonstrate all the software development practices         expected of a 400-level course. For example, all potential file failures must be resolved elegantly, any screen presentation must be of high quality, any data structures or management must demonstrate high quality, supporting actions and components must demonstrate effective modularity with the use of          functions, there may not be any global or single-letter variables, and so on. If there is any question about these standards, check with the Instructor

- one example of clean modularity is that no functions other than the main        function, or functions that directly support the main function, may be in the      main driver file. All simulator actions, utility functions, and any other support    code must be in other files with file names that clearly indicate what kind of      support code will be contained within. It is expected that for the final                assignment, there will be at least five or six separate C files, but in most cases, no more than ten to twelve

- students may use any of the C libraries specified in this paragraph as needed, but may not use any other libraries, and may not use pre-developed data         structures, tools, or programs that students are expected to write for this         project.

•  Allowed Libraries: stdbool.h, stddef.h, sys/time.h, math.h, stdio.h, stdlib.h, pthread.h, time.h, and string.h

•  Also allowed: printf family functions, including printf, fprintf, sprintf, snprintf

•   Disallowed functions: utility functions are any functions that start with “str” (e.g., strcpy, strcat, strtok, etc.)

•   Disallowed functions: functions that implement conversions such as atoi, atof, etc.

•  Any of these or other functions that conduct utility actions must be written by the individual student using them

•    Students who want to use other libraries or have questions about utility functions must check with the Instructor for approval

•   If a given function or library other than mentioned in this paragraph is approved, the approval will be shared with all students in the class

•  The use of unapproved headers/libraries and/or utility functions will cause a reduction in credit.

- in addition, when specified in the instructions, students must use

POSIX/pthread operations to manage the I/O operations but may NOT use        previously created threads such as timer threads (e.g., sleep, msleep, usleep,  etc.). If there are any questions on this, ask the Instructor so your grade is not harmed by an incorrect choice.

- all programs must compile without errors or warnings, and run on the CEFNS   linux system (i.e., linux.cefns.nau.edu). All programs must also be tested for any memory issues using the Valgrind/Memcheck software product, and this      must be tested on the CEFNS system as well. Individual students may develop   their programs in any environment they choose* but – as stated – the program  must compile and run, and pass the Valgrind tests, on the CEFNS system. It      will be a good idea to check individual programs on this system well before the  program is due, which will probably include during the development time.

*While this specification allows for the use of MS/Windows tools, there will come a point in the development process – very likely in Sim02 – that you will have    to use Linux to implement threading operations to meet the program                 requirements. You are advised to jump right into the Linux environment and      get through the initial struggles during your development of the first program    as it will be the easiest assignment

- for each programming assignment:

•   Each student will upload the program files using his or her own secret ID which will be generated and provided to students in their BBLearn grade rows; note that this is NOT the NAU student ID

•  The file for each student must be tarred and zipped in its own directory named Sim0x_ secret ID> as specified below (e.g.,     Directory name: Sim01_123456), and must be able to be unzipped to the directory on any Linux computer

•  Any and all files necessary for the operation of the program must be included, which would be all the .c, .h, and make files

•   In addition, a grading Rubric spreadsheet will be provided with each     assignment; this must also be included in the tar/gz file, and must be   named Sim0x_GradingForm_ secret ID>.xlsx (e.g., Sim01_GradingForm_123456.xlsx)

•  Any extraneous files added such as unnecessary library, data files, or object files will be cause for credit reduction

•  The file must be named Sim0X_ ID>.tar.gz where X represents  the specific project number, and the students secret ID code is placed in the  location. An example would be Sim01_123456.tar.gz

•  The programs must be uploaded at or before 4:00 pm on the date for   each specific programming project/phase, and at or before 4:00 pm for each grading component

•   Dates are found previously in this document.

THE PROGRAM CONFIGURATION DATA

All programs must be able to input and store the contents of the file shown next.    Note that any of the nine configuration lines may be in any order in the file.           However, the “Start Simulator...” and the “End Simulator...” lines will be located at the beginning and end of the file as shown.

Start Simulator Configuration File

Version/Phase: 1.0

File Path: Test_3.mdf

CPU Scheduling Code: NONE

Quantum Time (cycles): 55

Memory Available (KB): 12000

Processor Cycle Time (msec): 10

I/O Cycle Time (msec): 20

Log To: Monitor

Log File Path: logfile_1.lgf

End Simulator Configuration File.

The following items specify the expected and allowed data that may be used in the configuration file. Each has a specification of limits or conditions and if any             configuration item is outside the specified limits, the uploading process must throw an error.

Version/Phase: This line will have a version number such as 1.25, 2.3, 3.44, etc. Note that the version/phase will be different for each assignment and will be          floating point values; in many cases, student programs are likely to have evolving  fractional version numbers as the programs are developed. Specification: 0.0 ≤      V/P ≤ 10.0

File Path: This line must contain the file path where the meta-data will be found. The assignment requirement is that the data must be in the same directory as the program

CPU Scheduling Code: This line will hold any of the following: FCFS-N, SJF-N, SRTF-P, FCFS-P, RR-P. No other code names are allowed, and if any are found,   the data access must be aborted, and the configuration function must signal          failure to the calling function. Note that the configuration input function should not display any output – this will be discussed later.

Quantum Time: This line will hold an integer specifying the quantum time for the Simulator. For the first couple of projects, this will be zero and/or will be ignored    by the program although it must still be stored in the data structure. Specification: 0 ≤ Q ≤ 100

Memory Available: This line will hold an integer specifying the system memory that will be available. For the first couple of projects this may also be ignored      although it must still be stored in the data structure. Specification: 1024 ≤ MA ≤ 102400 (1 MB to 100 MB in KB form)

Processor Cycle Time (msec): This line will hold an integer cycle time that will specify the number of milliseconds each processor cycle will consume.

Specification: 1 ≤ PCT ≤ 1000 I/O Cycle Time (msec): This line will also hold an integer cycle time like the processor cycle time. Specification: 1 ≤ IOCT ≤ 10,000

Log To: This line will hold one of three terms, being Monitor, File, or Both. No other code names are allowed, and if any are found, the data access must be     aborted, and the configuration input function must signal failure to the calling     function

Log File Path: This line will hold the file path of the log file, which is used if “Log

To:” has selected either File or Both. It must still hold some string quantity even  if “Log To:” is set to Monitor (e.g., No_Logfile, or None)                                      At the end of the configuration file, the last “End Simulator . . . “ must be found in the configuration file exactly as shown above.

Most failure issues such as missing file, corrupted file data, or incomplete data       must stop the function and elegantly respond. This includes closing the input file if it is open, releasing any acquired memory, halting any other processing, file I/O,   or file management, and providing an indication to the calling function as to what  went wrong. Remember that the function must communicate the error to the        calling function; error messages must all be printed from the main function.

THE PROGRAM META-DATA

The program meta-data components are as follows:

Commands: sys, app, dev, cpu, mem

In/Out arguments: in, out

First string argument (after In/Out where used): start, end process, allocate, access, ethernet, hard drive, keyboard, monitor, serial, sound signal, usb, video signal

If one integer after “start” and comma: This is the entry cycle time into the system (optional in this project)

If one integer argument after comma: This is the cycle time for the operation

If two integer arguments after comma: These are the base and offset for memory operations.

Sample meta-data

Start Program Meta-Data Code:

sys start

app start, 0

dev in, hard drive, 18

cpu process, 9

cpu process, 9

cpu process, 9

dev out, monitor, 60

app end

app start, 0

dev in, sound signal, 40

mem allocate, 2048, 4096

dev in, hard drive, 30

mem allocate, 2760, 2890

dev in, sound signal, 25

cpu process, 6

mem allocate, 3000, 4000

dev out, usb, 10

mem allocate, 3500, 3700

app end

app start, 0

dev in, video signal, 70

cpu process, 10

dev out, monitor, 70

dev in, hard drive, 18

cpu process, 9

app end

app start, 0

dev in, sound signal, 35

dev out, monitor, 100

dev in, keyboard, 50

cpu process, 9

dev out, video signal, 49

app end

app start, 0

dev in, keyboard, 90

dev out, sound signal, 40

dev out, serial, 32

cpu process, 10

dev in, hard drive, 15

app end

sys end

End Program Meta-Data Code.

GENERAL INFORMATION

The cycle times are applied as specified here:

The cycle time represents the number of milliseconds per cycle for the program.    For example, if a device has a 50 msec/cycle time (found in the configuration file), and it is supposed to run for 10 cycles (found in the meta-data file, the device       operation (i.e., the timer for that device) must actually run for 500 mSec. An         onboard clock interface of some kind must be used to manage this, and the           precision must be to the microsecond level. To repeat, the simulator must             represent real time; if the operations take 10 seconds, the simulator must take 10 seconds.

SUPPORTING PROGRAM CODE

Timing the simulator operations:

A support file simtimer.c and its header file will be provided for student              consideration. It is not required for students to use this code, however timer        displays used for each of the assignments must correctly show the time at           microsecond precision (i.e., 0.000001 sec) as specified previously. The                microsecond display is demonstrated in the Sim01 demonstration program, which will also be provided.

Creating example test programs:

The program proggen.c has been developed to support testing and work with this assignment. It can generate test program meta-data with varying parameters,       although it does not generate memory access or allocation op codes as these need to be uniquely created. It can also be modified as needed to use different              operations-generating algorithm(s). Besides using this program for its intended      purpose, students can also observe expected programming practices especially as  relates to readability. As noted previously in this document, comments are allowed but not expected; program code should be eminently readable by the use of self-   documenting identifiers. That said, this code is significantly commented to support learning.

RUNNING THE SIMULATOR

The simulator will input a configuration file that is accepted from the command line, as follows:

./sim0x [-zz] config_y.cnf

*x is the project number (1-4), y is the number of a given configuration file, and zz is one or more of the three specified command line switches

Note that the program MUST work in this form, and ONLY in this form. The use of any console input actions for the configuration or meta data files will be       cause for significant credit reduction. The configuration file must be used as a        command-line argument, and the meta data file must be opened after acquiring    the meta data file name from the configuration file. Any deviation from this           requirement will cause a reduction of credit.

Also note that differing configuration files will be used for various testing purposes.

Phase I (Sim01) – Input Data Management

DESCRIPTION

This phase – which is a review of data structures, implemented in C – will require  the creation of two data-acquisition operations that upload and store two sets of    data: the Simulator configuration file, and the Simulator meta-data file. It will also provide a display representing the running simulator.

While this is a stand-alone project, students are wise to assess the next three     phases of the project so they can consider the requirements and develop their     code to be modular components of the larger system. The last project or two will be pretty complicated but will not be difficult to develop as long as the base        components have been developed well.

IMPORTANT: As mentioned previously, no processing function should ever display an output. The configuration and meta-data input operations are a good example. If there is a failure in the operation/function, it should provide some form of         messaging back to the calling function so the calling function can manage the       issue, which may include displaying an error message and/or shutting down the    program. Any processing functions (i.e., functions not specifically focused on I/O   actions other than its specifications) that conduct any I/O will experience a           significant reduction of credit. As a note, the simulator function’s task is to display simulated operations, so it is acceptable for that function, along with its                subordinate functions, to display or store output.

MAIN FILE/MAIN METHOD/DRIVER

One file will contain the main file for the simulator program. As mentioned             previously in this document, no other functions or operations should be in the        main file except the main function itself, and most of this function’s actions will be to call other functions to conduct the necessary operations. The main function       should be developed to upload the configuration and meta-data files, and to           conduct the simulation process before any other code is written; this is                  demonstrated in the tutorial related to this course. If implemented correctly, this    function will not change throughout this project.

CONFIGURATION FILE

The configuration file must be uploaded to the system as called by the main      function. Any issues with incorrect commands, in/out arguments, and string or  other arguments including specified limits for the configuration items must stop the program and report the issue as specifically as possible.

META-DATA FILE

The meta-data file must also be uploaded to the system as called by the main       function and again, any incorrect or misspelled commands or string arguments, or out of limit numerical arguments must stop the program, and report the issue as   specifically as possible.

As specified above, students will be provided a meta-data file generation program. The meta-data acquisition component must upload any meta-data file of any size, any number of actions, any number of programs, etc., and all student programs    must work correctly on any correctly formed meta-data file.

ASSIGNMENT

As specified in the description, students are to develop modules that, when called,  input and store the Simulator configuration data and the Simulator meta-data. The Sim01 program will also provide a call to the function that runs the simulator. For   purposes of this first assignment, the function will simply output “runSim called      here” to the monitor to demonstrate that the main driver program is fully              operational. Once this part of the assignment is completed, there should be no       reason to go back and modify the main program.

Once the modules are developed, they must be executed in a driver program and tested with varying data to prove they are working correctly.

IMPORTANT: It will not be enough to hack together a program that seems to work. All programs must be eminently readable since each program will be graded by      one of your peers in the class in a double-blind anonymous system. Even if your     program works – or seems to work – correctly, it will not receive full credit if it is    difficult to read and/or understand. Refer to the programming standards provided   in each project rubric as well as the example program code provided. While these   standards are not an absolute requirement, the intent (readability) of the               standards is a requirement. Also review each assignment rubric early in you.