cfdp_bp_filestore_example/main.c

// ////////////////////////////////////////////////////////////////////////////
//  
// Sample program creates 1MB, 2MB and 3MB pathnames to 1MB, 2MB and 3MB files 
// created by the cfdp_bp_destination example application.  Filestore actions, 
// initiated by this program, are performed on these files.  The program uses 
// the Filestore, FilestoreComponentION, AddFilestore, 
// AddFilestoreComponentRequestION, SendAllFilestoreRequests, 
// MonitorAllCFDPTransactions and RemoveFilestoreComponentRequest API 
// functions. 
//
// Main with optional input defining pathname for the CFDP configuration file.  
// The default CFDP configuration file pathname is 
// "./cfdp_bp_filestore_example_config.txt".
//
// The "cfdp_bp_destination" example must be running on the destination
// platform prior to starting other CFDP BP examples.  Assumes the source and
// and destination platforms are using the same operating system and user
// account.  Remote eid/node = 2.
//
// ////////////////////////////////////////////////////////////////////////////

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <sys/timeb.h>
#include <string.h>
#include "ds_shared.h"
#include "cfdp_shared.h"
#include "trek_error.h"
#include "toolkit_ds_api_error_codes.h"
#include "toolkit_cfdp_api_error_codes.h"
#include "trek_toolkit_common_api_ansi_c.h"
#include "toolkit_cfdp_api_ansi_c.h"
#include "toolkit_ds_api_ansi_c.h"
#ifdef __linux__
#include <unistd.h>
#else
#include <windows.h>
#endif

unsigned int message_mask;
char home_path[256];

// ////////////////////////////////////////////////////////////////////////////
//
// PrintTheMessage controls how messages are processed and displayed to 
// the user.
//
// ////////////////////////////////////////////////////////////////////////////

void PrintTheMessage(message_struct_type *mess_struct_ptr)
{
    if (mess_struct_ptr->category & message_mask)
    {
        printf("%s%s\n",GetMessageCategoryAsPaddedString(mess_struct_ptr->category),
                mess_struct_ptr->message);
    }
}

// ////////////////////////////////////////////////////////////////////////////
//
// DeviceData's packet_buffer_ptr processes a cfdp_struct ptr defined as 
// follows:
//
// char           source_pathname[200];
// char           destination_pathname[200];
// long long      eid;                      (destination)
// char           transaction_id[50];
// unsigned short percent_transferred;
// unsigned long  bytes_transferred;
// unsigned long  file_size;
// unsigned long  cfdp_configuration; (e.g., DS_DEVICE_SENDING, 
//                                           DS_DEVICE_RECEIVING)
// unsigned long  cfdp_status;        (e.g., DS_PACKET_SENDING, 
//                                           DS_PACKET_RECEIVING,
//                                           DS_SUSPEND, DS_RESUME, 
//                                           DS_REPORT, 
//                                           DS_CANCEL, 
//                                           DS_SUCCESS, 
//                                           DS_FAIL, 
//                                           DS_ABANDON, 
//                                           DS_UNKNOWN)
//
// The cfdp_struct can be used to determine each file's transactions ID as  
// well as monitor a file's transfer status.
//
// ////////////////////////////////////////////////////////////////////////////

void DeviceData(const char      *device_key, 
                int             packet_length, 
                unsigned char   *packet_buffer_ptr)
{
    unsigned int count;
    cfdp_struct_type *cfdp_struct_ptr;
    // Retrieve the individual cfdp structs from the packet_buffer;
    for (count = 0; count*sizeof(cfdp_struct_type) < (unsigned int)packet_length; count++)
    {
        cfdp_struct_ptr = (cfdp_struct_type *)(packet_buffer_ptr + count*sizeof(cfdp_struct_type));
        if (message_mask & MSG_CAT_PROGRESS)
        {
            printf("Progress Transaction_id %s -> %s\t file size=%lld\t bytes trans=%lld\t percent trans=%u%%\n",
                    cfdp_struct_ptr->transaction_id,
                    cfdp_struct_ptr->destination_pathname,
                    cfdp_struct_ptr->file_size,
                    cfdp_struct_ptr->bytes_transferred,
                    cfdp_struct_ptr->percent_transferred);
        }
    }
}

// ////////////////////////////////////////////////////////////////////////////
//
// InitExampleDataFilesPathnames creates and returns
// the appropriate source and destination pathnames.
//
// ////////////////////////////////////////////////////////////////////////////

