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

Last change on this file since 597 was 567, checked in by alain, 6 years ago

Complete restructuration of kernel locks.
File size: 6.6 KB
Line 
1/*
2 * kmem.h - kernel unified memory allocator interface
3 *
4 * Authors  Ghassan Almaless (2008,2009,2010,2011,2012)
5 *          Alain Greiner (2016,2017,2018)
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
28#include <hal_kernel_types.h>
29#include <kcm.h>
30
31/*************************************************************************************
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.
34 ************************************************************************************/
35
36enum
37{
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                                */
47  KMEM_BARRIER          = 9,   /*! remote_barrier_t                                 */
48
49  KMEM_DEVFS_CTX        = 10,  /*! fatfs_inode_t                                    */
50  KMEM_FATFS_CTX        = 11,  /*! fatfs_ctx_t                                      */
51  KMEM_VFS_CTX          = 12,  /*! vfs_context_t                                    */
52  KMEM_VFS_INODE        = 13,  /*! vfs_inode_t                                      */
53  KMEM_VFS_DENTRY       = 14,  /*! vfs_dentry_t                                     */
54  KMEM_VFS_FILE         = 15,  /*! vfs_file_t                                       */
55  KMEM_SEM              = 16,  /*! remote_sem_t                                     */
56  KMEM_CONDVAR          = 17,  /*! remote_condvar_t                                 */
57  KMEM_MUTEX            = 18,  /*! remote_mutex_t                                   */
58  KMEM_512_BYTES        = 19,  /*! 512 bytes aligned                                */
59
60  KMEM_TYPES_NR         = 21,
61};
62
63/*************************************************************************************
64 * This defines the generic Allocation Flags that can be associated to
65 * a Kernel Memory Request.
66 ************************************************************************************/
67
68#define AF_NONE       0x0000   // no attributes
69#define AF_KERNEL     0x0001   // for kernel use
70#define AF_ZERO       0x0002   // must be reset to 0
71
72/*************************************************************************************
73 * This structure defines a Kernel Memory Request.
74 ************************************************************************************/
75
76typedef struct kmem_req_s
77{
78    uint32_t      type;   /*! request type                                          */
79    uint32_t      size;   /*! ln2(nb_pages) if PPM / bytes if KHM / unused by KCM   */
80    uint32_t      flags;  /*! request attributes                                    */
81    void        * ptr;    /*! local pointer on allocated buffer (only used by free) */
82}
83kmem_req_t;
84
85/*************************************************************************************
86 * This generic function allocates physical memory in the local cluster
87 * as specified by the request descriptor.
88 * It uses three specialised physical memory allocators, depending on request type:
89 * - PPM (Physical Pages Manager) allocates N contiguous physical pages,
90 *       N must be a power of 2.
91 * - KHM (Kernel Heap Manager) allocates a physical memory buffer,
92 *       that can have any size.
93 * - KCM (Kernel Cache Manager) allocates various fixed size objects,
94 *       handling a dedicated cache for each object type.
95 *************************************************************************************
96 * @ req   : local pointer to allocation request.
97 * @ return a local pointer on page descriptor if PPM (i.e. type KMEM_PAGE).
98 *   return a local pointer to allocated buffer if KCM or KHM.
99 *   return NULL if no physical memory available.
100 ************************************************************************************/
101void * kmem_alloc( kmem_req_t * req );
102
103/*************************************************************************************
104 * This function releases previously allocated physical memory, as specified
105 * by the "type" and "ptr" fiels of the kmem-req_t request.
106 *************************************************************************************
107 * @ req : local pointer to request descriptor.
108 ************************************************************************************/
109void  kmem_free ( kmem_req_t * req );
110
111/*************************************************************************************
112 * This function returns a printable string for a kmem object type.
113 *************************************************************************************
114 * @ type   : kmem object type.
115 ************************************************************************************/
116char * kmem_type_str( uint32_t type );
117
118/*************************************************************************************
119 * This function returns the size (bytes) for a kmem object type.
120 *************************************************************************************
121 * @ type   : kmem object type.
122 ************************************************************************************/
123uint32_t kmem_type_size( uint32_t type );
124
125/*************************************************************************************
126 * This function displays the content of the KCM pointers Table
127 ************************************************************************************/
128void kmem_print_kcm_table( void );
129
130
131#endif  /* _KMEM_H_ */
Note: See TracBrowser for help on using the repository browser.