/* * 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 "@(#) pos_rtime.c 1.25 05/08/19 SwRI" #include #include #include "ret_codes.h" #include "gen_defs.h" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_POSITION_REAL_TIME SUBROUTINE * * * * DESCRIPTION * * This routine is called to position the data and header file pointers * * for the real time data files. If the user entered a -1 for the start * * time, the file descriptor for the data file is positioned at the beginning * * of the data file. If the user entered a -2 for the start time, the file * * descriptor for the data file is positioned one record from the end of the * * data file, with the reason being so that the EOF or LOS record can be * * processed correctly. This check is made to ensure that the user would not * * be forever stuck waiting for another data record to be placed in this data * * file. One data and the corresponding header record is read so that * * information is ready to be processed when the user calls the data read * * routine (either read_drec() or read_tensor_data()). * * * * INPUT VARIABLES * * SDDAS_SHORT btime_yr the start time requested (year component) * * SDDAS_SHORT btime_day the start time requested (day component) * * SDDAS_LONG btime_sec the start time requested (seconds) * * SDDAS_LONG btime_nsec the start time requested (nanoseconds) * * SDDAS_SHORT etime_yr the stop time requested (year component) * * SDDAS_SHORT etime_day the stop time requested (day component) * * SDDAS_LONG etime_sec the stop time requested (seconds component) * * SDDAS_LONG etime_nsec the stop time requested (nanoseconds) * * void *data_ptr ptr to the memory location for the structure * * that holds returned data values (either * * idf_data or tensor_data) * * * * USAGE * * x = ir_position_real_time (btime_yr, btime_day, btime_sec, btime_nsec, * * etime_yr, etime_day, etime_sec, etime_nsec, * * data_ptr) * * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * read() reads N bytes from the file associated with * * the file descriptor given * * lseek() moves the file pointer to a location within * * the file * * ir_alloc_exp_once() allocates memory that is needed in order to * * utilize the generic routines provided for * * retrieving experiment data * * ir_network_order() converts data read from data/header files * * between network byte order and host byte order * * ir_swap_data_array () swaps the data values if necessary to be * * in host byte order * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * SDDAS_CHAR ir_swap_data flag that is used to determine when the data * * matrix is to be converted to host byte order * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds specific * * *ex 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 * * int num_bytes the number of bytes requested from the file * * int ret_bytes the number of bytes actually read by READ() * * off_t ret_val holds the value returned by the called routine * * SDDAS_LONG num_records the number of data records in the data file * * SDDAS_LONG bytes no. of bytes to seek by for the LSEEK routine * * SDDAS_LONG *hdr_off the offset into the header file (in bytes) * * SDDAS_SHORT rval holds the value returned by the called routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_position_real_time (SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec, SDDAS_SHORT etime_yr, SDDAS_SHORT etime_day, SDDAS_LONG etime_sec, SDDAS_LONG etime_nsec, void *data_ptr) { extern struct general_info ginfo; extern SDDAS_CHAR ir_swap_data; struct experiment_info *ex; struct ptr_rec *ptr; int num_bytes, ret_bytes; off_t ret_val; SDDAS_LONG num_records, bytes, *hdr_off; SDDAS_SHORT rval; /***************************************************************************/ /* 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 start time is -1, set the pointer at the beginning of the file. */ /* If start time is -2, set the pointer at the end of the file. */ /**************************************************************************/ if (btime_sec == -1) ret_val = lseek (ex->fdd, (off_t) 0, 0); else { ret_val = lseek (ex->fdd, (off_t) 0, 2); /******************************************************************/ /* Make sure that the pointer is on a record boundary. Back up */ /* one record from the end of the file. */ /******************************************************************/ num_records = ret_val / ptr->d_size; bytes = (num_records - 1) * ptr->d_size; if (bytes < 0) bytes = 0; ret_val = lseek (ex->fdd, (off_t) bytes, 0); } /***********************************************************************/ /* Read the data record and the appropriate header record. */ /***********************************************************************/ num_bytes = ptr->d_size; ret_bytes = read (ex->fdd, ex->DATA_MEM, num_bytes); if (ret_bytes < 0) return (POS_DATA_READ_ERROR); else if (ret_bytes == 0) { ex->drec_eof = 1; return (EOF_STATUS); } /********************************************************************/ /* Either we read before the listener could finish writing, or the */ /* listener never received the file closure packet and wrote down */ /* 20 bytes of -1 or -2 values. */ /********************************************************************/ ir_swap_data = 1; ir_network_order (0, 1); if (ret_bytes != num_bytes) { /********************************************************************/ /* The file closure flags are always in the first hdr_offset field.*/ /* There are three long data values in the data structure before */ /* the header offsets. */ /********************************************************************/ hdr_off = (SDDAS_LONG *) (ex->DATA_MEM + 3 * sizeof (SDDAS_LONG)); /*******************************************************************/ /* We read before the listener could finish writing so back up */ /* the partial no. of bytes read for future read attempts. */ /*******************************************************************/ ex->drec_eof = 1; ret_val = lseek (ex->fdd, (off_t) (-1 * ret_bytes), 1); if (*hdr_off == NO_MORE_DATA) return (LOS_STATUS); else if (*hdr_off == NEXT_FILE) return (NEXT_FILE_STATUS); else return (EOF_STATUS); } ret_val = lseek (ex->fdh, (off_t) *(ptr->HDR_OFF), 0); /************************************************************************/ /* Allocate memory that is needed in order to utilize the generic */ /* routines provided for retrieving experiment data. This call will */ /* read the header record that is associated with the data record. */ /************************************************************************/ rval = ir_alloc_exp_once (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, data_ptr); if (rval != ALL_OKAY) return (rval); /***********************************************************************/ /* Make sure the data array is in host byte order. Must be done */ /* AFTER the header record information has checked. */ /***********************************************************************/ ir_swap_data_array (); /************************************************************************/ /* Initialize variables pertinent to the data read routines (READ_DREC */ /* and READ_TENSOR_DATA) and return to the calling routine. */ /************************************************************************/ ptr->time_row = 0; ptr->time_col = 0; ptr->cur_sen_set = 0; ex->accum_ss_sz = 0; ex->accum_ss_ms = 0; ex->accum_ss_ns = 0; ptr->chg_sen_set = 0; ptr->reset_hdr = 1; ex->fnext = 1; /* CARRIE - This field is used only by the SCF code for a vector IDFS */ /* source. Leave it set at initialized value for tensor processing. */ if (ex->header_format == ORIGINAL_HEADER) ex->num_sample = (ex->smp_id == 2) ? 1 : *ptr->hdr_fmt1_ptr->N_SAMPLE; return (ALL_OKAY); }