Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	fx_directory_information_get.c	Lines:	39	39	100.0 %
Date:	2024-03-11 05:15:45	Branches:	28	28	100.0 %


/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** FileX Component                                                       */
/**                                                                       */
/**   Directory                                                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define FX_SOURCE_CODE


/* Include necessary system files.  */

#include "fx_api.h"
#include "fx_system.h"
#include "fx_directory.h"
#include "fx_file.h"
#include "fx_utility.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _fx_directory_information_get                       PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    William E. Lamie, Microsoft Corporation                             */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function first attempts to find the specified directory name.  */
/*    If found, the complete file parameters are placed in all non-NULL   */
/*    return parameters.  If the file name is not found, the appropriate  */
/*    error code is returned to the caller.                               */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    media_ptr                             Media control block pointer   */
/*    directory_name                        Directory name pointer        */
/*    attributes                            Pointer to attributes         */
/*    size                                  Pointer to size               */
/*    year                                  Pointer to year               */
/*    month                                 Pointer to month              */
/*    day                                   Pointer to day                */
/*    hour                                  Pointer to hour               */
/*    minute                                Pointer to minute             */
/*    second                                Pointer to second             */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    return status                                                       */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _fx_directory_search                  Search for the file name in   */
/*                                          the directory structure       */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  05-19-2020     William E. Lamie         Initial Version 6.0           */
/*  09-30-2020     William E. Lamie         Modified comment(s), verified */
/*                                            memcpy usage,               */
/*                                            resulting in version 6.1    */
/*                                                                        */
/**************************************************************************/
UINT  _fx_directory_information_get(FX_MEDIA *media_ptr, CHAR *directory_name,
                                    UINT *attributes, ULONG *size,
                                    UINT *year, UINT *month, UINT *day,
                                    UINT *hour, UINT *minute, UINT *second)
{

UINT         status;
FX_DIR_ENTRY dir_entry;
ULONG        open_count;
FX_FILE     *search_ptr;


#ifndef FX_MEDIA_STATISTICS_DISABLE

    /* Increment the number of times this service has been called.  */
    media_ptr -> fx_media_directory_information_gets++;
#endif

    /* Setup pointer to media name buffer.  */
    dir_entry.fx_dir_entry_name =  media_ptr -> fx_media_name_buffer + FX_MAX_LONG_NAME_LEN;

    /* Clear the short name string.  */
    dir_entry.fx_dir_entry_short_name[0] =  0;

    /* Check the media to make sure it is open.  */
    if (media_ptr -> fx_media_id != FX_MEDIA_ID)
    {

        /* Return the media not opened error.  */
        return(FX_MEDIA_NOT_OPEN);
    }

    /* If trace is enabled, insert this event into the trace buffer.  */
    FX_TRACE_IN_LINE_INSERT(FX_TRACE_DIRECTORY_INFORMATION_GET, media_ptr, directory_name, 0, 0, FX_TRACE_DIRECTORY_EVENTS, 0, 0)

    /* Protect against other threads accessing the media.  */
    FX_PROTECT

    /* Search the system for the supplied directory name.  */
    status =  _fx_directory_search(media_ptr, directory_name, &dir_entry, FX_NULL, FX_NULL);

    /* Determine if the search was successful.  */
    if (status != FX_SUCCESS)
    {

        /* Release media protection.  */
        FX_UNPROTECT

        /* Return the error code.  */
        return(status);
    }

    /* Check the list of open files for others open for writing.  */
    open_count =  media_ptr -> fx_media_opened_file_count;
    search_ptr =  media_ptr -> fx_media_opened_file_list;
    while (open_count)
    {

        /* Look at each opened file to see if the same file is opened
           for writing.  */
        if ((search_ptr -> fx_file_dir_entry.fx_dir_entry_log_sector == dir_entry.fx_dir_entry_log_sector) &&
            (search_ptr -> fx_file_dir_entry.fx_dir_entry_byte_offset == dir_entry.fx_dir_entry_byte_offset) &&
            (search_ptr -> fx_file_open_mode))
        {

            /* The file has been opened for writing by a previous call. Use the information used by
               the writer instead of what is currently on the media.  */
            _fx_utility_memory_copy((UCHAR *)&search_ptr -> fx_file_dir_entry, (UCHAR *)&dir_entry, sizeof(FX_DIR_ENTRY)); /* Use case of memcpy is verified. */
            break;
        }

        /* Adjust the pointer and decrement the search count.  */
        search_ptr =  search_ptr -> fx_file_opened_next;
        open_count--;
    }

    /* Check to see if attributes are required.  */
    if (attributes)
    {

        /* Pickup the attributes.  */
        *attributes =  dir_entry.fx_dir_entry_attributes;
    }

    /* Check to see if the size is required.  */
    if (size)
    {

        /* Pickup the size.  */
        *size =  (ULONG)dir_entry.fx_dir_entry_file_size;
    }

    /* Check to see if the year is required.  */
    if (year)
    {

        /* Pickup the year.  */
        *year =  ((dir_entry.fx_dir_entry_date >> FX_YEAR_SHIFT) & FX_YEAR_MASK) +
                                                                        FX_BASE_YEAR;
    }

    /* Check to see if the month is required.  */
    if (month)
    {

        /* Pickup the month.  */
        *month =  (dir_entry.fx_dir_entry_date >> FX_MONTH_SHIFT) & FX_MONTH_MASK;
    }

    /* Check to see if the day is required.  */
    if (day)
    {

        /* Pickup the day.  */
        *day =  dir_entry.fx_dir_entry_date & FX_DAY_MASK;
    }

    /* Check to see if the hour is required.  */
    if (hour)
    {

        /* Pickup the hour.  */
        *hour =  (dir_entry.fx_dir_entry_time >> FX_HOUR_SHIFT) & FX_HOUR_MASK;
    }

    /* Check to see if the minute is required.  */
    if (minute)
    {

        /* Pickup the minute.  */
        *minute =  (dir_entry.fx_dir_entry_time >> FX_MINUTE_SHIFT) & FX_MINUTE_MASK;
    }

    /* Check to see if the second is required.  */
    if (second)
    {

        /* Pickup the second.  */
        *second =  (dir_entry.fx_dir_entry_time & FX_SECOND_MASK) * 2;
    }

    /* Release media protection.  */
    FX_UNPROTECT

    /* Directory information get is complete, return successful status.  */
    return(FX_SUCCESS);
}



