EECS 340 Project 1 Winter 18
Project 1: Web Client and Server Overview
In this part of the project, your group will build a simple web client and a succession of servers to which it can connect. In addition you will learn how to checkout and build Minet. The goal is to slowly introduce you to Unix, Minet, and socket programming and get you to a stage where you will be able to tackle the subsequent parts of the project. The client and servers you’ll build will run both on the kernel stack and on the Minet stack. The last server that you will construct will have roughly the same structure as the TCP and IP layers of the network stack you will build. There are also extra credit servers you may build that are structured like a real high performance web server or cache, such as Inktomi’s Traffic Server, the Squid cache, Apache, or Microsoft’s IIS.
HTTP and HTML
The combination of HTTP, the Hypertext Transport Protocol, and HTML, the Hypertext Markup Language, forms the basis for the World Wide Web. HTTP provides a standard way for a client to request typed content from a server, and for a server to return such data to the client. “Typed content” simply means a bunch of bytes annotated with information (a MIME type) that tells us how we should interpret them. For example, the MIME type text/plain tells us that the bytes are unadorned ASCII text. You will implement a greatly simplified version of HTTP 1.0.
HTML (type text/html) content provides a standard way to encode structured text that can contain pointers to other typed content. A web browser parses an HTML page, fetches all the content it refers to, and then renders the page and the additional embedded content appropriately.
HTTP Example
In this project, you will only implement HTTP, and only a tiny subset of HTTP 1.0 at that. HTTP was originally a very simple, but very inefficient protocol. As a result of fixing its efficiency problems, modern HTTP is considerably more complicated. It’s current specification, RFC 2616, is over a hundred pages long! Fortunately, for the purposes of this project, we can ignore most of the specification and implement a tiny subset.
The HTTP protocol works on top of TCP, a reliable stream-oriented transport protocol, and is based on human-readable messages. Because of these two facts, we can use the telnet program to investigate how HTTP works. We’ll use telnet in the role of the client and www.cs.northwestern.edu in the role of the server. The typed content we’ll transfer is the CS department’s home page. This is essentially the same as fetching the home page using your favorite web browser.
Page 1 of 10
EECS 340 Project 1 Winter 18
The following shows what this looks like for the URL http://www.cs.northwestern.edu/index.html. The text in bold is what you would type, while the text in italic are the parts of the response that we’ll talk about.
$ telnet www.cs.northwestern.edu 80 Trying 129.105.100.7…
Connected to webl.cs.northwestern.edu Escape character is ‘^]’.
GET /index.html HTTP/1.0
(blank line)
HTTP/1.1 404 Not Found
Date: Wed, 01 Dec 2004 21:13:42 GMT
Server: Apache/2.0.47 (Unix) mod_ssl/2.0.47 OpenSSL/0.9.6b DAV/2 PHP/4.3.3 mod_auth_kerb/4.13
Last-Modified: Fri, 16 May 2003 17:26:24 GMT
ETag: “840b3-816-58165000”
Accept-Ranges: bytes
Content-Length: 2070
Connection: close
Content-Type: text/html; charset=ISO-8859-1
…
Connection closed by foreign host.
$
The first thing to notice is that we are opening a TCP connection to port 80 (telnet looks up the service “http” in the list /etc/services and discovers that it is a TCP service that runs on port 80.) Telnet does a DNS lookup on the host www.cs.northwestern.edu and finds that it is at IP address 129.105.100.7. It then does a reverse lookup on the IP address to find the canonical name of the machine. It then opens the connection and lets us type.
“GET /index.html HTTP/1.0” is the most basic form of an HTTP 1.0 request, and the form that you will implement. It says “please give me the file that you think of as /index.html using the 1.0 version of the HTTP protocol.” The blank line demarcates the end of the request. This is necessary because a more complex request may place further conditions (on additional lines) on what the client is willing to accept and how it is willing to accept it.
The response always begins with a line that states the version of the protocol that the server speaks (“HTTP/1.1” in this case), an error code (“404”), and a textual
Page 2 of 10
EECS 340 Project 1 Winter 18
description of what that error code means (“Not Found”). Next, the server provides a bunch of information about the content it is about the send as well as information about itself and what kinds of services it can provide. The most critical lines here are “Content-Length: 2070”, which tells us that the content will consist of 2070 bytes, and “Content-Type: text/html”, which tells us how to interpret the content we shall receive. A blank line demarcates the end of the response header and the beginning of the actual content. After the content has been sent, the server closes the connection.
You can find correct implementations of the http client and servers (as binaries) that you’ll build in this project in /home/maw602/EECS340/netclass-execs, accessible on any TLAB machine.
Part 0: Get, build, configure, and run your Minet Stack
To get your copy of Minet, first decide where you want to place it. We recommend /home/you, which is accessible from all TLAB machines. Start by changing to the directory you select. Next, copy Minet:
cp /home/maw602/EECS340/minet-netclass-w18.tar.gz .
tar –xvzf minet-netclass-w18.tar.gz
Now you should have a subdirectory minet-netclass. Congratulations! You should put this directory on your path:
export PATH=$PATH:/home/you/minet-netclass
or
if your default shell is csh.
Now, for this very first time you build, you need to create default dependencies.
cd minet-netclass
touch .dependencies
Now you can make the dependencies, clean, and build Minet and your project on any TLAB machine.
make clean
make depend
make
You’ll typically only run the last command for the remainder of this part of the project.
Notice that http_client and http_server1,2,3 are built. These are stubs that do nothing. You will write them for this project, filling in their corresponding .cc files. You can
setenv PATH ${PATH}:/home/you/minet-netclass
Page 3 of 10
EECS 340 Project 1 Winter 18
find binary versions of correct implementations in /home/maw602/EECS340/netclass- execs.
To initialize Minet, do
source setup.sh
Notice that you must be using an sh-style shell for this to work. If you’re using something else, you can run /bin/bash. You can also change your login shell using chsh.
The above command should open up a number of xterms. Note that the Minet configuration for this class is slightly different from how it is described in the technical report. In particular, your stack will use “device_driver2” and will not use “reader” and “writer”. This is not important.
Part 1: HTTP Client
Write a client program that supports the following command line and semantics.
http_client k|u server_name server_port server_path
“k|u” indicates whether the client should run using the kernel stack (the regular stack) or the user stack (the Minet stack). For this project, you only need to run using the kernel stack. To see how to handle this argument, take a look at the stub http_client.cc file. Please build your client by filling out this file.
When run, http_client should open a connection to port server_port on the machine server_name, and then send an HTTP request for the content at server_path. It should then read the HTTP response the server provides. If the response is that server_path is valid and includes the data, http_client should write the data out to standard out and exit with a return code of zero. You can then view this output using a web browser such as netscape or lynx. If there is an error, http_client should write the response to standard error and exit with a return code of –1. For example,
http_client k networks.cs.northwestern.edu 80 bla should print “If you’re reading this now, your code works!” to standard out and return
zero, while
http_client k www.cs.northwestern.edu 80 bla should print the response to standard error and return –1.
Page 4 of 10
EECS 340 Project 1 Winter 18
Part 2: Connection-at-a-time HTTP Server
Write an HTTP server that handles one connection at a time and that serves files in the current directory. This is the simplest kind of server. The command-line interface will be
http_server1 k|u port
You will then be able to use http_client, telnet, or any web browser, to fetch files from your server. For example, if you run
http_client k host port http_server1.cc
you should receive the contents of your source file.
It is important to note that you will not be able to use port 80. Ports less than 1500 are reserved, and you need special permissions to bind to them.
Your server should have the following structure:
1. Create a TCP socket to listen for new connections on (What packet family and type should you use?)
2. Bind that socket to the port provided on the command line. We’ll call this socket the accept socket.
3. Listen on the accept socket (What will happen if you use a small backlog versus a larger backlog? What if you set the backlog to zero?)
4. Do the following repeatedly
a. Accept a new connection on the accept socket (When does accept return?
Is your process consuming cycles while it is in accept?) Accept will return a new socket for the connection. We’ll call this new socket the connection socket. (What is the 5-tuple describing the connection?)
b. Read the HTTP request from the connection socket and parse it. (How do you know how many bytes to read?)
c. Check to see if the file requested exists.
d. If the file exists, construct the appropriate HTTP response (What’s the
right number?), write it to the connection socket, and then open the file
and write its contents to the connection socket.
e. If the file doesn’t exist, construct a HTTP error response and write it back
to the connection socket
f. Close the connection socket.
Part 3: Simple Select-based Multiple-connection-at-a-time Server
The server you wrote for part 2 can handle only one connection at a time. Try the following. Open a telnet connection to your http_server1 and type nothing. Now make a request to your server using your http_client program. What happens? If the connection request is refused, try increasing the backlog you specified for listen in http_server1 and then try again. After http_server1 accepts a connection, it blocks
Page 5 of 10
EECS 340 Project 1 Winter 18
(stalls) while reading the request and so is unable to accept another connection. Connection requests that arrive during this time are either queued, if the listen queue (whose size you specified using listen) is not full, or refused, if it is.
Consider what happens if the current connection is very slow, that it is running over a modem link, for example. Your server is spending most of its time idle waiting for this slow connection while other connection requests are being queued or refused. Reading the request is only one place where http_server1 can block. It can also block on waiting for a new connection, on reading data from a file, and on writing that data to the socket.
Write an HTTP server, http_server2, that avoids just two of these situations: waiting for a connection to be established, and waiting on the read after a connection has been established. You can make the following assumptions:
• If you can read one byte from the socket without blocking, you can read the whole request without blocking.
• Reads on the file will never block
• Writes will never block
It is important to note that if you have no open connections and there are no pending connections, then you should block.
To support multiple connections at a time in http_server2, you will need to do two things:
• Explicitly maintain the state of each open connection
• Block on multiple sockets, file descriptors, events, etc.
It is up to you to decide what the contents of the state of a connection are and how you will maintain them. However, Unix, as well as most other operating systems, provides a mechanism for waiting on multiple events. The Unix mechanism is the select system call. select allows us to wait for one or more file descriptors (a socket is a kind of file descriptor) to become available for reading (so that at least one byte can be read without blocking), writing (so that at least one byte can be written without blocking), or to have an exceptional condition happen (so that the error can be handled). In addition, select can also wait for a certain amount of time to pass. We have provided you with a version of select called minet_select. minet_select has precisely the same semantics as select (man select), but it makes it easy to choose between the kernel network stack and the user-level Minet stack.
Your server should have the following structure:
1. Create a TCP socket to listen for new connections on
2. Bind that socket to the port provided on the command line.
3. Listen on that socket, which we shall call the accept socket.
4. Initialize the list of open connections to empty
5. Do the following repeatedly
a. Make a list of the sockets we are waiting to read from the list of open connections. We shall call this the read list.
Page 6 of 10
EECS 340
b.
c. d.
Project 1 Winter 18
Add the accept socket to the read list. Having a new connection arrive on this socket makes it available for reading, it’s just that we use a strange kind of read, the accept call, to do the read.
Call minet_select with the read list. Your program will now block until one of the sockets on the read list is ready to be read.
For each socket on the read list that minet_select has marked readable, do the following:
i. If it is the accept socket, accept the new connection and add it to the list of open connections with the appropriate state
ii. If it some other socket, performs steps 4.b through 4.f from the description of http_server1. After closing the socket, delete it from the list of open connections.
Test your server using telnet and http_client as described above.
Extra Credit: Complex Select-based Multiple-connection-at-a-time Server
http_server2 can handle multiple connections at a time, but there remain a number of places where it can block. These are implicit in the assumptions we have made. In general, almost any system call can block. In particular, if select tells us that a file descriptor is readable, it only means that at least one byte can be read. Reading any subsequent byte may block. The same holds true for writes.
To avoid unnecessary blocking, then, the program must check each system call that may block, and certainly read and write, before it executes the system call. Does this mean that we have to call select before we read or write each byte? Not necessarily. We can instead using non-blocking I/O. If we set a file descriptor to operate in non-blocking mode, then system calls on that file descriptor will fail with an EAGAIN error instead of blocking. EAGAIN means “I can’t do that right now because doing so would block you and you asked me never to let that happen.” To read more about non-blocking I/O, see the man page for fcntl. fcntl(fd,F_SETFL,O_NONBLOCK) is one way to set a file descriptor to non-blocking I/O. To learn how to retrieve error codes from system calls, check out the man page for errno.
For extra credit, you can build an HTTP server, http_server3, which uses select and non-blocking I/O to provide availability even in the face of blocking on any of the reads, writes, and accepts, as well as dealing with partial reads and writes. The overall structure of the code is as follows.
1. Create a TCP socket to listen for new connections on
2. Bind that socket to the port provided on the command line.
3. Listen on that socket, which we shall call the accept socket.
4. Initialize the list of open connections to empty. You should associate with each
connection its state and the file descriptor for the file it is reading, etc.
5. Do the following repeatedly
Page 7 of 10
EECS 340
e.
f. g.
h. i.
Project 1 Winter 18
Make a list of file descriptors we are waiting to read from the list of open connections. This will include both sockets and file descriptors for files you are in the process of reading. We shall call this the read list.
Add the accept socket to the read list.
Make a list of sockets we are waiting to write from the list of open connections. We shall call this the write list.
Call minet_select with the read list and the write list. Your program will now block until one of the sockets on the read list is ready to be read or written.
For each socket on the read list that minet_select has marked readable do the following
i. If it is the accept socket, accept the new connection, set its socket to be non-blocking, and add it to the list of open connections with the appropriate state
ii. If it’s some other socket, look up its connection in the list of open connections, figure out how much you have left to read, and then read until you get an EAGAIN or you’ve read the whole request.
Mechanics
j.
1. If you get the EAGAIN, update the connection state to reflect you much you have read.
2. If you’ve read the whole file, close the file, update the connection state to reflect that you are ready to start writing the contents to the socket.
For each socket on the write list that minet_select has marked writeable do the following.
i. Look up its connection in the list of open connections, figure out how much you have left to write, and then write until you get an EAGAIN or you’ve read the whole request.
1. If you get the EAGAIN, update the connection state to reflect how much you’ve written.
2. If you’ve written the whole file, close the socket and remove the connection from the list of open connections.
1. 2.
If you get the EAGAIN, update the connection’s state accordingly.
If you’ve read the whole request, open the file, set its file descriptor to non-blocking, add it to the connection state, and update the state to note that you’re in the process of reading the file.
If it’s some other file descriptor, look up its connection in
iii.
the list of open connections, figure out how much you have left to read, and then read until you get an EAGAIN or you’ve read the whole file.
• You should work in a group of three people. Ideally, you should have the same partners for all the parts of the project.
Page 8 of 10
EECS 340 Project 1 Winter 18
• Your code must use the Minet sockets layer that we will provide. This layer can be set to pass through calls to kernel sockets interface, or it can pass calls to the Minet user-level stack (the TCP (and possibly IP) parts of which you will write later in the quarter!) Here you will be using it in its kernel-pass-through mode. There is a separate handout on compiling and linking with the Minet sockets layer.
• Your code must be written in C or C++ and must compile and run under Red Hat Linux 7.3 on the machines in our using the default versions of gcc and make that are available there. We will expect that running “make project_a” will generate the executables http_client, http_server1, http_server2, and (if you decide to do the extra credit), http_server3 according to our Makefile.
• You will hand in http_client.cc, http_server1.cc, http_server2.cc and (if you do it) http_server3.cc. If you modify our makefile for some reason, you should hand that in too. Your submission should bundle said files, plus a README, into a tarball using:
tar -czvf
where
• DO NOT: change filenames or file types; include any additional header files or libraries; upload unnecessary files
Sharing Files With Your Partner And Using Version Control
You and your partner will want to be able to work on the same code base. The easiest way for you to do this in our current environment is to trust each other and share one account.
A more powerful way to share files and to assure that you never throw away good work is to use CVS or some other form of version control. You can create your own CVS repository and give your partner access to it. Not only will this let you share files via the repository, but the repository will store all the different versions of your files, and CVS will mediate the work that you and your partner do separately. If you do version control software, make sure that your code is only accessible to your own group.
Things That May Help You
• Section 2.2 of your textbook provides more information about HTTP and shows another example of simple HTTP interactions.
• You can (and should) play with real web servers using telnet to port 80. The 2 “bla” file examples listed above are real.
• You should not be using the server you made to test the client you made, or vice versa (because it is very possible that you made some formatting mistake in both). Servers 2 and 3 will work with real web browsers (
• RFC 2616, which you can find via http://www.ietf.org, is the specification for HTTP 1.1. This can be daunting, but it is the standard. The specification of HTTP 1.0, RFC 1945, is simpler and probably as relevant for this assignment.
• Section 2.6 of your textbook gives examples of writing TCP clients and servers in Java, while Section 2.8 gives examples of a simple web server written using Java.
Page 9 of 10
EECS 340 Project 1 Winter 18
• The handout “Sockets in a Nutshell”.
• The handout “Minet Sockets”
• The handout “Make in a Nutshell”
• The Minet Technical Report
• Rick Steven’s Unix Network Programming book has lots of source code examples.
• The C++ Standard Template Library
• The micro_http server (http://www.acme.com/software/micro_httpd/) can show you
how to parse and generate HTTP requests and responses.
• CVS (http://www.loria.fr/~molli/cvs-index.html) is a powerful tool for managing
versions of your code and helping you and your partner avoid stepping on each
other’s toes.
• The following paragraph is to help you not find yourself “accidentally” cheating.
Here are some examples of cheating: using code from someone not in your group; using solution code as “reference” material; making your code publicly available online; sharing your code with another group; using code from other versions of this course. Essentially, if you find yourself even looking at any code pertaining to this project that is not 1) generic documentation (for C, Linux, etc.), 2) written by your own group, or 3) deliberately provided by this course’s instructors, stop. If you’re in doubt, contact the TAs to clarify. To those of you still considering cheating, note that modified variable names and varied line arrangement does not fool our code comparison tool.
Page 10 of 10
Reviews
There are no reviews yet.