389 lines
21 KiB
C
389 lines
21 KiB
C
#ifndef _LIBSM
|
|
#define _LIBSM
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdarg.h>
|
|
#include <sys/types.h>
|
|
#include <node.h>
|
|
|
|
/* Code retour des fonctions constituant l'API */
|
|
|
|
typedef long SMT_Status;
|
|
|
|
#define SMS_OK NDS_OK /* La fonction s'est correctement exécutée et a produit un résultat */
|
|
#define SMS_KO NDS_KO /* La fonction s'est correctement exécutée mais n'a pas produit de résultat */
|
|
#define SMS_NO_WAIT 2 /* Opération sur sémaphore en mode IPC_NOWAIT qui n'a pas pu aboutir */
|
|
|
|
#define SMS_YES SMS_OK /* Résultat booléen positif */
|
|
#define SMS_NO SMS_KO /* Résultat booléen négatif */
|
|
|
|
#define SMS_ERRMEM NDS_ERRMEM /* Problème d'allocation mémoire */
|
|
#define SMS_ERRAPI NDS_ERRAPI /* Utilisation incorrecte des API */
|
|
#define SMS_ERRSHM -3 /* Problème relatif aux segments de mémoire partagée */
|
|
#define SMS_ERRSEM -4 /* Problème relatif à l'utilisation des sémaphores */
|
|
#define SMS_ERRSIG -5 /* Opération sur sémaphore interrompue par un signal */
|
|
|
|
#define SM_ERROR(s) ((s) < 0) /* Tous les codes retour négatifs correspondent à des erreurs */
|
|
|
|
typedef int SMT_Flags;
|
|
|
|
#define SMD_UNDEF 0
|
|
|
|
/* Flags d'ouverture d'un heap ou d'une instance de la librairie */
|
|
|
|
#define SMD_CREATE 0x01 /* Création */
|
|
#define SMD_OPEN 0x02 /* Ouverture simple */
|
|
#define SMD_DESTROY 0x04 /* Destruction */
|
|
#define SMD_CLOSE 0x08 /* Fermeture simple */
|
|
|
|
/* NB : pour l'ouverture de la librairie, les valeurs SMD_OPEN et SMD_CREATE sont mutuellement exclusives */
|
|
|
|
/* Flags de verrouillage */
|
|
|
|
#define SMD_READ 0x04 /* verrou partagé */
|
|
#define SMD_WRITE 0x08 /* verrou exclusif */
|
|
#define SMD_NO_LOCK 0x00 /* aucun verrou */
|
|
|
|
#define SMD_LOCK_MSK(a) ((a) & (SMD_READ|SMD_WRITE))
|
|
|
|
/* Mode de debug sur l'ouverture de la librairie */
|
|
|
|
#define SMD_DEBUG_NONE 0x00 /* pour n'afficher aucun message généré par les diverses librairies */
|
|
#define SMD_DEBUG 0x10 /* pour afficher les messages générés par la librairie */
|
|
#define SMD_DEBUG_ALL 0x20 /* pour afficher les messages générés par toutes les librairies sous-jacentes */
|
|
|
|
#define SMD_DEBUG_MSK(a) ((a) & (SMD_DEBUG|SMD_DEBUG_ALL))
|
|
|
|
/* Différentes types de configuration d'un heap */
|
|
|
|
typedef int SMT_Config;
|
|
|
|
#define SMD_SEGMENT_SIZE 1 /* Définir la taille des segments */
|
|
#define SMD_HEAP_LIMIT 2 /* Définir la taille maximale */
|
|
#define SMD_AUTO_COMPRESS 3 /* Définir la taille d'un FCR à partir de laquelle
|
|
la compression du heap est autmatiquement activée */
|
|
|
|
#define SMD_DEFAULT_COMPRESS 1000 /* si + de 1000 chunks libres, alors compression du heap */
|
|
|
|
/* Différentes valeurs de configuration */
|
|
|
|
#define SMD_UNLIMITED 0
|
|
#define SMD_NO_AUTO_COMPRESS 0
|
|
|
|
/* Nom du heap système */
|
|
|
|
#define HEAP_SYSTEM "system"
|
|
|
|
#ifndef FALSE
|
|
#define FALSE 0
|
|
#endif
|
|
|
|
#ifndef TRUE
|
|
#define TRUE 1
|
|
#endif
|
|
|
|
char SM_Error_Msg [512];
|
|
|
|
#ifndef SM_MODE
|
|
#define SM_MODE 0
|
|
#endif
|
|
|
|
#if SM_MODE == 1 /* API sans vérification des arguments */
|
|
|
|
#define SM_Library_Open SM_Library_Open_I
|
|
#define SM_Library_Instance_Get SM_Library_Instance_Get_I
|
|
#define SM_Library_Context_Set SM_Library_Context_Set_I
|
|
#define SM_Library_Context_Get SM_Library_Context_Get_I
|
|
#define SM_Library_Close SM_Library_Close_I
|
|
#define SM_Library_Dump SM_Library_Dump_I
|
|
#define SM_Library_Unlock SM_Library_Unlock_I
|
|
#define SM_Library_Stderr_Set SM_Library_Stderr_Set_I
|
|
#define SM_Heap_Exist SM_Heap_Exist_I
|
|
#define SM_Heap_Open SM_Heap_Open_I
|
|
#define SM_Heap_IsOpen SM_Heap_IsOpen_I
|
|
#define SM_Heap_Close SM_Heap_Close_I
|
|
#define SM_Heap_End SM_Heap_End_I
|
|
#define SM_Heap_Compress SM_Heap_Compress_I
|
|
#define SM_Heap_Config SM_Heap_Config_I
|
|
#define SM_Heap_Check SM_Heap_Check_I
|
|
#define SM_Heap_Lock SM_Heap_Lock_I
|
|
#define SM_Heap_Unlock SM_Heap_Unlock_I
|
|
#define SM_Chunk_Alloc SM_Chunk_Alloc_I
|
|
#define SM_Chunk_Free SM_Chunk_Free_I
|
|
|
|
#else /* API avec vérification des arguments */
|
|
|
|
#define SM_Library_Open SM_Library_Open_C
|
|
#define SM_Library_Instance_Get SM_Library_Instance_Get_C
|
|
#define SM_Library_Context_Set SM_Library_Context_Set_C
|
|
#define SM_Library_Context_Get SM_Library_Context_Get_C
|
|
#define SM_Library_Close SM_Library_Close_C
|
|
#define SM_Library_Dump SM_Library_Dump_C
|
|
#define SM_Library_Unlock SM_Library_Unlock_C
|
|
#define SM_Library_Stderr_Set SM_Library_Stderr_Set_C
|
|
#define SM_Heap_Exist SM_Heap_Exist_C
|
|
#define SM_Heap_Open SM_Heap_Open_C
|
|
#define SM_Heap_IsOpen SM_Heap_IsOpen_C
|
|
#define SM_Heap_Close SM_Heap_Close_C
|
|
#define SM_Heap_End SM_Heap_End_C
|
|
#define SM_Heap_Compress SM_Heap_Compress_C
|
|
#define SM_Heap_Config SM_Heap_Config_C
|
|
#define SM_Heap_Check SM_Heap_Check_C
|
|
#define SM_Heap_Lock SM_Heap_Lock_C
|
|
#define SM_Heap_Unlock SM_Heap_Unlock_C
|
|
#define SM_Chunk_Alloc SM_Chunk_Alloc_C
|
|
#define SM_Chunk_Free SM_Chunk_Free_C
|
|
|
|
#endif
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Structure de la base de heaps */
|
|
/*------------------------------------------------------------------------------*/
|
|
|
|
typedef struct {
|
|
int SysMemID; /* ID de la 1ère zone de mémoire partagée de la base */
|
|
int DataMemID; /* ID de la 2ème zone de mémoire partagée de la base */
|
|
size_t Size; /* Taille de la zone de mémoire partagée */
|
|
int SemID; /* ID du sémaphore pour la gestion des verrous */
|
|
NDT_Root * MHR; /* Memory Heap Root : racine de la liste de heap */
|
|
pid_t Creator; /* ID du processus créateur de la base */
|
|
pid_t Writer; /* ID du dernier processus ayant accédé en écriture à la base */
|
|
void * Free; /* Pointeur sur la première zone libre de la base */
|
|
void * Attach; /* Adresse du dernier attachement */
|
|
size_t Segment_Size; /* Taille par défaut des segments qui composeront les heaps */
|
|
} SMT_Base;
|
|
|
|
/* Référence sur la base de heaps */
|
|
|
|
SMT_Base * SM_Base;
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Structure d'un MHH (Memory Heap Header) */
|
|
/* Rappel : un MHH est une valeur attachée à un MHN (Memory Heap Node) */
|
|
/*------------------------------------------------------------------------------*/
|
|
|
|
typedef struct {
|
|
char Name [256]; /* Nom du heap */
|
|
int SemID; /* ID du sémaphore pour la gestion des verrous */
|
|
NDT_Root * DSR; /* Data Segment Root */
|
|
NDT_Root * ACR; /* Allocated Chunks Root */
|
|
NDT_Root * FCR; /* Free Chunks Root */
|
|
pid_t Writer; /* ID du processus ayant accédé en dernier au MHH en écriture */
|
|
int State; /* Etat d'un heap (valide, non validé ou corrompu) */
|
|
size_t Segment_Size; /* Taille des segments de mémoire composant le heap */
|
|
size_t Limit_Size; /* Taille limite du heap (par défaut : pas de limite) */
|
|
int Auto_Compress; /* Nombre de chunks libres à partir duquel le heap est automatiquement compressé */
|
|
} SMT_MHH;
|
|
|
|
/* Heap ouvert */
|
|
|
|
typedef struct {
|
|
char * Name;
|
|
SMT_MHH * MHH;
|
|
SMT_Flags Lock_Mode; /* Mode dans lequel le heap est verrouillé */
|
|
int Nb_Seg; /* Nombre de segments du heap lors de son ouverture */
|
|
} SMT_Heap;
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Structure d'un DSH (Data Segment Header) */
|
|
/* Rappel : un DSH est une valeur attachée à un DSN (noeud de DSR) */
|
|
/*------------------------------------------------------------------------------*/
|
|
|
|
typedef struct {
|
|
int MemID; /* ID de la zone de mémoire partagée */
|
|
size_t Size; /* Taille de la zone de mémoire partagée */
|
|
void * Start; /* Adresse de début de la zone de mémoire partagée */
|
|
} SMT_DSH;
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Structure d'un chunk */
|
|
/* Rappel : un chunk est la valeur attachée à un noeud de ACR ou FCR */
|
|
/*------------------------------------------------------------------------------*/
|
|
|
|
typedef struct {
|
|
size_t Size; /* Taille allouée au chunk */
|
|
void * Data; /* Adresse de la zone de données du chunk */
|
|
} SMT_Chunk;
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Ouverture d'une instance de la librairie */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Instance : numéro d'instance de la librairie */
|
|
/* (I) Context : nom du nouveau contexte */
|
|
/* (I) Flags : indicateur création/ouverture + mode d'affichage des erreurs */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Open_I ( int Instance, const char * Context, SMT_Flags Flags );
|
|
SMT_Status SM_Library_Open_C ( int Instance, const char * Context, SMT_Flags Flags );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Récupération du numéro de l'instance utilisée */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (O) Instance : adresse du numéro de l'instance utilisée */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Instance_Get_I ( int * Instance);
|
|
SMT_Status SM_Library_Instance_Get_C ( int * Instance);
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Changement de contexte d'utilisation de la librairie */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Context : nom du nouveau contexte */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Context_Set_I ( const char * Context );
|
|
SMT_Status SM_Library_Context_Set_C ( const char * Context );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Récupération du nom du contexte utilisé */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (O) Context : adresse du nom du contexte utilisé */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Context_Get_I ( char ** Context );
|
|
SMT_Status SM_Library_Context_Get_C ( char ** Context );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Fermeture de l'instance de la librairie */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Flags : mode de fermeture (destruction ou fermeture simple) */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Close_I ( SMT_Flags Flags );
|
|
SMT_Status SM_Library_Close_C ( SMT_Flags Flags );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Affichage des informations de la base de mémoires partagées */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Out : pointeur sur le flux de sortie */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Dump_I ( FILE * Out );
|
|
SMT_Status SM_Library_Dump_C ( FILE * Out );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Libération de tous les verrous (base, heap) */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Unlock_I ( void );
|
|
SMT_Status SM_Library_Unlock_C ( void );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Définition de la sortie standard des messages d'erreur de la librairie */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Library_Stderr_Set_I ( FILE * Out );
|
|
SMT_Status SM_Library_Stderr_Set_C ( FILE * Out );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Test d'existence d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap_Name : nom du heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Exist_I ( const char * Heap_Name );
|
|
SMT_Status SM_Heap_Exist_C ( const char * Heap_Name );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Ouverture/création d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap_Name : nom du heap */
|
|
/* (O) Heap : pointeur sur le heap ouvert / créé */
|
|
/* (I) Seg_Size : taille des segments du heap */
|
|
/* (I) Flags : mode d'ouverture du heap */
|
|
/* (O) Locked : verrou effectif (TRUE ou FALSE) */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Open_I ( const char * Heap_Name, SMT_Heap ** Heap, size_t Seg_Size, SMT_Flags Flags, int * Locked );
|
|
SMT_Status SM_Heap_Open_C ( const char * Heap_Name, SMT_Heap ** Heap, size_t Seg_Size, SMT_Flags Flags, int * Locked );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Teste si un heap a déjà été ouvert par le processus courant */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap_Name : nom du heap */
|
|
/* (O) Heap : adresse du pointeur sur le heap ouvert */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_IsOpen_I ( const char * Heap_Name, SMT_Heap ** Heap );
|
|
SMT_Status SM_Heap_IsOpen_C ( const char * Heap_Name, SMT_Heap ** Heap );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Fermeture d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Close_I ( SMT_Heap * Heap );
|
|
SMT_Status SM_Heap_Close_C ( SMT_Heap * Heap );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Destruction d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap_Name : nom du heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_End_I ( const char * Heap_Name );
|
|
SMT_Status SM_Heap_End_C ( const char * Heap_Name );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Compression d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (O) Compress : pointeur sur la taille mémoire gagnée */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Compress_I ( SMT_Heap * Heap, size_t * Compress );
|
|
SMT_Status SM_Heap_Compress_C ( SMT_Heap * Heap, size_t * Compress );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Configuration d'un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (I) Tag : type de configuration */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Config_I ( SMT_Heap * Heap, SMT_Config Tag, ... );
|
|
SMT_Status SM_Heap_Config_C ( SMT_Heap * Heap, SMT_Config Tag, ... );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Vérification/correction des structures d'un heap : */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (O) Nb_Detected : pointeur sur le nombre d'erreurs détectées */
|
|
/* (O) Nb_Corrected : pointeur sur le nombre d'erreurs corrigées */
|
|
/* (I) Out : pointeur sur le flux de sortie du rapport */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Check_I ( SMT_Heap * Heap, int * Nb_Detected, int * Nb_Corrected, FILE * Out);
|
|
SMT_Status SM_Heap_Check_C ( SMT_Heap * Heap, int * Nb_Detected, int * Nb_Corrected, FILE * Out);
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Pose d'un verrou sur un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (I) Flags : mode de verrouillage (SMD_READ ou SMD_WRITE) */
|
|
/* (O) Locked : verrouillage effectué (TRUE ou FALSE) */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Lock_I ( SMT_Heap * Heap, SMT_Flags Flags, int * Locked );
|
|
SMT_Status SM_Heap_Lock_C ( SMT_Heap * Heap, SMT_Flags Flags, int * Locked );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Libération d'un verrou sur un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Heap_Unlock_I ( SMT_Heap * Heap );
|
|
SMT_Status SM_Heap_Unlock_C ( SMT_Heap * Heap );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Allocation d'un chunk dans un heap */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (I) Size : taille du chunk */
|
|
/* (O) Ptr : pointeur sur la zone de données allouée */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Chunk_Alloc_I ( SMT_Heap * Heap, size_t Alloc_Size, void ** Ptr );
|
|
SMT_Status SM_Chunk_Alloc_C ( SMT_Heap * Heap, size_t Alloc_Size, void ** Ptr );
|
|
|
|
/*------------------------------------------------------------------------------*/
|
|
/* Désallocation d'un chunk */
|
|
/*------------------------------------------------------------------------------*/
|
|
/* (I) Heap : pointeur sur un heap ouvert */
|
|
/* (I) Ptr : adresse de la zone de données du chunk à désallouer */
|
|
/*------------------------------------------------------------------------------*/
|
|
SMT_Status SM_Chunk_Free_I ( SMT_Heap * Heap, void * Ptr );
|
|
SMT_Status SM_Chunk_Free_C ( SMT_Heap * Heap, void * Ptr );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|