int InitExampleDataFilesPathnames(char *pathname1MB,
                                  char *destination_pathname1MB,
                                  char *pathname2MB,
                                  char *destination_pathname2MB,
                                  char *pathname3MB,
                                  char *destination_pathname3MB)
{
    struct timeb timebuffer;

    if (TCAACGetHomeDirectory(home_path,sizeof(home_path)) != SUCCESS)
    {
        return(FAIL);
    }

    // Create a 1MB path names 
    sprintf(pathname1MB, "%s/cfdp_bp_destination_data_file_1MB",home_path);

    // Create a destination time tag appended file name 
    ftime(&timebuffer);
    sprintf(destination_pathname1MB,"%s_%u",
            pathname1MB,
            (unsigned int)timebuffer.time);

    // Create a 2MB path names 
    sprintf(pathname2MB, "%s/cfdp_bp_destination_data_file_2MB",home_path);

    // Create a destination time tag appended file name 
    sprintf(destination_pathname2MB,"%s_%u",
            pathname2MB,
            (unsigned int)timebuffer.time);

    // Create a 3MB path names 
    sprintf(pathname3MB, "%s/cfdp_bp_destination_data_file_3MB",home_path);

    // Create a destination time tag appended file name 
    sprintf(destination_pathname3MB,"%s_%u",
            pathname3MB,
            (unsigned int)timebuffer.time);
    return(SUCCESS);
}

// ////////////////////////////////////////////////////////////////////////////
//  
// Sample program creates 1MB, 2MB and 3MB pathnames to 1MB, 2MB and 3MB files 
// created by the cfdp_bp_destination example application.  Filestore actions, 
// initiated by this program, are performed on these files.  The program uses 
// the Filestore, FilestoreComponentION, AddFilestore, 
// AddFilestoreComponentRequestION, SendAllFilestoreRequests, 
// MonitorAllCFDPTransactions and RemoveFilestoreComponentRequest API 
// functions. 
//
// Main with optional input defining pathname for the CFDP configuration file.  
// The default CFDP configuration file pathname is 
// "./cfdp_bp_filestore_example_config.txt".
//
// The "cfdp_bp_destination" example must be running on the destination
// platform prior to starting other CFDP BP examples.  Assumes the source and
// and destination platforms are using the same operating system and user
// account.  Remote eid/node = 2.
//
// ////////////////////////////////////////////////////////////////////////////

