DESCRIPTION

The mcSysInfo() C API is part of SysInfo from MagniComp. It allows the caller to obtain system information about the local or remote system's configuration via a platform neutral interface. Data is returned in platform nuetral data structures. This allows applications to be built using mcSysInfo() which are platform neutral. Available detailed system data includes general configuration, installed hardware, software, disk partitioning, system configuration, and kernel parameters. See mcsysinfo(1) for an overview of SysInfo.

The mcsysinfoperl(3) perl(1) object API may also be used if a perl(1) interface is required.

The MagniComp mcsysinfo(1) command uses the mcsysinfoc(3) API to obtain system configuration data and present it in human and machine readable formats.

The Query.Op parameter controls the basic operation performed by mcSysInfo(). The following values are supported:

CONFIGURATION WITH McsiOpt_t

The McsiOpt_t type is used to specify configuration options when Query.Op is set to MCSIOP_SETOPTS. It's defined as follows:

#define MCSIOPT_NOSERIAL	0x000001	/* Don't check serial #'s */
#define MCSIOPT_DEBUG		0x000002	/* Enable debugging output */

/*
 * Set mcSysInfo() options.
 *
 * This type is based to mcSysInfo() to allow the caller to specify
 * API options.
 *
 * Passed to mcSysInfo() when MCSIquery_t.Op = MCSIOP_SETOPTS
 */
typedef struct {
    int			Flags;		/* General flags */
    char	       *ProgramPath;	/* Path to this program */
    char	       *ProgramName;	/* Name of this program */
    char	       *ConfigDir;	/* SysInfo config dir */
    char	       *ConfigFile;	/* Caller specified config file */
} McsiOpt_t;

The ConfigDir and ProgramName members are required to be set prior to any MCSIOP_CREATE operation. Failure to set ConfigDir may result in incomplete data being returned.

QUERY INTERFACE

The Query is defined as follows:

/*
 * Query type for mcSysInfo() calls
 */
typedef struct {
    /* Caller's Input */
    int         Op;         /* MCSIOP_* operator */
    int         Cmd;        /* MCSI_* command to perform */
    uint_t      Flags;      /* Option Flags */
    char      **SearchExp;  /* Search Expression */
    Opaque_t    In;         /* Ptr to Input */
    size_t      InSize;     /* Size of In */
    /* Results */
    Opaque_t    Out;        /* Ptr to Output */
    size_t      OutSize;    /* Size of Out */
} MCSIquery_t;

The members of MCSIquery_t are defined as follows:

The valid values for Cmd are as follows:

DESCRIPTION OF DevInfo_t

The primary device information data type is DevInfo_t which is defined as:

struct _DevInfo {
    char              *Name;       /* Name (e.g. cgtwo0) */
    char              *Driver;     /* Driver Name (e.g. cgtwo) */
    char             **Aliases;    /* Alias Names */
    char              *AltName;    /* Alt name */
    char             **Files;      /* Device files */
    int                Type;       /* Device type (eg DT_TAPE) */
    int                ClassType;  /* Class type (eg SCSI,IPI) */
    char              *Vendor;     /* Hardware Vendor */
    char              *Model;      /* Model */
    char              *ModelDesc;  /* eg SCSI, 4.0GB, etc. */
    char              *Serial;     /* Serial Number */
    char              *Capacity;   /* Capacity of device */
    char              *Speed;      /* Speed of device */
    char              *Revision;   /* Revision Info */
    DevDesc_t         *DescList;   /* Device Description */
    int                Unit;       /* Unit number */
    int                NodeID;     /* ID of this node */
    char              *MasterName; /* Name of master */
    void              *DevSpec;    /* Device specific info */
    struct _DevInfo   *Master;     /* Device controller */
    struct _DevInfo   *Slaves;     /* Devices on this device */
    struct _DevInfo   *Next;       /* Pointer to next device */
    /* Internal use only */
    void              *OSdata;     /* Data from OS */
    /* Obsolete */
    int                Addr;       /* Address */
    int                Prio;       /* Priority */
    int                Vec;        /* Vector */
};
typedef struct _DevInfo DevInfo_t;

