Skip to content

Commit

Permalink
Fix nasa#648, rename internal fields for consistency
Browse files Browse the repository at this point in the history 
Use a variable name that matches the type of resource being accessed,
rather than just "local".  In particular this is important for readability
of timecb and timebase code where functions need often need to access both
types of objects at the same time.  This also updates filesys code to match.
  • Loading branch information
@jphickey
jphickey committed Dec 2, 2020
1 parent 51ced94 commit f9d508d
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 91 deletions.
100 changes: 50 additions & 50 deletions src/os/shared/src/osapi-filesys.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,17 @@ const char OS_FILESYS_RAMDISK_VOLNAME_PREFIX[] = "RAM";
*-----------------------------------------------------------------*/
bool OS_FileSys_FindVirtMountPoint(void *ref, osal_index_t local_id, const OS_common_record_t *obj)
{
OS_filesys_internal_record_t *rec = &OS_filesys_table[local_id];
const char * target = (const char *)ref;
OS_filesys_internal_record_t *filesys = &OS_filesys_table[local_id];
const char * target = (const char *)ref;
size_t mplen;

if ((rec->flags & OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL) == 0)
if ((filesys->flags & OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL) == 0)
{
return false;
}

mplen = strlen(rec->virtual_mountpt);
return (mplen > 0 && strncmp(target, rec->virtual_mountpt, mplen) == 0 &&
mplen = strlen(filesys->virtual_mountpt);
return (mplen > 0 && strncmp(target, filesys->virtual_mountpt, mplen) == 0 &&
(target[mplen] == '/' || target[mplen] == 0));
} /* end OS_FileSys_FindVirtMountPoint */

Expand All @@ -104,7 +104,7 @@ bool OS_FileSys_FindVirtMountPoint(void *ref, osal_index_t local_id, const OS_co
int32 OS_FileSys_Initialize(char *address, const char *fsdevname, const char *fsvolname, size_t blocksize,
osal_blockcount_t numblocks, bool should_format)
{
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;
int32 return_code;
OS_object_token_t token;

Expand All @@ -123,25 +123,25 @@ int32 OS_FileSys_Initialize(char *address, const char *fsdevname, const char *fs
}

/* check names are not excessively long strings */
if (strlen(fsdevname) >= sizeof(local->device_name) || strlen(fsvolname) >= sizeof(local->volume_name))
if (strlen(fsdevname) >= sizeof(filesys->device_name) || strlen(fsvolname) >= sizeof(filesys->volume_name))
{
return OS_FS_ERR_PATH_TOO_LONG;
}

return_code = OS_ObjectIdAllocateNew(LOCAL_OBJID_TYPE, fsdevname, &token);
if (return_code == OS_SUCCESS)
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

/* Reset the table entry and save the name */
OS_OBJECT_INIT(token, local, device_name, fsdevname);
OS_OBJECT_INIT(token, filesys, device_name, fsdevname);

/* populate the VolumeName and BlockSize ahead of the Impl call,
* so the implementation can reference this info if necessary */
local->blocksize = blocksize;
local->numblocks = numblocks;
local->address = address;
strcpy(local->volume_name, fsvolname);
filesys->blocksize = blocksize;
filesys->numblocks = numblocks;
filesys->address = address;
strcpy(filesys->volume_name, fsvolname);

/*
* Determine basic type of filesystem, if not already known
Expand All @@ -150,11 +150,11 @@ int32 OS_FileSys_Initialize(char *address, const char *fsdevname, const char *fs
* contains the string "RAM" then it is a RAM disk. Otherwise
* leave the type as UNKNOWN and let the implementation decide.
*/
if (local->fstype == OS_FILESYS_TYPE_UNKNOWN &&
(local->address != NULL || strncmp(local->volume_name, OS_FILESYS_RAMDISK_VOLNAME_PREFIX,
sizeof(OS_FILESYS_RAMDISK_VOLNAME_PREFIX) - 1) == 0))
if (filesys->fstype == OS_FILESYS_TYPE_UNKNOWN &&
(filesys->address != NULL || strncmp(filesys->volume_name, OS_FILESYS_RAMDISK_VOLNAME_PREFIX,
sizeof(OS_FILESYS_RAMDISK_VOLNAME_PREFIX) - 1) == 0))
{
local->fstype = OS_FILESYS_TYPE_VOLATILE_DISK;
filesys->fstype = OS_FILESYS_TYPE_VOLATILE_DISK;
}

return_code = OS_FileSysStartVolume_Impl(OS_ObjectIndexFromToken(&token));
Expand All @@ -172,7 +172,7 @@ int32 OS_FileSys_Initialize(char *address, const char *fsdevname, const char *fs

if (return_code == OS_SUCCESS)
{
local->flags |= OS_FILESYS_FLAG_IS_READY;
filesys->flags |= OS_FILESYS_FLAG_IS_READY;
}
else
{
Expand Down Expand Up @@ -224,7 +224,7 @@ int32 OS_FileSysAPI_Init(void)
*-----------------------------------------------------------------*/
int32 OS_FileSysAddFixedMap(osal_id_t *filesys_id, const char *phys_path, const char *virt_path)
{
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;
int32 return_code;
OS_object_token_t token;
const char * dev_name;
Expand Down Expand Up @@ -263,20 +263,20 @@ int32 OS_FileSysAddFixedMap(osal_id_t *filesys_id, const char *phys_path, const
return_code = OS_ObjectIdAllocateNew(LOCAL_OBJID_TYPE, dev_name, &token);
if (return_code == OS_SUCCESS)
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

/* Reset the table entry and save the name */
OS_OBJECT_INIT(token, local, device_name, dev_name);
OS_OBJECT_INIT(token, filesys, device_name, dev_name);

strncpy(local->volume_name, dev_name, sizeof(local->volume_name) - 1);
strncpy(local->system_mountpt, phys_path, sizeof(local->system_mountpt) - 1);
strncpy(local->virtual_mountpt, virt_path, sizeof(local->virtual_mountpt) - 1);
strncpy(filesys->volume_name, dev_name, sizeof(filesys->volume_name) - 1);
strncpy(filesys->system_mountpt, phys_path, sizeof(filesys->system_mountpt) - 1);
strncpy(filesys->virtual_mountpt, virt_path, sizeof(filesys->virtual_mountpt) - 1);

/*
* mark the entry that it is a fixed disk
*/
local->fstype = OS_FILESYS_TYPE_FS_BASED;
local->flags = OS_FILESYS_FLAG_IS_FIXED;
filesys->fstype = OS_FILESYS_TYPE_FS_BASED;
filesys->flags = OS_FILESYS_FLAG_IS_FIXED;

/*
* The "mount" implementation is required as it will
Expand All @@ -286,7 +286,7 @@ int32 OS_FileSysAddFixedMap(osal_id_t *filesys_id, const char *phys_path, const

if (return_code == OS_SUCCESS)
{
local->flags |= OS_FILESYS_FLAG_IS_READY;
filesys->flags |= OS_FILESYS_FLAG_IS_READY;
return_code = OS_FileSysMountVolume_Impl(OS_ObjectIndexFromToken(&token));
}

Expand All @@ -295,7 +295,7 @@ int32 OS_FileSysAddFixedMap(osal_id_t *filesys_id, const char *phys_path, const
/*
* mark the entry that it is a fixed disk
*/
local->flags |= OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL;
filesys->flags |= OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL;
}

/* Check result, finalize record, and unlock global table. */
Expand Down Expand Up @@ -424,23 +424,23 @@ int32 OS_mount(const char *devname, const char *mountpoint)
{
int32 return_code;
OS_object_token_t token;
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;

/* Check parameters */
if (devname == NULL || mountpoint == NULL)
{
return OS_INVALID_POINTER;
}

if (strlen(devname) >= sizeof(local->device_name) || strlen(mountpoint) >= sizeof(local->virtual_mountpt))
if (strlen(devname) >= sizeof(filesys->device_name) || strlen(mountpoint) >= sizeof(filesys->virtual_mountpt))
{
return OS_FS_ERR_PATH_TOO_LONG;
}

return_code = OS_ObjectIdGetByName(OS_LOCK_MODE_GLOBAL, LOCAL_OBJID_TYPE, devname, &token);
if (return_code == OS_SUCCESS)
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

/*
* READY flag should be set (mkfs/initfs must have been called on this FS)
Expand All @@ -449,12 +449,12 @@ int32 OS_mount(const char *devname, const char *mountpoint)
* FIXED flag _should_ always be unset (these don't support mount/unmount)
* but to support abstraction this is not enforced.
*/
if ((local->flags & ~OS_FILESYS_FLAG_IS_FIXED) != OS_FILESYS_FLAG_IS_READY)
if ((filesys->flags & ~OS_FILESYS_FLAG_IS_FIXED) != OS_FILESYS_FLAG_IS_READY)
{
/* mount() cannot be used on this file system at this time */
return_code = OS_ERR_INCORRECT_OBJ_STATE;
}
else if (local->system_mountpt[0] == 0)
else if (filesys->system_mountpt[0] == 0)
{
/*
* The system mount point should be a non-empty string.
Expand All @@ -470,8 +470,8 @@ int32 OS_mount(const char *devname, const char *mountpoint)
{
/* mark as mounted in the local table.
* For now this does both sides (system and virtual) */
local->flags |= OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL;
strcpy(local->virtual_mountpt, mountpoint);
filesys->flags |= OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL;
strcpy(filesys->virtual_mountpt, mountpoint);
}

OS_ObjectIdRelease(&token);
Expand All @@ -498,15 +498,15 @@ int32 OS_unmount(const char *mountpoint)
{
int32 return_code;
OS_object_token_t token;
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;

/* Check parameters */
if (mountpoint == NULL)
{
return OS_INVALID_POINTER;
}

if (strlen(mountpoint) >= sizeof(local->virtual_mountpt))
if (strlen(mountpoint) >= sizeof(filesys->virtual_mountpt))
{
return OS_FS_ERR_PATH_TOO_LONG;
}
Expand All @@ -516,7 +516,7 @@ int32 OS_unmount(const char *mountpoint)

if (return_code == OS_SUCCESS)
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

/*
* FIXED flag should always be unset (these don't support mount/unmount at all)
Expand All @@ -525,7 +525,7 @@ int32 OS_unmount(const char *mountpoint)
*
* The FIXED flag is not enforced to support abstraction.
*/
if ((local->flags & ~OS_FILESYS_FLAG_IS_FIXED) !=
if ((filesys->flags & ~OS_FILESYS_FLAG_IS_FIXED) !=
(OS_FILESYS_FLAG_IS_READY | OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL))
{
/* unmount() cannot be used on this file system at this time */
Expand All @@ -540,7 +540,7 @@ int32 OS_unmount(const char *mountpoint)
{
/* mark as mounted in the local table.
* For now this does both sides (system and virtual) */
local->flags &= ~(OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL);
filesys->flags &= ~(OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM | OS_FILESYS_FLAG_IS_MOUNTED_VIRTUAL);
}

OS_ObjectIdRelease(&token);
Expand Down Expand Up @@ -706,7 +706,7 @@ int32 OS_FS_GetPhysDriveName(char *PhysDriveName, const char *MountPoint)
{
OS_object_token_t token;
int32 return_code;
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;

if (MountPoint == NULL || PhysDriveName == NULL)
{
Expand All @@ -724,11 +724,11 @@ int32 OS_FS_GetPhysDriveName(char *PhysDriveName, const char *MountPoint)

if (return_code == OS_SUCCESS)
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

if ((local->flags & OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM) != 0)
if ((filesys->flags & OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM) != 0)
{
strncpy(PhysDriveName, local->system_mountpt, OS_FS_PHYS_NAME_LEN - 1);
strncpy(PhysDriveName, filesys->system_mountpt, OS_FS_PHYS_NAME_LEN - 1);
PhysDriveName[OS_FS_PHYS_NAME_LEN - 1] = 0;
}
else
Expand Down Expand Up @@ -811,7 +811,7 @@ int32 OS_TranslatePath(const char *VirtualPath, char *LocalPath)
OS_object_token_t token;
int32 return_code;
const char * name_ptr;
OS_filesys_internal_record_t *local;
OS_filesys_internal_record_t *filesys;
size_t SysMountPointLen;
size_t VirtPathLen;
size_t VirtPathBegin;
Expand Down Expand Up @@ -868,15 +868,15 @@ int32 OS_TranslatePath(const char *VirtualPath, char *LocalPath)
}
else
{
local = OS_OBJECT_TABLE_GET(OS_filesys_table, token);
filesys = OS_OBJECT_TABLE_GET(OS_filesys_table, token);

if ((local->flags & OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM) != 0)
if ((filesys->flags & OS_FILESYS_FLAG_IS_MOUNTED_SYSTEM) != 0)
{
SysMountPointLen = strlen(local->system_mountpt);
VirtPathBegin = strlen(local->virtual_mountpt);
SysMountPointLen = strlen(filesys->system_mountpt);
VirtPathBegin = strlen(filesys->virtual_mountpt);
if (SysMountPointLen < OS_MAX_LOCAL_PATH_LEN)
{
memcpy(LocalPath, local->system_mountpt, SysMountPointLen);
memcpy(LocalPath, filesys->system_mountpt, SysMountPointLen);
}
}
else
Expand Down
Loading

0 comments on commit f9d508d

Please sign in to comment.