[dragonfly.git] / sys / netproto / smb / smb_subr.h

/*
 * Copyright (c) 2000-2001, Boris Popov
 * 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 Boris Popov.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: src/sys/netsmb/smb_subr.h,v 1.1.2.1 2001/05/22 08:32:34 bp Exp $
 * $DragonFly: src/sys/netproto/smb/smb_subr.h,v 1.15 2006/12/22 23:57:54 swildner Exp $
 */
#ifndef _NETSMB_SMB_SUBR_H_
#define _NETSMB_SMB_SUBR_H_

#ifndef _KERNEL
#error "This file shouldn't be included from userland programs"
#endif

#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_SMBTEMP);
#endif

/*
 * For compatibility with 5.x
 */
#define	PDROP	PUSRFLAG1	/* OR'd with pri to stop re-entry of interlock mutex */

#define SMBERROR(format, args...) kprintf("%s: "format, __func__ ,## args)
#define SMBPANIC(format, args...) kprintf("%s: "format, __func__ ,## args)

#ifdef SMB_SOCKET_DEBUG
#define SMBSDEBUG(format, args...) kprintf("%s: "format, __func__ ,## args)
#else
#define SMBSDEBUG(format, args...)
#endif

#ifdef SMB_IOD_DEBUG
#define SMBIODEBUG(format, args...) kprintf("%s: "format, __func__ ,## args)
#else
#define SMBIODEBUG(format, args...)
#endif

#ifdef SMB_SOCKETDATA_DEBUG
void m_dumpm(struct mbuf *m);
#else
#define m_dumpm(m)
#endif

#define	SMB_SIGMASK(set) 						\
	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
	 SIGISMEMBER(set, SIGQUIT))

#define	smb_suser(cred)	priv_check_cred(cred, PRIV_ROOT, 0)

#include <sys/lock.h>
#include <sys/spinlock.h>
#include <sys/spinlock2.h>

#define	lockdestroy(lock)
#define	smb_slock			spinlock
#define	smb_sl_init(sl, desc)		spin_init(sl)
#define	smb_sl_destroy(sl)
#define	smb_sl_lock(sl)			spin_lock_wr(sl)
#define	smb_sl_unlock(sl)		spin_unlock_wr(sl)

#define SMB_STRFREE(p)	do { if (p) smb_strfree(p); } while(0)

/*
 * The simple try/catch/finally interface.
 * With GCC it is possible to allow more than one try/finally block per
 * function, but we'll avoid it to maintain portability.
 */
#define itry		{						\
				int _tval;				\

#define icatch(var)							\
				goto _finlab;				\
				(void)&&_catchlab;			\
				_catchlab:				\
				var = _tval;

#define ifinally		(void)&&_finlab;			\
				_finlab:				
#define iendtry		}

#define inocatch							\
				goto _finlab;				\
				(void)&&_catchlab;			\
				_catchlab:				\

#define ithrow(t)	do {						\
				if ((_tval = (int)(t)) != 0)		\
					goto _catchlab;			\
			} while (0)

#define ierror(t,e)	do {						\
				if (t) {				\
					_tval = e;			\
					goto _catchlab;			\
				}					\
			} while (0)

typedef u_int16_t	smb_unichar;
typedef	smb_unichar	*smb_uniptr;

/*
 * Crediantials of user/process being processing in the connection procedures
 */
struct smb_cred {
	struct thread *	scr_td;
	struct ucred *	scr_cred;
};

extern smb_unichar smb_unieol;

struct mbchain;
struct proc;
struct thread;
struct smb_vc;
struct smb_rq;


void smb_makescred(struct smb_cred *scred, struct thread *td, struct ucred *cred);
int  smb_proc_intr(struct thread *td);
char *smb_strdup(const char *s);
void *smb_memdup(const void *umem, int len);
char *smb_strdupin(char *s, int maxlen);
void *smb_memdupin(void *umem, int len);
void smb_strtouni(u_int16_t *dst, const char *src);
void smb_strfree(char *s);
void smb_memfree(void *s);
void *smb_zmalloc(unsigned long size, struct malloc_type *type, int flags);

