ipc.h

Go to the documentation of this file.

#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#include<libtransistor/types.h>

struct ipc_server_object_t;

typedef struct {
    session_h session;
} ipc_domain_t;

typedef struct {
    int32_t object_id; 
    union {
        session_h session; 
        ipc_domain_t *domain; 
    };
    bool is_borrowed; 
} ipc_object_t;

typedef struct ipc_multi_session_node_t ipc_multi_session_node_t;
struct ipc_multi_session_node_t {
    ipc_multi_session_node_t *prev;
    ipc_multi_session_node_t *_Atomic next;
    ipc_object_t object;
    _Atomic _Bool is_busy;
};

typedef struct {
    ipc_object_t original;
    ipc_multi_session_node_t first;
} ipc_multi_session_t;

typedef struct {
    void *addr;
    uint64_t size; 
    uint32_t type;
} ipc_buffer_t;

typedef struct {
    uint32_t type;
    uint32_t num_buffers;
    ipc_buffer_t **buffers; 
    uint32_t request_id;
    void *raw_data;
    size_t raw_data_size; 
    bool send_pid;
    uint8_t num_copy_handles;
    uint8_t num_move_handles;
    uint8_t num_objects;
    handle_t *copy_handles; 
    handle_t *move_handles; 
    ipc_object_t *objects; 
    bool close_object; 
} ipc_request_t;

typedef struct {
    uint32_t num_buffers; 
    ipc_buffer_t **buffers; 
    void *raw_data; 
    size_t raw_data_size; 
    bool send_pid; 
    uint64_t *pid; 
    uint8_t num_copy_handles; 
    uint8_t num_move_handles; 
    uint8_t num_objects; 
    handle_t *copy_handles; 
    handle_t *move_handles; 
    struct ipc_server_object_t **objects; 
} ipc_request_fmt_t;

typedef struct {
    uint32_t type;
    uint32_t num_buffers;
    ipc_buffer_t **buffers;
    result_t result_code;
    void *raw_data;
    size_t raw_data_size; // in BYTES
    bool send_pid;
    uint8_t num_copy_handles;
    uint8_t num_move_handles;
    uint8_t num_objects;
    handle_t *copy_handles;
    handle_t *move_handles;
    struct ipc_server_object_t **objects;
} ipc_response_t;

typedef struct {
    uint32_t num_copy_handles;
    uint32_t num_move_handles;
    uint32_t num_objects;
    handle_t *copy_handles;
    handle_t *move_handles;
    ipc_object_t *objects;
  
    size_t raw_data_size; 
    void *raw_data;

    bool has_pid;
    uint64_t *pid;
} ipc_response_fmt_t;

extern ipc_request_t      ipc_default_request;

extern ipc_response_t     ipc_default_response;

extern ipc_request_fmt_t  ipc_default_request_fmt;

extern ipc_response_fmt_t ipc_default_response_fmt;

extern ipc_object_t       ipc_null_object;

typedef enum {
    IPC_DEBUG_LEVEL_NONE, 
    IPC_DEBUG_LEVEL_UNPACKING_ERRORS, 
    IPC_DEBUG_LEVEL_UNFLATTENING_ERRORS, 
    IPC_DEBUG_LEVEL_FLIGHT_ERRORS, 
    IPC_DEBUG_LEVEL_ALL, 
} ipc_debug_level_t;

extern ipc_debug_level_t ipc_debug_level; 

typedef struct {
    uint16_t message_type;
    uint32_t raw_data_section_size; 
    uint32_t num_x_descriptors;
    uint32_t num_a_descriptors;
    uint32_t num_b_descriptors;
    uint32_t num_w_descriptors;
    uint32_t c_descriptor_flags;
    uint32_t *x_descriptors;
    uint32_t *a_descriptors;
    uint32_t *b_descriptors;
    uint32_t *w_descriptors;
    uint32_t *c_descriptors;
    uint32_t num_copy_handles;
    uint32_t num_move_handles;
    handle_t *copy_handles; 
    handle_t *move_handles; 
    bool has_pid;
    uint64_t pid;
    int pre_padding; 
    int post_padding; 
    uint32_t *data_section; 
} ipc_message_t;

result_t ipc_pack_request(uint32_t *buffer, const ipc_request_t *rq, ipc_object_t object);

result_t ipc_pack_response(uint32_t *buffer, const ipc_response_t *rs, struct ipc_server_object_t *object);

result_t ipc_unpack(uint32_t *buffer, ipc_message_t *msg);

result_t ipc_unflatten_request(ipc_message_t *msg, ipc_request_fmt_t *rs, struct ipc_server_object_t *object);

result_t ipc_unflatten_response(ipc_message_t *msg, ipc_response_fmt_t *rs, ipc_object_t object);

result_t ipc_send(ipc_object_t object, ipc_request_t *rq, ipc_response_fmt_t *rs);

result_t ipc_send_multi(ipc_multi_session_t *multi, ipc_request_t *rq, ipc_response_fmt_t *rs);

result_t ipc_convert_to_domain(ipc_object_t *session, ipc_domain_t *domain);

result_t ipc_convert_to_multi(ipc_multi_session_t *multi, ipc_object_t *object);

result_t ipc_clone_current_object(ipc_object_t source, ipc_object_t *clone);

result_t ipc_close(ipc_object_t object);

result_t ipc_close_domain(ipc_domain_t domain);

result_t ipc_close_multi(ipc_multi_session_t *multi);

#ifdef __cplusplus
}
#endif