/* * 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 "@(#) chk_dep_hdr.c 1.16 05/08/19 SwRI" #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_CHECK_DEPENDENT_ON_HEADER SUBROUTINE * * * * DESCRIPTION * * This routine is called to determine if the arrays for the sensor data, * * mode data, sample sequence values, azimuthal angles and pitch angles are * * large enough to accomodate the data based upon the header sizes. If not, * * the space is enlarged to the newly defined size. * * * * INPUT VARIABLES * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * * * USAGE * * x = ir_check_dependent_on_header (idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * malloc() allocates memory * * realloc() reallocates previously allocated memory * * sizeof () the size of the specified object in bytes * * ir_alloc_swp_data() allocates space for the sample sequence values* * ir_initialize_transformation_structure () initializes elements of the * * transformation structure * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * struct direction_cos *dcos_ptr ptr to the direction cosine structure * * struct euler_info a pointer to the structure that holds euler * * *pmi_ptr angle information * * struct transformation_info *trans_ptr ptr to transformation structure * * SDDAS_LONG offset indexing variable * * SDDAS_LONG bytes_per_item variable used to cut down on repeated * * multiplications * * SDDAS_USHORT num_ele number of sample sequence values * * SDDAS_USHORT n_sample the number of samples returned for each sensor* * SDDAS_SHORT ret_val holds value returned by called routine * * SDDAS_SHORT num_pmi_angles number of euler angles to return * * SDDAS_BOOL n_sample_increased flag which indicates if n_sample changed * * added for speed-up issues * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * size_t bytes the number of bytes to allocate * * size_t num_bytes_slong the number of bytes needed for a SDDAS_LONG * * size_t num_bytes_sfloat the number of bytes needed for a SDDAS_FLOAT * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_check_dependent_on_header (void *idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; struct direction_cos *dcos_ptr; struct euler_info *pmi_ptr; struct transformation_info *trans_ptr; SDDAS_LONG offset, bytes_per_item; SDDAS_USHORT num_ele, n_sample; SDDAS_SHORT ret_val, num_pmi_angles; SDDAS_BOOL n_sample_increased; void *tmp_ptr; size_t bytes, num_bytes_slong, num_bytes_sfloat; /***********************************************************************/ /* Set a pointer to the structure which holds all pointers for header */ /* and data information for the experiment currently being processed. */ /***********************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; if (ex->header_format != ORIGINAL_HEADER) return (WRONG_HEADER_FORMAT); /****************************************************************************/ /* Since void pointer, make sure correct type of data structure being used.*/ /* Data structures define the same elements at the beginning of the */ /* structure definition. */ /****************************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; if (EXP_DATA->header_format != ORIGINAL_HEADER) return (WRONG_DATA_STRUCTURE); n_sample = *ptr->hdr_fmt1_ptr->N_SAMPLE; if (n_sample <= 0) return (RESET_DATA_MALLOC); n_sample_increased = sFalse; /*************************************************************************/ /* If the space for the data is not large enough to handle this virtual */ /* instrument, enlarge the memory size. This array will end up being */ /* maxed out to the largest number of elements for ALL virtual inst. */ /* that use this data structure. For speed issues, got rid of */ /* conditional check for first allocation and call to malloc() since */ /* realloc() with NULL ptr acts the same. */ /*************************************************************************/ num_bytes_slong = sizeof (SDDAS_LONG); num_bytes_sfloat = sizeof (SDDAS_FLOAT); bytes = n_sample * num_bytes_slong; if (bytes > EXP_DATA->data_size) { /*************************************************************************/ /* The only way to get inside this conditional is if n_sample increased */ /* in size, so note this so that other conditionals that are dependent */ /* only on a change to n_sample can be checked as a group instead of */ /* individually. */ /*************************************************************************/ n_sample_increased = sTrue; if ((tmp_ptr = realloc (EXP_DATA->base_data, bytes)) ==NO_MEMORY) return (RESET_DATA_REALLOC); EXP_DATA->base_data = tmp_ptr; EXP_DATA->sen_data = (SDDAS_LONG *) EXP_DATA->base_data; EXP_DATA->data_size = (SDDAS_UINT) bytes; } /***************************************************************************/ /* If this is true, no need for individual size comparisons; simply */ /* compute and reallocate. */ /***************************************************************************/ if (n_sample_increased == sTrue) { /***************************************************************************/ /* If the space for the start and stop azimuthal angles is not large */ /* enough to handle this virtual instrument, enlarge the memory size. */ /* This array will end up being maxed out to the largest number of */ /* elements for ALL virtual inst. that use this data structure. For */ /* speed issues, got rid of conditional check for first allocation and */ /* call to malloc() since realloc() with NULL ptr acts the same. */ /***************************************************************************/ offset = n_sample * num_bytes_sfloat; bytes = offset + offset; if ((tmp_ptr = realloc (EXP_DATA->base_angle, bytes)) == NO_MEMORY) return (RESET_ANGLE_REALLOC); EXP_DATA->base_angle = tmp_ptr; EXP_DATA->start_az = (SDDAS_FLOAT *) EXP_DATA->base_angle; /* Cast base_angle to char ptr since void and offset is in bytes. */ EXP_DATA->stop_az = (SDDAS_FLOAT *) ((SDDAS_CHAR *) EXP_DATA->base_angle + offset); EXP_DATA->angle_size = (SDDAS_UINT) bytes; /****************************************************************************/ /* Allocate space to hold pitch angles if no memory has been allocated yet */ /* IF the data set makes use of pitch angle information. */ /****************************************************************************/ if (ex->pa_def && ex->return_pitch_angles == sTrue) { /**************************************************************************/ /* Leave conditional check since direction_cos structure also to be */ /* allocated. */ /**************************************************************************/ bytes = n_sample * num_bytes_sfloat; if (EXP_DATA->base_pitch == NO_MEMORY) { if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_PITCH_MALLOC); EXP_DATA->base_pitch = tmp_ptr; EXP_DATA->pitch_size = (SDDAS_UINT) bytes; EXP_DATA->pitch_angles = (SDDAS_FLOAT *) EXP_DATA->base_pitch; /**************************************************************************/ /* Allocate space for the structure which holds the direction cosines. */ /**************************************************************************/ bytes = sizeof (struct direction_cos); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_DCOS_MALLOC); EXP_DATA->base_dir_cosines = tmp_ptr; EXP_DATA->dir_cosines = (struct direction_cos *) EXP_DATA->base_dir_cosines; /**************************************************************************/ /* Allocate space (5) for the direction cosine, start/stop azimuthal and */ /* start/stop theta values. 3 = x, y and z in the equation. */ /**************************************************************************/ dcos_ptr = EXP_DATA->dir_cosines; bytes_per_item = n_sample * num_bytes_sfloat * 3; bytes = bytes_per_item * 5; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_DCOS_VAL_MALLOC); dcos_ptr->base_mem = tmp_ptr; dcos_ptr->dir_cos123 = (SDDAS_FLOAT *) dcos_ptr->base_mem; offset = bytes_per_item; /* Cast base_angle to char ptr since void and offset is in bytes. */ dcos_ptr->start_az123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->stop_az123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->start_theta123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->stop_theta123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); } /***************************************************************************/ /* If the space for the angles is not large enough to handle this virtual */ /* instrument, enlarge the memory size. */ /***************************************************************************/ else { if ((tmp_ptr = realloc (EXP_DATA->base_pitch, bytes)) == NO_MEMORY) return (RESET_PITCH_REALLOC); EXP_DATA->base_pitch = tmp_ptr; EXP_DATA->pitch_size = (SDDAS_UINT) bytes; EXP_DATA->pitch_angles = (SDDAS_FLOAT *) EXP_DATA->base_pitch; /****************************************************************************/ /* Reallocate space (5) for the direction cosine, start/stop azimuthal and */ /* start/stop theta values. 3 = x, y and z in the equation. */ /****************************************************************************/ dcos_ptr = EXP_DATA->dir_cosines; bytes_per_item = n_sample * num_bytes_sfloat * 3; bytes = bytes_per_item * 5; if ((tmp_ptr = realloc (dcos_ptr->base_mem, bytes)) == NO_MEMORY) return (RESET_DCOS_VAL_REALLOC); dcos_ptr->base_mem = tmp_ptr; dcos_ptr->dir_cos123 = (SDDAS_FLOAT *) dcos_ptr->base_mem; /* Cast base_mem to char ptr since void and offset is in bytes. */ offset = bytes_per_item; dcos_ptr->start_az123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->stop_az123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->start_theta123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); offset += bytes_per_item; dcos_ptr->stop_theta123 = (SDDAS_FLOAT *) ((SDDAS_CHAR *) dcos_ptr->base_mem + offset); } } /****************************************************************************/ /* Does the data set makes use of spacecraft potential info? */ /****************************************************************************/ if (ex->potential_def) { /****************************************************************************/ /* If the space for the spacecraft potential is not large enough to handle */ /* this virtual instrument, enlarge the memory size. For speed issues, */ /* got rid of conditional check for first allocation and call to malloc() */ /* since realloc() with NULL ptr acts the same. */ /****************************************************************************/ bytes = n_sample * num_bytes_sfloat; if ((tmp_ptr = realloc (EXP_DATA->base_potential, bytes)) == NO_MEMORY) return (RESET_POT_REALLOC); EXP_DATA->base_potential = tmp_ptr; EXP_DATA->potential_size = (SDDAS_UINT) bytes; EXP_DATA->potential = (SDDAS_FLOAT *) EXP_DATA->base_potential; } /****************************************************************************/ /* Does the data set makes use of background info? */ /****************************************************************************/ if (ex->background_def) { /****************************************************************************/ /* If space for the background is not large enough to handle this virtual */ /* instrument, enlarge the memory size. For speed issues, got rid of */ /* conditional check for first allocation and call to malloc() since */ /* realloc() with NULL ptr acts the same. */ /****************************************************************************/ bytes = n_sample * num_bytes_sfloat; if ((tmp_ptr = realloc (EXP_DATA->base_background, bytes)) == NO_MEMORY) return (RESET_BKGD_REALLOC); EXP_DATA->base_background = tmp_ptr; EXP_DATA->background_size = (SDDAS_UINT) bytes; EXP_DATA->background = (SDDAS_FLOAT *) EXP_DATA->base_background; } /****************************************************************************/ /* Allocate space to hold euler angles if no memory has been allocated yet */ /* IF the data set makes use of euler angle information. */ /****************************************************************************/ if (ex->euler_def) { /**************************************************************************/ /* Leave conditional check since transformation_info structure is needed */ /* for either EULER or CELESTIAL information. */ /**************************************************************************/ if (EXP_DATA->base_transform == NO_MEMORY) { /**************************************************************************/ /* Allocate space for the structure which holds the transformation info. */ /* and initialize elements of the structure. */ /**************************************************************************/ bytes = sizeof (struct transformation_info); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_TINFO_MALLOC); EXP_DATA->base_transform = tmp_ptr; EXP_DATA->idfs_transformation = (struct transformation_info *) EXP_DATA->base_transform; ir_initialize_transformation_structure (idf_data_ptr); } trans_ptr = EXP_DATA->idfs_transformation; pmi_ptr = ex->euler_angles; num_pmi_angles = (pmi_ptr != NO_MEMORY) ? pmi_ptr->num_pmi_angles : MAX_EULER_ANGLES; /****************************************************************************/ /* If the space for the euler angles is not large enough to handle this */ /* virtual instrument, enlarge the memory size. For speed issues, got */ /* rid of conditional check for first allocation and call to malloc() */ /* since realloc() with NULL ptr acts the same. While there are n_sample */ /* euler angles, there are only num_pmi_angles rotation axes since these */ /* do not change from step to step. */ /****************************************************************************/ bytes = num_bytes_sfloat * n_sample * num_pmi_angles; bytes += sizeof (SDDAS_SHORT) * num_pmi_angles; if ((tmp_ptr = realloc (trans_ptr->base_euler, bytes)) == NO_MEMORY) return (RESET_EULER_REALLOC); trans_ptr->base_euler = tmp_ptr; trans_ptr->euler_size = (SDDAS_UINT) bytes; trans_ptr->euler_angles = (SDDAS_FLOAT *) trans_ptr->base_euler; /* Cast base_euler to char ptr since void and offset is in bytes. */ offset = num_bytes_sfloat * n_sample * num_pmi_angles; trans_ptr->euler_rot_axis = (SDDAS_SHORT *) ((SDDAS_CHAR *) trans_ptr->base_euler + offset); } /****************************************************************************/ /* Allocate space to hold celestial position angles if no memory has been */ /* allocated yet IF the data set makes use of celestial position info. */ /****************************************************************************/ if (ex->celestial_def) { /**************************************************************************/ /* Leave conditional check since transformation_info structure is needed */ /* for either EULER or CELESTIAL information. */ /**************************************************************************/ if (EXP_DATA->base_transform == NO_MEMORY) { /**************************************************************************/ /* Allocate space for the structure which holds the transformation info. */ /* and initialize elements of the structure. */ /**************************************************************************/ bytes = sizeof (struct transformation_info); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_TINFO_MALLOC); EXP_DATA->base_transform = tmp_ptr; EXP_DATA->idfs_transformation = (struct transformation_info *) EXP_DATA->base_transform; ir_initialize_transformation_structure (idf_data_ptr); } /****************************************************************************/ /* If the space for the celestial position angles is not large enough to */ /* handle this virtual instrument, enlarge the memory size. For speed */ /* issues, got rid of conditional check for first allocation and call to */ /* malloc() since realloc() with NULL ptr acts the same. */ /****************************************************************************/ trans_ptr = EXP_DATA->idfs_transformation; bytes = num_bytes_sfloat * n_sample * NUM_CP_ANGLES; if ((tmp_ptr = realloc (trans_ptr->base_celestial, bytes)) == NO_MEMORY) return (RESET_CP_REALLOC); trans_ptr->base_celestial = tmp_ptr; trans_ptr->celestial_size = (SDDAS_UINT) bytes; trans_ptr->declination_angles = (SDDAS_FLOAT *) trans_ptr->base_celestial; /* Cast base_celestial to char ptr since void and offset is in bytes. */ offset = num_bytes_sfloat * n_sample; trans_ptr->rt_ascension_angles = (SDDAS_FLOAT *) ((SDDAS_CHAR *) trans_ptr->base_celestial + offset); } } /************************************************************************/ /* Allocate space to hold mode flags that are to be returned to the */ /* user, retured as SDDAS_LONGs, if modes are defined for the data set.*/ /************************************************************************/ if (*ptr->I_MODE != 0) { /*************************************************************************/ /* If the space for the modes is not large enough to handle this virtual*/ /* instrument, enlarge the memory size. This array will end up being */ /* maxed out to the largest number of elements for ALL virtual inst. */ /* using this data structure. For speed issues, got rid of conditional */ /* check for first allocation and call to malloc() since realloc() with */ /* NULL ptr acts the same. */ /*************************************************************************/ bytes = *(ptr->I_MODE) * num_bytes_slong; if (bytes > EXP_DATA->mode_size) { if ((tmp_ptr = realloc (EXP_DATA->base_mode, bytes)) == NO_MEMORY) return (RESET_MODE_REALLOC); EXP_DATA->base_mode = tmp_ptr; EXP_DATA->mode = (SDDAS_LONG *) EXP_DATA->base_mode; EXP_DATA->mode_size = (SDDAS_UINT) bytes; EXP_DATA->mode_len = bytes / num_bytes_slong; } } /*************************************************************************/ /* Allocate space to hold the sample sequence values. */ /*************************************************************************/ num_ele = (ex->smp_id == 2) ? 1 : n_sample; ret_val = ir_alloc_swp_data (num_ele, idf_data_ptr); if (ret_val != ALL_OKAY) return (ret_val); /**************************************************************************/ /* Allocate space to hold the number of elements in each cal. set, which */ /* is needed by convert_to_units since the values can change from header */ /* to header. */ /**************************************************************************/ if (ex->cal_sets != 0) { if (EXP_DATA->base_cset == NO_MEMORY) { bytes = ex->cal_sets * sizeof (SDDAS_ULONG); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (RESET_CSET_MALLOC); EXP_DATA->base_cset = tmp_ptr; EXP_DATA->cset_num = (SDDAS_ULONG *) EXP_DATA->base_cset; } } return (ALL_OKAY); }