/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) alloc_sdata.c 1.9 05/08/19 SwRI" #include #include "ret_codes.h" #include "user_defs.h" #include "gen_defs.h" #include "libtrec_idfs.h" /******************************************************************************* * * * IR_ALLOC_SWEEP_DATA SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to allocate the space that is needed to * * hold the data, normalization factors and the bin status values for the * * sweep(s) processed by the SWEEP_DATA routine. There is one buffer for * * each type of unit being returned. If the user asked for raw and base * * units to be returned, there is one buffer for the raw data and one buffer * * for the base units data, for a total of 2 buffers. The size of the * * buffers depends upon the number of bins asked for by the user (the routine * * SET_BIN_INFO must be used to set up this info). There is one buffer that * * is not associated with any particular sensor that is used as holding space * * so that the calls to convert_to_units() are minimized. In addition, space * * is allocated to hold center and band values for temporary conversion * * purposes. This space is maxed out with respect to the largest sweep * * length of all data parameters. * * * * INPUT VARIABLES * * None * * * * USAGE * * x = ir_alloc_sweep_data () * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * realloc() reallocates previously allocated memory * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concern- * * ing the experiment that is being processed * * SDDAS_FLOAT *ir_units_data buffer space used to hold the values from * * the call to convert_to_units for each * * data level requested (used so only 1 call * * is needed per data value) * * SDDAS_FLOAT *ir_swp_base_units space used to hold sample sequence values * * (used by all parameters) * * SDDAS_FLOAT *ir_swp_low, space used to hold the sweep band widths * * *ir_swp_high (used by all parameters) * * SDDAS_UINT ir_units_bytes the number of bytes allocated to hold the * * values from convert_to_units() * * SDDAS_UINT ir_swp_bytes the number of bytes allocated to hold the * * sample sequence values * * void *ir_base_units pointer to the space allocated to hold the * * values from the call to convert_to_units * * for each data level requested * * void *ir_base_swp pointer to the space allocated to hold the * * sample sequence values * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct fill_data *fptr pointer to the fill_data structure being * * processed * * struct fill_sensor *sptr pointer to the fill_sensor structure being * * processed * * register SDDAS_FLOAT *dptr pointer to the data array * * register SDDAS_FLOAT *tfrac pointer to the normalization factors * * reg SDDAS_FLOAT *stop_loop loop termination variable * * register SDDAS_SHORT i looping variable * * reg SDDAS_CHAR *bin_stat pointer to the bin status array * * size_t bytes the number of bytes to allocate * * size_t num_bytes_sfloat the number of bytes needed for a SDDAS_FLOAT* * SDDAS_UINT compare_size the number of bytes needed to process all * * requested data levels for the combo being * * processed * * SDDAS_UINT unit_size the number of bytes needed to process one * * data level for the combo being processed * * SDDAS_LONG offset offset index value * * SDDAS_LONG num_bytes variable used to hold common calculation * * for byte size determination * * SDDAS_SHORT num_units the total number of units or data levels to * * be returned for all sensors * * SDDAS_SHORT max_units the number of data levels that triggered the* * reallocation of the units data buffers * * char expand_units flag indicating that the buffer space for * * all units needs to be expanded * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_alloc_sweep_data (void) { extern struct general_info ginfo; extern SDDAS_FLOAT *ir_units_data, *ir_swp_base_units, *ir_swp_low; extern SDDAS_FLOAT *ir_swp_high; extern SDDAS_UINT ir_units_bytes, ir_swp_bytes; extern void *ir_base_units, *ir_base_swp; struct experiment_info *ex; struct fill_data *fptr; struct fill_sensor *sptr; register SDDAS_FLOAT *dptr, *tfrac, *stop_loop; register SDDAS_SHORT i; register SDDAS_CHAR *bin_stat; size_t bytes, num_bytes_sfloat; SDDAS_UINT compare_size, unit_size; SDDAS_LONG offset, num_bytes; SDDAS_SHORT num_units, max_units; char expand_units = 0; void *tmp_ptr; /**************************************************************************/ /* Determine how many different types of units are being returned for */ /* each sensor and sum up for all sensors being processed. */ /**************************************************************************/ num_bytes_sfloat = sizeof (SDDAS_FLOAT); ex = ginfo.expt; fptr = ex->fill_arrays; num_units = 0; max_units = 0; unit_size = ex->swp_len * num_bytes_sfloat; for (i = 0; i < ex->num_fill_sensor; ++i) { sptr = ex->fill_sen_ptr + i; num_units += sptr->num_units; /**********************************************************************/ /* When calculating the size of the units buffer, consider both the */ /* number of data levels AND number of samples since both determine */ /* number of data points. For example, level = 2 num sample = 16 */ /* equals 32 whereas, level = 4 num sample = 4 = 16 (more levels but */ /* less data points). */ /**********************************************************************/ compare_size = sptr->num_units * unit_size; if (compare_size > ir_units_bytes) { /******************************************************************/ /* Since haven't allocated yet to update ir_units_bytes, make */ /* sure to get max units of ALL sensors (num_fill_sensor). */ /******************************************************************/ if (sptr->num_units > max_units) max_units = sptr->num_units; expand_units = 1; } } /*************************************************************************/ /* In order to cut down on the number of calls to convert_to_units(), */ /* space is allocated to hold the results for all units processed for */ /* any sensor from any of the virtual instruments being processed. */ /* There should be swp_len floating point values for each data level */ /* being processed. Swp_len is used instead of num_bins since this */ /* array holds the number of values returned by READ_DREC() which may */ /* be more than the number of bins defined. */ /*************************************************************************/ if (expand_units) { ir_units_bytes = max_units * unit_size; if (ir_base_units == NO_MEMORY) { if ((tmp_ptr = malloc (ir_units_bytes)) == NO_MEMORY) return (SWEEP_UNITS_MALLOC); ir_base_units = tmp_ptr; } else { if ((tmp_ptr = realloc (ir_base_units, ir_units_bytes)) == NO_MEMORY) return (SWEEP_UNITS_REALLOC); ir_base_units = tmp_ptr; } ir_units_data = (SDDAS_FLOAT *) ir_base_units; } /***********************************************************************/ /* Allocate space to hold the sample sequence values and to create */ /* the bands from these center values. The worst case is swp_len */ /* elements are returned. This array ends up being maxed out since */ /* it is used by all parameters. For the bands, allocate one extra */ /* bin in case of contiguous values. */ /***********************************************************************/ bytes = ex->swp_len * num_bytes_sfloat + (ex->swp_len + 1) * num_bytes_sfloat + (ex->swp_len + 1) * num_bytes_sfloat; if (ir_base_swp == NO_MEMORY) { ir_swp_bytes = bytes; if ((tmp_ptr = malloc (ir_swp_bytes)) == NO_MEMORY) return (SWEEP_SWP_MALLOC); ir_base_swp = tmp_ptr; /* Cast ir_base_swp to char * since void * and offset is in bytes. */ ir_swp_base_units = (SDDAS_FLOAT *) (ir_base_swp); offset = ex->swp_len * num_bytes_sfloat; ir_swp_low = (SDDAS_FLOAT *) ((SDDAS_CHAR *) ir_base_swp + offset); offset += (ex->swp_len + 1) * num_bytes_sfloat; ir_swp_high = (SDDAS_FLOAT *) ((SDDAS_CHAR *) ir_base_swp + offset); } else if (bytes > ir_swp_bytes) { ir_swp_bytes = bytes; if ((tmp_ptr = realloc (ir_base_swp, ir_swp_bytes)) == NO_MEMORY) return (SWEEP_SWP_REALLOC); ir_base_swp = tmp_ptr; /* Cast ir_base_swp to char * since void * and offset is in bytes. */ ir_swp_base_units = (SDDAS_FLOAT *) (ir_base_swp); offset = ex->swp_len * num_bytes_sfloat; ir_swp_low = (SDDAS_FLOAT *) ((SDDAS_CHAR *) ir_base_swp + offset); offset += (ex->swp_len + 1) * num_bytes_sfloat; ir_swp_high = (SDDAS_FLOAT *) ((SDDAS_CHAR *) ir_base_swp + offset); } /***************************************************************************/ /* Allocate space for data, normalization and bin status values (one-to- */ /* one mapping). Use the number of bins defined for the instrument. */ /***************************************************************************/ num_bytes = num_units * ex->bin_ptr->num_bins; bytes = (num_bytes_sfloat + num_bytes_sfloat + sizeof (SDDAS_CHAR)) * num_bytes; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (SWEEP_DATA_MALLOC); fptr->base_data = tmp_ptr; /* Cast base_data to char * since void * and offset is in bytes. */ fptr->data = (SDDAS_FLOAT *) (fptr->base_data); offset = num_bytes * num_bytes_sfloat; fptr->tot_frac = (SDDAS_FLOAT *) ((SDDAS_CHAR *) fptr->base_data + offset); offset += num_bytes * num_bytes_sfloat; fptr->bin_stat = (SDDAS_CHAR *) ((SDDAS_CHAR *) fptr->base_data + offset); /***********************************************************************/ /* Initialize the buffer for each DATA LEVEL (units) for each sensor */ /* being processed. Use normalization since could run out of data */ /* due to to LOS. */ /***********************************************************************/ dptr = fptr->data; bin_stat = fptr->bin_stat; tfrac = fptr->tot_frac; stop_loop = fptr->data + num_bytes; for (; dptr < stop_loop; ++dptr, ++tfrac, ++bin_stat) { *dptr = OUTSIDE_MIN; *tfrac = 0.0; *bin_stat = 0; } return (ALL_OKAY); }