Current File : //usr/include/kvm.h

/*
 * Copyright (c) 1987, 2015, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef	_KVM_H
#define	_KVM_H

#include <sys/types.h>
#include <nlist.h>
#include <sys/user.h>
#include <sys/proc.h>


#ifdef __cplusplus
extern "C" {
#endif

/* filename prefixes */
#define	VMCORE_PREFIX	"vmcore"
#define	VMDUMP_PREFIX	"vmdump"

/*
 * Maximum length of {vmcore, vmdump}-<section_name>.<bounds> consists of:
 *  strlen({VMCORE_PREFIX, VMDUMP_PREFIX}) + 1 + DS_MAX_NAMELEN + 1 +
 *  MAX_BOUNDS_LEN + terminating zero
 */
#define	MAX_BOUNDS_LEN	19	/* should be enough for long */
#define	MAX_DUMPFILE_NAME_LEN	6 + 1 + DS_MAX_NAMELEN + 1 + MAX_BOUNDS_LEN + 1

/*
 * maximum lenght of namelist file  'unix.<bounds>' consists of:
 *  strlen("unix") + 1 + MAX_BOUNDS_LEN + terminating zero
 */
#define	MAX_NAMELIST_LEN	4 + 1 + MAX_BOUNDS_LEN + 1

/* define a 'cookie' to pass around between user code and the library */
typedef struct _kvmd kvm_t;


/* Flags for kvm_open */

/*
 * Do not perform search for additional core files which contain sections that
 * are dumped, but not present in the corefile being opened.
 */
#define	KVM_NSRCH	0x1000000

/*
 * No separate namelist file. Use symbol table that is embedded into system
 * core file for symbol lookup.
 */
#define	KVM_NNAMELIST	0x2000000

/* libkvm routine definitions */

#ifdef __STDC__

extern kvm_t	*kvm_open(const char *, const char *, const char *,
		int, const char *);
extern int	kvm_close(kvm_t *);
extern int	kvm_nlist(kvm_t *, struct nlist []);
extern ssize_t	kvm_read(kvm_t *, uintptr_t, void *, size_t) __ATTR_DEPRECATED;
extern ssize_t	kvm_kread(kvm_t *, uintptr_t, void *, size_t);
extern ssize_t	kvm_uread(kvm_t *, uintptr_t, void *, size_t);
extern ssize_t	kvm_aread(kvm_t *, uintptr_t, void *, size_t, struct as *);
extern ssize_t	kvm_pread(kvm_t *, uint64_t, void *, size_t);
extern ssize_t	kvm_write(kvm_t *, uintptr_t, const void *, size_t)
    __ATTR_DEPRECATED;
extern ssize_t	kvm_kwrite(kvm_t *, uintptr_t, const void *, size_t);
extern ssize_t	kvm_uwrite(kvm_t *, uintptr_t, const void *, size_t);
extern ssize_t	kvm_awrite(kvm_t *, uintptr_t, const void *, size_t,
		struct as *);
extern ssize_t	kvm_pwrite(kvm_t *, uint64_t, const void *, size_t);
extern uint64_t	kvm_physaddr(kvm_t *, struct as *, uintptr_t);
extern int	kvm_getadi_phys(kvm_t *, uintptr_t);
extern int	kvm_setadi_phys(kvm_t *, uintptr_t, int);
extern proc_t	*kvm_getproc(kvm_t *, pid_t);
extern proc_t	*kvm_nextproc(kvm_t *);
extern int	kvm_setproc(kvm_t *);
extern user_t	*kvm_getu(kvm_t *, struct proc *);
extern int	kvm_getcmd(kvm_t *, proc_t *, user_t *, char ***, char ***);

#else

extern kvm_t	*kvm_open();
extern int	kvm_close();
extern int	kvm_nlist();
extern ssize_t	kvm_read();
extern ssize_t	kvm_kread();
extern ssize_t	kvm_uread();
extern ssize_t	kvm_aread();
extern ssize_t	kvm_pread();
extern ssize_t	kvm_write();
extern ssize_t	kvm_kwrite();
extern ssize_t	kvm_uwrite();
extern ssize_t	kvm_awrite();
extern ssize_t	kvm_pwrite();
extern uint64_t	Kvm_physaddr();
extern proc_t	*kvm_getproc();
extern proc_t	*kvm_nextproc();
extern int	kvm_setproc();
extern user_t	*kvm_getu();
extern int	kvm_getcmd();

#endif	/* __STDC__ */

#ifdef	__cplusplus
}
#endif

#endif	/* _KVM_H */