Generated by: GCOVR (Version 4.1)

Line	Branch	Exec	Source
1			/***************************************************************************
2			* Copyright (c) 2024 Microsoft Corporation
3			*
4			* This program and the accompanying materials are made available under the
5			* terms of the MIT License which is available at
6			* https://opensource.org/licenses/MIT.
7			*
8			* SPDX-License-Identifier: MIT
9			**************************************************************************/
10
11
12			/**************************************************************************/
13			/**************************************************************************/
14			/** */
15			/** FileX Component */
16			/** */
17			/** Directory */
18			/** */
19			/**************************************************************************/
20			/**************************************************************************/
21
22			#define FX_SOURCE_CODE
23
24
25			/* Include necessary system files. */
26
27			#include "fx_api.h"
28			#include "fx_system.h"
29			#include "fx_directory.h"
30			#include "fx_file.h"
31			#include "fx_utility.h"
32
33
34			/**************************************************************************/
35			/* */
36			/* FUNCTION RELEASE */
37			/* */
38			/* _fx_directory_information_get PORTABLE C */
39			/* 6.1 */
40			/* AUTHOR */
41			/* */
42			/* William E. Lamie, Microsoft Corporation */
43			/* */
44			/* DESCRIPTION */
45			/* */
46			/* This function first attempts to find the specified directory name. */
47			/* If found, the complete file parameters are placed in all non-NULL */
48			/* return parameters. If the file name is not found, the appropriate */
49			/* error code is returned to the caller. */
50			/* */
51			/* INPUT */
52			/* */
53			/* media_ptr Media control block pointer */
54			/* directory_name Directory name pointer */
55			/* attributes Pointer to attributes */
56			/* size Pointer to size */
57			/* year Pointer to year */
58			/* month Pointer to month */
59			/* day Pointer to day */
60			/* hour Pointer to hour */
61			/* minute Pointer to minute */
62			/* second Pointer to second */
63			/* */
64			/* OUTPUT */
65			/* */
66			/* return status */
67			/* */
68			/* CALLS */
69			/* */
70			/* _fx_directory_search Search for the file name in */
71			/* the directory structure */
72			/* */
73			/* CALLED BY */
74			/* */
75			/* Application Code */
76			/* */
77			/* RELEASE HISTORY */
78			/* */
79			/* DATE NAME DESCRIPTION */
80			/* */
81			/* 05-19-2020 William E. Lamie Initial Version 6.0 */
82			/* 09-30-2020 William E. Lamie Modified comment(s), verified */
83			/* memcpy usage, */
84			/* resulting in version 6.1 */
85			/* */
86			/**************************************************************************/
87		7	UINT _fx_directory_information_get(FX_MEDIA media_ptr, CHAR directory_name,
88			UINT attributes, ULONG size,
89			UINT year, UINT month, UINT *day,
90			UINT hour, UINT minute, UINT *second)
91			{
92
93			UINT status;
94			FX_DIR_ENTRY dir_entry;
95			ULONG open_count;
96			FX_FILE *search_ptr;
97
98
99			#ifndef FX_MEDIA_STATISTICS_DISABLE
100
101			/* Increment the number of times this service has been called. */
102		7	media_ptr -> fx_media_directory_information_gets++;
103			#endif
104
105			/* Setup pointer to media name buffer. */
106		7	dir_entry.fx_dir_entry_name = media_ptr -> fx_media_name_buffer + FX_MAX_LONG_NAME_LEN;
107
108			/* Clear the short name string. */
109		7	dir_entry.fx_dir_entry_short_name[0] = 0;
110
111			/* Check the media to make sure it is open. */
112	✓✓	7	if (media_ptr -> fx_media_id != FX_MEDIA_ID)
113			{
114
115			/* Return the media not opened error. */
116		1	return(FX_MEDIA_NOT_OPEN);
117			}
118
119			/* If trace is enabled, insert this event into the trace buffer. */
120			FX_TRACE_IN_LINE_INSERT(FX_TRACE_DIRECTORY_INFORMATION_GET, media_ptr, directory_name, 0, 0, FX_TRACE_DIRECTORY_EVENTS, 0, 0)
121
122			/* Protect against other threads accessing the media. */
123		6	FX_PROTECT
124
125			/* Search the system for the supplied directory name. */
126		6	status = _fx_directory_search(media_ptr, directory_name, &dir_entry, FX_NULL, FX_NULL);
127
128			/* Determine if the search was successful. */
129	✓✓	6	if (status != FX_SUCCESS)
130			{
131
132			/* Release media protection. */
133		1	FX_UNPROTECT
134
135			/* Return the error code. */
136		1	return(status);
137			}
138
139			/* Check the list of open files for others open for writing. */
140		5	open_count = media_ptr -> fx_media_opened_file_count;
141		5	search_ptr = media_ptr -> fx_media_opened_file_list;
142	✓✓	20	while (open_count)
143			{
144
145			/* Look at each opened file to see if the same file is opened
146			for writing. */
147	✓✓	16	if ((search_ptr -> fx_file_dir_entry.fx_dir_entry_log_sector == dir_entry.fx_dir_entry_log_sector) &&
148	✓✓	7	(search_ptr -> fx_file_dir_entry.fx_dir_entry_byte_offset == dir_entry.fx_dir_entry_byte_offset) &&
149	✓✓	3	(search_ptr -> fx_file_open_mode))
150			{
151
152			/* The file has been opened for writing by a previous call. Use the information used by
153			the writer instead of what is currently on the media. */
154		1	_fx_utility_memory_copy((UCHAR )&search_ptr -> fx_file_dir_entry, (UCHAR )&dir_entry, sizeof(FX_DIR_ENTRY)); /* Use case of memcpy is verified. */
155		1	break;
156			}
157
158			/* Adjust the pointer and decrement the search count. */
159		15	search_ptr = search_ptr -> fx_file_opened_next;
160		15	open_count--;
161			}
162
163			/* Check to see if attributes are required. */
164	✓✓	5	if (attributes)
165			{
166
167			/* Pickup the attributes. */
168		3	*attributes = dir_entry.fx_dir_entry_attributes;
169			}
170
171			/* Check to see if the size is required. */
172	✓✓	5	if (size)
173			{
174
175			/* Pickup the size. */
176		3	*size = (ULONG)dir_entry.fx_dir_entry_file_size;
177			}
178
179			/* Check to see if the year is required. */
180	✓✓	5	if (year)
181			{
182
183			/* Pickup the year. */
184		3	*year = ((dir_entry.fx_dir_entry_date >> FX_YEAR_SHIFT) & FX_YEAR_MASK) +
185			FX_BASE_YEAR;
186			}
187
188			/* Check to see if the month is required. */
189	✓✓	5	if (month)
190			{
191
192			/* Pickup the month. */
193		3	*month = (dir_entry.fx_dir_entry_date >> FX_MONTH_SHIFT) & FX_MONTH_MASK;
194			}
195
196			/* Check to see if the day is required. */
197	✓✓	5	if (day)
198			{
199
200			/* Pickup the day. */
201		3	*day = dir_entry.fx_dir_entry_date & FX_DAY_MASK;
202			}
203
204			/* Check to see if the hour is required. */
205	✓✓	5	if (hour)
206			{
207
208			/* Pickup the hour. */
209		3	*hour = (dir_entry.fx_dir_entry_time >> FX_HOUR_SHIFT) & FX_HOUR_MASK;
210			}
211
212			/* Check to see if the minute is required. */
213	✓✓	5	if (minute)
214			{
215
216			/* Pickup the minute. */
217		4	*minute = (dir_entry.fx_dir_entry_time >> FX_MINUTE_SHIFT) & FX_MINUTE_MASK;
218			}
219
220			/* Check to see if the second is required. */
221	✓✓	5	if (second)
222			{
223
224			/* Pickup the second. */
225		4	second = (dir_entry.fx_dir_entry_time & FX_SECOND_MASK) 2;
226			}
227
228			/* Release media protection. */
229		5	FX_UNPROTECT
230
231			/* Directory information get is complete, return successful status. */
232		5	return(FX_SUCCESS);
233			}
234