source: trunk/kernel/mm/kmem.h @ 620

Last change on this file since 620 was 619, checked in by alain, 6 years ago

1) Fix a bug in KSH : after the "load" command,

the [ksh] prompt is now printed after completion
of the loaded application.

2) Fix a bug in vmm_handle_cow() : the copy-on-write

use now a hal_remote_memcpy() to replicate the page content.
File size: 6.8 KB
RevLine 
[1]1/*
2 * kmem.h - kernel unified memory allocator interface
3 *
4 * Authors  Ghassan Almaless (2008,2009,2010,2011,2012)
[567]5 *          Alain Greiner (2016,2017,2018)
[1]6 *
7 * Copyright (c) UPMC Sorbonne Universites
8 *
9 * This file is part of ALMOS-MKH.
10 *
11 * ALMOS-MKH is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2.0 of the License.
14 *
15 * ALMOS-MKH is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with ALMOS; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25#ifndef _KMEM_H_
26#define _KMEM_H_
27
[457]28#include <hal_kernel_types.h>
[1]29#include <kcm.h>
30
31/*************************************************************************************
[23]32 * This enum defines the Kernel Memory Types for dynamically allocated objects.
33 * WARNING : this enum must be kepts consistent with use in kmem.c file.
[1]34 ************************************************************************************/
35
36enum
37{
[611]38    KMEM_PAGE             = 0,   /*! reserved for PPM allocator                     */
39    KMEM_GENERIC          = 1,   /*! reserved for KHM allocator                     */
40    KMEM_KCM              = 2,   /*! kcm_t                                          */
41    KMEM_VSEG             = 3,   /*! vseg_t                                         */
42    KMEM_DEVICE           = 4,   /*! device_t                                       */
43    KMEM_MAPPER           = 5,   /*! mapper_t                                       */
44    KMEM_PROCESS          = 6,   /*! process_t                                      */
45    KMEM_CPU_CTX          = 7,   /*! hal_cpu_context_t                              */
46    KMEM_FPU_CTX          = 8,   /*! hal_fpu_context_t                              */
[619]47    KMEM_GEN_BARRIER      = 9,   /*! generi_cbarrier_t                              */
[1]48
[619]49    KMEM_SMP_BARRIER      = 10,  /*! simple_barrier_t                               */
50    KMEM_DEVFS_CTX        = 11,  /*! fatfs_inode_t                                  */
51    KMEM_FATFS_CTX        = 12,  /*! fatfs_ctx_t                                    */
52    KMEM_VFS_CTX          = 13,  /*! vfs_context_t                                  */
53    KMEM_VFS_INODE        = 14,  /*! vfs_inode_t                                    */
54    KMEM_VFS_DENTRY       = 15,  /*! vfs_dentry_t                                   */
55    KMEM_VFS_FILE         = 16,  /*! vfs_file_t                                     */
56    KMEM_SEM              = 17,  /*! remote_sem_t                                   */
57    KMEM_CONDVAR          = 18,  /*! remote_condvar_t                               */
58    KMEM_MUTEX            = 19,  /*! remote_mutex_t                                 */
[1]59
[619]60    KMEM_DIR              = 20,  /*! remote_dir_t                                   */
61    KMEM_512_BYTES        = 21,  /*! 512 bytes aligned                              */
[611]62
[619]63    KMEM_TYPES_NR         = 22,
[1]64};
65
66/*************************************************************************************
[18]67 * This defines the generic Allocation Flags that can be associated to
[1]68 * a Kernel Memory Request.
69 ************************************************************************************/
70
71#define AF_NONE       0x0000   // no attributes
[18]72#define AF_KERNEL     0x0001   // for kernel use
[1]73#define AF_ZERO       0x0002   // must be reset to 0
74
75/*************************************************************************************
[18]76 * This structure defines a Kernel Memory Request.
[1]77 ************************************************************************************/
78
79typedef struct kmem_req_s
80{
81    uint32_t      type;   /*! request type                                          */
82    uint32_t      size;   /*! ln2(nb_pages) if PPM / bytes if KHM / unused by KCM   */
83    uint32_t      flags;  /*! request attributes                                    */
84    void        * ptr;    /*! local pointer on allocated buffer (only used by free) */
[18]85}
[1]86kmem_req_t;
87
88/*************************************************************************************
89 * This generic function allocates physical memory in the local cluster
90 * as specified by the request descriptor.
[7]91 * It uses three specialised physical memory allocators, depending on request type:
[1]92 * - PPM (Physical Pages Manager) allocates N contiguous physical pages,
93 *       N must be a power of 2.
94 * - KHM (Kernel Heap Manager) allocates a physical memory buffer,
95 *       that can have any size.
96 * - KCM (Kernel Cache Manager) allocates various fixed size objects,
97 *       handling a dedicated cache for each object type.
98 *************************************************************************************
[7]99 * @ req   : local pointer to allocation request.
[619]100 * @ return a local pointer on page descriptor if KMEM_PAGE.
[7]101 *   return a local pointer to allocated buffer if KCM or KHM.
102 *   return NULL if no physical memory available.
[1]103 ************************************************************************************/
104void * kmem_alloc( kmem_req_t * req );
105
106/*************************************************************************************
107 * This function releases previously allocated physical memory, as specified
108 * by the "type" and "ptr" fiels of the kmem-req_t request.
109 *************************************************************************************
110 * @ req : local pointer to request descriptor.
111 ************************************************************************************/
112void  kmem_free ( kmem_req_t * req );
113
[7]114/*************************************************************************************
115 * This function returns a printable string for a kmem object type.
116 *************************************************************************************
117 * @ type   : kmem object type.
118 ************************************************************************************/
119char * kmem_type_str( uint32_t type );
[1]120
[7]121/*************************************************************************************
122 * This function returns the size (bytes) for a kmem object type.
123 *************************************************************************************
124 * @ type   : kmem object type.
125 ************************************************************************************/
126uint32_t kmem_type_size( uint32_t type );
127
128/*************************************************************************************
[18]129 * This function displays the content of the KCM pointers Table
[7]130 ************************************************************************************/
[486]131void kmem_print_kcm_table( void );
[7]132
133
[1]134#endif  /* _KMEM_H_ */
Note: See TracBrowser for help on using the repository browser.