safmgr.h

Go to the documentation of this file.

/*
 *
 * Copyright (C) Micro Focus 2006-2014.  All rights reserved.
 *
 * The software and information contained herein are proprietary to, and
 * comprise valuable trade secrets of, Micro Focus International Ltd., 
 * which intends to preserve as trade secrets such software and 
 * information. This software is an unpublished copyright of Micro Focus  
 * and may not be used, copied, transmitted, or stored in any manner.  
 * This software and information or any other copies thereof may not be
 * provided or otherwise made available to any other person.
 *
 *      Enterprise Server SAF (Security) Manager
 *      Manager Startup and Control
 *
 *      @(#)safmgr.h    $Revision: 621664 $     
 *
 *      $Date: 2014-08-11 20:08:36 -0400 (Mon, 11 Aug 2014) $
 *
 ****************************************************************************/

/* Start of source module safmgr.h */
#if !defined(SafMGR_H)
#define SafMGR_H

static const char *SafMGR_Hsccsid =
   "@(#)safmgr.h  $Revision: 621664 $ built " __DATE__ " " __TIME__ ;

/***
Doxygen Note: There's a Doxygen bug that prevents resolving references
to files with hyphens in their names in Dot diagrams. That means we
cannot add eg -- URL="\ref saf-env.c" -- to the diagrams below, where a
box would logically link to the page for a saf-*.c file.
***/

/* SAF Manager Version */
#include "saf-version.h"



/***
NOTE: Some of these structures have equivalent COBOL definitions in safmgr.cpy.
Changes MUST be reflected there, and the CAS team must be notified to update
their externals.
***/



#define SafESM_MAX 8

/*
Opaque declarations for the structures that contain configuration
information for the SAF Manager and for ESM modules.  See
COMMS/mfds/1.05/mdsa/mdsa_internal.h for contents.
*/

struct cas_saf_config_internal;
struct cas_esm_config_internal;

/*
Opaque declaration for the SAF API structure, in case safapi.h has
not been included yet.
*/

struct safpb_parameter_block;


struct SafInit
{
   mf_uns32     Version;        
   #define      SafMGR_API_VER  1       
   mf_uns32     Environment;    
   #define      SafENV_CAS      0       
   #define      SafENV_MFDS     (1<< 0) 
   #define      SafENV_CICS     (1<< 1) 
   #define      SafENV_IMS      (1<< 2) 
   #define      SafENV_JES      (1<< 3) 
   #define      SafENV_SOLO     (1ul<<31) 
   #define      SafENV_MTOMASK  0x0eul  
   mf_uns32     Reason;

   #define      SafMGR_FAIL_NONE        0 
   #define      SafMGR_FAIL_GENERAL     1 
   #define      SafMGR_FAIL_RESOURCE    2 
   #define      SafMGR_FAIL_MGRCFG      3 
   #define      SafMGR_FAIL_LOAD        4 
   #define      SafMGR_FAIL_ESMCFG      5 
   #define      SafMGR_FAIL_ESMENTRY  100 
   #define      SafMGR_FAIL_ESM       101 
   #define      SafMGR_FAIL_ENV       200 
   mf_uns32     Detail;

   char         ServerName[8];   
   char         Reserved[8];     
   int        (*CasMsgF)();

   int        (*CasTmpF)();

   int        (*CasLockF)();

   int        (*FailAudit)(const struct safpb_parameter_block *);

   struct cas_saf_config_internal
               *Config;         
   mf_uns32     ESMCnt;         
   struct cas_esm_config_internal
               *ESMCfg[SafESM_MAX];
};





#define SafINIT_OK      0 
#define SafINIT_NULL    1 
#define SafINIT_VER     2 
#define SafINIT_BAD_CB  3 
#define SafINIT_ENV     4 
#define SafINIT_CFG     5 
#define SafINIT_CNT     6 
#define SafINIT_ESMCFG  7 
#define SafINIT_RESRCE  8 
#define SafINIT_OTHER  15 
#define SafINIT_FAIL   16 
#define SafINIT_BADENV     128 
#define SafINIT_INTERNAL   129 
#define SafINIT_MODNAME    130 
#define SafINIT_MODLOAD    131 
#define SafINIT_ENVFUNC    132 
#define SafINIT_EXTERNAL   133 
typedef enum SafRet
{
   SafR_OK        =  0, 
   SafR_PARAM     =  1, 
   SafR_RESOURCE  =  2, 
   SafR_EXFAIL    =  3, 
   SafR_STATE     =  4, 
   SafR_INTERNAL  =  5, 
   SafR_NOTFOUND  =  6, 
   SafR_TRUNCATED =  7, 
   SafR_NOMORE    =  8, 
   SafR_INVALID   =  9, 
   SafR_ESM       = 10, 
   SafR_END       = 11, 
   SafR_NOTIMPL   = 12, 
   SafR_Invalid,
   SafR_Sizer = (1<<30)
} SafRet;



/* SAF Manager API */

mf_uns32 safmgr(struct SafInit *Init);
mf_uns32 safterm(mf_uns32 What, void *Reserved);
mf_uns32 safcfg(struct SafInit *Init, void *Reserved);
mf_uns32 safcfgesm(int Index, struct cas_esm_config_internal *Config,
                   void *Reserved);


#define SafTERM_THREAD  0  
#define SafTERM_PROCESS 1  
#define SafTERM_ESF     2  



/* Helper APIs */

int SafStrcmpCI(const char *, const char *);
int SafStrcmpCIN(const char *, const char *, size_t);
char *SafDupStr(const char *);

#define SafSTRCMP(s1, op, s2) (strcmp((s1),(s2)) op 0)


#define SafSTRCMP_N(s1, op, s2, n) (strncmp((s1),(s2),(n)) op 0)


#define SafSTRCMP_CI(s1, op, s2) (SafStrcmpCI((s1),(s2)) op 0)


#define SafSTRCMP_CIN(s1, op, s2, n) (SafStrcmpCIN((s1),(s2),(n)) op 0)


/* Helper for SafSTRING */
#define SafDO_STR(x) #x

#define SafSTRING(x) SafDO_STR(x)


/* Internal APIs */

mf_uns32 SafNative32u(mf_uns32 NetValue);
int SafState(void);
SafRet SafQueryCfg(const char *Class, const char *Name, char **ValueP);


/***
SafLOG_ALL can be defined in the build to log more information for each
request. This currently requires editing common.mak.
***/

#if !defined SafLOG_ALL
   #define SafLOG_ALL 0
#endif

#endif

/* End of safmgr.h */