[linux-block.git] / include / linux / elfcore.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_ELFCORE_H
#define _LINUX_ELFCORE_H

#include <linux/user.h>
#include <linux/bug.h>
#include <linux/sched/task_stack.h>
#include <linux/types.h>
#include <linux/signal.h>
#include <linux/time.h>
#include <linux/ptrace.h>
#include <linux/fs.h>
#include <linux/elf.h>

struct coredump_params;

struct elf_siginfo
{
	int	si_signo;			/* signal number */
	int	si_code;			/* extra code */
	int	si_errno;			/* errno */
};

/*
 * Definitions to generate Intel SVR4-like core files.
 * These mostly have the same names as the SVR4 types with "elf_"
 * tacked on the front to prevent clashes with linux definitions,
 * and the typedef forms have been avoided.  This is mostly like
 * the SVR4 structure, but more Linuxy, with things that Linux does
 * not support and which gdb doesn't really use excluded.
 */
struct elf_prstatus_common
{
	struct elf_siginfo pr_info;	/* Info associated with signal */
	short	pr_cursig;		/* Current signal */
	unsigned long pr_sigpend;	/* Set of pending signals */
	unsigned long pr_sighold;	/* Set of held signals */
	pid_t	pr_pid;
	pid_t	pr_ppid;
	pid_t	pr_pgrp;
	pid_t	pr_sid;
	struct __kernel_old_timeval pr_utime;	/* User time */
	struct __kernel_old_timeval pr_stime;	/* System time */
	struct __kernel_old_timeval pr_cutime;	/* Cumulative user time */
	struct __kernel_old_timeval pr_cstime;	/* Cumulative system time */
};

struct elf_prstatus
{
	struct elf_prstatus_common common;
	elf_gregset_t pr_reg;	/* GP registers */
	int pr_fpvalid;		/* True if math co-processor being used.  */
};

#define ELF_PRARGSZ	(80)	/* Number of chars for args */

struct elf_prpsinfo
{
	char	pr_state;	/* numeric process state */
	char	pr_sname;	/* char for pr_state */
	char	pr_zomb;	/* zombie */
	char	pr_nice;	/* nice val */
	unsigned long pr_flag;	/* flags */
	__kernel_uid_t	pr_uid;
	__kernel_gid_t	pr_gid;
	pid_t	pr_pid, pr_ppid, pr_pgrp, pr_sid;
	/* Lots missing */
	char	pr_fname[16];	/* filename of executable */
	char	pr_psargs[ELF_PRARGSZ];	/* initial part of arg list */
};

static inline void elf_core_copy_regs(elf_gregset_t *elfregs, struct pt_regs *regs)
{
#ifdef ELF_CORE_COPY_REGS
	ELF_CORE_COPY_REGS((*elfregs), regs)
#else
	BUG_ON(sizeof(*elfregs) != sizeof(*regs));
	*(struct pt_regs *)elfregs = *regs;
#endif
}

static inline void elf_core_copy_kernel_regs(elf_gregset_t *elfregs, struct pt_regs *regs)
{
#ifdef ELF_CORE_COPY_KERNEL_REGS
	ELF_CORE_COPY_KERNEL_REGS((*elfregs), regs);
#else
	elf_core_copy_regs(elfregs, regs);
#endif
}

static inline int elf_core_copy_task_regs(struct task_struct *t, elf_gregset_t* elfregs)
{
#if defined (ELF_CORE_COPY_TASK_REGS)
	return ELF_CORE_COPY_TASK_REGS(t, elfregs);
#elif defined (task_pt_regs)
	elf_core_copy_regs(elfregs, task_pt_regs(t));
#endif
	return 0;
}

extern int dump_fpu (struct pt_regs *, elf_fpregset_t *);

static inline int elf_core_copy_task_fpregs(struct task_struct *t, struct pt_regs *regs, elf_fpregset_t *fpu)
{
#ifdef ELF_CORE_COPY_FPREGS
	return ELF_CORE_COPY_FPREGS(t, fpu);
#else
	return dump_fpu(regs, fpu);
#endif
}