int main(int argc, char *argv[])
{
    int return_value; 
    char pathname[256];
    char pathname1MB[256];
    char destination_pathname1MB[256];
    char pathname2MB[256];
    char destination_pathname2MB[256];
    char pathname3MB[256];
    char destination_pathname3MB[256];
    long long eid;
    unsigned int transaction_count;
    cfdp_struct_type *cfdp_struct_array_ptr = NULL;
    unsigned int timeout_in_sec;
    unsigned int i;
    char log_path[256];
    char log_filename[256];
    unsigned int lifespan;
    bp_class_of_service_type cos;                   
    unsigned int ordinal;           
    bp_transmission_mode_type mode;             
    bp_criticality_type criticality;

    char filestore_pathname[256];

    // Intialize message mask to print error messages.
    message_mask = MSG_CAT_ERROR;

    // Set default CFDP config_pathname 
    strcpy (pathname, "./cfdp_bp_filestore_example_config.txt");
    if (argc == 2)
    {
        strcpy(pathname,argv[1]);
    }
    else if (argc > 2)
    {
        printf("Error    Command line contains too many arguments.\n");
        return 0;
    }
    
    strcpy(log_path,"");
    strcpy(log_filename,"cfdp_bp_filestore_example_log_file");
    StartLoggingCFDPMessages(log_path,
                             log_filename,
                             FALSE_OR_NO);

    // Register the PrintMessage callback function prior to InitToolkitCfdp
    // to process error messages that may be generated during CFDP 
    // initialization.
    RegisterMessage(&PrintTheMessage);

    // Initialize CFDP. This funcition creates and connects the CFDP library.
    if (InitToolkitCfdp(pathname) == SUCCESS)
    {
        // Must initialize toolkit CFDP prior to recording CFDP metrics 
        strcpy(log_path,"");
        strcpy(log_filename,"cfdp_bp_filestore_example_metrics_file");
        StartRecordingCFDPMetricsSnapshot(log_path,log_filename);

        if (GetDisplayMessageMask(&message_mask) != SUCCESS)
        {
            printf("Error    Failed to GetDisplayMessageMask.\n");
        }

        // Register the CFDPDeviceData callback function after initialization 
        // since the CFDPDevice does not exist prior to initialization and this
        // function would fail.
        if (RegisterCFDPDeviceData(&DeviceData) != SUCCESS)
        {
            printf("Error    Failed to RegisterCFDPDeviceData.\n");
        }

        // Create a 1MB, 2MB and 3MB example data file pathnames.
        if (InitExampleDataFilesPathnames(pathname1MB,
                                          destination_pathname1MB,
                                          pathname2MB,
                                          destination_pathname2MB,
                                          pathname3MB,
                                          destination_pathname3MB) != SUCCESS)
        {
            printf("Error    Failed to InitExampleDataFiles.\n");
            DSCleanUp();
            return 0;
        }

        // Initialize the destination eid node number
        eid = 2;

        printf("\nCFDP BP Filestore Example\n\n");

        sprintf(filestore_pathname, "%s/test_create_file",home_path);

        // Exercise various filestore actions using the API.

        // Create a file in the home directory.
        if (Filestore(CFDP_CREATE_FILE,filestore_pathname,NULL,eid) != SUCCESS)
        {
            printf("Error    Failed to create file.\n");
            DSCleanUp();
            return 0;
        }

        lifespan = 86400;
        cos = BPD_STD_PRIORITY;             
        ordinal = 0;                
        mode = BPD_ASSURED;
        criticality = BPD_NOT_CRITICAL;

        // Delete the newly created 3MB data file in the home directory.
        if (FilestoreComponentION(CFDP_DELETE_FILE,pathname3MB,NULL,eid,
            lifespan,cos,ordinal,mode,criticality) != SUCCESS)
        {
            printf("Error    Failed to delete file.\n");
            DSCleanUp();
            return 0;
        }
        
        // Add the filestore action to append the 2MB data file to the end of the 
        // 1MB data file to a list of filestore actions.
        if (AddFilestore(CFDP_APPEND_FILE,pathname1MB,pathname2MB,eid) != SUCCESS)
        {
            printf("Error    Failed to append file.\n");
            DSCleanUp();
            return 0;
        }

        // Add the filestore action to rename the 1MB data file to a list of filestore 
        // actions.
        if (AddFilestore(CFDP_RENAME_FILE,pathname1MB,destination_pathname3MB,eid) != SUCCESS)
        {
            printf("Error    Failed to rename file.\n");
            DSCleanUp();
            return 0;
        }

        lifespan = 86400;
        cos = BPD_STD_PRIORITY;             
        ordinal = 0;                
        mode = BPD_ASSURED;
        criticality = BPD_NOT_CRITICAL;

        // Add the filestore action to delete the 2MB data file to a list of filestore 
        // actions.
        if (AddFilestoreComponentRequestION(CFDP_DELETE_FILE,pathname2MB,NULL,eid,lifespan,
            cos,ordinal,mode,criticality) != SUCCESS)
        {
            printf("Error    Failed to add delete file request.\n");
            DSCleanUp();
            return 0;
        }
    
        // Execute the list of filestore actions.
        if (SendAllRequests() != SUCCESS)
        {
            printf("Error    Failed to SendAllFilestoreRequests.\n");
            DSCleanUp();
            return 0;
        }
        
        // Set the monitor timeout so MonitorAllCFDPTransactions will not hang
        // indefinitely waiting for a transaction to complete execution.
        timeout_in_sec = 300;
        transaction_count = 5;
        // Get the final transaction status for the CFDP transactions.
        // NOTE: The cfdp config file "support_cfdp_status_requests" parameter 
        // and the "support_transaction_result_message" must be "true" to 
        // support transaction status monitoring.
        return_value = MonitorAllCFDPTransactions(timeout_in_sec,
                                                  &transaction_count,
                                                  &cfdp_struct_array_ptr);
        if (return_value == SUCCESS || return_value == CFDP_TIMEOUT)
        {
            // Loop through the array of cfdp structs to determine the final 
            // status of each CFDP transaction
            for (i=0; i<transaction_count;i++)
            {
                // Check for unsuccessful file transfer status (e.g.,DS_CANCEL,
                // DS_FAIL, DS_ABANDON, DS_UNKNOWN)
                if (cfdp_struct_array_ptr[i].cfdp_status == DS_SUCCESS)
                {
                    // Remove the request so subsequent calls to "Filestore" will not
                    // attempt to send the same filestore action.
                    RemoveFilestoreComponentRequest((cfdp_filestore_action_type)
                        cfdp_struct_array_ptr[i].cfdp_filestore_action,
                        cfdp_struct_array_ptr[i].source_pathname,
                        cfdp_struct_array_ptr[i].destination_pathname,
                        cfdp_struct_array_ptr[i].eid);
                }
                else
                {
                    // Take appropriate action
                    printf("Info     Failed to execute filestore with transaction ID: %s.\n", 
                            cfdp_struct_array_ptr[i].transaction_id);
                }
            }

            // NOTE: Problems may develop when freeing the memory associated 
            // with the cfdp_struct_array if the CFDP library's compiler or 
            // run time environment does not match the application code's 
            // compiler or run time environment.  This method is provided to 
            // avoid those problems. The code, "free(cfdp_struct_array_ptr)" 
            // will work if the library and application code's compilers 
            // are the same.
             FreeCFDPStructArrayMemoryAlloc(cfdp_struct_array_ptr);
        }
        else
        {
            printf("Error    Failed to MonitorAllCFDPTransactions.\n");
        }

    }  // end if (InitToolkitCfdp(pathname) == SUCCESS)
    // Sleep 1 second prior to exiting.
    #ifdef __linux__
    sleep(2);
    #else
    Sleep(2000);
    #endif
    DSCleanUp();
    return 0;
}