xref: /freebsd/usr.sbin/iscsid/iscsid.h (revision febdb468801f35e51c6c5c22221cfce9197c6f3b)
1 /*-
2  * Copyright (c) 2012 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Edward Tomasz Napierala under sponsorship
6  * from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef ISCSID_H
33 #define	ISCSID_H
34 
35 #include <stdbool.h>
36 #include <stdint.h>
37 
38 #include <iscsi_ioctl.h>
39 
40 #define	DEFAULT_PIDFILE			"/var/run/iscsid.pid"
41 
42 #define	CONN_DIGEST_NONE		0
43 #define	CONN_DIGEST_CRC32C		1
44 
45 #define CONN_MUTUAL_CHALLENGE_LEN	1024
46 
47 struct connection {
48 	int			conn_iscsi_fd;
49 #ifndef ICL_KERNEL_PROXY
50 	int			conn_socket;
51 #endif
52 	unsigned int		conn_session_id;
53 	struct iscsi_session_conf	conn_conf;
54 	char			conn_target_alias[ISCSI_ADDR_LEN];
55 	uint8_t			conn_isid[6];
56 	uint32_t		conn_statsn;
57 	int			conn_header_digest;
58 	int			conn_data_digest;
59 	bool			conn_initial_r2t;
60 	bool			conn_immediate_data;
61 	size_t			conn_max_data_segment_length;
62 	size_t			conn_max_burst_length;
63 	size_t			conn_first_burst_length;
64 	char			conn_mutual_challenge[CONN_MUTUAL_CHALLENGE_LEN];
65 	unsigned char		conn_mutual_id;
66 };
67 
68 struct pdu {
69 	struct connection	*pdu_connection;
70 	struct iscsi_bhs	*pdu_bhs;
71 	char			*pdu_data;
72 	size_t			pdu_data_len;
73 };
74 
75 #define	KEYS_MAX		1024
76 
77 struct keys {
78 	char			*keys_names[KEYS_MAX];
79 	char			*keys_values[KEYS_MAX];
80 	char			*keys_data;
81 	size_t			keys_data_len;
82 };
83 
84 struct keys		*keys_new(void);
85 void			keys_delete(struct keys *key);
86 void			keys_load(struct keys *keys, const struct pdu *pdu);
87 void			keys_save(struct keys *keys, struct pdu *pdu);
88 const char		*keys_find(struct keys *keys, const char *name);
89 int			keys_find_int(struct keys *keys, const char *name);
90 void			keys_add(struct keys *keys,
91 			    const char *name, const char *value);
92 void			keys_add_int(struct keys *keys,
93 			    const char *name, int value);
94 
95 struct pdu		*pdu_new(struct connection *ic);
96 struct pdu		*pdu_new_response(struct pdu *request);
97 void			pdu_receive(struct pdu *request);
98 void			pdu_send(struct pdu *response);
99 void			pdu_delete(struct pdu *ip);
100 
101 void			login(struct connection *ic);
102 
103 void			discovery(struct connection *ic);
104 
105 void			log_init(int level);
106 void			log_set_peer_name(const char *name);
107 void			log_set_peer_addr(const char *addr);
108 void			log_err(int, const char *, ...)
109 			    __dead2 __printf0like(2, 3);
110 void			log_errx(int, const char *, ...)
111 			    __dead2 __printf0like(2, 3);
112 void			log_warn(const char *, ...) __printf0like(1, 2);
113 void			log_warnx(const char *, ...) __printflike(1, 2);
114 void			log_debugx(const char *, ...) __printf0like(1, 2);
115 
116 char			*checked_strdup(const char *);
117 bool			timed_out(void);
118 void			fail(const struct connection *, const char *);
119 
120 #endif /* !ISCSID_H */
121