#if defined(CONFIG_UM) || defined(CONFIG_IA64)
/*
 * These functions parameterize elf_core_dump in fs/binfmt_elf.c to write out
 * extra segments containing the gate DSO contents.  Dumping its
 * contents makes post-mortem fully interpretable later without matching up
 * the same kernel and hardware config to see what PC values meant.
 * Dumping its extra ELF program headers includes all the other information
 * a debugger needs to easily find how the gate DSO was being used.
 */
extern Elf_Half elf_core_extra_phdrs(void);
extern int
elf_core_write_extra_phdrs(struct coredump_params *cprm, loff_t offset);
extern int
elf_core_write_extra_data(struct coredump_params *cprm);
extern size_t elf_core_extra_data_size(void);
#else
static inline Elf_Half elf_core_extra_phdrs(void)
{
	return 0;
}

static inline int elf_core_write_extra_phdrs(struct coredump_params *cprm, loff_t offset)
{
	return 1;
}

static inline int elf_core_write_extra_data(struct coredump_params *cprm)
{
	return 1;
}

static inline size_t elf_core_extra_data_size(void)
{
	return 0;
}
#endif

#endif /* _LINUX_ELFCORE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LINUX_ELFCORE_H
	3	#define _LINUX_ELFCORE_H
	4
1da177e4	5	#include <linux/user.h>
187f1882	6	#include <linux/bug.h>
68db0cf1	7	#include <linux/sched/task_stack.h>
1e6b57d6 AV	8	#include <linux/types.h>
	9	#include <linux/signal.h>
	10	#include <linux/time.h>
	11	#include <linux/ptrace.h>
	12	#include <linux/fs.h>
	13	#include <linux/elf.h>
1da177e4	14
506f21c5 AV	15	struct coredump_params;
506f21c5 AV	16
1e6b57d6 AV	17	struct elf_siginfo
	18	{
	19	int si_signo; /* signal number */
	20	int si_code; /* extra code */
	21	int si_errno; /* errno */
	22	};
	23
	24	/*
	25	* Definitions to generate Intel SVR4-like core files.
	26	* These mostly have the same names as the SVR4 types with "elf_"
	27	* tacked on the front to prevent clashes with linux definitions,
	28	* and the typedef forms have been avoided. This is mostly like
	29	* the SVR4 structure, but more Linuxy, with things that Linux does
	30	* not support and which gdb doesn't really use excluded.
	31	*/
f2485a2d	32	struct elf_prstatus_common
1e6b57d6 AV	33	{
	34	struct elf_siginfo pr_info; /* Info associated with signal */
	35	short pr_cursig; /* Current signal */
	36	unsigned long pr_sigpend; /* Set of pending signals */
	37	unsigned long pr_sighold; /* Set of held signals */
	38	pid_t pr_pid;
	39	pid_t pr_ppid;
	40	pid_t pr_pgrp;
	41	pid_t pr_sid;
	42	struct __kernel_old_timeval pr_utime; /* User time */
	43	struct __kernel_old_timeval pr_stime; /* System time */
	44	struct __kernel_old_timeval pr_cutime; /* Cumulative user time */
	45	struct __kernel_old_timeval pr_cstime; /* Cumulative system time */
f2485a2d AV	46	};
	47
	48	struct elf_prstatus
	49	{
	50	struct elf_prstatus_common common;
1e6b57d6	51	elf_gregset_t pr_reg; /* GP registers */
1e6b57d6 AV	52	int pr_fpvalid; /* True if math co-processor being used. */
	53	};
	54
	55	#define ELF_PRARGSZ (80) /* Number of chars for args */
	56
	57	struct elf_prpsinfo
	58	{
	59	char pr_state; /* numeric process state */
	60	char pr_sname; /* char for pr_state */
	61	char pr_zomb; /* zombie */
	62	char pr_nice; /* nice val */
	63	unsigned long pr_flag; /* flags */
	64	__kernel_uid_t pr_uid;
	65	__kernel_gid_t pr_gid;
	66	pid_t pr_pid, pr_ppid, pr_pgrp, pr_sid;
	67	/* Lots missing */
	68	char pr_fname[16]; /* filename of executable */
	69	char pr_psargs[ELF_PRARGSZ]; /* initial part of arg list */
	70	};
	71
