[apple/network_cmds.git] / kdumpd.tproj / kdump.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1983, 1993
 *	The Regents of the University of California.  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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * 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.
 *
 *	@(#)kdump.h	8.1 (Berkeley) 6/2/93
 */

#ifndef _KDUMP_H_
#define	_KDUMP_H_
#include <netinet/ip_var.h>
#include <netinet/udp.h>
#include <netinet/udp_var.h>

/* Mac OS X kernel core dump server, based on the BSD trivial file
 * transfer protocol server (FreeBSD distribution), with several
 * modifications. This server is *not* compatible with tftp, as the
 * protocol has changed considerably.
 */

#define	SEGSIZE		512		/* data segment size */
#define MAXIMUM_KDP_PKTSIZE (16384)
/*
 * Packet types.
 */
#define	RRQ	1			/* read request */
#define	WRQ	2			/* write request */
#define	DATA	3			/* data packet */
#define	ACK	4			/* acknowledgement */
#define	ERROR	5			/* error code */
#define KDP_SEEK 6                     /* Seek to specified offset */
#define KDP_EOF  7                     /* end of file */

struct	kdumphdr {
	short	th_opcode;		/* packet type */
	union {
		unsigned int tu_block;	/* block # */
		unsigned int tu_code;	/* error code */
		char	tu_stuff[1];	/* request packet stuff */
	} th_u;
	char	th_data[0];		/* data or error string */
}__attribute__((packed));

#define	th_block	th_u.tu_block
#define	th_code		th_u.tu_code
#define	th_stuff	th_u.tu_stuff
#define	th_msg		th_data

/*
 * Error codes.
 */
#define	EUNDEF		0		/* not defined */
#define	ENOTFOUND	1		/* file not found */
#define	EACCESS		2		/* access violation */
#define	ENOSPACE	3		/* disk full or allocation exceeded */
#define	EBADOP		4		/* illegal KDUMP operation */
#define	EBADID		5		/* unknown transfer ID */
#define	EEXISTS		6		/* file already exists */
#define	ENOUSER		7		/* no such user */

#define DEBUG 0
#define WRITE_DEBUG 0
#define KDUMPD_DEBUG_LEVEL LOG_ALERT
#define KDP_LARGE_CRASHDUMP_PKT_SIZE (1440 - sizeof(struct udpiphdr))

#endif
Commit	Line	Data
ac2f15b3 A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
a2c93a76 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
ac2f15b3	11	*
a2c93a76 A	12	* This Original Code and all software distributed under the License are
a2c93a76 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
ac2f15b3 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
ac2f15b3 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
a2c93a76 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
ac2f15b3 A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* Copyright (c) 1983, 1993
	24	* The Regents of the University of California. All rights reserved.
	25	*
	26	* Redistribution and use in source and binary forms, with or without
	27	* modification, are permitted provided that the following conditions
	28	* are met:
	29	* 1. Redistributions of source code must retain the above copyright
	30	* notice, this list of conditions and the following disclaimer.
	31	* 2. Redistributions in binary form must reproduce the above copyright
	32	* notice, this list of conditions and the following disclaimer in the
	33	* documentation and/or other materials provided with the distribution.
	34	* 3. All advertising materials mentioning features or use of this software
	35	* must display the following acknowledgement:
	36	* This product includes software developed by the University of
	37	* California, Berkeley and its contributors.
	38	* 4. Neither the name of the University nor the names of its contributors
	39	* may be used to endorse or promote products derived from this software
	40	* without specific prior written permission.
	41	*
	42	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	43	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	44	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	45	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	46	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	47	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	48	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	49	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	50	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	51	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	52	* SUCH DAMAGE.
	53	*
	54	* @(#)kdump.h 8.1 (Berkeley) 6/2/93
	55	*/
	56
	57	#ifndef _KDUMP_H_
	58	#define _KDUMP_H_
44bd3e4d A	59	#include <netinet/ip_var.h>
	60	#include <netinet/udp.h>
	61	#include <netinet/udp_var.h>
ac2f15b3 A	62
	63	/* Mac OS X kernel core dump server, based on the BSD trivial file
	64	* transfer protocol server (FreeBSD distribution), with several
	65	* modifications. This server is not compatible with tftp, as the
	66	* protocol has changed considerably.
	67	*/
	68
	69	#define SEGSIZE 512 /* data segment size */
44bd3e4d	70	#define MAXIMUM_KDP_PKTSIZE (16384)
ac2f15b3 A	71	/*
	72	* Packet types.
	73	*/
	74	#define RRQ 1 /* read request */
	75	#define WRQ 2 /* write request */
	76	#define DATA 3 /* data packet */
	77	#define ACK 4 /* acknowledgement */
	78	#define ERROR 5 /* error code */
	79	#define KDP_SEEK 6 /* Seek to specified offset */
	80	#define KDP_EOF 7 /* end of file */
	81
	82	struct kdumphdr {
	83	short th_opcode; /* packet type */
	84	union {
	85	unsigned int tu_block; /* block # */
	86	unsigned int tu_code; /* error code */
	87	char tu_stuff[1]; /* request packet stuff */
	88	} th_u;
44bd3e4d	89	char th_data[0]; /* data or error string */
ac2f15b3 A	90	}__attribute__((packed));
	91
	92	#define th_block th_u.tu_block
	93	#define th_code th_u.tu_code
	94	#define th_stuff th_u.tu_stuff
	95	#define th_msg th_data
	96
	97	/*
	98	* Error codes.
	99	*/
	100	#define EUNDEF 0 /* not defined */
	101	#define ENOTFOUND 1 /* file not found */
	102	#define EACCESS 2 /* access violation */
	103	#define ENOSPACE 3 /* disk full or allocation exceeded */
	104	#define EBADOP 4 /* illegal KDUMP operation */
	105	#define EBADID 5 /* unknown transfer ID */
	106	#define EEXISTS 6 /* file already exists */
	107	#define ENOUSER 7 /* no such user */
	108
44bd3e4d A	109	#define DEBUG 0
	110	#define WRITE_DEBUG 0
	111	#define KDUMPD_DEBUG_LEVEL LOG_ALERT
	112	#define KDP_LARGE_CRASHDUMP_PKT_SIZE (1440 - sizeof(struct udpiphdr))
	113
ac2f15b3	114	#endif