/**************************************************************************** * * Copyright (c) 2015 Vijay Venkatraman. All rights reserved. * * 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. * 3. Neither the name PX4 nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * 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 OWNER 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. * ****************************************************************************/ /** * @file param.c * * Global parameter store. * * Note that it might make sense to convert this into a driver. That would * offer some interesting options regarding state for e.g. ORB advertisements * and background parameter saving. */ //#include #include #include #include #include #include #include #include #include #include #include #include #include #include "systemlib/param/param.h" #include "systemlib/uthash/utarray.h" #include "systemlib/bson/tinybson.h" #include "uORB/uORB.h" #include "uORB/topics/parameter_update.h" #include "px4_parameters.h" #include #include "shmem.h" #define debug(fmt, args...) do { } while(0) #ifdef __PX4_QURT //Mode not supported by qurt #define PARAM_OPEN(a, b, ...) open(a, b) #else #define PARAM_OPEN open #endif #define PARAM_CLOSE close /** * Array of static parameter info. */ #ifdef _UNIT_TEST extern struct param_info_s param_array[]; extern struct param_info_s *param_info_base; extern struct param_info_s *param_info_limit; #else static struct param_info_s *param_info_base = (struct param_info_s *) &px4_parameters; #endif #define param_info_count px4_parameters.param_count /** * Storage for modified parameters. */ struct param_wbuf_s { param_t param; union param_value_u val; bool unsaved; }; uint8_t *param_changed_storage = 0; int size_param_changed_storage_bytes = 0; const int bits_per_allocation_unit = (sizeof(*param_changed_storage) * 8); //#define ENABLE_SHMEM_DEBUG extern int get_shmem_lock(const char *caller_file_name, int caller_line_number); extern void release_shmem_lock(void); struct param_wbuf_s *param_find_changed(param_t param); void init_params(void); extern void init_shared_memory(void); extern void copy_params_to_shmem(struct param_info_s *param_info_base); extern struct shmem_info *shmem_info_p; uint64_t sync_other_prev_time = 0, sync_other_current_time = 0; extern void update_to_shmem(param_t param, union param_value_u value); extern int update_from_shmem(param_t param, union param_value_u *value); static int param_set_internal(param_t param, const void *val, bool mark_saved, bool notify_changes, bool is_saved); unsigned char set_called_from_get = 0; static int param_import_done = 0; /*at startup, params are loaded from file, if present. we dont want to send notifications that time since muorb is not ready*/ static int param_load_default_no_notify(void); static unsigned get_param_info_count(void) { /* Singleton creation of and array of bits to track changed values */ if (!param_changed_storage) { size_param_changed_storage_bytes = (param_info_count / bits_per_allocation_unit) + 1; param_changed_storage = calloc(size_param_changed_storage_bytes, 1); /* If the allocation fails we need to indicate failure in the * API by returning PARAM_INVALID */ if (param_changed_storage == NULL) { return 0; } } return param_info_count; } /** flexible array holding modified parameter values */ UT_array *param_values; /** array info for the modified parameters array */ const UT_icd param_icd = {sizeof(struct param_wbuf_s), NULL, NULL, NULL}; /** parameter update topic */ ORB_DEFINE(parameter_update, struct parameter_update_s); /** parameter update topic handle */ static orb_advert_t param_topic = NULL; static void param_set_used_internal(param_t param); static param_t param_find_internal(const char *name, bool notification); /** lock the parameter store */ static void param_lock(void) { //do {} while (px4_sem_wait(¶m_sem) != 0); } /** unlock the parameter store */ static void param_unlock(void) { //px4_sem_post(¶m_sem); } /** assert that the parameter store is locked */ static void param_assert_locked(void) { /* TODO */ } /** * Test whether a param_t is value. * * @param param The parameter handle to test. * @return True if the handle is valid. */ bool handle_in_range(param_t param) { int count = get_param_info_count(); return (count && param < count); } /** * Compare two modifid parameter structures to determine ordering. * * This function is suitable for passing to qsort or bsearch. */ static int param_compare_values(const void *a, const void *b) { struct param_wbuf_s *pa = (struct param_wbuf_s *)a; struct param_wbuf_s *pb = (struct param_wbuf_s *)b; if (pa->param < pb->param) { return -1; } if (pa->param > pb->param) { return 1; } return 0; } /** * Locate the modified parameter structure for a parameter, if it exists. * * @param param The parameter being searched. * @return The structure holding the modified value, or * NULL if the parameter has not been modified. */ struct param_wbuf_s * param_find_changed(param_t param) { struct param_wbuf_s *s = NULL; param_assert_locked(); if (param_values != NULL) { while ((s = (struct param_wbuf_s *)utarray_next(param_values, s)) != NULL) { if (s->param == param) { break; } } } return s; } static void param_notify_changes(bool is_saved) { struct parameter_update_s pup = { .timestamp = hrt_absolute_time(), .saved = is_saved }; /* * If we don't have a handle to our topic, create one now; otherwise * just publish. */ if (param_topic == NULL) { param_topic = orb_advertise(ORB_ID(parameter_update), &pup); } else { orb_publish(ORB_ID(parameter_update), param_topic, &pup); } } param_t param_find_internal(const char *name, bool notification) { param_t param; /* perform a linear search of the known parameters */ for (param = 0; handle_in_range(param); param++) { if (!strcmp(param_info_base[param].name, name)) { if (notification) { param_set_used_internal(param); } return param; } } /* not found */ return PARAM_INVALID; } param_t param_find(const char *name) { return param_find_internal(name, true); } param_t param_find_no_notification(const char *name) { return param_find_internal(name, false); } unsigned param_count(void) { return get_param_info_count(); } unsigned param_count_used(void) { //TODO FIXME: all params used right now #if 0 unsigned count = 0; // ensure the allocation has been done if (get_param_info_count()) { for (unsigned i = 0; i < size_param_changed_storage_bytes; i++) { for (unsigned j = 0; j < bits_per_allocation_unit; j++) { if (param_changed_storage[i] & (1 << j)) { count++; } } } } return count; #else return get_param_info_count(); #endif } param_t param_for_index(unsigned index) { unsigned count = get_param_info_count(); if (count && index < count) { return (param_t)index; } return PARAM_INVALID; } param_t param_for_used_index(unsigned index) { #if 0 int count = get_param_info_count(); if (count && index < count) { /* walk all params and count used params */ unsigned used_count = 0; for (unsigned i = 0; i < (unsigned)size_param_changed_storage_bytes; i++) { for (unsigned j = 0; j < bits_per_allocation_unit; j++) { if (param_changed_storage[i] & (1 << j)) { /* we found the right used count, * return the param value */ if (index == used_count) { return (param_t)(i * bits_per_allocation_unit + j); } used_count++; } } } } return PARAM_INVALID; #else return param_for_index(index); #endif } int param_get_index(param_t param) { if (handle_in_range(param)) { return (unsigned)param; } return -1; } int param_get_used_index(param_t param) { // TODO FIXME: the used bit is not supported right now, therefore just count all. #if 0 /* this tests for out of bounds and does a constant time lookup */ if (!param_used(param)) { return -1; } /* walk all params and count, now knowing that it has a valid index */ int used_count = 0; for (unsigned i = 0; i < (unsigned)size_param_changed_storage_bytes; i++) { for (unsigned j = 0; j < bits_per_allocation_unit; j++) { if (param_changed_storage[i] & (1 << j)) { if ((unsigned)param == i * bits_per_allocation_unit + j) { return used_count; } used_count++; } } } return -1; #else return param; #endif } const char * param_name(param_t param) { return handle_in_range(param) ? param_info_base[param].name : NULL; } bool param_value_is_default(param_t param) { return param_find_changed(param) ? false : true; } bool param_value_unsaved(param_t param) { static struct param_wbuf_s *s; s = param_find_changed(param); return (s && s->unsaved) ? true : false; } enum param_type_e param_type(param_t param) { return handle_in_range(param) ? param_info_base[param].type : PARAM_TYPE_UNKNOWN; } size_t param_size(param_t param) { if (handle_in_range(param)) { switch (param_type(param)) { case PARAM_TYPE_INT32: case PARAM_TYPE_FLOAT: return 4; case PARAM_TYPE_STRUCT ... PARAM_TYPE_STRUCT_MAX: /* decode structure size from type value */ return param_type(param) - PARAM_TYPE_STRUCT; default: return 0; } } return 0; } /** * Obtain a pointer to the storage allocated for a parameter. * * @param param The parameter whose storage is sought. * @return A pointer to the parameter value, or NULL * if the parameter does not exist. */ static const void * param_get_value_ptr(param_t param) { const void *result = NULL; param_assert_locked(); if (handle_in_range(param)) { const union param_value_u *v; /* work out whether we're fetching the default or a written value */ struct param_wbuf_s *s = param_find_changed(param); if (s != NULL) { v = &s->val; } else { v = ¶m_info_base[param].val; } if (param_type(param) >= PARAM_TYPE_STRUCT && param_type(param) <= PARAM_TYPE_STRUCT_MAX) { result = v->p; } else { result = v; } } return result; } int param_get(param_t param, void *val) { int result = -1; param_lock(); if (!handle_in_range(param)) { return result; } union param_value_u value; if (update_from_shmem(param, &value)) { set_called_from_get = 1; param_set_internal(param, &value, true, false, false); set_called_from_get = 0; } const void *v = param_get_value_ptr(param); if (val != NULL) { memcpy(val, v, param_size(param)); result = 0; } #ifdef ENABLE_SHMEM_DEBUG if (param_type(param) == PARAM_TYPE_INT32) { PX4_INFO("param_get for %s : %d", param_name(param), ((union param_value_u *)val)->i); } else if (param_type(param) == PARAM_TYPE_FLOAT) { PX4_INFO("param_get for %s : %f", param_name(param), (double)((union param_value_u *)val)->f); } else { PX4_INFO("Unknown param type for %s", param_name(param)); } #endif param_unlock(); return result; } static int param_set_internal(param_t param, const void *val, bool mark_saved, bool notify_changes, bool is_saved) { int result = -1; bool params_changed = false; PX4_DEBUG("param_set_internal params: param = %d, val = 0x%X, mark_saved: %d, notify_changes: %d", param, val, (int)mark_saved, (int)notify_changes); param_lock(); if (!handle_in_range(param)) { return result; } mark_saved = true; //mark all params as saved if (param_values == NULL) { utarray_new(param_values, ¶m_icd); } if (param_values == NULL) { debug("failed to allocate modified values array"); goto out; } if (handle_in_range(param)) { struct param_wbuf_s *s = param_find_changed(param); if (s == NULL) { /* construct a new parameter */ struct param_wbuf_s buf = { .param = param, .val.p = NULL, .unsaved = false }; /* add it to the array and sort */ utarray_push_back(param_values, &buf); utarray_sort(param_values, param_compare_values); /* find it after sorting */ s = param_find_changed(param); } /* update the changed value */ switch (param_type(param)) { case PARAM_TYPE_INT32: s->val.i = *(int32_t *)val; break; case PARAM_TYPE_FLOAT: s->val.f = *(float *)val; break; case PARAM_TYPE_STRUCT ... PARAM_TYPE_STRUCT_MAX: if (s->val.p == NULL) { s->val.p = malloc(param_size(param)); if (s->val.p == NULL) { debug("failed to allocate parameter storage"); goto out; } } memcpy(s->val.p, val, param_size(param)); break; default: goto out; } s->unsaved = !mark_saved; params_changed = true; result = 0; } out: param_unlock(); /* * If we set something, now that we have unlocked, go ahead and advertise that * a thing has been set. */ if (!param_import_done) { notify_changes = 0; } if (params_changed && notify_changes) { param_notify_changes(is_saved); } if (result == 0 && !set_called_from_get) { update_to_shmem(param, *(union param_value_u *)val); } #ifdef ENABLE_SHMEM_DEBUG if (param_type(param) == PARAM_TYPE_INT32) { PX4_INFO("param_set for %s : %d", param_name(param), ((union param_value_u *)val)->i); } else if (param_type(param) == PARAM_TYPE_FLOAT) { PX4_INFO("param_set for %s : %f", param_name(param), (double)((union param_value_u *)val)->f); } else { PX4_INFO("Unknown param type for %s", param_name(param)); } #endif return result; } int param_set(param_t param, const void *val) { return param_set_internal(param, val, false, true, false); } int param_set_no_autosave(param_t param, const void *val) { return param_set_internal(param, val, false, true, true); } int param_set_no_notification(param_t param, const void *val) { return param_set_internal(param, val, false, false, false); } bool param_used(param_t param) { // TODO FIXME: for now all params are used return true; int param_index = param_get_index(param); if (param_index < 0) { return false; } return param_changed_storage[param_index / bits_per_allocation_unit] & (1 << param_index % bits_per_allocation_unit); } void param_set_used_internal(param_t param) { int param_index = param_get_index(param); if (param_index < 0) { return; } param_changed_storage[param_index / bits_per_allocation_unit] |= (1 << param_index % bits_per_allocation_unit); } int param_reset(param_t param) { struct param_wbuf_s *s = NULL; bool param_found = false; param_lock(); if (handle_in_range(param)) { /* look for a saved value */ s = param_find_changed(param); /* if we found one, erase it */ if (s != NULL) { int pos = utarray_eltidx(param_values, s); utarray_erase(param_values, pos, 1); } param_found = true; } param_unlock(); if (s != NULL) { param_notify_changes(false); } return (!param_found); } void param_reset_all(void) { param_lock(); if (param_values != NULL) { utarray_free(param_values); } /* mark as reset / deleted */ param_values = NULL; param_unlock(); param_notify_changes(false); } void param_reset_excludes(const char *excludes[], int num_excludes) { param_lock(); param_t param; for (param = 0; handle_in_range(param); param++) { const char *name = param_name(param); bool exclude = false; for (int index = 0; index < num_excludes; index ++) { int len = strlen(excludes[index]); if ((excludes[index][len - 1] == '*' && strncmp(name, excludes[index], len - 1) == 0) || strcmp(name, excludes[index]) == 0) { exclude = true; break; } } if (!exclude) { param_reset(param); } } param_unlock(); param_notify_changes(false); } #ifdef __PX4_QURT static const char *param_default_file = "/dev/fs/params"; #else static const char *param_default_file = "/usr/share/data/adsp/params"; #endif static char *param_user_file = NULL; int param_set_default_file(const char *filename) { if (param_user_file != NULL) { free(param_user_file); param_user_file = NULL; } if (filename) { param_user_file = strdup(filename); } return 0; } const char * param_get_default_file(void) { return (param_user_file != NULL) ? param_user_file : param_default_file; } int param_save_default(void) { int res = OK; int fd = -1; bool is_locked = false; const char *filename = param_get_default_file(); if (get_shmem_lock(__FILE__, __LINE__) != 0) { PX4_ERR("Could not get shmem lock"); res = ERROR; goto exit; } is_locked = true; fd = PARAM_OPEN(filename, O_WRONLY | O_CREAT, PX4_O_MODE_666); if (fd < 0) { PX4_ERR("failed to open param file: %s", filename); goto exit; } res = param_export(fd, false); if (res != OK) { PX4_ERR("failed to write parameters to file: %s", filename); goto exit; } // After writing the file, also do a fsync to prevent loosing params if power is cut. res = fsync(fd); if (res != 0) { PX4_ERR("failed to do fsync: %s", strerror(errno)); goto exit; } PARAM_CLOSE(fd); fd = -1; exit: if (is_locked) { release_shmem_lock(); } if (fd >= 0) { close(fd); } if (res == OK) { PX4_INFO("saving params completed successfully"); } return res; } /** * @return 0 on success, 1 if all params have not yet been stored, -1 if device open failed, -2 if writing parameters failed */ int param_load_default(void) { int fd_load = PARAM_OPEN(param_get_default_file(), O_RDONLY); if (fd_load < 0) { /* no parameter file is OK, otherwise this is an error */ if (errno != ENOENT) { PX4_ERR("open '%s' for reading failed", param_get_default_file()); return -1; } return 1; } int result = param_load(fd_load); PARAM_CLOSE(fd_load); if (result != 0) { PX4_ERR("error reading parameters from '%s'", param_get_default_file()); return -2; } return 0; } /** * @return 0 on success, 1 if all params have not yet been stored, -1 if device open failed, -2 if writing parameters failed */ static int param_load_default_no_notify(void) { int fd_load = open(param_get_default_file(), O_RDONLY); if (fd_load < 0) { release_shmem_lock(); /* no parameter file is OK, otherwise this is an error */ if (errno != ENOENT) { PX4_DEBUG("open '%s' for reading failed", param_get_default_file()); return -1; } return 1; } int result = param_import(fd_load); close(fd_load); PX4_INFO("param loading done"); if (result != 0) { PX4_WARN("error reading parameters from '%s'", param_get_default_file()); return -2; } return 0; } int param_export(int fd, bool only_unsaved) { struct param_wbuf_s *s = NULL; struct bson_encoder_s encoder; int result = -1; param_lock(); bson_encoder_init_file(&encoder, fd); /* no modified parameters -> we are done */ if (param_values == NULL) { result = 0; goto out; } while ((s = (struct param_wbuf_s *)utarray_next(param_values, s)) != NULL) { int32_t i; float f; /* * If we are only saving values changed since last save, and this * one hasn't, then skip it */ if (only_unsaved && !s->unsaved) { continue; } s->unsaved = false; /* Make sure to get latest from shmem before saving. */ update_from_shmem(s->param, &s->val); /* append the appropriate BSON type object */ switch (param_type(s->param)) { case PARAM_TYPE_INT32: i = s->val.i; if (bson_encoder_append_int(&encoder, param_name(s->param), i)) { PX4_DEBUG("BSON append failed for '%s'", param_name(s->param)); goto out; } break; case PARAM_TYPE_FLOAT: f = s->val.f; if (bson_encoder_append_double(&encoder, param_name(s->param), f)) { PX4_DEBUG("BSON append failed for '%s'", param_name(s->param)); goto out; } break; case PARAM_TYPE_STRUCT ... PARAM_TYPE_STRUCT_MAX: if (bson_encoder_append_binary(&encoder, param_name(s->param), BSON_BIN_BINARY, param_size(s->param), param_get_value_ptr(s->param))) { PX4_DEBUG("BSON append failed for '%s'", param_name(s->param)); goto out; } break; default: PX4_DEBUG("unrecognized parameter type"); goto out; } } result = 0; out: param_unlock(); if (result == 0) { result = bson_encoder_fini(&encoder); } return result; } struct param_import_state { bool mark_saved; }; static int param_import_callback(bson_decoder_t decoder, void *private, bson_node_t node) { float f; int32_t i; void *v, *tmp = NULL; int result = -1; struct param_import_state *state = (struct param_import_state *)private; /* * EOO means the end of the parameter object. (Currently not supporting * nested BSON objects). */ if (node->type == BSON_EOO) { PX4_DEBUG("end of parameters"); return 0; } /* * Find the parameter this node represents. If we don't know it, * ignore the node. */ param_t param = param_find_no_notification(node->name); if (param == PARAM_INVALID) { PX4_DEBUG("ignoring unrecognised parameter '%s'", node->name); return 1; } /* * Handle setting the parameter from the node */ switch (node->type) { case BSON_INT32: if (param_type(param) != PARAM_TYPE_INT32) { PX4_DEBUG("unexpected type for '%s", node->name); goto out; } i = node->i; v = &i; PX4_DEBUG("Imported %s with value %d", param_name(param), i); break; case BSON_DOUBLE: if (param_type(param) != PARAM_TYPE_FLOAT) { PX4_DEBUG("unexpected type for '%s", node->name); goto out; } f = node->d; v = &f; PX4_DEBUG("Imported %s with value %f", param_name(param), (double)f); break; case BSON_BINDATA: if (node->subtype != BSON_BIN_BINARY) { PX4_DEBUG("unexpected subtype for '%s", node->name); goto out; } if (bson_decoder_data_pending(decoder) != param_size(param)) { PX4_DEBUG("bad size for '%s'", node->name); goto out; } /* XXX check actual file data size? */ tmp = malloc(param_size(param)); if (tmp == NULL) { PX4_DEBUG("failed allocating for '%s'", node->name); goto out; } if (bson_decoder_copy_data(decoder, tmp)) { PX4_DEBUG("failed copying data for '%s'", node->name); goto out; } v = tmp; break; default: PX4_DEBUG("unrecognised node type"); goto out; } if (param_set_internal(param, v, state->mark_saved, true, false)) { PX4_DEBUG("error setting value for '%s'", node->name); goto out; } if (tmp != NULL) { free(tmp); tmp = NULL; } /* don't return zero, that means EOF */ result = 1; out: if (tmp != NULL) { free(tmp); } return result; } static int param_import_internal(int fd, bool mark_saved) { struct bson_decoder_s decoder; int result = -1; struct param_import_state state; if (bson_decoder_init_file(&decoder, fd, param_import_callback, &state)) { PX4_DEBUG("decoder init failed"); goto out; } state.mark_saved = mark_saved; do { result = bson_decoder_next(&decoder); } while (result > 0); out: if (result < 0) { PX4_DEBUG("BSON error decoding parameters"); } return result; } int param_import(int fd) { return param_import_internal(fd, false); } int param_load(int fd) { param_reset_all(); return param_import_internal(fd, true); } void param_foreach(void (*func)(void *arg, param_t param), void *arg, bool only_changed, bool only_used) { param_t param; for (param = 0; handle_in_range(param); param++) { /* if requested, skip unchanged values */ if (only_changed && (param_find_changed(param) == NULL)) { continue; } if (only_used && !param_used(param)) { continue; } func(arg, param); } } uint32_t param_hash_check(void) { uint32_t param_hash = 0; param_lock(); /* compute the CRC32 over all string param names and 4 byte values */ for (param_t param = 0; handle_in_range(param); param++) { if (!param_used(param)) { continue; } const char *name = param_name(param); const void *val = param_get_value_ptr(param); param_hash = crc32part((const uint8_t *)name, strlen(name), param_hash); param_hash = crc32part(val, sizeof(union param_value_u), param_hash); } param_unlock(); return param_hash; } void init_params(void) { //copy params to shared memory init_shared_memory(); /*load params automatically*/ #ifdef __PX4_POSIX param_load_default_no_notify(); #endif param_import_done = 1; copy_params_to_shmem(param_info_base); #ifdef ENABLE_SHMEM_DEBUG PX4_INFO("Offsets:"); PX4_INFO("params_val %lu, krait_changed %lu, adsp_changed %lu", (unsigned char *)shmem_info_p->params_val - (unsigned char *)shmem_info_p, (unsigned char *)&shmem_info_p->krait_changed_index - (unsigned char *)shmem_info_p, (unsigned char *)&shmem_info_p->adsp_changed_index - (unsigned char *)shmem_info_p); #endif }