/* * 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_spin_swp_times.c 1.1 05/08/19 SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_ALLOC_SPIN_SWEEP_TIMES SUBROUTINE * * * * DESCRIPTION * * This routine will allocate space to hold the time per step for the data * * source being processed. This routine is used for spin processing and for * * data buffering purposes (parent source for spin processing). * * * * INPUT VARIABLES * * struct sweep_times *sptr a pointer to the structure which holds the * * time per step information * * SDDAS_LONG num_bins the number of time slots to allocate (computed * * only for data buffer manipulation) * * * * USAGE * * x = ir_alloc_spin_sweep_times (&sptr, num_bins) * * * * NECESSARY SUBPROGRAMS * * malloc() allocates memory * * sizeof () the size of the specified object in bytes * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds specific * * *ex experiment information * * SDDAS_LONG offset index into allocated memory * * SDDAS_LONG max_size max. size for packed scalars or max elements * * in a sweep for a sweeping instrument * * SDDAS_LONG max_size_slong number of bytes needed for max_size elements * * which are SDDAS_LONG data types * * SDDAS_LONG max_size_sshort number of bytes needed for max_size elements * * which are SDDAS_SHORT data types * * 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_sshort the number of bytes needed for a SDDAS_SHORT * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_alloc_spin_sweep_times (struct sweep_times *sptr, SDDAS_LONG num_bins) { extern struct general_info ginfo; struct experiment_info *ex; SDDAS_LONG offset, max_size, max_size_slong, max_size_sshort; /* Leave variables as is. */ size_t bytes, num_bytes_slong, num_bytes_sshort; void *tmp_ptr; /*************************************************************************/ /* Allocate space to save year, day, milliseconds and nanoseconds start */ /* and stop time component for each sample in the parent source. Cannot */ /* assume that the start of B = the end of A since timing may be */ /* parallel down the column so need two arrays. If the parent instrument*/ /* is a scalar, use the max_packing value in case of packed scalars. */ /*************************************************************************/ num_bytes_slong = sizeof (SDDAS_LONG); num_bytes_sshort = sizeof (SDDAS_SHORT); if (num_bins == -1) { ex = ginfo.expt; if (ex->smp_id == 2) max_size = ex->max_packing; else max_size = ex->swp_len; } /*************************************************************************/ /* Allocate space to save year, day, milliseconds and nanoseconds start */ /* and stop time component for each time slot created to cover entire */ /* data buffer. Cannot assume that the start of B = the end of A since */ /* timing may be parallel down the column so need two arrays. */ /*************************************************************************/ else max_size = num_bins; max_size_slong = max_size * num_bytes_slong; max_size_sshort = max_size * num_bytes_sshort; bytes = 4 * (num_bytes_slong + num_bytes_sshort) * max_size; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (START_SPIN_TIME_MALLOC); sptr->base_time = tmp_ptr; /****************************************************************************/ /* Cast base_time to a char. ptr since it is void and offset is in bytes. */ /****************************************************************************/ sptr->btime_yr = (SDDAS_SHORT *) sptr->base_time; offset = max_size_sshort; sptr->btime_day = (SDDAS_SHORT *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_sshort; sptr->btime_ms = (SDDAS_LONG *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_slong; sptr->btime_ns = (SDDAS_LONG *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_slong; sptr->etime_yr = (SDDAS_SHORT *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_sshort; sptr->etime_day = (SDDAS_SHORT *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_sshort; sptr->etime_ms = (SDDAS_LONG *)((SDDAS_CHAR *) sptr->base_time + offset); offset += max_size_slong; sptr->etime_ns = (SDDAS_LONG *)((SDDAS_CHAR *) sptr->base_time + offset); return (ALL_OKAY); }