amxd_transaction.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** Redistribution and use in source and binary forms, with or without modification,
** are permitted provided that the following conditions are met:
**
** 1. Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
**
** 2. Redistributions in binary form must reproduce the above copyright notice,
** this list of conditions and the following disclaimer in the documentation
** and/or other materials provided with the distribution.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
****************************************************************************/
 
#if !defined(__AMXD_TRANSACTION_H__)
#define __AMXD_TRANSACTION_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxd/amxd_types.h>
 
typedef enum _amxd_tattr_id {
    amxd_tattr_change_ro,           
    amxd_tattr_change_pub,          
    amxd_tattr_change_prot,         
    amxd_tattr_change_priv,         
} amxd_tattr_id_t;
 
typedef struct _amxd_trans_attr {
    uint32_t read_only : 1;         // can change read-only parameters
} amxd_trans_attr_t;
 
typedef struct _amxd_trans_action {
    amxc_llist_it_t it;
    amxd_action_t action;
    amxc_var_t data;
} amxd_trans_action_t;
 
typedef struct _amxd_transaction {
    amxc_llist_t actions;           // list of actions to do when transaction is applied
    amxc_llist_t validate;          // objects or object trees that needs validation
    amxc_llist_t garbage;           // list of objects that need to be destroyed when transaction is done
    amxd_object_t* current;         // current selected object
    amxd_trans_attr_t attr;         // transaction attributes
    amxd_dm_access_t access;        // transaction access
    amxc_var_t retvals;             // list of return values of actions
    amxd_status_t status;           // transaction status code
    int fail_index;                 // index of failed action
} amxd_trans_t;
 
#define amxd_trans_set_value(type, trans, name, value) \
    amxd_trans_set_ ## type(trans, name, value)
 
amxd_status_t amxd_trans_init(amxd_trans_t* const trans);
 
void amxd_trans_clean(amxd_trans_t* const trans);
 
amxd_status_t amxd_trans_new(amxd_trans_t** trans);
 
void amxd_trans_delete(amxd_trans_t** trans);
 
amxd_status_t amxd_trans_set_attr(amxd_trans_t* trans,
                                  amxd_tattr_id_t attr,
                                  bool enable);
 
amxd_status_t amxd_trans_add_action(amxd_trans_t* const trans,
                                    const amxd_action_t reason,
                                    const amxc_var_t* data);
 
amxd_status_t amxd_trans_select_pathf(amxd_trans_t* const trans,
                                      const char* path,
                                      ...) __attribute__ ((format(printf, 2, 3)));
 
amxd_status_t amxd_trans_select_object(amxd_trans_t* trans,
                                       const amxd_object_t* const object);
 
amxd_status_t amxd_trans_set_param(amxd_trans_t* const trans,
                                   const char* param_name,
                                   amxc_var_t* const value);
 
amxd_status_t amxd_trans_add_inst(amxd_trans_t* const trans,
                                  const uint32_t index,
                                  const char* name);
 
amxd_status_t amxd_trans_del_inst(amxd_trans_t* const trans,
                                  const uint32_t index,
                                  const char* name);
 
amxd_status_t amxd_trans_add_mib(amxd_trans_t* const trans,
                                 const char* mib_name);
 
amxd_status_t amxd_trans_apply(amxd_trans_t* const trans,
                               amxd_dm_t* const dm);
 
void amxd_trans_dump(const amxd_trans_t* const trans,
                     const int fd,
                     const bool reverse);
 
// helper functions
static inline
amxd_status_t amxd_trans_set_cstring_t(amxd_trans_t* const trans,
                                       const char* name,
                                       const char* value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(cstring_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_csv_string_t(amxd_trans_t* const trans,
                                          const char* name,
                                          const char* value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(csv_string_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_ssv_string_t(amxd_trans_t* const trans,
                                          const char* name,
                                          const char* value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(ssv_string_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_bool(amxd_trans_t* const trans,
                                  const char* name,
                                  bool value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(bool, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_int8_t(amxd_trans_t* const trans,
                                    const char* name,
                                    int8_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int8_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_uint8_t(amxd_trans_t* const trans,
                                     const char* name,
                                     uint8_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint8_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_int16_t(amxd_trans_t* const trans,
                                     const char* name,
                                     int16_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int16_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_uint16_t(amxd_trans_t* const trans,
                                      const char* name,
                                      uint16_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint16_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_int32_t(amxd_trans_t* const trans,
                                     const char* name,
                                     int32_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int32_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_uint32_t(amxd_trans_t* const trans,
                                      const char* name,
                                      uint32_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint32_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_int64_t(amxd_trans_t* const trans,
                                     const char* name,
                                     int64_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int64_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_uint64_t(amxd_trans_t* const trans,
                                      const char* name,
                                      uint64_t value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint64_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_double(amxd_trans_t* const trans,
                                    const char* name,
                                    double value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(double, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
static inline
amxd_status_t amxd_trans_set_amxc_ts_t(amxd_trans_t* const trans,
                                       const char* name,
                                       amxc_ts_t* value) {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(amxc_ts_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXD_TRANSACTION_H__