Rx3/liblog-bdm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Première version

Browse Source
This commit is contained in:
smas
2000-07-31 13:15:35 +00:00
commit 43e6f0ee89
16 changed files with 10505 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

638
lib/liblog.3 Normal file
View File

@@ -0,0 +1,638 @@
'\" t
.\" @(#)LIBLOG.3 1.0 00/07/04 SMA;
.TH LIBLOG 3 "07 Apr 2000"
.SH NOM
LIBLOG (librairie d'interface avec le systeme de suivi et de pilotage)
.SH SYNOPSIS
.LP
.BI "cc [flag ...] file ... -lver -ldl -lnode -lshmem -ldatastr -lmsg -ladm -lgen -llog [library ...]"
.LP
.BI "#include <log.h>"
.LP
.BI "LOGT_Status LOG_Library_Open ( int " Instance ", LOGT_Flags " Open_Mode ");"
.LP
.BI "LOGT_Status LOG_Library_Close ( LOGT_Flags " Close_Mode ");"
.LP
.BI "LOGT_Status LOG_Library_Stderr_Set ( FILE * " Out ");"
.LP
.BI "LOGT_Status LOG_Channel_Open ( LOGT_Channel ** " Channel ", int " Pid ", int " Channel_Id ", char * " Module_Name ", char * " Master_Module_Name ");"
.LP
.BI "LOGT_Status LOG_Channel_Enter ( LOGT_Channel * " Channel ", char * " Sub_Module_Name ");"
.LP
.BI "LOGT_Status LOG_Channel_Leave ( LOGT_Channel * " Channel ", char * " Sub_Module_Name ");"
.LP
.BI "LOGT_Status LOG_Channel_Close ( LOGT_Channel * " Channel ");"
.LP
.BI "LOGT_Status LOG_RTab_Alloc ( LOGT_RTab ** " Rtab ", char * " Name " );"
.LP
.BI "LOGT_Status LOG_RTab_Setup ( LOGT_RTab * " RTab ", LOGT_RuleClass " Rule_Class ", LOGT_Rule " Rule ", LOGT_Rooting " Value ");"
.LP
.BI "LOGT_Status LOG_RTab_Add ( LOGT_Channel * " Channel ", LOGT_RTab * " RTab ");"
.LP
.BI "LOGT_Status LOG_RTab_Remove ( LOGT_Channel * " Channel ", LOGT_RTab * " RTab ");"
.LP
.BI "LOGT_Status LOG_RTab_Free ( LOGT_RTab * " RTab ");"
.LP
.BI "LOGT_Status LOG_Trigger_Add ( LOGT_Trigger ** " Trigger ", LOGT_Channel * " Channel ", LOGT_RTab * " RTab ", char * " Event_Type ", LOGT_Flags " Trigger_Mode ");"
.LP
.BI "LOGT_Status LOG_Trigger_Remove ( LOGT_Trigger * " Trigger ");"
.LP
.BI "LOGT_Status LOG_Event_Send ( LOGT_Channel * " Channel ", LOGT_RC * " Return_Code ", char * " Cd_Support ", va_list " Data ");"
.LP
.BI "LOGT_RC LOG_Event_External_Send ( LOGT_Channel * " Channel ", char * " Cd_Support ", char * " Data ");"
.LP
.BI "LOGT_Status LOG_Event_Info_Get ( LOGT_Channel * " Channel ", LOGT_Info * " Info ", va_list " Data ");"
.LP
.BI "LOGT_Status LOG_Event_Cpt_Get ( LOGT_Channel * " Channel ", int * " Cpt "[LOGD_RC_SIZE], char * " Reg_Expr ");"
.LP
.SH FONCTIONS
.LP
.BI "LOGT_Status LOG_Library_Open ( int " Instance ", LOGT_Flags " Open_Mode ");"
.LP
.RS 3
La librairie LIBLOG met en place des ressources partagees par tous les traitements qui utilise la meme instance de la librairie LIBLOG :
.LP
.RS 3
- les tables de routage systeme (GMRT et GDRT)
.LP
- le cache des modules
.LP
- le cache des formats d'evenement
.LP
- la queue de messages pour inserer les evenements en base
.RS -3
.LP
Cette fonction permet d'acceder a ces ressources partagees pour une instance particuliere de la librairie:
.LP
.RS 3
- en creation si
.I Open_Mode
vaut
.B LOGD_CREATE
.LP
- en ouverture simple si
.I Open_Mode
vaut
.B LOGD_OPEN
.RS -3
.LP
.I NB
: l'indicateur d'ouverture
.I Open_Mode
pourra etre combinee avec un mode de debugging (
.B MSGD_DEBUG_NONE
: aucun message d'erreur n'est affiche
.LP
.B MSGD_DEBUG
: les messages d'erreur generes par la librairie LIBMSG sont affiches sur la sortie standard d'erreur
.LP
.B MSGD_DEBUG_ALL
: les messages d'erreur generes par toutes les librairies sous-jacentes a la LIBMSG sont affiches sur la sortie standard d'erreur
.LP
.I NB
: l'appel a cette fonction est obligatoire avant d'utiliser toute autre fonction de la librairie LIBLOG.
.LP
Le mode
.B LOGD_CREATE
est exclusivement reserve aux administrateurs !
.LP
.RS -3
.BI "LOGT_Status LOG_Library_Close ( LOGT_Flags " Close_Mode " );"
.LP
.RS 3
Cette fonction permet de fermer ou de supprimer les ressources partagees de l'instance qu a ete ouverte :
.LP
.RS 3
- Suppression si
.I Close_Mode
vaut
.B LOGD_DESTROY
.LP
- Fermeture simple si
.I Close_Mode
vaut
.B LOGD_CLOSE
.RS -3
.LP
.I NB
: la fermeture de la librairie est absolument necessaire une fois qu'un traitement a fini de l'utiliser.
.LP
Le mode
.B LOGD_DESTROY
est exclusivement reserve aux administrateurs !
.LP
.RS -3
.BI "LOGT_Status LOG_Library_Stderr_Set ( FILE * " Out " );"
.LP
.RS 3
Cette fonction permet de definir
.I Out
comme la sortie standard des messages d'erreur de la librarie.
.RS -3
.LP
.BI "LOGT_Status LOG_Channel_Open ( LOGT_Channel ** " Channel ", int " Pid ", int " Channel_Id ", char * " Module_Name ", char * " Master_Module_Name ");"
.LP
.RS 3
Cette fonction permet de creer un channel a travers lequel des evenements seront envoyes au systeme de suivi.
Elle requiert les arguments suivants :
.RS 3
.LP
* (Out)
.I Channel
: l'adresse du pointeur sur le channel a creer
.LP
* (In)
.I Pid
: l'identifiant du processus proprietaire du channel
.LP
* (In)
.I Channel_Id
: l'identifiant du channel
.LP
* (In)
.I Module_Name
: le nom du module proprietaire du channel
.LP
* (In)
.I Master_Module_Name
: le nom du module maitre (facultatif)
.RS -3
.LP
.I Pour info
:
Le nom du module proprietaire du channel permet de connaitre le traitement qui est a l'origine des evenements qui sont envoyes au suivi. Le nom du module maitre permet de connaitre le contexte de lancement de ce traitement.
.LP
Le numero du processus permet de distinguer differents processus realisant un meme traitement.
.LP
L'identifiant du channel permet de distinguer les differents channels d'un meme processus.
.LP
.I NB
: si le numero de processus passe en parametre vaut 0, alors c'est le processus courant qui sera considere comme processus proprietaire.
Ce parametre doit surtout etre renseigne pour les programmes shell, afin que ce ne soit pas le numero de processus demon qui soit pris en compte.
.LP
Par convention, en fonctionnement mono-thread, l'identifiant du channel sera fixe a 0. En fonctionnement multi-thread, l'utilisateur est libre de fixer ce parametre comme il le veut.
.LP
.I NB
: si le nom du module maitre vaut NULL, alors il sera renseigne avec le nom du module proprietaire du channel.
.LP
.RS -3
.BI "LOGT_Status LOG_Channel_Enter ( LOGT_Channel * " Channel ", char * " Sub_Module_Name " );"
.LP
.RS 3
Cette fonction permet d'affecter un sous-module a un channel.
Un sous-module correspond en general au nom d'une fonction du traitement. Il permet de mieux identifier la partie du traitement qui genere les evenements.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (In)
.I Channel
: le pointeur sur le channel de communication
.LP
* (In)
.I Sub_Module_Name
: le nom du sous-module a attacher au channel
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_Channel_Leave ( LOGT_Channel * " Channel ", char * " Sub_Module_Name " );"
.LP
.RS 3
Cette fonction permet de supprimer un sous-module d'un channel.
Le sous-module qui lui avait ete precedemment affecte est devient alors le sous-module actif.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (In)
.I Channel
: le pointeur sur le channel de communication
.LP
* (In)
.I Sub_Module_Name
: le nom du sous-module a supprimer du channel
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_Channel_Close ( LOGT_Channel * " Channel " );"
.LP
.RS 3
Cette fonction permet de fermer un channel.
.LP
.I Channel
est un pointeur sur le channel a fermer
.LP
.RS -3
.BI "LOGT_Status LOG_RTab_Alloc ( LOGT_RTab ** " Rtab ", char * " Name " );"
.LP
.RS 3
Cette fonction permet de creer une table de routage utilisateur.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (Out) RTab
: adresse d'un pointeur sur la table de routage a creer.
.LP
* (In) Name
: nom de la table de routage.
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_RTab_Setup ( LOGT_RTab * " RTab ", LOGT_RuleClass " Rule_Class ", LOGT_Rule " Rule ", LOGT_Rooting " Value " );"
.LP
.RS 3
Cette fonction permet de parametrer une table de routage utilisateur, par ajout d'une regle de routage.
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I RTab
: un pointeur sur la table de routage
.LP
* (In)
.I Rule_Class
: la classe de la nouvelle regle
.LP
* (In)
.I Rule
: la nouvelle regle
.LP
* (In)
.I Value
: la valeur de la nouvelle regle
.RS -3
.LP
La classe de regle designe la maniere de selectionner les types d'evenement concernes par la nouvelle regle :
.LP
.RS 3
-
.B LOGD_SELECT_ALL
: selection de tous les types d'evenements
.LP
-
.B LOGD_SELECT_GRV
: selection des types d'evenement selon leur gravite
.LP
-
.B LOGD_SELECT_RC
: selection des types d'evenement selon le code retour qui y est associe
.LP
-
.B LOGD_SELECT_TYPE
: selection des types d'evenement selon leur nom
.RS -3
.LP
La regle depend de la classe de regle choisie:
.LP
.RS 3
- NULL pour la classe
.B LOGD_SELECT_ALL
.LP
- code gravite pour la classe
.B LOGD_SELECT_GRV
.LP
- code retour pour la classe
.B LOGD_SELECT_RC
.LP
- nom du type d'evenement (expression reguliere) pour la classe
.B LOGD_SELECT_TYPE
.RS -3
.LP
La valeur de la regle est le type de routage a appliquer aux types d'evenement concernes par la regle :
.RS 3
.LP
-
.B LOGD_NULL
: routage vers /dev/null (aucun traitement de l'evenement)
.LP
-
.B LOGD_STDERR
: affichage de l'evenement sur la sortie standard d'erreur
.LP
-
.B LOGD_DATABASE
: insertion de l'evenement dans la base de donnees du suivi
.LP
-
.B LOGD_DEFAULT
: routage par defaut
.LP
-
.B LOGD_PREVIOUS
: routage defini dans la table de routage precedente
.RS -3
.LP
Pour parametrer une table de routage utilisateur, on commencera par definir les regles les plus generales (LOGD_ALL) et finir avec les regles les plus specifiques.
.LP
.RS -3
.BI "LOGT_Status LOG_RTab_Add ( LOGT_Channel * " Channel ", LOGT_RTab * " RTab " );"
.LP
.RS 3
Cette fonction permet d'affecter une nouvelle table de routage utilisateur a un channel.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I RTab
: un pointeur sur la table de routage
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_RTab_Remove ( LOGT_Channel * " Channel ", LOGT_RTab * " RTab " );"
.LP
.RS 3
Cette fonction permet de supprimer l'association d'une table de routage utilisateur a un channel.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I RTab
: un pointeur sur la table de routage
.RS -3
.LP
L'utilisateur pourra utiliser la constante LOGD_TOP_RTAB comme deuxieme argument, pour supprimer la table de routage de tete (la plus recemment associee au channel).
.LP
.RS -3
.BI "LOGT_Status LOG_RTab_Free ( LOGT_RTab * " RTab " );"
.LP
.RS 3
Cette fonction permet de supprimer une table de routage utilisateur.
.LP
.I RTab
est un pointeur sur la table de routage a supprimer.
.LP
NB : avant de supprimer une table de routage, on verifiera qu'elle n'est attachee a aucun channel.
.LP
.RS -3
.BI "LOGT_Status LOG_Trigger_Add ( LOGT_Trigger ** " Trigger ", LOGT_Channel * " Channel ", LOGT_RTab * "RTab ", char * " Event_Type ", LOGT_Flags " Trigger_Mode " );"
.LP
.RS 3
Cette fonction permet d'ajouter un trigger a un channel.
.LP
Elle requiert les arguments suivants :
.RS 3
.LP
* (Out)
.I Trigger
: l'adresse du pointeur sur le nouveau trigger
.LP
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I RTab
: un pointeur sur la table de routage concernee
.LP
* (In)
.I Event_Type
: le type d'evenement declencheur (expression reguliere)
.LP
* (In)
.I Trigger_Mode
: le mode de fonctionnement du trigger
.RS -3
.LP
.I Rappel
:
.LP
Si un trigger fonctionne sur le mode
.B LOGD_ONESHOT
, il est automatiquement supprime des lors qu'il a ete active. En mode
.B LOGD_PERMANENT
, le trigger reste active en permanence.
.LP
Si un trigger fonctionne sur le mode
.B LOGD_ADD
, l'activation du trigger provoque l'association de la table de routage avec le channel. Avec le mode
.B LOGD_REMOVE
, l'activation du trigger correspond a leur dissociation.
.LP
Les differents modes de fonctionnement peuvent etre combines par addition binaire.
.LP
.I NB
: plusieurs triggers peuvent etre poses sur un meme channel.
.LP
.RS -3
.BI "LOGT_Status LOG_Trigger_Remove ( LOGT_Trigger * " Trigger " );"
.LP
.RS 3
Cette fonction permet de supprimer un trigger positionne sur un channel.
.LP
.I Trigger
est un pointeur sur le trigger a supprimer.
.LP
.RS -3
.BI "LOGT_Status LOG_Event_Send ( LOGT_Channel * " Channel ", LOGT_RC * " Return_Code ", char * " Cd_Support ", va_list " Data ");"
.LP
.RS 3
Cette fonction permet d'envoyer un evenement a travers un channel et de recuperer le code retour associe au type d'evenement (pilotage).
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (Out)
.I RC
: un pointeur sur le code retour
.LP
* (In)
.I Cd_Support
: le code du support source
.LP
* (In)
.I Data
: une liste d'arguments contenant les donnees de l'evenement
.RS -3
.LP
.RS -3
.BI "LOGT_RC LOG_Event_External_Send ( LOGT_Channel * " Channel ", char * " Cd_Support ", char * " Data ");"
.LP
.RS 3
Cette fonction est definie pour tous les appels a partir de programmes ecrits en PL/SQL.
Elle permet d'envoyer un evenement a travers un channel et de recuperer le code retour associe au type d'evenement (pilotage).
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I Cd_Support
: le code du support source
.LP
* (In)
.I Data
: une chaine de caracteres contenant les donnees de l'evenement
.RS -3
.LP
.I NB
: la fonction retourne le code retour associe au type d'evenement.
.LP
.RS -3
.BI "LOGT_Status LOG_Event_Info_Get ( LOGT_Channel * " Channel ", LOGT_Info * " Info ", va_list " Data " );"
.LP
.RS 3
Cette fonction permet de simuler l'envoi d'un evenement et de recuperer toutes les informations concernant le type par lequel il a ete resolu.
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (Out)
.I Info
: un pointeur sur les informations a recuperer
.LP
* (In)
.I Data
: une liste d'arguments contenant les donnees de l'evenement a tester
.RS -3
.LP
.I NB
: le type LOGT_Info est une structure qui contient les informations suivantes :
.LP
.RS 3
-
.B EvtType
(type d'evenement par lequel l'evenement est resolu) de type char *
.LP
-
.B RC
(code retour associe) de type
.B LOGT_RC
.LP
-
.B Gravite
(code gravite associe) de type
.B LOGT_Gravite
.LP
-
.B Rooting
(routage associe) de type
.B LOGT_Rooting
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_Event_Info_External_Get ( LOGT_Channel * " Channel ", LOGT_Info * " Info ", char * " Event_Name " );"
.LP
.RS 3
Cette fonction permet de simuler l'envoi d'un evenement et de recuperer toutes les informations concernant le type par lequel il a ete resolu.
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (Out)
.I Info
: un pointeur sur les informations a recuperer
.LP
* (In)
.I Event_Name
: le nom de l'evenement a tester
.RS -3
.LP
.RS -3
.BI "LOGT_Status LOG_Event_Cpt_Get ( LOGT_Channel * " Channel ", int * " Cpt " [LOGD_RC_SIZE], char * " Reg_Expr " );"
.LP
.RS 3
Cette fonction permet de recuperer les compteurs d'evenements dont le nom correspond a une expression reguliere.
.LP
Elle requiert les arguments suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (Out)
.I Cpt
: un pointeur sur un tableau de compteurs
.LP
* (In)
.I Reg_Expr
: une expression reguliere
.RS -3
.LP
.I NB
: le tableau de compteurs doit etre alloue par l'utilisateur.
.LP
La fonction retourne dans ce tableau le nombre d'evenements correspondant a l'expression reguliere ayant ete envoyes via le channel pour chacun des codes retour.
.LP
.I Exemple
: Cpt[LOGD_RC_OK] contiendra le nombre d'evenements envoyes ayant retourne le code LOGD_RC_OK.
.SH CODES RETOUR
.LP
Toutes les fonctions constituant l'API de la librairie LIBLOG retournent un code de type
.B LOGT_Status
:
.LP
.RS 3
-
.B LOGS_OK
: la fonction s'est correctement executee et a produit un resultat
.LP
-
.B LOGS_KO
: la fonction s'est correctement executee mais n'a pas produit de resultat
.LP
-
.B LOGS_ERRAPI
: la fonction a ete appelee avec des arguments de valeur incorrecte
.LP
-
.B LOGS_ERRMEM
: la fonction ne s'est pas correctement executee pour un probleme d'allocation memoire
.LP
-
.B LOGS_ERRSHM
: la fonction ne s'est pas correctement executee pour un probleme relatif a la memoire partagee
.LP
-
.B LOGS_ERRSIG
: une operation sur semaphore a ete interrompue par un signal
.LP
-
.B LOGS_ERRSEM
: la fonction ne s'est pas correctement executee pour un probleme relatif a l'utilisation des semaphores
.LP
-
.B DSS_ERRDLL
: la fonction ne s'est pas correctement executee pour un probleme de chargement dynamique d'objet
.LP
.RS -3
.I NB
: la macro
.B LOG_ERROR()
permet de tester si un code retour correspond a une erreur.
.LP
En cas d'erreur, la variable
.B LOG_Error_Msg
contient un message du type :
.LP
.RS 3
Error <Nom fonction> : <message d'erreur>
.RS -3
.LP

4725
lib/liblog.c Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
lib/liblog.doc Normal file
View File

Binary file not shown.

179
lib/liblog.h Normal file
View File

@@ -0,0 +1,179 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <unistd.h>
#include <ctype.h>
#include <ver.h>
#include <log.h>
/* Expressions régulières */
#ifdef LINUX
#include <regex.h>
typedef regex_t RegExp_t;
#define RegExp_Size sizeof (regex_t)
#define RegExp_Compile(s, e) regcomp (e, s, REG_NOSUB) == 0
#define RegExp_Match(s, e) regexec (e, s, 0, NULL, 0) != REG_NOMATCH
#else
#include <regexpr.h>
typedef char RegExp_t;
#define RegExp_Size 256
#define RegExp_Compile(s, e) compile (s, e, e + RegExp_Size)
#define RegExp_Match(s, e) step (s, e)
#endif
extern char * strdup (const char *);
/* Nom de la variable d'environnement définissant la valeur par défaut du module maître */
#define MASTER_MODULE_ENV "MASTER"
#define LOG_FILE_MANAGER "liblog.so"
/* Tous les heaps et data structures générés par la librairie LIBLOG sont préfixés */
#define LOG_PREFIX "LOG"
/* Port de messages d'envoi des événements */
MSGT_Port * Send_Port;
/* Elément du cache des modules */
typedef struct {
char * Name; /* Nom du module (sert à la recherche) */
int Id; /* Identifiant numérique du type d'événement */
} LOGT_Module;
/* Elément de la table de routage GDRT */
typedef struct {
char * Name; /* Nom du type d'événement (base de recherche) */
int Terminal; /* Signifie que le type d'événement existe sans contexte */
int Id; /* Identifiant numérique du type d'événement */
LOGT_Gravite Gravite; /* Code gravité */
LOGT_RC RC; /* Code de retour servant au pilotage */
LOGT_Rooting Rooting; /* Type de routage par défaut */
NDT_Root * Next_Dim; /* Dimension suivante = pointeur sur un arbre */
} LOGT_GDRT_Evt;
#define EVENT_NB_DIM 4
/* Elément d'une table de routage quelconque (hormis la GDRT) */
typedef struct {
int Id; /* Identifiant numérique du type d'événement (sert à la recherche) */
LOGT_Rooting Rooting; /* Type de routage */
} LOGT_RTab_Evt;
/* Définition du nom des différentes ressources de la librairie */
/*
Heap dans lequel sera stockée la base de la librairie LIBLOG :
Ce heap ne contient que la structure LOGT_Base qui permet de référencer
les autres ressources système de la librairie.
Ce heap ne sera constitué que d'une unique segment très petit.
*/
#define LOGD_BASE_HEAP_NAME "BASE"
#define LOGD_BASE_HEAP_SEGMENT_SIZE 100
/*
Heap dans lequel sont stockées les caches :
Ces heaps contiennent à priori un grand nombre de valeurs.
On les crée donc avec des segments de données suffisamment grands.
*/
#define LOGD_KMOD_SEGMENT_SIZE 50000
#define LOGD_KMOD_NAME "KMOD"
#define LOGD_KFORMAT_SEGMENT_SIZE 1100000
#define LOGD_KFORMAT_NAME "KFORMAT"
#define LOGD_GDRT_SEGMENT_SIZE 400000
#define LOGD_GDRT_NAME "GDRT"
/*
En règle générale, les tables de routage suivantes resteront vides :
Leur heap sont donc créés avec des segments de données relativement petits.
*/
#define LOGD_EMPTY_RTAB_SEGMENT_SIZE 3000
#define LOGD_GMRT_NAME "GMRT"
#define LOGD_LDRT_NAME "LDRT"
#define LOGD_LMRT_NAME "LMRT"
/*
Heap dans lequel sera stockée les listes de tables de routage :
Ces liste ne contiendront pas à priori un grand nombre de valeurs.
Les heaps sous-jacents n'ont donc pas besoin besoin d'être très grands.
*/
#define LOGD_RTAB_LIST_SEGMENT_SIZE 100240
#define LOGD_CHANNEL_LIST_NAME "CHANNEL_REF"
#define LOGD_LDRT_LIST_NAME "LDRT_REF"
#define LOGD_LMRT_LIST_NAME "LMRT_REF"
#define LOGD_URT_LIST_NAME "URT_REF"
/* Elément d'une structure de compteurs d'événement */
typedef struct {
char * Name; /* Nom du type d'événement */
int Total; /* Nombre total d'envois */
} LOGT_Event_Cpt;
SMT_Heap * LOG_Base_Heap;
/* Compteur d'ouverture de la librairie */
unsigned int LOG_Open_Counter = 0;
/* Flux de sortie des messages d'erreur générés par la librairie */
FILE * LOG_stderr;
/* Entêtes des fonctions privées */
NDT_Status LOG_Base_RTabList_Manager (va_list args_ptr);
NDT_Status LOG_Base_ChannelList_Manager (va_list args_ptr);
NDT_Status LOG_GDRT_Manager (va_list);
NDT_Status LOG_GDRT_Dim_Manager (va_list);
LOGT_Status LOG_GDRT_Event_Find (LOGT_GDRT_Evt **, char **, char *);
LOGT_Status LOG_GDRT_Recursive_Find (char **, NDT_Root *, int, LOGT_GDRT_Evt **, char **);
LOGT_Status LOG_GDRT_Event_Create (const char *, int, LOGT_Gravite, LOGT_RC, LOGT_Rooting, int *);
LOGT_Status LOG_GDRT_Recursive_Select (int, NDT_Root *, LOGT_RTab *, LOGT_RuleClass, LOGT_Rule *, LOGT_Rooting, const char *, char *);
NDT_Status LOG_KMOD_Manager (va_list);
NDT_Status LOG_KFORMAT_Manager (va_list);
NDT_Status LOG_KFORMAT_DataList_Manager (va_list);
NDT_Status LOG_Channel_RTabList_Manager (va_list);
NDT_Status LOG_Channel_Event_CptList_Manager (va_list);
NDT_Status LOG_Channel_SubModuleList_Manager (va_list);
NDT_Status LOG_Channel_TriggerList_Manager (va_list);
LOGT_Status LOG_Channel_Rooting_Find (LOGT_Channel *, int, LOGT_Rooting *);
NDT_Status LOG_RTab_Manager (va_list);
#define DATA_ARG_LIST 1
#define DATA_STRING 2
LOGT_Status LOG_Event_Internal_Send (int, LOGT_Channel *, LOGT_RC *, char *, va_list, char *);
LOGT_Status LOG_Event_Data_Get (int, char *, char **, size_t *, va_list *, char *);
LOGT_Status LOG_Event_Data_Tag_Get (int, va_list *, char **, int *, char *);
LOGT_Status LOG_Event_Data_Macro_Get (int, va_list *, char **, char *, char *);
int LOG_NextString_Get (char ** ptr, char * result);
char * LOG_RTType_Label_Get (LOGT_RTType);
char * LOG_RC_Label_Get (LOGT_RC);
char * LOG_Rooting_Label_Get (LOGT_Rooting);
void LOG_Error_Print(void);
static char * LOG_Name_Prefix (const char *);

424
lib/libtool.3 Normal file
View File

@@ -0,0 +1,424 @@
'\" t
.\" @(#)LIBTOOL.3 1.0 00/22/02 SMA;
.TH LIBTOOL 3 "22 Feb 2000"
.SH NOM
LIBTOOL (utilitaires pour la librairie LIBLOG)
.SH SYNOPSIS
.LP
.BI "cc [flag ...] file ... -lver -ldl -lnode -lshmem -ldatastr -ladm -llog -ltool [library ...]"
.LP
.BI "#include <tool.h>"
.LP
.BI "TLT_Status TL_Library_Stderr_Set ( FILE * " Out ");"
.LP
.BI "TLT_Status TL_LIBLOG_Load ( TL_Cache " To_Load " );"
.LP
.BI "TLT_Status TL_LIBLOG_Unload ( TL_Cache " To_Unload " );"
.LP
.BI "TLT_Status TL_Channel_RTab_Add ( LOGT_Channel * " Channel ", char * " Kunf_Name " );"
.LP
.BI "TLT_Status TL_Channel_Trigger_Add ( LOGT_Channel * " Channel ", char * " Kunf_Name " );"
.LP
.SH DESCRIPTION
.LP
La bibliotheque LIBTOOL fournit un ensemble d'utilitaires lies a la librairie LIBLOG :
.LP
.RS 3
- Creation de tables de routage et de triggers a partir de fichiers de configuration KUNF
.LP
- Mise a jour des caches de donnees de la librairie LIBLOG (cache des modules, cache des formats d'evenement, table de routage par defaut
.RS -3
.LP
.SH FONCTIONS
.LP
.BI "TLT_Status TL_Library_Stderr_Set ( FILE * " Out " );"
.LP
.RS 3
Cette fonction permet de definir
.I Out
comme la sortie standard des messages d'erreur de la librarie.
.RS -3
.LP
.BI "TLT_Status TL_LIBLOG_Load ( TL_Cache " To_Load " );"
.LP
.RS 3
Cette fonction permet de charger les caches de donnees de la base de la librairie LIBLOG
.LP
L'argument
.I To_Load
represente la liste des caches de donnees a charger
, sous forme d'une combinaison binaire des trois valeurs suivantes :
.LP
.RS 3
-
.B TLD_KMOD
: pour charger le cache de modules
.LP
-
.B TLD_KFORMAT
: pour charger le cache de formats d'evenement
.LP
-
.B TLD_GDRT
: pour charger la table de routage par defaut
.LP
.RS -3
NB : les caches doivent etre prealablement vides avant d'etre charges.
.LP
.RS -3
.BI "TLT_Status TL_LIBLOG_Unload ( TL_Cache " To_Unload " );"
.LP
.RS 3
Cette fonction permet de vider les caches de donnees de la base de la librairie LIBLOG
.LP
L'argument
.I To_Unload
represente la liste des caches de donnees a vider
, sous forme d'une combinaison binaire des trois valeurs suivantes :
.RS 3
.LP
-
.B TLD_KMOD
: pour vider le cache de modules
.LP
-
.B TLD_KFORMAT
: pour vider le cache de formats d'evenement
.LP
-
.B TLD_GDRT
: pour vider la table de routage par defaut
.RS -3
.LP
.RS -3
.BI "TLT_Status TL_Channel_RTab_Add ( LOGT_Channel * " Channel ", char * " Kunf_Name " );"
.LP
.RS 3
Cette fonction permet d'ajouter toutes les tables de routage d'une section KUNF a un channel.
.LP
Elle attend les parametres suivants :
.LP
.RS 3
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I Kunf_Name
: le nom de la section KUNF
.RS -3
.LP
.RS -3
.BI "TLT_Status TL_Channel_Trigger_Add ( LOGT_Channel * " Channel ", char * " Kunf_Name " );"
.LP
.RS 3
Cette fonction permet d'ajouter tous les triggers d'une section KUNF a un channel.
.LP
Elle attend les parametres suivants :
.RS 3
.LP
* (In)
.I Channel
: un pointeur sur le channel
.LP
* (In)
.I Kunf_Name
: le nom de la section KUNF
.RS -3
.LP
.SH FICHIER DE CONFIGURATION
.LP
Le fichier KUNF contient deux types de sections:
.RS 3
.LP
-
.B [ROOTING_TABLE]
: liste des tables de routage
.LP
-
.B [TRIGGER]
: liste des triggers
.RS -3
.LP
Chaque table de routage est identifiee par une sous-section de la forme
.B [ROOTING_TABLE:<table_name>]
.
.LP
Les regles de routage sont designees par une section de la forme
.B [ROOTING_TABLE:<table_name>:<rule_name>]
.
.LP
Une regle de routage definit les proprietes suivantes :
.RS 3
.LP
*
.B class
: ce tag definit la classe de la regle et peut prendre les valeurs suivantes :
.LP
.RS 3
-
.B ALL
pour selectionner tous les evenements
.LP
-
.B GRV
pour selectionner les evenements selon leur gravite
.LP
-
.B RC
pour selectionner les evenements selon leur code retour associe
.LP
-
.B TYPE
pour selectionner les evenements selon leur type
.RS -3
.LP
*
.B rule
: ce tag definit la regle elle-meme et peut prendre les valeurs suivantes :
.LP
.RS 3
- pour la classe
.B ALL
: aucune valeur a definir
.LP
- pour la classe
.B GRV
:
.B INFO
,
.B TRACE
,
.B FONCT
,
.B DETAIL
,
.B STAT
,
.B ERR
,
.B REJDON
,
.B REJENR
,
.B WARNING
,
.B RECYCLE
,
.B EXIT
,
.B ABEND
.LP
- pour la classe
.B RC
:
.B OK
,
.B ANOERR
,
.B REJDON
,
.B REJENR
,
.B WARNING
,
.B RECYCLE
,
.B EXIT
,
.B ABEND
.LP
- pour la classe
.B TYPE
: expression reguliere sur le type d'evenement
.LP
.I Attention
: le caractere ':' etant interdit dans les sections kunf, on le notera conventionnellement par "{2pts}".
.LP
Les expressions regulieres seront notees selon le standard UNIX (voir regexp).
.LP
.RS -3
*
.B rooting
: ce tag definit le routage associe a la regle et peut prendre les valeurs suivantes :
.LP
.RS 3
-
.B DATABASE
: routage de l'evenement vers la base de suivi
.LP
-
.B STDERR
: routage de l'evenement vers la sortie standard d'erreur
.LP
-
.B NULL
: routage de l'evenement vers /dev/null (i.e l'evenement n'est pas traite)
.LP
-
.B DEFAULT
: routage par defaut
.LP
-
.B PREVIOUS
: routage de la table precedente du channel
.RS -3
.LP
.RS -3
Chaque trigger est identifie par une section de la forme
.B [ROOTING_TABLE:<trigger_name>]
.
.LP
A un trigger sont associees plusieurs proprietes :
.RS 3
.LP
*
.B event
: ce tag designe le type d'evenement declencheur du trigger (expression reguliere)
.LP
*
.B type
: ce tag definit le type du trigger et peut prendre les valeurs suivantes :
.RS 3
.LP
-
.B ADD
pour un trigger qui ajoute une table de routage a un channel
.LP
-
.B REMOVE
pour un trigger qui supprime une table de routage d'un channel
.RS -3
.LP
*
.B mode
: ce tag designe la persistance du trigger et peut prendre les valeurs suivantes :
.RS 3
.LP
-
.B ONE_SHOT
pour un trigger qui ne fonctionne qu'une seule fois
.LP
-
.B PERMANENT
pour un trigger qui fonctionne tant qu'il n'est pas desactive
.RS -3
.LP
*
.B rooting_table
: ce tag definit le nom de la table de routage concernee par le trigger
.RS -3
.LP
.LP
.I Exemple
:
.LP
.RS 3
[ROOTING_TABLE]
.LP
[ROOTING_TABLE:TOTO]
.LP
[ROOTING_TABLE:TOTO:RULE1]
.LP
class=ALL
.LP
rooting=DATABASE
.LP
[ROOTING_TABLE:TOTO:RULE2]
.LP
class=RC
.LP
rule=REJENR
.LP
rooting=STDERR+DATABASE
.LP
[ROOTING_TABLE:TOTO:RULE3]
.LP
class=TYPE
.LP
rule=COMPTEUR.*
.LP
rooting=NULL
.LP
[ROOTING_TABLE:TITI]
.LP
[ROOTING_TABLE:TOTO:RULE1]
.LP
class=ALL
.LP
rooting=PREVIOUS
.LP
[ROOTING_TABLE:TOTO:RULE2]
.LP
class=GRV
.LP
rule=WARNING
.LP
rooting=DEFAULT
.LP
[ROOTING_TABLE:TOTO:RULE3]
.LP
class=RC
.LP
rule=ABEND
.LP
rooting=STDERR
.LP
[ROOTING_TABLE:TOTO:RULE4]
.LP
class=TYPE
.LP
rule=*SQLERR*
.LP
rooting=STDERR
.LP
[TRIGGER]
.LP
[TRIGGER:TATA]
.LP
event=COMPTEUR.*@.*{2pts}.*{2pts}TB.*
.LP
type=ADD
.LP
rooting_table=TOTO
.LP
mode=ONE_SHOT
.LP
.RS -3
Dans l'exemple ci-dessus, le fichier de configuration definit deux tables de routage nommees TOTO (3 regles) et TITI (4 regles) et un trigger nomme TATA.
.LP
.I NB
: les noms des regles de routage sont libres. Ils doivent seulement etre differents les uns des autres pour une meme table de routage.
.LP
Pour davantage de precisions sur la notion de table de routage ou de trigger, le lecteur se referera a la documentation de la librairie LIBLOG.
.LP
.RS -3
.SH CODES RETOUR
.LP
Toutes les fonctions constituant l'API de la librairie LIBTOOL retournent un code de type
.B TLT_Status
:
.LP
.RS 3
-
.B TLS_OK
si la fonction s'est correctement executee
.LP
-
.B TLS_KO
si une erreur s'est produite
.RS -3
.LP
En cas d'erreur, la variable
.B TL_Error_Msg
contient un message du type :
.LP
.RS 3
Error <Nom fonction> : <message d'erreur>
.RS -3
.LP
Dans une prochaine version, la librairie proposera des codes retour plus explicites, permettant de distinguer les differents types d'erreur.
.LP
.SH VOIR AUSSI
.B liblog
(3)

BIN
lib/libtool.doc Normal file
View File

Binary file not shown.

49
lib/libtool.h Normal file
View File

@@ -0,0 +1,49 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ver.h>
#include <kunf.h>
#include <shmem.h>
#include <log.h>
#include <tool.h>
extern char * strdup (const char *);
FILE * TL_stderr = NULL;
char TL_Info_Msg[256];
/* Déclarations pour ORACLE */
void pipo(void);
void pipo(void)
{
unsigned int x;
x = sqlstm.sqlvsn;
}
#define sqlstm _sqlstm
extern void sqlglm(char *, size_t *, size_t *);
#define SQL_OK 0
#define SQL_NO_DATA_FOUND 1403
#define SQL_FETCHED_COLUMN_NULL -1405
char * oracx = NULL;
void TL_Info_Print (void);
void TL_Error_Print (void);
TLT_Status TL_RTab_Add (LOGT_Channel *, char *);
TLT_Status TL_Trigger_Add (LOGT_Channel *, char *);
TLT_Status TL_GDRT_Load(void);
TLT_Status TL_KMOD_Load(void);
TLT_Status TL_KFORMAT_Load(void);
TLT_Status TL_GDRT_Unload(void);
TLT_Status TL_KMOD_Unload(void);
TLT_Status TL_KFORMAT_Unload(void);
TLT_Status TL_Param_Get (void);
TLT_Status TL_Database_Connect (void);
char * Oracle_Message_Get (void);
char * trim (char *);

1369
lib/libtool.pc Normal file
View File

File diff suppressed because it is too large Load Diff

516
lib/log.h Normal file
View File

@@ -0,0 +1,516 @@
#ifndef _LIBLOG
#define _LIBLOG
#ifdef __cplusplus
extern "C" {
#endif
#include <node.h>
#include <shmem.h>
#include <datastr.h>
#include <msg.h>
/*********** Anciennes librairies **************
#include <logevt.h>
#include <GetEvt.h>
************************************************/
/* Codes retour des fonctions de l'API */
typedef int LOGT_Status;
#define LOGS_OK DSS_OK /* La fonction s'est correctement exécutée et a produit un résultat */
#define LOGS_KO DSS_KO /* La fonction s'est correctement exécutée mais n'a pas produit de résultat */
#define LOGS_ERRMEM MSGS_ERRMEM /* Problème d'allocation mémoire */
#define LOGS_ERRAPI MSGS_ERRAPI /* Utilisation incorrecte des API */
#define LOGS_ERRSHM MSGS_ERRSHM /* Problème relatif aux segments de mémoire partagée */
#define LOGS_ERRSEM MSGS_ERRSEM /* Problème relatif à l'utilisation des sémaphores */
#define LOGS_ERRSIG MSGS_ERRSIG /* Opération sur sémpahore interrompue par un signal système */
#define LOGS_ERRDLL MSGS_ERRDLL /* Problème de chargement dynamique de librairie */
#define LOG_ERROR(s) (s < 0) /* Tous les codes retour négatifs correspondent à des erreurs */
/* Notion de routage (possibilité de les combiner par addition binaire) */
typedef int LOGT_Rooting;
#define LOGD_ROOTING_DATABASE 0x01 /* Routage vers la base de suivi */
#define LOGD_ROOTING_STDERR 0x02 /* Routage vers la sortie standard d'erreur */
#define LOGD_ROOTING_DEFAULT 0x04 /* Routage de la table de routage par défaut */
#define LOGD_ROOTING_PREVIOUS 0x08 /* Routage de la table de routage précédente */
#define LOGD_ROOTING_NULL 0x10 /* Routage vers /dev/null */
#define LOGD_ROOTING_DATABASE_MSK(a) (LOGD_ROOTING_DATABASE & a)
#define LOGD_ROOTING_STDERR_MSK(a) (LOGD_ROOTING_STDERR & a)
/* Notion de gravité (classe d'événement) */
typedef int LOGT_Gravite;
#define LOGD_GRV_INFO 'I'
#define LOGD_GRV_TRACE 'T'
#define LOGD_GRV_FONCT 'F'
#define LOGD_GRV_DETAIL 'L'
#define LOGD_GRV_STAT 'S'
#define LOGD_GRV_ERR 'E'
#define LOGD_GRV_REJDON 'D'
#define LOGD_GRV_REJENR 'R'
#define LOGD_GRV_WARNING 'W'
#define LOGD_GRV_RECYCLE 'Y'
#define LOGD_GRV_EXIT 'X'
#define LOGD_GRV_ABEND 'A'
/* Notion de code retour (pour le pilotage) */
typedef int LOGT_RC;
#define LOGD_RC_OK 0 /* Continuation */
#define LOGD_RC_ANOERR 4 /* Anomalie */
#define LOGD_RC_REJDON 6 /* Rejet de la donnée */
#define LOGD_RC_REJENR 7 /* Rejet de l'enregistrement */
#define LOGD_RC_WARNING 8 /* Evénement inconnu */
#define LOGD_RC_RECYCLE 10 /* Recyclage de l'enregistrement */
#define LOGD_RC_EXIT 14 /* Sortie du traitement */
#define LOGD_RC_ABEND 16 /* Interruption du traitement */
#define LOGD_RC_SIZE 17 /* Taille des tableaux de codes retour (voir fonction LOG_Event_Cpt_Get) */
/* Type de table de routage */
typedef int LOGT_RTType;
#define LOGD_GMRT 0 /* Global Master Rooting Table */
#define LOGD_LMRT 1 /* Local Master Rooting Table */
#define LOGD_URT 2 /* User Rooting Table */
#define LOGD_LDRT 3 /* Local Default Rooting Table */
#define LOGD_GDRT 4 /* Global Default Rooting Table */
/* Notion de table de routage */
typedef struct {
char * Name; /* Nom de la table de routage */
LOGT_RTType Type; /* Type de la table de routage */
NDT_Root * Root; /* Pointeur sur la structure contenant les événements */
int Nb_Channel; /* Nombre de canaux auquels est rattachée la table */
pid_t Pid; /* Processus propriétaire de la table de routage (utile au garbage collector) */
} LOGT_RTab;
#define LOGD_RTAB_DEFAULT 0 /* Référence à la table de routage par défaut */
#define LOGD_RTAB_PREVIOUS 1 /* Référence à la table de routage précédente */
/* Notion de classe de règle de sélection des événements */
typedef int LOGT_RuleClass;
#define LOGD_SELECT_ALL 1 /* Règle appliquée à tous les événements */
#define LOGD_SELECT_GRV 2 /* Règle appliquée aux événements d'une certaine gravité */
#define LOGD_SELECT_RC 3 /* Règle appliquée aux événements associés à un certain code retour */
#define LOGD_SELECT_TYPE 4 /* Règle appliquée aux événements d'un certain type */
/* Notion de règle de sélection des événements */
typedef void LOGT_Rule; /* Contient le code gravité, code retour ou type d'événement selon la classe de la règle */
/* Différents indicateurs */
typedef int LOGT_Flags;
/* Modes d'ouverture et de fermeture */
#define LOGD_CREATE SMD_CREATE /* Création */
#define LOGD_OPEN SMD_OPEN /* Ouverture simple */
#define LOGD_DESTROY SMD_DESTROY /* Destruction */
#define LOGD_CLOSE SMD_CLOSE /* Fermeture simple */
/* Flags de debug sur l'ouverture de la librairie */
#define LOGD_DEBUG_NONE SMD_DEBUG_NONE /* pour n'afficher aucun message généré par les diverses librairies */
#define LOGD_DEBUG SMD_DEBUG /* pour afficher les messages générés par la librairie */
#define LOGD_DEBUG_ALL SMD_DEBUG_ALL /* pour afficher les messages générés par toutes les librairies sous-jacentes */
#define LOGD_DEBUG_MSK (MSGD_DEBUG & MSGD_DEBUG_ALL)
/* Mode de fonctionnement d'un trigger */
#define LOGD_ADD 0x01 /* Trigger d'ajout de table de routage */
#define LOGD_REMOVE 0x02 /* Trigger de suppression de table de routage */
#define LOGD_ONE_SHOT 0x04 /* Trigger actif une seul fois */
#define LOGD_PERMANENT 0x08 /* Trigger actif en permanence */
#define LOGD_ADD_MSK(a) (LOGD_ADD & a)
#define LOGD_REMOVE_MSK(a) (LOGD_REMOVE & a)
#define LOGD_ONE_SHOT_MSK(a) (LOGD_ONE_SHOT & a)
#define LOGD_PERMANENT_MSK(a) (LOGD_PERMANENT & a)
/* Notion de channel */
typedef struct {
pid_t Pid; /* Processus propriétaire du channel */
int Id; /* Identifiant du channel */
int ModuleId; /* Identifiant du module envoyeur */
int Master_ModuleId; /* Identifiant du module primaire */
NDT_Root * RTab_List; /* Liste de tables de routage */
NDT_Root * SubModule_List; /* Liste des sous-modules */
NDT_Root * Trigger_List; /* Liste des triggers posés sur le channel */
NDT_Root * Event_Cpt_List; /* Liste de compteurs d'événements */
} LOGT_Channel;
/* Notion de trigger (ajout ou suppression dynamique de tables de routage) */
typedef struct LOGT_Trigger
{
char * Event_Name; /* Evénement déclencheur du trigger */
LOGT_RTab * RTab; /* Table de routage utilisateur concernée */
LOGT_Flags Mode; /* Mode de fonctionnement du trigger */
LOGT_Channel * Channel; /* Channel auquel est rattaché le trigger */
} LOGT_Trigger;
/* Base système de la librairie LIBLOG */
typedef struct {
NDT_Root * KMOD; /* Cache des modules */
NDT_Root * KFORMAT; /* Cache des formats d'événement */
LOGT_RTab * GDRT; /* Table GDRT */
LOGT_RTab * GMRT; /* Table GMRT */
NDT_Root * LMRT_List; /* Liste des LMRT */
NDT_Root * LDRT_List; /* Liste des LDRT */
NDT_Root * URT_List; /* Liste des URT */
NDT_Root * Channel_List; /* Liste des channels */
} LOGT_Base;
LOGT_Base * LOG_Base = NULL;
/* Informations sur un type d'événement */
typedef struct {
unsigned int Event_Type; /* Identifiant du type d'événement */
char * Event_Name; /* Nom du type d'événément */
LOGT_Rooting Rooting; /* Routage associé */
LOGT_Gravite Gravite; /* Code gravité associé */
LOGT_RC RC; /* Code retour associé */
NDT_Root * Data_List; /* Liste des données du format de l'événement */
} LOGT_Info;
/* Format d'un type d'événement */
typedef struct {
unsigned int Event_Type; /* Type d'événement */
NDT_Root * Data_List; /* Liste des données du format */
} LOGT_Event_Format;
/* Message explicite des erreurs générées par la librairie LINLOG */
char LOG_Error_Msg [256];
/* Identifiant du port de messages pour l'envoi des événements */
#define LOGD_EVENT_PORT_NAME "EVENT_PORT"
/* Type des messages qui contiennent les événements */
#define LOGD_EVENT_MSG_TYPE 100
/*
Formatage des événements par les clients de la LIBLOG :
EVEN1[.EVEN2[.EVEN3]]@[MODULE1[.MODULE2[.MODULE3]]]:[MODE1[.MODE2[.MODE3]]]:[GEO1[.GEO2[.GEO3]]]
*/
#define EVEN1 0x00000101
#define EVEN2 0x00000102
#define EVEN3 0x00000103
#define MODULE1 0x00000201
#define MODULE2 0x00000202
#define MODULE3 0x00000203
#define MODE1 0x00000301
#define MODE2 0x00000302
#define MODE3 0x00000303
#define GEO1 0x00000401
#define GEO2 0x00000402
#define GEO3 0x00000403
#define DEFAULT -1L
#define CHAR 0L
#define STRING 1L
#define SHORT 2L
#define INT 3L
#define LONG 4L
#define FLOAT 5L
#define DOUBLE 6L
#define END_NAME -1
#define END_DATA "END_DATA"
/* Format d'un message contenant un événement */
#define EVENT_FORMAT_VERSION_SIZE 10 /* sur 10 caractères max */
#define EVENT_FORMAT_VERSION "V1.0"
/* Zone de données du message :
- Version de format de message : 10 octets |
- Numéro de processus envoyeur : 4 octets | Entête
- Identifiant du module envoyeur : 4 octets |
- Identifiant du module primaire : 4 octets |
- Identifiant du type d'événement : 4 octets
- Taille du nom de l'événement : 1 octet |
- Nom de l'événement |
- Taille du code support : 1 octet |
- Code support |
- Taille du nom de la macro-donnée : 1 octet | Evénement |
- Nom de la macro-donnée | |
- Taille de la valeur de la macro-donnée : 1 octet | | N fois
- Valeur de la macro-donnée | |
*/
typedef struct {
char Version [EVENT_FORMAT_VERSION_SIZE];
unsigned int Sending_Pid;
unsigned int ModuleId;
unsigned int Master_ModuleId;
} LOGT_Event_Msg_Header;
typedef struct {
LOGT_Event_Msg_Header Header;
unsigned int Event_Type;
size_t Data_Size;
char Event_Data;
} LOGT_Event_Msg_Data;
/* Définition des alias de l'API */
#ifndef LOG_MODE
#define LOG_MODE 0
#endif
#if LOG_MODE == 1
/* API sans vérification des arguments */
# define LOG_Library_Open LOG_Library_Open_I
# define LOG_Library_Close LOG_Library_Close_I
# define LOG_Library_Stderr_Set LOG_Library_Stderr_Set_I
# define LOG_Channel_Open LOG_Channel_Open_I
# define LOG_Channel_Enter LOG_Channel_Enter_I
# define LOG_Channel_Leave LOG_Channel_Leave_I
# define LOG_Channel_Close LOG_Channel_Close_I
# define LOG_RTab_Alloc LOG_RTab_Alloc_I
# define LOG_RTab_Setup LOG_RTab_Setup_I
# define LOG_RTab_Add LOG_RTab_Add_I
# define LOG_RTab_Remove LOG_RTab_Remove_I
# define LOG_RTab_Free LOG_RTab_Free_I
# define LOG_Trigger_Add LOG_Trigger_Add_I
# define LOG_Trigger_Remove LOG_Trigger_Remove_I
# define LOG_Event_Send LOG_Event_Send_I
# define LOG_Event_External_Send LOG_Event_External_Send_I
# define LOG_Event_Info_Get LOG_Event_Info_Get_I
# define LOG_Event_Cpt_Get LOG_Event_Cpt_Get_I
#else
/* API avec vérification des arguments */
# define LOG_Library_Open LOG_Library_Open_C
# define LOG_Library_Close LOG_Library_Close_C
# define LOG_Library_Stderr_Set LOG_Library_Stderr_Set_C
# define LOG_Channel_Open LOG_Channel_Open_C
# define LOG_Channel_Enter LOG_Channel_Enter_C
# define LOG_Channel_Leave LOG_Channel_Leave_C
# define LOG_Channel_Close LOG_Channel_Close_C
# define LOG_RTab_Alloc LOG_RTab_Alloc_C
# define LOG_RTab_Setup LOG_RTab_Setup_C
# define LOG_RTab_Add LOG_RTab_Add_C
# define LOG_RTab_Remove LOG_RTab_Remove_C
# define LOG_RTab_Free LOG_RTab_Free_C
# define LOG_Trigger_Add LOG_Trigger_Add_C
# define LOG_Trigger_Remove LOG_Trigger_Remove_C
# define LOG_Event_Send LOG_Event_Send_C
# define LOG_Event_External_Send LOG_Event_External_Send_C
# define LOG_Event_Info_Get LOG_Event_Info_Get_C
# define LOG_Event_Cpt_Get LOG_Event_Cpt_Get_C
#endif
/*------------------------------------------------------------------------------*/
/* Ouverture de la librairie */
/*------------------------------------------------------------------------------*/
/* (I) Instance : numéro de l'instance à ouvrir */
/* (I) Context : contexte d'utilisation de la librairie */
/* (I) Open_Mode : mode d'ouverture de la librairie */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Library_Open_I ( int Instance, const char * Context, LOGT_Flags Open_Mode );
LOGT_Status LOG_Library_Open_C ( int Instance, const char * Context, LOGT_Flags Open_Mode );
/*------------------------------------------------------------------------------*/
/* Fermeture de l'instance de la librairie */
/*------------------------------------------------------------------------------*/
/* (I) Close_Mode : mode de fermeture de la librairie */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Library_Close_I ( LOGT_Flags Close_Mode );
LOGT_Status LOG_Library_Close_C ( LOGT_Flags Close_Mode );
/*------------------------------------------------------------------------------*/
/* Définition de la sortie standard des messages d'erreur de la librairie */
/*------------------------------------------------------------------------------*/
/* (I) Out : flux de sortie des messages d'erreur */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Library_Stderr_Set_I ( FILE * Out );
LOGT_Status LOG_Library_Stderr_Set_C ( FILE * Out );
/*------------------------------------------------------------------------------*/
/* Création d'un canal de communication */
/*------------------------------------------------------------------------------*/
/* (O) Channel : adresse du pointeur sur le canal créé */
/* (I) Pid : numéro du processus propriétaire du canal */
/* (I) Channel_Id : identifiant du canal au sein du processus */
/* (I) Module_Name : nom du module propriétaire du canal */
/* (I) Master_Module_Name : nom du module primaire */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Channel_Open_I (LOGT_Channel ** Channel, int Pid, int Channel_Id, const char * Module_Name, const char * Master_Module_Name);
LOGT_Status LOG_Channel_Open_C (LOGT_Channel ** Channel, int Pid, int Channel_Id, const char * Module_Name, const char * Master_Module_Name);
/*------------------------------------------------------------------------------*/
/* Entrée dans un sous-module pour un canal de communication */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le canal */
/* (I) SubModule_Name : nom du sous-module */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Channel_Enter_I ( LOGT_Channel * Channel, const char * SubModule_Name );
LOGT_Status LOG_Channel_Enter_C ( LOGT_Channel * Channel, const char * SubModule_Name );
/*------------------------------------------------------------------------------*/
/* Sortie d'un sous-module pour un canal de communication */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le canal */
/* (I) SubModule_Name : nom du sous-module */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Channel_Leave_I ( LOGT_Channel * Channel, const char * SubModule_Name );
LOGT_Status LOG_Channel_Leave_C ( LOGT_Channel * Channel, const char * SubModule_Name );
/*------------------------------------------------------------------------------*/
/* Fermeture d'un canal de communication */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le canal à fermer */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Channel_Close_I ( LOGT_Channel * Channel);
LOGT_Status LOG_Channel_Close_C ( LOGT_Channel * Channel);
/*------------------------------------------------------------------------------*/
/* Création d'une table de routage utilisateur */
/*------------------------------------------------------------------------------*/
/* (O) RTab : adresse du pointeur sur la table de routage */
/* (I) Name : nom de la table de routage */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_RTab_Alloc_I ( LOGT_RTab ** RTab, char * Name );
LOGT_Status LOG_RTab_Alloc_C ( LOGT_RTab ** RTab, char * Name );
/*------------------------------------------------------------------------------*/
/* Ajout d'une règle à une table de routage */
/*------------------------------------------------------------------------------*/
/* (I) RTab : pointeur sur la table de routage */
/* (I) RuleClass : classe de la nouvelle règle */
/* (I) Rule : pointeur sur la nouvelle règle */
/* (I) Value : valeur de la nouvelle règle */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_RTab_Setup_I ( LOGT_RTab * RTab, LOGT_RuleClass RuleClass, LOGT_Rule * Rule, LOGT_Rooting Value );
LOGT_Status LOG_RTab_Setup_C ( LOGT_RTab * RTab, LOGT_RuleClass RuleClass, LOGT_Rule * Rule, LOGT_Rooting Value );
/*------------------------------------------------------------------------------*/
/* Ajout d'une table de routage à un canal de communication */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le canal de communication */
/* (I) RTab : pointeur sur la table de routage */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_RTab_Add_I ( LOGT_Channel * Channel, LOGT_RTab * RTab );
LOGT_Status LOG_RTab_Add_C ( LOGT_Channel * Channel, LOGT_RTab * RTab );
/*------------------------------------------------------------------------------*/
/* Suppression d'une table de routage d'un canal de communication */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le canal de communication */
/* (I) RTab : pointeur sur la table de routage */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_RTab_Remove_I ( LOGT_Channel * Channel, LOGT_RTab * RTab );
LOGT_Status LOG_RTab_Remove_C ( LOGT_Channel * Channel, LOGT_RTab * RTab );
/*------------------------------------------------------------------------------*/
/* Destruction d'une table de routage */
/*------------------------------------------------------------------------------*/
/* (I) RTab : pointeur sur la table de routage */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_RTab_Free_I ( LOGT_RTab * RTab );
LOGT_Status LOG_RTab_Free_C ( LOGT_RTab * RTab );
/*------------------------------------------------------------------------------*/
/* Ajout d'un trigger */
/*------------------------------------------------------------------------------*/
/* (O) Trigger : adresse du pointeur sur le trigger mis en place */
/* (I) Channel : pointeur sur le canal de communication */
/* (I) RTab : pointeur sur la table de routage à appliquer */
/* (I) Type_Evt : type d'événement déclencheur ( expression régulière ) */
/* (I) Mode : mode de fonctionnement du trigger */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Trigger_Add_I ( LOGT_Trigger ** Trigger, LOGT_Channel * Channel, LOGT_RTab * RTab, char * Type_Evt, LOGT_Flags Mode );
LOGT_Status LOG_Trigger_Add_C ( LOGT_Trigger ** Trigger, LOGT_Channel * Channel, LOGT_RTab * RTab, char * Type_Evt, LOGT_Flags Mode );
/*------------------------------------------------------------------------------*/
/* Suppression d'un trigger */
/*------------------------------------------------------------------------------*/
/* (I) Trigger : pointeur sur le trigger mis en place */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Trigger_Remove_I ( LOGT_Trigger * Trigger );
LOGT_Status LOG_Trigger_Remove_C ( LOGT_Trigger * Trigger );
/*------------------------------------------------------------------------------*/
/* Envoi d'un événement */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur un canal de communication */
/* (O) RC : pointeur sur le code retour associé à l'événement */
/* (I) Cd_Support : code du support source */
/* (I) Data : données de l'événement */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Event_Send_I ( LOGT_Channel * Channel, LOGT_RC * RC, char * Cd_Support, va_list Data );
LOGT_Status LOG_Event_Send_C ( LOGT_Channel * Channel, LOGT_RC * RC, char * Cd_Support, va_list Data );
/*------------------------------------------------------------------------------*/
/* Envoi d'un événement ( PL/SQL ou shell ) */
/*------------------------------------------------------------------------------*/
/* (I) Channel : identifiant du channel */
/* (I) Cd_Support : code du support source */
/* (I) Data : données de l'événement */
/*------------------------------------------------------------------------------*/
/* (O) Retourne le code retour associé au type d'événement */
/*------------------------------------------------------------------------------*/
LOGT_RC LOG_Event_External_Send_I ( LOGT_Channel * Channel, char * Cd_Support, char * Data );
LOGT_RC LOG_Event_External_Send_C ( LOGT_Channel * Channel, char * Cd_Support, char * Data );
/*------------------------------------------------------------------------------*/
/* Retourne les informations du type par lequel un événement est résolu */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur un canal de communication */
/* (O) Info : pointeur sur les informations à récupérer */
/* (I) Event_Name : nom de l'événement */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Event_Info_Get_I ( LOGT_Channel * Channel, LOGT_Info ** Info, char * Event_Name );
LOGT_Status LOG_Event_Info_Get_C ( LOGT_Channel * Channel, LOGT_Info ** Info, char * Event_Name );
/*------------------------------------------------------------------------------*/
/* Retourne le nombre d'événements envoyés par code retour */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur un canal de communication */
/* (O) Cpt : pointeur sur un tableau de compteurs d'événement */
/* (I) RegExpr : expression régulière sur le nom d'événement */
/*------------------------------------------------------------------------------*/
LOGT_Status LOG_Event_Cpt_Get_I ( LOGT_Channel * Channel, int * Cpt [LOGD_RC_SIZE], char * RegExpr );
LOGT_Status LOG_Event_Cpt_Get_C ( LOGT_Channel * Channel, int * Cpt [LOGD_RC_SIZE], char * RegExpr );
#ifdef __cplusplus
}
#endif
#endif

68
lib/tool.h Normal file
View File

@@ -0,0 +1,68 @@
#ifndef _LIBTOOL
#define _LIBTOOL
#ifdef __cplusplus
extern "C" {
#endif
#include <log.h>
/* Codes retour des fonctions de l'API */
typedef int TLT_Status;
#define TLS_OK LOGS_OK
#define TLS_KO LOGS_KO
typedef int TLT_Cache;
#define TLD_KMOD 0001
#define TLD_KFORMAT 0010
#define TLD_GDRT 0100
char TL_Error_Msg[256];
/*------------------------------------------------------------------------------*/
/* Définition de la sortie standard des messages d'erreur de la librairie */
/*------------------------------------------------------------------------------*/
/* (I) Out : flux de sortie des messages d'erreur */
/*------------------------------------------------------------------------------*/
TLT_Status TL_Library_Stderr_Set ( FILE * Out );
/*------------------------------------------------------------------------------*/
/* Chargement des caches de la librairie LIBLOG */
/*------------------------------------------------------------------------------*/
/* (I) ToLoad : liste des caches de données à charger */
/* (combinaison de TLD_KMOD, TLD_KFORMAT et TLD_GDRT) */
/*------------------------------------------------------------------------------*/
TLT_Status TL_LIBLOG_Load (TLT_Cache ToLoad);
/*------------------------------------------------------------------------------*/
/* Déchargement des caches de la librairie LIBLOG */
/*------------------------------------------------------------------------------*/
/* (I) ToUnload : liste des caches de données à décharger */
/* (combinaison de TLD_KMOD, TLD_KFORMAT et TLD_GDRT) */
/*------------------------------------------------------------------------------*/
TLT_Status TL_LIBLOG_Unload (TLT_Cache ToUnload);
/*------------------------------------------------------------------------------*/
/* Affectation de toutes les tables de routage d'une section KUNF à un channel */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le channel */
/* (I) Kunf_Nm : nom de la section KUNF */
/*------------------------------------------------------------------------------*/
TLT_Status TL_Channel_RTab_Add (LOGT_Channel * My_Channel, const char * Kunf_Nm);
/*------------------------------------------------------------------------------*/
/* Affectation de tous les triggers d'une section KUNF à un channel */
/*------------------------------------------------------------------------------*/
/* (I) Channel : pointeur sur le channel */
/* (I) Kunf_Nm : nom de la section KUNF */
/*------------------------------------------------------------------------------*/
TLT_Status TL_Channel_Trigger_Add (LOGT_Channel * My_Channel, const char * Kunf_Nm);
#ifdef __cplusplus
}
#endif
#endif