The members of DevInfo_t are defined as follows:

struct _CpuInfo {
    char		       *Man;		/* Manufacturer */
    char		       *Model;		/* Model of CPU */
    char		       *Arch;		/* Architecture Name */
    char		       *ArchVer;	/* Architecture Version */
    char		       *Serial;		/* Serial# */
    int				BitSize;	/* Bits 32/64/... */
    Large_t			Speed;		/* Clock Speed in Mhz */
    CacheInfo_t		       *L1iCache;	/* L1 Instruction Cache */
    CacheInfo_t		       *L1dCache;	/* L1 Data Cache */
    CacheInfo_t		       *L2Cache;	/* L2 Cache */
    /* General features */
    Bool_t			HasFPU;		/* Has FPU */
    int				Stepping;	/* Stepping */
    Desc_t		       *Features;	/* List of features */
};
typedef struct _CpuInfo		CpuInfo_t;

/*
 * Cache Information type
 */
typedef struct {
    int				Enabled;	/* Is this cache enabled? */
    int				Type;		/* Type of Cache */
    int				Level;		/* Level=1, 2, ... */
    Large_t			Size;		/* Size (bytes) */
    int				Speed;		/* Speed (ns) */
    int				Assoc;		/* Associativity */
    int				Lines;		/* # Lines */
    int				LineSize;	/* Line Size (bytes)*/
    int				TLB;		/* # TLB Entries */
    int				TLBAssoc;	/* # TLB Associativity */
    int				Socketed;	/* Is cache socketed? */
    char		       *Location;	/* Location relative to CPU */
    char		       *SramType;	/* SRAM Type */
    char		       *EccType;	/* ECC Type */
    char		       *Mode;		/* Mode (Write Back/Through..*/
} CacheInfo_t;

DESCRIPTION OF License_t

The License_t type defines a license entry as follows:

/*
 * Types of licenses
 */
#define LT_FLOAT		1		/* Floating/concurrent */
#define LT_NODELOCK		2		/* Locked to 1 node */
/*
 * License Types
 * Order/value must match LT_* values
 */
#define LICENSE_TYPES		{ "", "float", "node", NULL }
#define LICENSE_DESCS		{ "", "Floating", "Node Locked", NULL }

/*
 * License class data
 */
struct _License {
    char		       *SoftName;	/* Name of software */
    char		       *SoftVer;	/* Version of software */
    int				Type;		/* One of LT_* */
    char		       *TypeStr;	/* String version of Type */
    char		       *TypeDescStr;	/* String type description */
    int				Port;		/* Port server runs on */
    char		       *File;		/* License file */
    char		       *ServerSoft;	/* Name of lic server sw */
    char		       *ServerVer;	/* License server sw ver */
    char		       *VendorServerSoft;/* Vendor server soft */
    char		       *VendorServerVer;/* Vendor server soft ver */
    int				Count;		/* # of allowed licenses */
    char		       *Issuer;		/* Who issued license */
    char		       *Hostid;		/* Hostid lic is for */
    char		       *IssueDate;	/* Date lic was issued */
    char		       *StartDate;	/* Start date */
    char		       *ExpireDate;	/* Date of expiration */
    char		       *Key;		/* License key */
    char		       *Serial;		/* Serial Number */
    struct _License	       *Next;		/* Next member */
};
typedef struct _License		License_t;

The members of License_t are defined as follows:

DESCRIPTION OF PartInfo_t

The PartInfo_t type defines a partition entry as follows:

/*
 * Partition Information (CN_PARTITION)
 */
struct _PartInfo {
    char	       *Title;		/* Describes this entry */
    char	       *DevPath;	/* Dev Path e.g. /dev/dsk/c0t0s1 */
    char	       *DevPathRaw;	/* Raw Dev Path e.g. /dev/rdsk/c0t0s1 */
    char	       *DevName;	/* Dev Name e.g. c0t0 */
    char	       *BaseName;	/* c0t0s1 */
    char	       *Name;		/* Name e.g. s1 */
    int			Num;		/* Part # for this disk e.g. 1 */
    char	       *Type;		/* Type e.g. ufs */
    char	       *TypeDesc;	/* Description of Type */
    u_int		TypeNum;	/* Numeric value of Type if any */
    char	       *UsageStatus;	/* String value for Usage (below) */
    char	       *MntName;	/* Mount Name e.g. /usr */
    char	      **MntOpts;	/* Mount Options e.g. rw,quota */
    Large_t		Size;		/* Size of partition (MB) */
    Large_t		AmtUsed;	/* Amt of space currently used (MB)*/
    int			SecSize;	/* Size of 1 sector */
    Large_t		StartSect;	/* Starting Sector # */
    Large_t		EndSect;	/* Ending Sector # */
    Large_t		NumSect;	/* Number of Sectors (size) */
    /* Internal use only */
    int			Usage;		/* How used, one of PIU_* */
    struct _PartInfo   *Next;
};
typedef struct _PartInfo PartInfo_t;

The members of PartInfo_t are defined as follows:

DESCRIPTION OF Printer_t

The Printer_t type defines a printer entry as follows:

/*
 * Printer Protocol types
 */
#define PP_LOCAL		1		/* Local device */
#define PP_LPD			2		/* Unix LPR/LPD */
#define PP_SYSV			3		/* Unix System V */
#define PP_SMB			4		/* Windows SMB */
/*
 * Printer Protocol names - must match PP_*
 */
#define PRINTER_PROTO_LIST \
{ \
    NULL, "Local", "LPD", "SYSV", "SMB" \
}

/*
 * Printer Languages
 */
#define PL_PS			"PostScript"	/* PostScript */
#define PL_PS1			"PostScript-1"	/* PostScript Level 1 */
#define PL_PS2			"PostScript-2"	/* PostScript Level 2 */
#define PL_PS3			"PostScript-3"	/* PostScript Level 3 */
#define PL_PCL			"PCL"		/* PCL */

/*
 * Printer class data
 */
struct _Printer {
    char		       *Queue;		/* Name of queue */
    char		      **Aliases;	/* Queue aliases */
    char		       *Desc;		/* Queue Description */
    char		       *Vendor;		/* Printer vendor */
    char		       *Model;		/* Printer model */
    int				Proto;		/* Protocol - One of PP_* */
    char		       *Device;		/* File name of device */
    char		       *Server;		/* Name of server */
    char		       *RemoteQueue;	/* Queue name on Server */
    char		      **Langs;		/* Supported Languages PL_* */
    char		       *SpoolDir;	/* Spool directory */
    long			MaxJobSize;	/* Max size of jobs (KB) */
    Desc_t		       *DescList;	/* Descriptions */
    struct _Printer	       *Next;		/* Next member */
};
typedef struct _Printer		Printer_t;

The members of Printer_t are defined as follows:

DESCRIPTION OF SoftInfo_t

The software information data type is SoftInfo_t which is defined as:

struct _SoftInfo {
    char	       *EntryType;	/* Entry Type MC_SET_*_S */
    int			EntryTypeNum;	/* Numeric EntryType */
    char	       *Name;		/* Name */
    char	       *Version;	/* Version */
    char	       *Revision;	/* Revision for this Version */
    char	       *Desc;		/* Description of software */
    char	       *DescVerbose;	/* Verbose Description */
    char	       *URL;	 	/* Product URL */
    char	       *License; 	/* Product License */
    char	       *Copyright; 	/* Product Copyright */
    char	       *Category;	/* Category pkg belongs to */
    char	       *SubCategory;	/* Sub Category */
    char	       *OSname;		/* OS name runs on */
    char	       *OSversion;	/* OS version runs on */
    char	       *Arch;		/* Architecture runs on */
    char	       *ISArch;		/* Instruct. Set Arch. */
    char	       *InstDate;	/* Installation Date */
    char	       *BuildDate;	/* Build Date */
    char	       *ProdStamp;	/* Production Stamp */
    char	       *BaseDir;	/* Base Dir for files */
    Large_t		DiskUsage;	/* Space used by FileList */
    SoftFileList_t     *FileList;	/* List of Files */
    Desc_t	       *DescList;	/* Misc Descriptions */
    /* Vendor's info */
    char	       *VendorName;	/* Name of vendor */
    char	       *VendorEmail;	/* Email of vendor */
    char	       *VendorPhone;	/* Phone of vendor */
    char	       *VendorStock;	/* Vendor's Stock # for Pkg */
    /* Tree Links */
    struct _SoftInfo   *Master;		/* (Up) Our parent */
    struct _SoftInfo   *Slaves;		/* (Down) Children */
    struct _SoftInfo   *Next;		/* (Side) Siblings */
};
typedef struct _SoftInfo SoftInfo_t;

The members of SoftInfo_t are defined below and except where noted, the string formats vary from OS to OS and package to package:

DESCRIPTION OF SoftFileList_t

The SoftFileList_t type defines software file information usually in a linked list. It is defined as follows:

/*
 * Software File Data
 */
struct _SoftFileData {
    int			Type;		/* File, dir, symlink, etc */
    char	       *Path;		/* Path to file */
    char	       *LinkTo;		/* Link To what */
    Large_t		FileSize;	/* Size of file */
    char	       *MD5;		/* MD5 checksum */
    char	       *CheckSum;	/* Platform specific checksum */
    char	      **PkgNames;	/* List of used by Pkgs */
    struct _SoftFileData *Next;		/* Next entry */
};
typedef struct _SoftFileData SoftFileData_t;

/*
 * List of SoftFileData_t entries
 */
struct _SoftFileList {
    SoftFileData_t     *FileData;	/* Ptr to FileData entry */
    struct _SoftFileList *Next;		/* Next entry in our list */
};
typedef struct _SoftFileList SoftFileList_t;
/*
 * SoftFile Types for SoftFileData.Type
 */
#define SFT_FILE	1		/* Plain file */
#define SFT_FILE_S	"File"
#define SFT_HLINK	2		/* Hard Link */
#define SFT_HLINK_S	"Hard-Link"
#define SFT_SLINK	3		/* Soft Link */
#define SFT_SLINK_S	"Symbolic-Link"
#define SFT_DIR		4		/* Directory */
#define SFT_DIR_S	"Directory"
#define SFT_CDEV	5		/* Device File */
#define SFT_CDEV_S	"Character-Device"
#define SFT_BDEV	6		/* Device File */
#define SFT_BDEV_S	"Block-Device"

The list of files associated with a package is defined by the SoftFileList_t type. The actual file data is defined in SoftFileList_t->FileData.

The members of SoftFileData_t are defined as follows:

RETURN VALUES

Upon successful completion, mcSysInfo() returns 0 and output data is available in the buffer indicated by the Out parameter. Upon error, mcSysInfo() returns -1.

COMPILATION

The libraries which need to be linked with your application include both mcSysInfo related libraries as well as OS libraries. The directory containing the mcSysInfo libraries is platform specific as well as what OS libraries are needed.

The libs command automatically determines the options to specify to your compiler/linker command to link in both the mcSysInfo libraries and the required OS libraries. Normally you just need to "backtic" the command at the end of your linking command. i.e.

`/opt/sysinfo/libexec/bin/libs`

NOTES

File descriptors are opened for certain MCSI_* commands when using the MCSIOP_CREATE operator depending upon the platform upon which mcSysInfo() is operating on. All file descriptors which are opened by the platform specific functions of mcSysInfo() are closed before returning.

FILES

/opt/sysinfo/config - Config files read at runtime

SEE ALSO

mcsysinfo(1), mcsysinfoperl(3)

URL

http://www.MagniComp.com/sysinfo