ctrl_runtime_messages.h

Go to the documentation of this file.

/*
START OF LICENSE STUB
    DeDOS: Declarative Dispersion-Oriented Software
    Copyright (C) 2017 University of Pennsylvania, Georgetown University

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
END OF LICENSE STUB
*/
#ifndef CTRL_RUNTIME_MESSAGES_H_
#define CTRL_RUNTIME_MESSAGES_H_
#include "dfg.h"

#include <unistd.h>
#include <stdbool.h>

enum ctrl_runtime_msg_type {

    // These first messages are meant for delivery to the main thread
    CTRL_CONNECT_TO_RUNTIME, 
    CTRL_CREATE_THREAD,      
    CTRL_DELETE_THREAD,      
    CTRL_MODIFY_ROUTE,       
    // TODO: CTRL_REPORT: a message type for requesting runtime status

    // These messages are meant for delivery to worker threads for MSUs
    CTRL_CREATE_MSU,    
    CTRL_DELETE_MSU,    
    CTRL_MSU_ROUTES     
};

struct ctrl_runtime_msg_hdr {
    enum ctrl_runtime_msg_type type; 
    int id;              
                         // TODO: implement confirmation based on ID of sent message
    int thread_id;       
    size_t payload_size; 
};


// Main thread messages

struct ctrl_add_runtime_msg {
    unsigned int runtime_id; 
    uint32_t ip; 
    int port;    
};

struct ctrl_create_thread_msg {
    int thread_id; 
    enum blocking_mode mode; 
    // TODO: Change blocking_mode to thread_mode
};

struct ctrl_delete_thread_msg {
    int thread_id; 
};

enum ctrl_route_msg_type {
    CREATE_ROUTE, 
    DELETE_ROUTE, 
    ADD_ENDPOINT, 
    DEL_ENDPOINT, 
    MOD_ENDPOINT  
};

struct ctrl_route_msg {
    enum ctrl_route_msg_type type; 
    int route_id;   
    int type_id;    
    int msu_id;     
    int key;        /*<< Key to associate with a route endpoint.
                         Neccessary for subtypes ::ADD_ENDPOINT, ::MOD_ENDPOINT */
    unsigned int runtime_id; /*<< Id of runtime on which endpoint is located.
                                  Neccessary for subtype ::ADD_ENDPOINT */
};

// Worker thread messages

struct ctrl_create_msu_msg {
    int msu_id;     
    int type_id;    
    struct msu_init_data init_data; 
    // TODO: Replace init_data with payload of variable size
};

struct ctrl_delete_msu_msg {
    bool force; 
    int msu_id; 
};

enum ctrl_msu_route_type {
    ADD_ROUTE, 
    DEL_ROUTE  
};

struct ctrl_msu_route_msg {
    enum ctrl_msu_route_type type; 
    int route_id; 
    int msu_id;   
};

#endif