freebsd-nq/lib/libprocstat/core.h

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2013 Mikolaj Golub <trociny@FreeBSD.org>
 * Copyright (c) 2017 Dell EMC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef _CORE_H
#define _CORE_H

enum psc_type {
	PSC_TYPE_PROC,
	PSC_TYPE_FILES,
	PSC_TYPE_VMMAP,
	PSC_TYPE_GROUPS,
	PSC_TYPE_UMASK,
	PSC_TYPE_RLIMIT,
	PSC_TYPE_OSREL,
	PSC_TYPE_PSSTRINGS,
	PSC_TYPE_ARGV,
	PSC_TYPE_ENVV,
	PSC_TYPE_AUXV,
	PSC_TYPE_PTLWPINFO,
	PSC_TYPE_MAX
};

struct procstat_core;

void procstat_core_close(struct procstat_core *core);
void *procstat_core_get(struct procstat_core *core, enum psc_type type,
    void * buf, size_t *lenp);
int procstat_core_note_count(struct procstat_core *core, enum psc_type type);
struct procstat_core *procstat_core_open(const char *filename);

#endif 	/* !_CORE_H_ */
Make libprocstat(3) extract procstat notes from a process core file. PR: kern/173723 Suggested by: jhb Glanced by: kib MFC after: 1 month 2013-04-20 07:47:26 +00:00			`/*-`
lib: further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 2-Clause license, however the tool I was using mis-identified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. 2017-11-26 02:00:33 +00:00			`* SPDX-License-Identifier: BSD-2-Clause-FreeBSD`
			`*`
Make libprocstat(3) extract procstat notes from a process core file. PR: kern/173723 Suggested by: jhb Glanced by: kib MFC after: 1 month 2013-04-20 07:47:26 +00:00			`* Copyright (c) 2013 Mikolaj Golub <trociny@FreeBSD.org>`
Add support for capturing 'struct ptrace_lwpinfo' for signals resulting in a process dumping core in the corefile. Also extend procstat to view select members of 'struct ptrace_lwpinfo' from the contents of the note. Sponsored by: Dell EMC Isilon 2017-03-30 18:21:36 +00:00			`* Copyright (c) 2017 Dell EMC`
Make libprocstat(3) extract procstat notes from a process core file. PR: kern/173723 Suggested by: jhb Glanced by: kib MFC after: 1 month 2013-04-20 07:47:26 +00:00			`* All rights reserved.`
			`*`
			`* Redistribution and use in source and binary forms, with or without`
			`* modification, are permitted provided that the following conditions`
			`* are met:`
			`* 1. Redistributions of source code must retain the above copyright`
			`* notice, this list of conditions and the following disclaimer.`
			`* 2. Redistributions in binary form must reproduce the above copyright`
			`* notice, this list of conditions and the following disclaimer in the`
			`* documentation and/or other materials provided with the distribution.`
			`*`
			* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`* SUCH DAMAGE.`
			`*`
			`* $FreeBSD$`
			`*/`

			`#ifndef _CORE_H`
			`#define _CORE_H`

			`enum psc_type {`
			`PSC_TYPE_PROC,`
			`PSC_TYPE_FILES,`
			`PSC_TYPE_VMMAP,`
Add procstat_getgroups function to retrieve process groups. MFC after: 1 month 2013-04-20 07:54:07 +00:00			`PSC_TYPE_GROUPS,`
Add procstat_getumask function to retrieve a process umask. MFC after: 1 month 2013-04-20 07:57:08 +00:00			`PSC_TYPE_UMASK,`
Add procstat_getrlimit function to retrieve a process resource limits info. MFC after: 1 month 2013-04-20 07:59:44 +00:00			`PSC_TYPE_RLIMIT,`
Add procstat_getosrel function to retrieve a process osrel info. MFC after: 1 month 2013-04-20 08:03:56 +00:00			`PSC_TYPE_OSREL,`
Extend libprocstat with functions to retrieve process command line arguments and environment variables. Suggested by: stas Reviewed by: jhb and stas (initial version) MFC after: 1 month 2013-04-20 08:07:04 +00:00			`PSC_TYPE_PSSTRINGS,`
			`PSC_TYPE_ARGV,`
			`PSC_TYPE_ENVV,`
Add procstat_getauxv function to retrieve a process auxiliary vector. MFC after: 1 month 2013-04-20 08:10:47 +00:00			`PSC_TYPE_AUXV,`
Add support for capturing 'struct ptrace_lwpinfo' for signals resulting in a process dumping core in the corefile. Also extend procstat to view select members of 'struct ptrace_lwpinfo' from the contents of the note. Sponsored by: Dell EMC Isilon 2017-03-30 18:21:36 +00:00			`PSC_TYPE_PTLWPINFO,`
			`PSC_TYPE_MAX`
Make libprocstat(3) extract procstat notes from a process core file. PR: kern/173723 Suggested by: jhb Glanced by: kib MFC after: 1 month 2013-04-20 07:47:26 +00:00			`};`

			`struct procstat_core;`

			`void procstat_core_close(struct procstat_core *core);`
			`void procstat_core_get(struct procstat_core core, enum psc_type type,`
			`void * buf, size_t *lenp);`
Add support for capturing 'struct ptrace_lwpinfo' for signals resulting in a process dumping core in the corefile. Also extend procstat to view select members of 'struct ptrace_lwpinfo' from the contents of the note. Sponsored by: Dell EMC Isilon 2017-03-30 18:21:36 +00:00			`int procstat_core_note_count(struct procstat_core *core, enum psc_type type);`
Make libprocstat(3) extract procstat notes from a process core file. PR: kern/173723 Suggested by: jhb Glanced by: kib MFC after: 1 month 2013-04-20 07:47:26 +00:00			`struct procstat_core procstat_core_open(const char filename);`

			`#endif /* !_CORE_H_ */`