int  smb_encrypt(const u_char *apwd, u_char *C8, u_char *RN);
int  smb_ntencrypt(const u_char *apwd, u_char *C8, u_char *RN);
int  smb_maperror(int eclass, int eno);
int  smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
	const char *src, int len, int caseopt);
int  smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
	const char *src, int caseopt);
int  smb_put_string(struct smb_rq *rqp, const char *src);
int  smb_put_asunistring(struct smb_rq *rqp, const char *src);

/*
 * Compatibilty with 5.x functions
 */
int kthread_create2(void (*func)(void *), void *arg,
    struct proc **newpp, int flags, const char *fmt, ...);
void kthread_exit2(void);
int smb_sleep(void *chan, struct smb_slock *sl, int slpflags, const char *wmesg, int timo);


#endif /* !_NETSMB_SMB_SUBR_H_ */
Commit	Line	Data
984263bc MD	1	/*
	2	* Copyright (c) 2000-2001, Boris Popov
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by Boris Popov.
	16	* 4. Neither the name of the author nor the names of any co-contributors
	17	* may be used to endorse or promote products derived from this software
	18	* without specific prior written permission.
	19	*
	20	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	21	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	24	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	* SUCH DAMAGE.
	31	*
	32	* $FreeBSD: src/sys/netsmb/smb_subr.h,v 1.1.2.1 2001/05/22 08:32:34 bp Exp $
a6ec04bc	33	* $DragonFly: src/sys/netproto/smb/smb_subr.h,v 1.15 2006/12/22 23:57:54 swildner Exp $
984263bc MD	34	*/
	35	#ifndef _NETSMB_SMB_SUBR_H_
	36	#define _NETSMB_SMB_SUBR_H_
	37
	38	#ifndef _KERNEL
	39	#error "This file shouldn't be included from userland programs"
	40	#endif
	41
	42	#ifdef MALLOC_DECLARE
	43	MALLOC_DECLARE(M_SMBTEMP);
	44	#endif
	45
	46	/*
	47	* For compatibility with 5.x
	48	*/
377d4740	49	#define PDROP PUSRFLAG1 /* OR'd with pri to stop re-entry of interlock mutex */
984263bc	50
a6ec04bc SW	51	#define SMBERROR(format, args...) kprintf("%s: "format, __func__ ,## args)
a6ec04bc SW	52	#define SMBPANIC(format, args...) kprintf("%s: "format, __func__ ,## args)
984263bc MD	53
984263bc MD	54	#ifdef SMB_SOCKET_DEBUG
a6ec04bc	55	#define SMBSDEBUG(format, args...) kprintf("%s: "format, __func__ ,## args)
984263bc MD	56	#else
	57	#define SMBSDEBUG(format, args...)
	58	#endif
	59
	60	#ifdef SMB_IOD_DEBUG
a6ec04bc	61	#define SMBIODEBUG(format, args...) kprintf("%s: "format, __func__ ,## args)
984263bc MD	62	#else
	63	#define SMBIODEBUG(format, args...)
	64	#endif
	65
	66	#ifdef SMB_SOCKETDATA_DEBUG
	67	void m_dumpm(struct mbuf *m);
	68	#else
	69	#define m_dumpm(m)
	70	#endif
	71
	72	#define SMB_SIGMASK(set) \
	73	(SIGISMEMBER(set, SIGINT) \|\| SIGISMEMBER(set, SIGTERM) \|\| \
	74	SIGISMEMBER(set, SIGHUP) \|\| SIGISMEMBER(set, SIGKILL) \|\| \
	75	SIGISMEMBER(set, SIGQUIT))
	76
