dss_internal.h

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

    int orte_dss_peek_type(orte_buffer_t *buffer, orte_data_type_t *type);

    int orte_dss_unload(orte_buffer_t *buffer, void **payload,
                        orte_std_cntr_t *bytes_used);
    int orte_dss_load(orte_buffer_t *buffer, void *payload, orte_std_cntr_t bytes_used);

    int orte_dss_register(orte_dss_pack_fn_t pack_fn,
                          orte_dss_unpack_fn_t unpack_fn,
                          orte_dss_copy_fn_t copy_fn,
                          orte_dss_compare_fn_t compare_fn,
                          orte_dss_size_fn_t size_fn,
                          orte_dss_print_fn_t print_fn,
                          orte_dss_release_fn_t release_fn,
                          bool structured,
                          const char *name, orte_data_type_t *type);

    void orte_dss_release(orte_data_value_t *value);

    char *orte_dss_lookup_data_type(orte_data_type_t type);

    void orte_dss_dump_data_types(int output);

    /*
     * Non-API functions
     */
    int orte_dss_pack_buffer(orte_buffer_t *buffer, void *src, orte_std_cntr_t num_vals,
                  orte_data_type_t type);

    int orte_dss_unpack_buffer(orte_buffer_t *buffer, void *dst, orte_std_cntr_t *num_vals,
                    orte_data_type_t type);

    /*
     * Internal pack functions
     */

    int orte_dss_pack_null(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);
    int orte_dss_pack_byte(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_bool(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_int(orte_buffer_t *buffer, void *src,
                          orte_std_cntr_t num_vals, orte_data_type_t type);
    int orte_dss_pack_int16(orte_buffer_t *buffer, void *src,
                            orte_std_cntr_t num_vals, orte_data_type_t type);
    int orte_dss_pack_int32(orte_buffer_t *buffer, void *src,
                            orte_std_cntr_t num_vals, orte_data_type_t type);
    int orte_dss_pack_int64(orte_buffer_t *buffer, void *src,
                            orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_sizet(orte_buffer_t *buffer, void *src,
                            orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_pid(orte_buffer_t *buffer, void *src,
                          orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_string(orte_buffer_t *buffer, void *src,
                             orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_std_cntr(orte_buffer_t *buffer, void *src, orte_std_cntr_t num,
                               orte_data_type_t type);

    int orte_dss_pack_data_type(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_data_value(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);

    int orte_dss_pack_byte_object(orte_buffer_t *buffer, void *src,
                           orte_std_cntr_t num_vals, orte_data_type_t type);

    /*
     * Internal unpack functions
     */

    int orte_dss_unpack_null(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);
    int orte_dss_unpack_byte(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_bool(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_int(orte_buffer_t *buffer, void *dest,
                            orte_std_cntr_t *num_vals, orte_data_type_t type);
    int orte_dss_unpack_int16(orte_buffer_t *buffer, void *dest,
                              orte_std_cntr_t *num_vals, orte_data_type_t type);
    int orte_dss_unpack_int32(orte_buffer_t *buffer, void *dest,
                              orte_std_cntr_t *num_vals, orte_data_type_t type);
    int orte_dss_unpack_int64(orte_buffer_t *buffer, void *dest,
                              orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_sizet(orte_buffer_t *buffer, void *dest,
                              orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_pid(orte_buffer_t *buffer, void *dest,
                            orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_string(orte_buffer_t *buffer, void *dest,
                               orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_std_cntr(orte_buffer_t *buffer, void *dest, orte_std_cntr_t *num,
                             orte_data_type_t type);

    int orte_dss_unpack_data_type(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_data_value(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);

    int orte_dss_unpack_byte_object(orte_buffer_t *buffer, void *dest,
                             orte_std_cntr_t *num_vals, orte_data_type_t type);

    /*
     * Internal copy functions
     */

    int orte_dss_std_copy(void **dest, void *src, orte_data_type_t type);

    int orte_dss_copy_null(char **dest, char *src, orte_data_type_t type);

    int orte_dss_copy_string(char **dest, char *src, orte_data_type_t type);

    int orte_dss_copy_byte_object(orte_byte_object_t **dest, orte_byte_object_t *src,
                                  orte_data_type_t type);

    int orte_dss_copy_data_value(orte_data_value_t **dest, orte_data_value_t *src,
                                  orte_data_type_t type);
    /*
     * Internal compare functions
     */

    int orte_dss_compare_bool(bool *value1, bool *value2, orte_data_type_t type);

    int orte_dss_compare_int(int *value1, int *value2, orte_data_type_t type);
    int orte_dss_compare_uint(uint *value1, uint *value2, orte_data_type_t type);

    int orte_dss_compare_size(size_t *value1, size_t *value2, orte_data_type_t type);

    int orte_dss_compare_pid(pid_t *value1, pid_t *value2, orte_data_type_t type);

    int orte_dss_compare_byte(char *value1, char *value2, orte_data_type_t type);
    int orte_dss_compare_char(char *value1, char *value2, orte_data_type_t type);
    int orte_dss_compare_int8(int8_t *value1, int8_t *value2, orte_data_type_t type);
    int orte_dss_compare_uint8(uint8_t *value1, uint8_t *value2, orte_data_type_t type);

    int orte_dss_compare_int16(int16_t *value1, int16_t *value2, orte_data_type_t type);
    int orte_dss_compare_uint16(uint16_t *value1, uint16_t *value2, orte_data_type_t type);

    int orte_dss_compare_int32(int32_t *value1, int32_t *value2, orte_data_type_t type);
    int orte_dss_compare_uint32(uint32_t *value1, uint32_t *value2, orte_data_type_t type);

    int orte_dss_compare_int64(int64_t *value1, int64_t *value2, orte_data_type_t type);
    int orte_dss_compare_uint64(uint64_t *value1, uint64_t *value2, orte_data_type_t type);

    int orte_dss_compare_null(char *value1, char *value2, orte_data_type_t type);

    int orte_dss_compare_string(char *value1, char *value2, orte_data_type_t type);

    int orte_dss_compare_std_cntr(orte_std_cntr_t *value1, orte_std_cntr_t *value2, orte_data_type_t type);

    int orte_dss_compare_dt(orte_data_type_t *value1, orte_data_type_t *value2, orte_data_type_t type);

    int orte_dss_compare_data_value(orte_data_value_t *value1, orte_data_value_t *value2, orte_data_type_t type);

    int orte_dss_compare_byte_object(orte_byte_object_t *value1, orte_byte_object_t *value2, orte_data_type_t type);

    /*
    * Internal size functions
    */
    int orte_dss_std_size(size_t *size, void *src, orte_data_type_t type);

    int orte_dss_size_string(size_t *size, char *src, orte_data_type_t type);

    int orte_dss_size_data_value(size_t *size, orte_data_value_t *src, orte_data_type_t type);

    int orte_dss_size_byte_object(size_t *size, orte_byte_object_t *src, orte_data_type_t type);

    /*
    * Internal print functions
    */
    int orte_dss_print_byte(char **output, char *prefix, uint8_t *src, orte_data_type_t type);

    int orte_dss_print_string(char **output, char *prefix, char *src, orte_data_type_t type);

    int orte_dss_print_size(char **output, char *prefix, size_t *src, orte_data_type_t type);
    int orte_dss_print_pid(char **output, char *prefix, pid_t *src, orte_data_type_t type);
    int orte_dss_print_bool(char **output, char *prefix, bool *src, orte_data_type_t type);
    int orte_dss_print_int(char **output, char *prefix, int *src, orte_data_type_t type);
    int orte_dss_print_uint(char **output, char *prefix, int *src, orte_data_type_t type);
    int orte_dss_print_uint8(char **output, char *prefix, uint8_t *src, orte_data_type_t type);
    int orte_dss_print_uint16(char **output, char *prefix, uint16_t *src, orte_data_type_t type);
    int orte_dss_print_uint32(char **output, char *prefix, uint32_t *src, orte_data_type_t type);
    int orte_dss_print_int8(char **output, char *prefix, int8_t *src, orte_data_type_t type);
    int orte_dss_print_int16(char **output, char *prefix, int16_t *src, orte_data_type_t type);
    int orte_dss_print_int32(char **output, char *prefix, int32_t *src, orte_data_type_t type);
#ifdef HAVE_INT64_T
    int orte_dss_print_uint64(char **output, char *prefix, uint64_t *src, orte_data_type_t type);
    int orte_dss_print_int64(char **output, char *prefix, int64_t *src, orte_data_type_t type);
#else
    int orte_dss_print_uint64(char **output, char *prefix, void *src, orte_data_type_t type);
    int orte_dss_print_int64(char **output, char *prefix, void *src, orte_data_type_t type);
#endif
    int orte_dss_print_null(char **output, char *prefix, void *src, orte_data_type_t type);
    int orte_dss_print_std_cntr(char **output, char *prefix, orte_std_cntr_t *src, orte_data_type_t type);
    int orte_dss_print_data_type(char **output, char *prefix, orte_data_type_t *src, orte_data_type_t type);
    int orte_dss_print_data_value(char **output, char *prefix, orte_data_value_t *src, orte_data_type_t type);
    int orte_dss_print_byte_object(char **output, char *prefix, orte_byte_object_t *src, orte_data_type_t type);


    /*
    * Internal release functions
    */
    void orte_dss_std_release(orte_data_value_t *value);

    void orte_dss_std_obj_release(orte_data_value_t *value);

    void orte_dss_release_byte_object(orte_data_value_t *value);

    /*
     * Internal helper functions
     */

    char* orte_dss_buffer_extend(orte_buffer_t *bptr, size_t bytes_to_add);

    bool orte_dss_too_small(orte_buffer_t *buffer, size_t bytes_reqd);

    orte_dss_type_info_t* orte_dss_find_type(orte_data_type_t type);

    int orte_dss_store_data_type(orte_buffer_t *buffer, orte_data_type_t type);

    int orte_dss_get_data_type(orte_buffer_t *buffer, orte_data_type_t *type);

#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif