zos-sys-info.h

Go to the documentation of this file.

 
// Licensed Materials - Property of IBM
// ZOSLIB
// (C) Copyright IBM Corp. 2020. All Rights Reserved.
// US Government Users Restricted Rights - Use, duplication
// or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 
// APIs that obtain various z/OS system info.
 
#ifndef ZOS_SYS_INFO_H_
#define ZOS_SYS_INFO_H_
 
#include "zos-macros.h"
 
#include <stdint.h>
#include <stdlib.h>
 
/* CPU model number length */
#define ZOSCPU_MODEL_LENGTH 4
 
typedef enum {
  ZOSLVL_V1R13 = 0,
  ZOSLVL_V2R1,
  ZOSLVL_V2R2,
  ZOSLVL_V2R3,
  ZOSLVL_V2R4,
  ZOSLVL_V2R5,
  ZOSLVL_V3R1,
  ZOSLVL_UNKNOWN,
} oslvl_t;
 
// CPU Management Control Table (CCT).
typedef struct ZOSCCT {
  uint8_t filler[110];
  uint16_t cpuCount; // Number of online CPUs.
} ZOSCCT_t;
 
// System Resources Manager Control Table (RMCT).
typedef struct ZOSRMCT {
  uint8_t name[4];
  struct ZOSCCT *__ptr32 cct;
} ZOSRMCT_t;
 
// RSM Control and Enumeration Area (RCE).
typedef struct ZOSRCE {
  uint8_t id[4];
  uint32_t pool; // Number of frames currently available to system.
} ZOSRCE_t;
 
// Communications Vector Table (CVT).
typedef struct ZOSCVT {
  uint8_t filler1[604];
  struct ZOSRMCT *__ptr32 rmct;
  uint8_t filler2[156];
  struct ZOSPCCAVT *__ptr32 pccavt;
  uint8_t filler3[400];
  struct ZOSRCE *__ptr32 rce;
  uint8_t filler4[92];
  uint8_t cvtoslvl[16];
} ZOSCVT_t;
 
// Prefixed Save Area (PSA).
// Maps storage starting at location 0.
typedef struct ZOSPSA {
  uint8_t filler[16]; // Ignore 16 bytes before CVT pointer.
  struct ZOSCVT *__ptr32 cvt;
} ZOSPSA_t;
 
// Physical Configuration Communication Area (PCCA).
// https://www.ibm.com/docs/en/zos/2.4.0?topic=information-pcca-mapping
typedef struct ZOSPCCA {
  char pcca[4];
  // Offset 4 is PCCACPID which is 12 bytes that gets broken down into:
  // https://www.ibm.com/docs/en/tdmffz/5.7?topic=reference-determine-cpu-serial-number
  char cpu_version[2];
  char cpu_lpid[2];
  char cpu_serial[4];
  char cpu_model[4];
  char filler1[372];
} ZOSPCCA;
 
// Physical CCA Vector Table (PCCAVT).
// https://www.ibm.com/docs/en/zos/2.4.0?topic=information-pccavt-mapping
typedef struct ZOSPCCAVT {
  struct ZOSPCCA *__ptr32 cpu0;
  char filler1[252];
} ZOSPCCAVT;
 
#ifdef __cplusplus
extern "C" {
#endif
 
__Z_EXPORT int __get_num_online_cpus(void);
 
__Z_EXPORT int __get_num_frames(void);
 
__Z_EXPORT oslvl_t __get_os_level(void);
 
__Z_EXPORT bool __is_os_level_at_or_above(oslvl_t level);
 
__Z_EXPORT bool __is_stfle_available();
 
__Z_EXPORT bool __is_vxf_available();
 
__Z_EXPORT bool __is_vef1_available();
 
__Z_EXPORT char *__get_cpu_model(char *buffer, size_t size);
 
#ifdef __cplusplus
}
#endif
#endif // ZOS_SYS_INFO_H_