895c1f85	77	#define smb_suser(cred) priv_check_cred(cred, PRIV_ROOT, 0)
984263bc MD	78
984263bc MD	79	#include <sys/lock.h>
8886b1fc MD	80	#include <sys/spinlock.h>
8886b1fc MD	81	#include <sys/spinlock2.h>
984263bc MD	82
984263bc MD	83	#define lockdestroy(lock)
8886b1fc MD	84	#define smb_slock spinlock
	85	#define smb_sl_init(sl, desc) spin_init(sl)
	86	#define smb_sl_destroy(sl)
d666840a MD	87	#define smb_sl_lock(sl) spin_lock_wr(sl)
d666840a MD	88	#define smb_sl_unlock(sl) spin_unlock_wr(sl)
984263bc MD	89
	90	#define SMB_STRFREE(p) do { if (p) smb_strfree(p); } while(0)
	91
	92	/*
	93	* The simple try/catch/finally interface.
	94	* With GCC it is possible to allow more than one try/finally block per
	95	* function, but we'll avoid it to maintain portability.
	96	*/
	97	#define itry { \
984263bc MD	98	int _tval; \
	99
	100	#define icatch(var) \
	101	goto _finlab; \
	102	(void)&&_catchlab; \
	103	_catchlab: \
	104	var = _tval;
	105
	106	#define ifinally (void)&&_finlab; \
	107	_finlab:
	108	#define iendtry }
	109
	110	#define inocatch \
	111	goto _finlab; \
	112	(void)&&_catchlab; \
	113	_catchlab: \
	114
	115	#define ithrow(t) do { \
	116	if ((_tval = (int)(t)) != 0) \
	117	goto _catchlab; \
	118	} while (0)
	119
	120	#define ierror(t,e) do { \
	121	if (t) { \
	122	_tval = e; \
	123	goto _catchlab; \
	124	} \
	125	} while (0)
	126
	127	typedef u_int16_t smb_unichar;
	128	typedef smb_unichar *smb_uniptr;
	129
	130	/*
	131	* Crediantials of user/process being processing in the connection procedures
	132	*/
	133	struct smb_cred {
dadab5e9	134	struct thread * scr_td;
984263bc MD	135	struct ucred * scr_cred;
	136	};
	137
	138	extern smb_unichar smb_unieol;
	139
	140	struct mbchain;
	141	struct proc;
dadab5e9	142	struct thread;
984263bc MD	143	struct smb_vc;
	144	struct smb_rq;
	145
	146
dadab5e9 MD	147	void smb_makescred(struct smb_cred scred, struct thread td, struct ucred *cred);
dadab5e9 MD	148	int smb_proc_intr(struct thread *td);
984263bc MD	149	char smb_strdup(const char s);
	150	void smb_memdup(const void umem, int len);
	151	char smb_strdupin(char s, int maxlen);
	152	void smb_memdupin(void umem, int len);
	153	void smb_strtouni(u_int16_t dst, const char src);
	154	void smb_strfree(char *s);
	155	void smb_memfree(void *s);
	156	void smb_zmalloc(unsigned long size, struct malloc_type type, int flags);
	157
	158	int smb_encrypt(const u_char apwd, u_char C8, u_char *RN);
	159	int smb_ntencrypt(const u_char apwd, u_char C8, u_char *RN);
	160	int smb_maperror(int eclass, int eno);
	161	int smb_put_dmem(struct mbchain mbp, struct smb_vc vcp,
	162	const char *src, int len, int caseopt);
	163	int smb_put_dstring(struct mbchain mbp, struct smb_vc vcp,
	164	const char *src, int caseopt);
	165	int smb_put_string(struct smb_rq rqp, const char src);
	166	int smb_put_asunistring(struct smb_rq rqp, const char src);
984263bc MD	167
	168	/*
	169	* Compatibilty with 5.x functions
	170	*/
	171	int kthread_create2(void (func)(void ), void *arg,
	172	struct proc *newpp, int flags, const char fmt, ...);
64053d25	173	void kthread_exit2(void);
8886b1fc	174	int smb_sleep(void chan, struct smb_slock sl, int slpflags, const char *wmesg, int timo);
984263bc MD	175
	176
	177	#endif /* !_NETSMB_SMB_SUBR_H_ */