/* * 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 "@(#) locate_ex.c 1.21 05/08/19 SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" /****************************************************************************** * * * IR_LOCATE_EX SUBROUTINE * * * * DESCRIPTION * * This routine checks to see if the data set requested by the user has * * already been encountered and initialized. If this combination is the * * first combination to be processed and the calling routine specified that * * memory be allocated, space is allocated for the experiment_info definition* * structure and this memory is initialized to reflect the current requested * * combination. Otherwise, if the calling routine is only verifying that the * * combination exists within the already defined combination, an error code * * is returned. If this combination is not the first combination to be * * processed, the combination was not found amongst the already defined * * combinations, and the calling routine specified that memory be allocated, * * the memory for the experiment_info structures are re-allocated in order * * to add an experiment_info structure for the new combination being * * processed. Otherwise, if the combination was not found, an error code is * * returned to the calling routine. If the combination is found amongst the * * already defined combinations, the pointers to the correct experiment_info * * structure are set. The version number allows multiple opens to the same * * IDFS data set, in which case, a unique experiment_info structure will be * * allocated for each version; that is, it is treated as a new combo to be * * processed. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten the filename extension for the data file * * to be utilized * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * SDDAS_CHAR alloc_mem flag which indicates if memory should be * * allocated if the requested combination is * * not found within the existing combinations * * * * USAGE * * x = ir_locate_ex (data_key, exten, vnum, alloc_mem) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * realloc() reallocates previously allocated memory * * ir_init_experiment_info() initializes a newly allocated experiment_ * * info structure * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concern- * * ing the experiment that is being processed * * * * INTERNAL VARIABLES * * reg struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * reg struct experiment_info loop termination variable * * *stop_ex * * register SDDAS_SHORT pos indicates which definition (0, 1, etc.) * * matches the combination requested * * size_t bytes the number of bytes to allocate * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_locate_ex (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_CHAR alloc_mem) { extern struct general_info ginfo; register struct experiment_info *ex, *stop_ex; register SDDAS_SHORT pos; size_t bytes; void *tmp_ptr; /************************************************************************/ /* Determine if the requested combination has already been processed. */ /************************************************************************/ ex = ginfo.exbase; stop_ex = ginfo.exbase + ginfo.nds; for (pos = 0; ex < stop_ex; ++ex, ++pos) { /***********************************************************************/ /* If the experiment_info structure for this combination has been */ /* allocated, set the pointers to point to this structure and return. */ /* To speed up the code, broke up the conditional into separate parts.*/ /***********************************************************************/ if (ex->data_key == data_key) { if (ex->version == vnum) { if (*(exten) == ex->exten[0] && (ex->exten[0] == '\0' || *(exten + 1) == ex->exten[1])) { ginfo.pos_ex = pos; ginfo.expt = ex; return (ALL_OKAY); } } } } /**************************************************************************/ /* If the calling routine is defining the combinations, define a new */ /* experiment_info structure for the new combination being processed. */ /**************************************************************************/ if (alloc_mem) { /*************************************************************************/ /* We need to re-alloc memory in order to define a new experiment_info */ /* for the new combination being processed. */ /*************************************************************************/ bytes = sizeof (struct experiment_info); ginfo.sexper = (ginfo.nds + 1) * bytes; if ((tmp_ptr = realloc (ginfo.mexper, ginfo.sexper)) == NO_MEMORY) return (LOCATE_EX_REALLOC); ginfo.mexper = tmp_ptr; ginfo.exbase = (struct experiment_info *) ginfo.mexper; /**********************************************************************/ /* Initialize the new experiment_info structure to reflect this */ /* combination. */ /**********************************************************************/ ir_init_experiment_info (ginfo.nds); ex = ginfo.exbase + ginfo.nds; ex->data_key = data_key; ex->exten[0] = *exten++; ex->exten[1] = *exten; ex->exten[2] = '\0'; ex->version = vnum; ginfo.pos_ex = ginfo.nds++; ginfo.expt = ex; /******************************************************************/ /* Memory needs to be allocated for the ptr_rec structure, which */ /* is included in each experiment_info structure. */ /******************************************************************/ bytes = sizeof (struct ptr_rec); if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (LOCATE_PTR_MALLOC); ex->bmem.base_info_ptr = tmp_ptr; ex->info_ptr = (struct ptr_rec *) ex->bmem.base_info_ptr; ex->info_ptr->prev_hd = -1; ex->info_ptr->cur_sen_set = -1; ex->info_ptr->h_size = -1; ex->info_ptr->chg_sen_set = 0; return (ALL_OKAY); } /**************************************************************************/ /* The combination being requested has never been defined, so return an */ /* error code to the calling routine. */ /**************************************************************************/ else return (LOCATE_NOT_FOUND); }