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

Last change on this file since 328 was 188, checked in by alain, 7 years ago

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