You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2023/01/05 15:04:24 UTC
[GitHub] [nuttx] hartmannathan commented on a diff in pull request #8026: Add mm map
hartmannathan commented on code in PR #8026:
URL: https://github.com/apache/nuttx/pull/8026#discussion_r1062566922
##########
fs/mmap/fs_anonmap.h:
##########
@@ -0,0 +1,64 @@
+/****************************************************************************
+ * fs/mmap/fs_anonmap.h
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership. The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+#ifndef __FS_MMAP_FS_ANONMAP_H
+#define __FS_MMAP_FS_ANONMAP_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <sys/types.h>
+#include <nuttx/mm/map.h>
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: map_anonymous
+ *
+ * Description:
+ * Support simulation of private anonymous mapping by allocating memory
+ * from heap
+ *
+ * Input Parameters:
+ * map Input struct containing user request
+ * kernel kmm_zalloc or kumm_zalloc
+ *
+ * Returned Value:
+ * On success returns 0. Otherwise negatet errno is returned appropriately.
Review Comment:
```suggestion
* On success returns 0. Otherwise negated errno is returned appropriately.
```
##########
fs/mmap/fs_rammap.c:
##########
@@ -44,12 +41,81 @@
* Public Data
****************************************************************************/
-/* This is the list of all mapped files */
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
-struct fs_allmaps_s g_rammaps =
+static int unmap_rammap(FAR struct task_group_s *group,
+ FAR struct mm_map_entry_s *map_entry,
+ FAR void *start,
+ size_t length)
{
- NXMUTEX_INITIALIZER
-};
+ FAR void *newaddr;
+ unsigned int offset;
+ bool kernel = map_entry->priv.i != 0 ? true : false;
+
+ /* Get the offset from the beginning of the region and the actual number
+ * of bytes to "unmap". All mappings must extend to the end of the region.
+ * There is no support for free a block of memory but leaving a block of
Review Comment:
```suggestion
* There is no support for freeing a block of memory but leaving a block of
```
##########
fs/mmap/fs_rammap.c:
##########
@@ -44,12 +41,81 @@
* Public Data
****************************************************************************/
-/* This is the list of all mapped files */
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
-struct fs_allmaps_s g_rammaps =
+static int unmap_rammap(FAR struct task_group_s *group,
+ FAR struct mm_map_entry_s *map_entry,
+ FAR void *start,
+ size_t length)
{
- NXMUTEX_INITIALIZER
-};
+ FAR void *newaddr;
+ unsigned int offset;
+ bool kernel = map_entry->priv.i != 0 ? true : false;
+
+ /* Get the offset from the beginning of the region and the actual number
+ * of bytes to "unmap". All mappings must extend to the end of the region.
+ * There is no support for free a block of memory but leaving a block of
+ * memory at the end. This is a consequence of using kumm_realloc() to
+ * simulate the unmapping.
+ */
+
+ offset = start - map_entry->vaddr;
+ if (offset + length < map_entry->length)
+ {
+ ferr("ERROR: Cannot umap without unmapping to the end\n");
+ return -ENOSYS;
+ }
+
+ /* Okay.. the region is beging umapped to the end. Make sure the length
Review Comment:
```suggestion
/* Okay.. the region is being umapped to the end. Make sure the length
```
##########
mm/map/mm_map.c:
##########
@@ -0,0 +1,325 @@
+/****************************************************************************
+ * mm/map/mm_map.c
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership. The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/mm/map.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <nuttx/sched.h>
+#include <nuttx/kmalloc.h>
+#include <assert.h>
+
+#if defined(CONFIG_BUILD_FLAT) || defined(__KERNEL__)
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+static bool in_range(FAR const void *start, size_t length,
+ FAR const void *range_start, size_t range_length)
+{
+ char *u_start = (char *)start;
+ char *u_end = u_start + length;
+ char *r_start = (char *)range_start;
+ char *r_end = r_start + range_length;
+
+ return (u_start >= r_start && u_start < r_end && /* start is in range */
+ u_end >= r_start && u_end <= r_end); /* end is in range */
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: mm_map_lock
+ *
+ * Description:
+ * Get exclusive access to task_group's mm_map
+ *
+ ****************************************************************************/
+
+int mm_map_lock(FAR struct task_group_s *group)
+{
+ return nxrmutex_lock(&group->tg_mm_map.mm_map_mutex);
+}
+
+/****************************************************************************
+ * Name: mm_map_unlock
+ *
+ * Description:
+ * Relinquish exclusive access to task_group's mm_map
+ *
+ ****************************************************************************/
+
+void mm_map_unlock(FAR struct task_group_s *group)
+{
+ DEBUGVERIFY(nxrmutex_unlock(&group->tg_mm_map.mm_map_mutex));
+}
+
+/****************************************************************************
+ * Name: mm_map_initialize
+ *
+ * Description:
+ * Allocates a task group specific mm_map stucture. Called when the group
+ * is initialized
+ *
+ ****************************************************************************/
+
+void mm_map_initialize(FAR struct mm_map_s *mm)
+{
+ sq_init(&mm->mm_map_sq);
+ nxrmutex_init(&mm->mm_map_mutex);
+}
+
+/****************************************************************************
+ * Name: mm_map_destroy
+ *
+ * Description:
+ * De-allocates a task group specific mm_map stucture and the mm_map_mutex
+ *
+ ****************************************************************************/
+
+void mm_map_destroy(FAR struct mm_map_s *mm)
+{
+ FAR struct mm_map_entry_s *map;
+
+ while ((map = (FAR struct mm_map_entry_s *)sq_remfirst(&mm->mm_map_sq)))
+ {
+ /* Pass null as group argument to indicate that actual MMU mappings
+ * must not be touched. The process is being deleted and we don't
+ * know in which context we are. Only kernel memory allocations
+ * need to be freed by drivers
+ */
+
+ /* Unmap the whole region */
+
+ if (!map->munmap ||
+ map->munmap(NULL, map, map->vaddr, map->length) < 0)
+ {
+ /* The driver doesn't support unmap, or unmap failed. Just free
+ * the entry.
+ * A call to drivers munmap failing here would be a bug in the
+ * driver. The driver should be able to unmap at least the full
+ * area, which it has mapped
+ */
+
+ kmm_free(map);
+ }
+ }
+
+ nxrmutex_destroy(&mm->mm_map_mutex);
+}
+
+/****************************************************************************
+ * Name: mm_map_add
+ *
+ * Description:
+ * Add a mapping to task group's mm_map list
+ *
+ ****************************************************************************/
+
+int mm_map_add(FAR struct mm_map_entry_s *entry)
+{
+ FAR struct tcb_s *tcb = nxsched_self();
+ FAR struct task_group_s *group = tcb->group;
+ FAR struct mm_map_s *mm = &group->tg_mm_map;
+ FAR struct mm_map_entry_s *map;
+ int ret;
+
+ if (!entry)
+ {
+ return -EINVAL;
+ }
+
+ /* Copy the provided mapping and add to the list */
+
+ map = kmm_malloc(sizeof(struct mm_map_entry_s));
+ if (!map)
+ {
+ return -EINVAL;
+ }
+
+ *map = *entry;
+
+ ret = mm_map_lock(group);
+ if (ret < 0)
+ {
+ kmm_free(map);
+ return ret;
+ }
+
+ sq_addfirst((sq_entry_t *)map, &mm->mm_map_sq);
+
+ mm_map_unlock(group);
+
+ return OK;
+}
+
+/****************************************************************************
+ * Name: mm_map_next
+ *
+ * Description:
+ * Returns the next mapping in the list.
+ *
+ ****************************************************************************/
+
+FAR struct mm_map_entry_s *mm_map_next(
+ FAR const struct mm_map_entry_s *entry)
+{
+ FAR struct tcb_s *tcb = nxsched_self();
+ FAR struct task_group_s *group = tcb->group;
+ FAR struct mm_map_s *mm = &group->tg_mm_map;
+ FAR struct mm_map_entry_s *map = NULL;
+
+ if (mm_map_lock(group) == OK)
+ {
+ if (entry == NULL)
+ {
+ map = (struct mm_map_entry_s *)sq_peek(&mm->mm_map_sq);
+ }
+ else
+ {
+ map = (struct mm_map_entry_s *)sq_next(((sq_entry_t *)entry));
+ }
+
+ mm_map_unlock(group);
+ }
+
+ return map;
+}
+
+/****************************************************************************
+ * Name: mm_map_find
+ *
+ * Description:
+ * Find the first mapping containing the range from the task group's list
+ *
+ ****************************************************************************/
+
+FAR struct mm_map_entry_s *mm_map_find(FAR const void *vaddr, size_t length)
+{
+ FAR struct tcb_s *tcb = nxsched_self();
+ FAR struct task_group_s *group = tcb->group;
+ FAR struct mm_map_s *mm = &group->tg_mm_map;
+ FAR struct mm_map_entry_s *map = NULL;
+
+ if (mm_map_lock(group) == OK)
+ {
+ map = (struct mm_map_entry_s *)sq_peek(&mm->mm_map_sq);
+
+ while (map && !in_range(vaddr, length, map->vaddr, map->length))
+ {
+ map = (struct mm_map_entry_s *)sq_next(((sq_entry_t *)map));
+ }
+
+ mm_map_unlock(group);
+ }
+
+ return map;
+}
+
+/****************************************************************************
+ * Name: mm_map_remove
+ *
+ * Description:
+ * Remove a mapping from the task group's list
+ *
+ ****************************************************************************/
+
+int mm_map_remove(FAR struct task_group_s *group,
+ FAR struct mm_map_entry_s **map)
+{
+ FAR struct mm_map_entry_s *prev;
+ FAR struct mm_map_entry_s *r = NULL;
+ FAR struct mm_map_s *mm;
+
+ if (!group)
+ {
+ /* We end up in here only through mm_map_destroy. The address
+ * environment is being destroyed and the group is not valid.
+ * just delete the entry
Review Comment:
```suggestion
* Just delete the entry
```
##########
fs/mmap/fs_rammap.c:
##########
@@ -44,12 +41,81 @@
* Public Data
****************************************************************************/
-/* This is the list of all mapped files */
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
-struct fs_allmaps_s g_rammaps =
+static int unmap_rammap(FAR struct task_group_s *group,
+ FAR struct mm_map_entry_s *map_entry,
+ FAR void *start,
+ size_t length)
{
- NXMUTEX_INITIALIZER
-};
+ FAR void *newaddr;
+ unsigned int offset;
+ bool kernel = map_entry->priv.i != 0 ? true : false;
+
+ /* Get the offset from the beginning of the region and the actual number
+ * of bytes to "unmap". All mappings must extend to the end of the region.
+ * There is no support for free a block of memory but leaving a block of
+ * memory at the end. This is a consequence of using kumm_realloc() to
+ * simulate the unmapping.
+ */
+
+ offset = start - map_entry->vaddr;
+ if (offset + length < map_entry->length)
+ {
+ ferr("ERROR: Cannot umap without unmapping to the end\n");
+ return -ENOSYS;
+ }
+
+ /* Okay.. the region is beging umapped to the end. Make sure the length
Review Comment:
Supposed to be "umapped" or "unmapped"?
##########
fs/mmap/fs_rammap.h:
##########
@@ -18,25 +18,7 @@
*
****************************************************************************/
-#ifndef __FS_MMAP_FS_RAMMAP_H
-#define __FS_MMAP_FS_RAMMAP_H
-
-/****************************************************************************
- * Included Files
- ****************************************************************************/
-
-#include <nuttx/config.h>
-
-#include <sys/types.h>
-#include <nuttx/mutex.h>
-
-#ifdef CONFIG_FS_RAMMAP
-
-/****************************************************************************
- * Public Types
- ****************************************************************************/
-
-/* This structure describes one file that has been copied to memory and
+/* This driver manages files that has been copied to memory and
Review Comment:
```suggestion
/* This driver manages files that have been copied to memory and
```
##########
include/nuttx/mm/map.h:
##########
@@ -63,11 +73,156 @@ struct mm_map_entry_s
struct mm_map_s
{
sq_queue_t mm_map_sq;
- mutex_t mm_map_mutex;
+ rmutex_t mm_map_mutex;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
-#endif /* __INCLUDE_NUTTX_MM_MM_MAP_H */
+/****************************************************************************
+ * Name: mm_map_lock
+ *
+ * Description:
+ * Get exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * OK on success
+ * A negated errno value on failure
+ *
+ ****************************************************************************/
+
+int mm_map_lock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_unlock
+ *
+ * Description:
+ * Relinquish exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_unlock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_initialize
+ *
+ * Description:
+ * Initialization function, called only by group_initialize
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_initialize(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_destroy
+ *
+ * Description:
+ * Uninitialization function, called only by group_release
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_destroy(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_add
+ *
+ * Description:
+ * Adds a virtual memory area into the list of mappings
+ *
+ * Input Parameters:
+ * entry - A pointer to mm_map_entry_s, mapping info to be added
+ *
+ * Returned Value:
+ * OK Added succesfully
Review Comment:
```suggestion
* OK Added successfully
```
##########
include/nuttx/mm/map.h:
##########
@@ -63,11 +73,156 @@ struct mm_map_entry_s
struct mm_map_s
{
sq_queue_t mm_map_sq;
- mutex_t mm_map_mutex;
+ rmutex_t mm_map_mutex;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
-#endif /* __INCLUDE_NUTTX_MM_MM_MAP_H */
+/****************************************************************************
+ * Name: mm_map_lock
+ *
+ * Description:
+ * Get exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * OK on success
+ * A negated errno value on failure
+ *
+ ****************************************************************************/
+
+int mm_map_lock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_unlock
+ *
+ * Description:
+ * Relinquish exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_unlock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_initialize
+ *
+ * Description:
+ * Initialization function, called only by group_initialize
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_initialize(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_destroy
+ *
+ * Description:
+ * Uninitialization function, called only by group_release
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_destroy(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_add
+ *
+ * Description:
+ * Adds a virtual memory area into the list of mappings
+ *
+ * Input Parameters:
+ * entry - A pointer to mm_map_entry_s, mapping info to be added
+ *
+ * Returned Value:
+ * OK Added succesfully
+ * -EINVAL: Invalid attempt to get the semaphore
+ * -EINTR: The wait was interrupted by the receipt of a signal.
+ * -ENOMEM: Out of memory
+ *
+ ****************************************************************************/
+
+int mm_map_add(FAR struct mm_map_entry_s *entry);
+
+/****************************************************************************
+ * Name: mm_map_next
+ *
+ * Description:
+ * Returns the next mapping in the list, following the argument.
+ * Can be used to iterate through all the mappings. Returns the first
+ * mapping when the argument "entry" is NULL.
+ *
+ * Input Parameters:
+ * entry - Pointer to a single mapping in this task group or NULL to get
+ * the first one
+ *
+ * Returned Value:
+ * Pointer to the next mapping
+ *
+ ****************************************************************************/
+
+FAR struct mm_map_entry_s *mm_map_next(
+ FAR const struct mm_map_entry_s *entry);
+
+/****************************************************************************
+ * Name: mm_map_find
+ *
+ * Description:
+ * Find the first mapping matching address and length
+ *
+ * Input Parameters:
+ * vaddr - Start address of the mapped area
+ * length - Length of the mapping
+ *
+ * Returned Value:
+ * Pointer to the mapping, NULL if not found
+ *
+ ****************************************************************************/
+
+FAR struct mm_map_entry_s *mm_map_find(FAR const void *vaddr,
+ size_t length);
+
+/****************************************************************************
+ * Name: mm_map_remove
+ *
+ * Description:
+ * Removes a virtual memory area from the list of mappings
+ * Sets the given pointer argument to a value which can be used to continue
+ * iteration (previous or NULL)
+ *
+ * Input Parameters:
+ * group - Pointer to current task_group_s. NULL in process exit case
+ * map - Pointer to a pointer to the mapping to be removed
+ *
+ * Returned Value:
+ * OK: Removed succesfully
Review Comment:
```suggestion
* OK: Removed successfully
```
##########
include/nuttx/mm/map.h:
##########
@@ -63,11 +73,156 @@ struct mm_map_entry_s
struct mm_map_s
{
sq_queue_t mm_map_sq;
- mutex_t mm_map_mutex;
+ rmutex_t mm_map_mutex;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
-#endif /* __INCLUDE_NUTTX_MM_MM_MAP_H */
+/****************************************************************************
+ * Name: mm_map_lock
+ *
+ * Description:
+ * Get exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * OK on success
+ * A negated errno value on failure
+ *
+ ****************************************************************************/
+
+int mm_map_lock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_unlock
+ *
+ * Description:
+ * Relinquish exclusive access to task_group's mm_map
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map_s
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_unlock(FAR struct task_group_s *group);
+
+/****************************************************************************
+ * Name: mm_map_initialize
+ *
+ * Description:
+ * Initialization function, called only by group_initialize
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_initialize(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_destroy
+ *
+ * Description:
+ * Uninitialization function, called only by group_release
+ *
+ * Input Parameters:
+ * mm - Pointer to the mm_map structure to be initialized
+ *
+ * Returned Value:
+ * None
+ *
+ ****************************************************************************/
+
+void mm_map_destroy(FAR struct mm_map_s *mm);
+
+/****************************************************************************
+ * Name: mm_map_add
+ *
+ * Description:
+ * Adds a virtual memory area into the list of mappings
+ *
+ * Input Parameters:
+ * entry - A pointer to mm_map_entry_s, mapping info to be added
+ *
+ * Returned Value:
+ * OK Added succesfully
+ * -EINVAL: Invalid attempt to get the semaphore
+ * -EINTR: The wait was interrupted by the receipt of a signal.
+ * -ENOMEM: Out of memory
+ *
+ ****************************************************************************/
+
+int mm_map_add(FAR struct mm_map_entry_s *entry);
+
+/****************************************************************************
+ * Name: mm_map_next
+ *
+ * Description:
+ * Returns the next mapping in the list, following the argument.
+ * Can be used to iterate through all the mappings. Returns the first
+ * mapping when the argument "entry" is NULL.
Review Comment:
```suggestion
* mapping when the argument "entry" is NULL.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org