1da177e4 LT	72	static inline void elf_core_copy_regs(elf_gregset_t elfregs, struct pt_regs regs)
	73	{
	74	#ifdef ELF_CORE_COPY_REGS
	75	ELF_CORE_COPY_REGS((*elfregs), regs)
	76	#else
	77	BUG_ON(sizeof(elfregs) != sizeof(regs));
	78	(struct pt_regs )elfregs = *regs;
	79	#endif
	80	}
	81
6cd61c0b TH	82	static inline void elf_core_copy_kernel_regs(elf_gregset_t elfregs, struct pt_regs regs)
	83	{
	84	#ifdef ELF_CORE_COPY_KERNEL_REGS
	85	ELF_CORE_COPY_KERNEL_REGS((*elfregs), regs);
	86	#else
	87	elf_core_copy_regs(elfregs, regs);
	88	#endif
	89	}
	90
1da177e4 LT	91	static inline int elf_core_copy_task_regs(struct task_struct t, elf_gregset_t elfregs)
1da177e4 LT	92	{
e9bf0cc7	93	#if defined (ELF_CORE_COPY_TASK_REGS)
1da177e4	94	return ELF_CORE_COPY_TASK_REGS(t, elfregs);
e9bf0cc7	95	#elif defined (task_pt_regs)
a65e7bfc	96	elf_core_copy_regs(elfregs, task_pt_regs(t));
1da177e4 LT	97	#endif
	98	return 0;
	99	}
	100
	101	extern int dump_fpu (struct pt_regs , elf_fpregset_t );
	102
	103	static inline int elf_core_copy_task_fpregs(struct task_struct t, struct pt_regs regs, elf_fpregset_t *fpu)
	104	{
	105	#ifdef ELF_CORE_COPY_FPREGS
	106	return ELF_CORE_COPY_FPREGS(t, fpu);
	107	#else
	108	return dump_fpu(regs, fpu);
	109	#endif
	110	}
	111
6e7b64b9	112	#if defined(CONFIG_UM) \|\| defined(CONFIG_IA64)
1fcccbac DH	113	/*
	114	* These functions parameterize elf_core_dump in fs/binfmt_elf.c to write out
	115	* extra segments containing the gate DSO contents. Dumping its
	116	* contents makes post-mortem fully interpretable later without matching up
	117	* the same kernel and hardware config to see what PC values meant.
	118	* Dumping its extra ELF program headers includes all the other information
	119	* a debugger needs to easily find how the gate DSO was being used.
	120	*/
	121	extern Elf_Half elf_core_extra_phdrs(void);
	122	extern int
506f21c5	123	elf_core_write_extra_phdrs(struct coredump_params *cprm, loff_t offset);
1fcccbac	124	extern int
aa3e7eaf	125	elf_core_write_extra_data(struct coredump_params *cprm);
8d9032bb	126	extern size_t elf_core_extra_data_size(void);
6e7b64b9 AB	127	#else
	128	static inline Elf_Half elf_core_extra_phdrs(void)
	129	{
	130	return 0;
	131	}
	132
	133	static inline int elf_core_write_extra_phdrs(struct coredump_params *cprm, loff_t offset)
	134	{
	135	return 1;
	136	}
	137
	138	static inline int elf_core_write_extra_data(struct coredump_params *cprm)
	139	{
	140	return 1;
	141	}
	142
	143	static inline size_t elf_core_extra_data_size(void)
	144	{
	145	return 0;
	146	}
	147	#endif
1da177e4 LT	148
1da177e4 LT	149	#endif /* _LINUX_ELFCORE_H */