libamxb  4.8.2
Bus Agnostic C API
amxb_ba_op_add.c
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 
55 #ifndef _GNU_SOURCE
56 #define _GNU_SOURCE
57 #endif
58 
59 #include <stdlib.h>
60 #include <stdio.h>
61 #include <errno.h>
62 #include <fcntl.h>
63 #include <string.h>
64 
65 #include <amxc/amxc.h>
66 #include <amxp/amxp.h>
67 
68 #include <amxd/amxd_common.h>
69 #include <amxd/amxd_dm.h>
70 #include <amxd/amxd_path.h>
71 #include <amxd/amxd_object.h>
72 
73 #include <amxb/amxb_be_intf.h>
74 #include <amxb/amxb.h>
75 
76 #include "amxb_priv.h"
77 
79  const char* object,
80  const char* rel_path,
81  uint32_t index,
82  const char* name,
83  amxc_var_t* values,
84  amxc_var_t* ret,
85  int timeout) {
86  amxb_invoke_t* invoke_ctx = NULL;
87  amxc_var_t args;
88  amxc_var_t* params = NULL;
89  int retval = amxd_status_unknown_error;
90 
91  amxc_var_init(&args);
92  amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
93 
94  if((rel_path != NULL) && (*rel_path != 0)) {
95  amxc_var_add_key(cstring_t, &args, "rel_path", rel_path);
96  }
97 
98  amxc_var_add_key(uint32_t, &args, "index", index);
99  amxc_var_add_key(cstring_t, &args, "name", name);
100  params = amxc_var_add_key(amxc_htable_t, &args, "parameters", NULL);
101  amxc_var_move(params, values);
102  amxc_var_add_key(uint32_t, &args, "access", bus_ctx->access);
103 
104  retval = amxb_new_invoke(&invoke_ctx, bus_ctx, object, NULL, "_add");
105  when_failed(retval, exit);
106  retval = amxb_invoke(invoke_ctx, &args, ret, NULL, NULL, timeout);
107  when_failed(retval, exit);
108 
109 exit:
110  amxc_var_clean(&args);
111  amxb_free_invoke(&invoke_ctx);
112  return retval;
113 }
114 
116  const char* object,
117  uint32_t index,
118  const char* name,
119  amxc_var_t* values,
120  amxc_var_t* ret,
121  int timeout) {
122  int retval = amxd_status_unknown_error;
123  const amxb_be_funcs_t* fns = NULL;
124  bool lobject = false;
125  amxd_path_t path;
126  char* fixed = NULL;
127  const char* rel_path = NULL;
128 
129  amxd_path_init(&path, NULL);
130  when_null(bus_ctx, exit);
131  when_null(bus_ctx->bus_ctx, exit);
132 
133  amxd_path_setf(&path, true, "%s", object);
134 
135  while(amxd_path_get_type(&path) == amxd_path_reference) {
136  retval = amxb_follow_reference(bus_ctx, &path, timeout);
137  when_failed(retval, exit);
138  }
139 
140  fixed = amxd_path_get_fixed_part(&path, true);
141  rel_path = amxd_path_get(&path, AMXD_OBJECT_TERMINATE);
142 
143  lobject = amxb_is_local_object(bus_ctx, fixed);
144  fns = bus_ctx->bus_fn;
145 
146  if(amxc_var_is_null(values)) {
147  amxc_var_set_type(values, AMXC_VAR_ID_HTABLE);
148  }
149 
150  if(lobject || !amxb_is_valid_be_func(fns, add, fns->add)) {
151  retval = amxb_invoke_add(bus_ctx, fixed, rel_path, index,
152  name, values, ret, timeout);
153  } else {
154  retval = fns->add(bus_ctx->bus_ctx, fixed, rel_path, index,
155  name, values, bus_ctx->access, ret, timeout);
156  }
157 
158 exit:
159  free(fixed);
160  amxd_path_clean(&path);
161  return retval;
162 }
Ambiorix bus agnostic API header file.
static int amxb_invoke_add(amxb_bus_ctx_t *const bus_ctx, const char *object, const char *rel_path, uint32_t index, const char *name, amxc_var_t *values, amxc_var_t *ret, int timeout)
Ambiorix Bus Backend Interface.
#define amxb_is_valid_be_func(ft, member, ptr)
Definition: amxb_priv.h:78
int PRIVATE amxb_follow_reference(amxb_bus_ctx_t *const bus_ctx, amxd_path_t *reference, int timeout)
Definition: amxb_ba_priv.c:116
bool PRIVATE amxb_is_local_object(amxb_bus_ctx_t *ctx, const char *obj_path)
Definition: amxb_ba_priv.c:94
int amxb_new_invoke(amxb_invoke_t **invoke_ctx, amxb_bus_ctx_t *const ctx, const char *object, const char *interface, const char *method)
Prepares a remote function invocation.
void amxb_free_invoke(amxb_invoke_t **invoke_ctx)
Deletes a function invoke context, and frees allocated memory.
int amxb_invoke(amxb_invoke_t *invoke_ctx, amxc_var_t *args, amxc_var_t *ret, amxb_be_cb_fn_t fn, void *priv, int timeout)
Invokes a remote function, as defined by the function invoke context.
int amxb_add(amxb_bus_ctx_t *const bus_ctx, const char *object, uint32_t index, const char *name, amxc_var_t *values, amxc_var_t *ret, int timeout)
Adds an instance to a multi-instance object.
The back-end interface structure.
amxb_be_add_t add
const amxb_be_funcs_t * bus_fn
Definition: amxb_types.h:121
uint32_t access
Definition: amxb_types.h:125
void * bus_ctx
Definition: amxb_types.h:122
static amxb_bus_ctx_t * bus_ctx
Definition: test_amxb_e2e.c:84