/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* bos72Q src/bos/usr/include/spc.h 1.23 */
/* */
/* Licensed Materials - Property of IBM */
/* */
/* COPYRIGHT International Business Machines Corp. 1984,2019 */
/* All Rights Reserved */
/* */
/* US Government Users Restricted Rights - Use, duplication or */
/* disclosure restricted by GSA ADP Schedule Contract with IBM Corp. */
/* */
/* IBM_PROLOG_END_TAG */
/* @(#)43 1.23 src/bos/usr/include/spc.h, cmdsrc, bos72Q, q2019_13A4 2/19/19 03:08:07 */
/*
* COMPONENT_NAME: (cmdsrc) System Resource Controller
*
* FUNCTIONS:
*
* ORIGINS: 27
*
* (C) COPYRIGHT International Business Machines Corp. 1984,1994
* All Rights Reserved
* Licensec Materials - Property of IBM
*
* US Government Users Restricted Rights - Use, duplication or
* disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
*/
/* System Resource Controler - Subsystem Process Control include file
** all subsystems that SRC will control using sockets or message queues
** should include this file
**/
#ifndef _H_SPC
#define _H_SPC
#include <sys/types.h>
#include <sys/un.h>
/* error code definitions for daemon support */
#include <srcerrno.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SRCNAMESZ 30
#define SRCPKTMAX 8192 /* maximum packet size */
#define SRC_BUF_MAX 2048 /* maximum message buffer length, in bytes */
#define SRC_XBUF_MAX 1280 /* maximum xdata length, in bytes */
#define SRC_STAT_MAX 64 /* maximum status text length, in bytes */
/* Reserved obect types */
#define SUBSVR 16
#define SUBSYSTEM 17
/* spawning actions */
#define RESPAWN 1 /* restart subsystem if it ends */
#define ONCE 2 /* do not restart subsystem */
/* contact options */
#define SRCIPC 1 /* contact is IPC */
#define SRCSIGNAL 2 /* contact is signal */
#define SRCSOCKET 3 /* contact is SOCKETS */
/* SRC true/false */
#define SRCOFF 0
#define SRCON 1
#define SRCNO SRCOFF
#define SRCYES SRCON
#define TIMELIMIT 20
/* Respawn as indicated from subsystem object class */
#define RESP_USE 0
/* Respawn is not allowed */
#define RESP_IGNORE 1
/* SRC action types
** SRC reservers the range 0 - 255 for SRC commands
**/
#define START 0
#define STOP 1
#define STATUS 2
#define SRCSTATUS STATUS
#define TRACE 4
#define REFRESH 5
/* SRC action types (new naming)
** SRC reserves the range 0 - 65535 for SRC commands
** If the "extended" bit is set, this is an extended req;
** this means that all actions must be in the range 0-32767.
**/
#define SRCACT_START 0
#define SRCACT_STOP 1
#define SRCACT_STATUS 2
#define SRCACT_TRACE 4
#define SRCACT_REFRESH 5
#define SRCACT_CONFIGURE 6
#define SRCACT_EXTENDED 16384
/* Parameter values for parm1 & parm2 */
/* stop normal subsystem or subsvr */
#define NORMAL 0
/* stop forced subsystem or subsvr */
#define FORCED 1
/* stop cancel (subsystem only) */
#define CANCEL 2
#define TRACEOFF 0
#define TRACEON 1
#define SHORTSTAT 0
#define LONGSTAT 1
#define SHORTTRACE SHORTSTAT
#define LONGTRACE LONGSTAT
#define SRCPARM_CONFIG_ADD 0 /* data should be added to existing */
#define SRCPARM_CONFIG_REPLACE 1 /* data should overwrite existing */
#define SRCPARM_CONFIG_REMOVE 2 /* data should be removed from existing */
#define SRCPARM_CONFIG_OTHER 3 /* data interpretation unspecified */
/* subsystem reply is continued
** CONTINUED from subsystem means that rtnmsg is just to be printed and
** another packet will follow this one.
** STATCONTINUED from subsystem means that another packet will
** follow this one (status only).
**/
#define CONTINUED 1
#define STATCONTINUED 2
/* new request indicator */
#define NEWREQUEST 3
/* last subsystem response packet indicator */
#define END 0
/* This continued parameter will trigger socket closure and buffer freeing */
#define SRC_CLOSE 4
/* Map older API calls to newer ones */
#ifndef SRCSUBSYS53
#define defssys defssys_53
#define addssys addssys_53
#define checkssys checkssys_53
#define ckcontact ckcontact_53
#define finishupdate finishupdate_53
#define chssys chssys_53
#define getssys getssys_53
#endif /* SRCSUBSYS53 */
/* define subsystem functions that return other than an int */
struct srchdr *srcrrqs();
/* src header to be included in all packets that are sent to and
** received from any subsystem
** In AIX 4.1, added a 4-byte pad to keep the srchdr structure the
** same length as in 3.2. (The sockaddr_un structure changed.)
**/
struct sockaddr_un_s {
uchar_t sun_len; /* sockaddr len including null */
sa_family_t sun_family; /* AF_UNIX */
char sun_path[104]; /* path name (gag). */
};
struct srchdr
{
struct sockaddr_un_s retaddr; /* return address for packets */
char pad[4]; /* Adjust for 4.1 change to socket */
short dversion; /* SRC packet version */
short cont; /* continuation indicator */
};
/* special header to prepend to all TCP packets
**/
struct srctcphdr
{
uint32_t hdrlen; /* length of this header */
uint32_t pktlen; /* length of packet to follow */
uint32_t cryptmeth; /* encryption method */
};
/* xtension header */
struct srcextreq
{
char xuname[SRCNAMESZ]; /* username associated with this request */
char xupass[SRCNAMESZ]; /* password for xuname */
short xlen; /* length of extended data that follows */
char xdata[SRC_XBUF_MAX]; /* extended data */
};
/* subsystem request */
struct subreq
{
short object; /* object type one of
** 1. SUBSYSTEM
** 2. subserver code point as defined
** in subserver object class
**/
short action; /* action requested of subsystem */
short parm1; /* first modifier for subsystem action */
short parm2; /* second modifier for subsystem action */
char objname[SRCNAMESZ];
/* name of object that request applies to
** 1. subsystem name
** 2. subserver object
** 3. subserver pid
**/
};
/* subsystem extended request - must overlay the above */
struct subxreq
{
short object; /* object type one of
** 1. SUBSYSTEM
** 2. subserver code point as defined
** in subserver object class
**/
short action; /* action requested of subsystem */
short parm1; /* first modifier for subsystem action */
short parm2; /* second modifier for subsystem action */
char objname[SRCNAMESZ];
/* name of object that request applies to
** 1. subsystem name
** 2. subserver object
** 3. subserver pid
**/
struct srcextreq extreq; /* extended request data */
};
/* Subsystem request receipt */
struct srcreq
{
#ifdef SRCBYQUEUE
mtyp_t mtype; /* mtype for message queue subsystems */
#endif
struct srchdr srchdr;
struct subreq subreq;
};
/* Subsystem request receipt (extended) */
struct srcxreq
{
#ifdef SRCBYQUEUE
mtyp_t mtype; /* mtype for message queue subsystems */
#endif
struct srchdr srchdr;
struct subxreq subxreq;
};
/* subsystem reply */
struct svrreply
{
short rtncode; /* subsystems response to the request
** negative on subsystem error
** or subsystem unique message returned
**/
short objtype; /* status object type one of
** 1. SUBSYSTEM
** 2. subserver code point
** 3. error code
**/
char objtext[65]; /* text discription to be included in
** response of subsystem action
**/
char objname[SRCNAMESZ];
/* name of object (subsystem/subsever) that
** this response belongs to
*/
char rtnmsg[256]; /* subsystem unique message */
};
/*
** Subsystem Status Reply
**/
struct statcode
{
short objtype; /* status object type one of
** 1. SUBSYSTEM
** 2. subserver code point
** 3. error code
**/
short status; /* status code */
char objtext[65]; /* text discription to be included in
** printing status for this object
**/
char objname[SRCNAMESZ];
/* name of object (subsystem/subsever) that
** this status belongs to
*/
};
/* Subsystem reply */
struct srcrep
{
struct srchdr srchdr;
struct svrreply svrreply;
};
/* Subsystem status reply */
struct statrep
{
struct srchdr srchdr;
struct statcode statcode[1];
};
/* Valid SRC status id's */
#define SRCACT 1 /* started & active */
#define SRCINAC 2 /* inactive */
#define SRCSTPG 3 /* stopping */
#define SRCSTAR 6 /* starting */
#define SRCSUSP 4 /* suspending */
#define SRCWARN 5 /* warned to stop */
#define SRCOPND 7 /* opened */
#define SRCLOSD 8 /* closed */
#define SRCOPPN 9 /* open pending */
#define SRCLSPN 10 /* close pending */
#define SRCINOP 11 /* inoperative */
#define SRCOBIN 12 /* open but inactive */
#define SRCNOSTAT 13 /* no status */
#define SRCTSTPN 14 /* test pending */
#define SRCTST 15 /* test active */
/* Valid SRC status id's (new naming; must match above) */
#define SRCSTAT_ACTIVE 1 /* started & active */
#define SRCSTAT_INACTIVE 2 /* inactive */
#define SRCSTAT_STOPPING 3 /* stopping */
#define SRCSTAT_SUSPENDING 4 /* suspending */
#define SRCSTAT_STOPWARN 5 /* warned to stop */
#define SRCSTAT_STARTING 6 /* starting */
#define SRCSTAT_OPENED 7 /* opened */
#define SRCSTAT_CLOSED 8 /* closed */
#define SRCSTAT_OPENPEND 9 /* open pending */
#define SRCSTAT_CLOSEPEND 10 /* close pending */
#define SRCSTAT_INOP 11 /* inoperative */
#define SRCSTAT_OBIN 12 /* open but inactive */
#define SRCSTAT_NOSTAT 13 /* no status */
#define SRCSTAT_TSTPEND 14 /* test pending */
#define SRCSTAT_TSTACT 15 /* test active */
#define SRCSTAT_CFGPEND 16 /* configure operation pending */
#define FIRST_STATUS_SRC SRCACT
#define LAST_STATUS_SRC SRCSTAT_CFGPEND
/* Is the process that will print the error/informative message
** a shell process or a background deamon process
**
*/
#define SDEAMON 0
#define SDAEMON 0
#define SSHELL 1
/* group charactor indicator */
#define SRCGROUP "" /* group char is a '^A' */
/* all subsystems charactor indicator */
#define SRCALLSUBSYS "" /* all char is a '^B' */
/* Function declarations. */
/* To send a START request to the subsystem and await its response. */
int srcstrt(
char *host,
char *name,
char *env,
char *parms,
unsigned int restrt,
int strtfrom
);
#ifdef __cplusplus
}
#endif
#endif /* _H_SPC */
/* End of spc.h */