Starting from:
$115
CS6210 Project 3- Big Picture Solution
In this project, you are going to implement major chunks of a simple distributed service using grpc.
Learnings from this project will also help you in the next project as you will become familiar with grpc and multithreading with threadpool.
Overview
You are going to build a store (You can think of Amazon Store!), which receives requests from different users, querying the prices offered by the different registered vendors.
Your store will be provided with a file of of vendor servers. On each product query, your store is supposed to request all of these vendor servers for their bid on the queried product.
Once your store has responses from all the vendors, it is supposed to collate the (bid, vendor_id) from the vendors and send it back to the requesting client.
Learning outcomes
Synchronous and Asynchronous RPC packages
Building a multi-threaded store in a distributed service
Environment Setup
To set up your environment, you can choose one of the following methods: - Option 1: Follow this link for a cmake based setup on your host machine - Option 2: Using Docker
Option 2: Setting Up the Docker Environment (Skip the whole option 2 section if you choose option 1)
If you prefer to use a Docker environment for Project 3, you can either use the pre-build docker image or build and run your own image. Option 2.1: Pre-build Docker image docker pull dcchico/aos_project3 docker run -it dcchico/aos_project3
Option 2.2: Build and Run your own image the following Dockerfile (Skip this step if you use Option 2.1: the pre-build docker image) Copy the code below into a file and name it "Dockerfile".
dockerfile FROM ubuntu:22.04 ENV MY_INSTALL_DIR /.local ENV PATH $MY_INSTALL_DIR/bin:$PATH RUN apt update && apt install -y cmake build-essential autoconf libtool pkg-config git zip unzip && git clone --recursesubmodules -b v1.58.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc /grpc && mkdir -p $MY_INSTALL_DIR WORKDIR /grpc/cmake/build RUN cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -
DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR ../.. && make -j 4 && make install WORKDIR /project3 COPY ./project3-template /project3 CMD /bin/bash Building and Running the Docker Image
Build the Docker image: docker build -t project3-docker . Run the Docker container: docker run -it project3-docker
Troubleshooting Undefined Reference to grpc::Status::OK
If you see errors like undefined reference to grpc::Status::OK while running make, add gRPC::grpc++_reflection to the linked libraries list for run_tests in /tests/CMakeLists.txt. Lines 10 to 17 should look like this: add_executable(run_tests client.cc run_tests.cc product_queries_util.h) target_link_libraries(run_tests Threads::Threads gRPC::grpc++ gRPC::grpc++_reflection p3protolib) add_dependencies(run_tests p3protolib)
How You Are Going to Implement It ( Step-by-step )
1. Make sure you understand how GRPC- synchronous and asynchronous calls work. Understand the given helloworld example. You will be building your store with asynchronous mechanisms ONLY.
2. Establish asynchronous GRPC communication between Your store and user client.
Your store and the vendors.
3. Create your thread pool and use it. Where will you use it and for what? Upon receiving a client request, you store will assign a thread from the thread pool to the incoming request for processing.
The thread will make async RPC calls to the vendors
The thread will await for all results to come back
The thread will collate the results
The thread will reply to the store client with the results of the call
Having completed the work, the thread will return to the thread pool
4. Do you have your user client request reaching to the vendors now? And can you see the bids from the different vendors at your user client end? Congratulations you almost got it! Now use the test harness to test if your server can serve multiple clients concurrently and make sure that your thread handling is correct.
Keep In Mind
1. Your Server has to handle
2. Multiple concurrent requests from clients
3. Be stateless so far as client requests are concerned (once the client request is serviced it can forget the client)
4. Manage the connections to the client requests and the requests it makes to the 3rd party vendors.
5. Server will get the vendor addresses from a file with line separated strings
6. Your server should be able to accept command line input of the vendor addresses file, address on which it is going to expose its service and maximum number of threads its threadpool should have.
7. The format of the invocation is:
./store 5. Remember to add references to all the resources you have used while working on the project.
Given to You
1. run_tests.cc - This will simulate real world users sending concurrent product queries. This will be released soon to you.
2. client.cc - This will be providing ability to connect to the store as a user.
3. vendor.cc - This wil act as the server providing bids for different products. Multiple instances of it will be run listening on different ip address and port.
4. Two .proto files store.proto - Comm. protocol between user(client) and store(server) vendor.proto -Comm. protocol between store(client) and vendor(server)
How to run the test setup
Go to project3 directory and build the program.
Three binaries would be created in the bin folder - store,run_tests and run_vendors. (Note that the location of bin folder depends on how you build the program.)
First run the command ./run_vendors vendor_addresses.txt & to start a process which will run multiple servers on different threads listening to (ip_address:ports) from the file given as command line argument.
Then start up your store which will read the same address file to know vendors' listening addresses. Also, your store should start listening on a port(for clients to connect to) given as command line argument.
Then finally run the command ./run_tests $IP_and_port_on_which_store_is_listening
$max_num_concurrent_client_requests to start a process which will simulate real world clients sending requests at the same time.
This process read the queries from the file product_query_list.txt
It will send some queries and print back the results, which you can use to verify your whole system's flow.
Grading
This project is not performance oriented, we will only test the functionality and correctness.
Below is the rubric:
Total Possible Score: 12
| Score | Reason | | ----- | ------ | | +2 | Code compiles | | +4 | Query output is correct | | +3 | Threadpool management | | +1 | store-server operates in async fashion | | +1 | store-client operates in async fashion | | +1 | Readme |
Deliverables
Submission Directory Structure:
Readme.txt src/CMakeLists.txt src/store.cc src/threadpool.h src/any_additional_supporting_files.*
You must use the collect_submission.py to create the submission zip file. Submit the zip file in gradescope. You can verify your submission using the autograder in gradescope.
FAQ
FAQ can be found here.
Learnings from this project will also help you in the next project as you will become familiar with grpc and multithreading with threadpool.
Overview
You are going to build a store (You can think of Amazon Store!), which receives requests from different users, querying the prices offered by the different registered vendors.
Your store will be provided with a file of of vendor servers. On each product query, your store is supposed to request all of these vendor servers for their bid on the queried product.
Once your store has responses from all the vendors, it is supposed to collate the (bid, vendor_id) from the vendors and send it back to the requesting client.
Learning outcomes
Synchronous and Asynchronous RPC packages
Building a multi-threaded store in a distributed service
Environment Setup
To set up your environment, you can choose one of the following methods: - Option 1: Follow this link for a cmake based setup on your host machine - Option 2: Using Docker
Option 2: Setting Up the Docker Environment (Skip the whole option 2 section if you choose option 1)
If you prefer to use a Docker environment for Project 3, you can either use the pre-build docker image or build and run your own image. Option 2.1: Pre-build Docker image docker pull dcchico/aos_project3 docker run -it dcchico/aos_project3
Option 2.2: Build and Run your own image the following Dockerfile (Skip this step if you use Option 2.1: the pre-build docker image) Copy the code below into a file and name it "Dockerfile".
dockerfile FROM ubuntu:22.04 ENV MY_INSTALL_DIR /.local ENV PATH $MY_INSTALL_DIR/bin:$PATH RUN apt update && apt install -y cmake build-essential autoconf libtool pkg-config git zip unzip && git clone --recursesubmodules -b v1.58.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc /grpc && mkdir -p $MY_INSTALL_DIR WORKDIR /grpc/cmake/build RUN cmake -DgRPC_INSTALL=ON -DgRPC_BUILD_TESTS=OFF -
DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR ../.. && make -j 4 && make install WORKDIR /project3 COPY ./project3-template /project3 CMD /bin/bash Building and Running the Docker Image
Build the Docker image: docker build -t project3-docker . Run the Docker container: docker run -it project3-docker
Troubleshooting Undefined Reference to grpc::Status::OK
If you see errors like undefined reference to grpc::Status::OK while running make, add gRPC::grpc++_reflection to the linked libraries list for run_tests in /tests/CMakeLists.txt. Lines 10 to 17 should look like this: add_executable(run_tests client.cc run_tests.cc product_queries_util.h) target_link_libraries(run_tests Threads::Threads gRPC::grpc++ gRPC::grpc++_reflection p3protolib) add_dependencies(run_tests p3protolib)
How You Are Going to Implement It ( Step-by-step )
1. Make sure you understand how GRPC- synchronous and asynchronous calls work. Understand the given helloworld example. You will be building your store with asynchronous mechanisms ONLY.
2. Establish asynchronous GRPC communication between Your store and user client.
Your store and the vendors.
3. Create your thread pool and use it. Where will you use it and for what? Upon receiving a client request, you store will assign a thread from the thread pool to the incoming request for processing.
The thread will make async RPC calls to the vendors
The thread will await for all results to come back
The thread will collate the results
The thread will reply to the store client with the results of the call
Having completed the work, the thread will return to the thread pool
4. Do you have your user client request reaching to the vendors now? And can you see the bids from the different vendors at your user client end? Congratulations you almost got it! Now use the test harness to test if your server can serve multiple clients concurrently and make sure that your thread handling is correct.
Keep In Mind
1. Your Server has to handle
2. Multiple concurrent requests from clients
3. Be stateless so far as client requests are concerned (once the client request is serviced it can forget the client)
4. Manage the connections to the client requests and the requests it makes to the 3rd party vendors.
5. Server will get the vendor addresses from a file with line separated strings
6. Your server should be able to accept command line input of the vendor addresses file, address on which it is going to expose its service and maximum number of threads its threadpool should have.
7. The format of the invocation is:
./store 5. Remember to add references to all the resources you have used while working on the project.
Given to You
1. run_tests.cc - This will simulate real world users sending concurrent product queries. This will be released soon to you.
2. client.cc - This will be providing ability to connect to the store as a user.
3. vendor.cc - This wil act as the server providing bids for different products. Multiple instances of it will be run listening on different ip address and port.
4. Two .proto files store.proto - Comm. protocol between user(client) and store(server) vendor.proto -Comm. protocol between store(client) and vendor(server)
How to run the test setup
Go to project3 directory and build the program.
Three binaries would be created in the bin folder - store,run_tests and run_vendors. (Note that the location of bin folder depends on how you build the program.)
First run the command ./run_vendors vendor_addresses.txt & to start a process which will run multiple servers on different threads listening to (ip_address:ports) from the file given as command line argument.
Then start up your store which will read the same address file to know vendors' listening addresses. Also, your store should start listening on a port(for clients to connect to) given as command line argument.
Then finally run the command ./run_tests $IP_and_port_on_which_store_is_listening
$max_num_concurrent_client_requests to start a process which will simulate real world clients sending requests at the same time.
This process read the queries from the file product_query_list.txt
It will send some queries and print back the results, which you can use to verify your whole system's flow.
Grading
This project is not performance oriented, we will only test the functionality and correctness.
Below is the rubric:
Total Possible Score: 12
| Score | Reason | | ----- | ------ | | +2 | Code compiles | | +4 | Query output is correct | | +3 | Threadpool management | | +1 | store-server operates in async fashion | | +1 | store-client operates in async fashion | | +1 | Readme |
Deliverables
Submission Directory Structure:
Readme.txt src/CMakeLists.txt src/store.cc src/threadpool.h src/any_additional_supporting_files.*
You must use the collect_submission.py to create the submission zip file. Submit the zip file in gradescope. You can verify your submission using the autograder in gradescope.
FAQ
FAQ can be found here.
1 file (870.4KB)
