2 * Copyright (c) 1997 Adrian Sun (asun@zoology.washington.edu)
10 #include <sys/types.h>
14 #include <netinet/in.h>
15 #include <atalk/afp.h>
16 #include <atalk/server_child.h>
17 #include <atalk/globals.h>
18 #include <netatalk/endian.h>
21 #include <sys/socket.h>
24 /* What a DSI packet looks like:
26 |-------------------------------|
27 |flags |command| requestID |
28 |-------------------------------|
29 |error code/enclosed data offset|
30 |-------------------------------|
32 |-------------------------------|
34 |-------------------------------|
36 CONVENTION: anything with a dsi_ prefix is kept in network byte order.
39 /* these need to be kept in sync w/ AFPTRANS_* in <atalk/afp.h>.
40 * convention: AFPTRANS_* = (1 << DSI_*) */
47 #define DSI_BLOCKSIZ 16
49 u_int8_t dsi_flags; /* packet type: request or reply */
50 u_int8_t dsi_command; /* command */
51 u_int16_t dsi_requestID; /* request ID */
52 u_int32_t dsi_code; /* error code or data offset */
53 u_int32_t dsi_len; /* total data length */
54 u_int32_t dsi_reserved; /* reserved field */
57 #define DSI_CMDSIZ 8192
58 #define DSI_DATASIZ 8192
60 /* child and parent processes might interpret a couple of these
65 struct dsi_block header;
66 struct sockaddr_storage server, client;
67 struct itimerval timer;
68 int tickle; /* tickle count */
69 int in_write; /* in the middle of writing multiple packets,
70 signal handlers can't write to the socket */
71 int msg_request; /* pending message to the client */
72 int down_request; /* pending SIGUSR1 down in 5 mn */
74 u_int32_t attn_quantum, datasize, server_quantum;
75 u_int16_t serverID, clientID;
77 u_int8_t commands[DSI_CMDSIZ], data[DSI_DATASIZ];
79 size_t datalen, cmdlen;
80 off_t read_count, write_count;
81 uint32_t flags; /* DSI flags like DSI_SLEEPING, DSI_DISCONNECTED */
83 int socket, serversock;
85 /* protocol specific open/close, send/receive
86 * send/receive fill in the header and use dsi->commands.
87 * write/read just write/read data */
88 pid_t (*proto_open)(struct DSI *);
89 void (*proto_close)(struct DSI *);
91 /* url registered with slpd */
97 char *bonjourname; /* server name as UTF8 maxlen MAXINSTANCENAMELEN */
98 int zeroconf_registered;
101 /* DSI readahead buffer used for buffered reads in dsi_peek */
102 size_t dsireadbuf; /* size of the DSI readahead buffer used in dsi_peek() */
110 #define DSIFL_REQUEST 0x00
111 #define DSIFL_REPLY 0x01
112 #define DSIFL_MAX 0x01
114 /* DSI session options */
115 #define DSIOPT_SERVQUANT 0x00 /* server request quantum */
116 #define DSIOPT_ATTNQUANT 0x01 /* attention quantum */
117 #define DSIOPT_REPLCSIZE 0x02 /* AFP replaycache size supported by the server (that's us) */
120 #define DSIFUNC_CLOSE 1 /* DSICloseSession */
121 #define DSIFUNC_CMD 2 /* DSICommand */
122 #define DSIFUNC_STAT 3 /* DSIGetStatus */
123 #define DSIFUNC_OPEN 4 /* DSIOpenSession */
124 #define DSIFUNC_TICKLE 5 /* DSITickle */
125 #define DSIFUNC_WRITE 6 /* DSIWrite */
126 #define DSIFUNC_ATTN 8 /* DSIAttention */
127 #define DSIFUNC_MAX 8 /* largest command */
129 /* DSI Error codes: most of these aren't used. */
130 #define DSIERR_OK 0x0000
131 #define DSIERR_BADVERS 0xfbd6
132 #define DSIERR_BUFSMALL 0xfbd5
133 #define DSIERR_NOSESS 0xfbd4
134 #define DSIERR_NOSERV 0xfbd3
135 #define DSIERR_PARM 0xfbd2
136 #define DSIERR_SERVBUSY 0xfbd1
137 #define DSIERR_SESSCLOS 0xfbd0
138 #define DSIERR_SIZERR 0xfbcf
139 #define DSIERR_TOOMANY 0xfbce
140 #define DSIERR_NOACK 0xfbcd
142 /* server and client quanta */
143 #define DSI_DEFQUANT 2 /* default attention quantum size */
144 #define DSI_SERVQUANT_MAX 0xffffffff /* server quantum */
145 #define DSI_SERVQUANT_MIN 32000 /* minimum server quantum */
146 #define DSI_SERVQUANT_DEF 0x0004A2E0L /* default server quantum */
148 /* default port number */
149 #define DSI_AFPOVERTCP_PORT 548
151 /* DSI session State flags */
152 #define DSI_DATA (1 << 0) /* we have received a DSI command */
153 #define DSI_RUNNING (1 << 1) /* we have received a AFP command */
154 #define DSI_SLEEPING (1 << 2) /* we're sleeping after FPZzz */
155 #define DSI_EXTSLEEP (1 << 3) /* we're sleeping after FPZzz */
156 #define DSI_DISCONNECTED (1 << 4) /* we're in diconnected state after a socket error */
157 #define DSI_DIE (1 << 5) /* SIGUSR1, going down in 5 minutes */
158 #define DSI_NOREPLY (1 << 6) /* in dsi_write we generate our own replies */
159 #define DSI_RECONSOCKET (1 << 7) /* we have a new socket from primary reconnect */
160 #define DSI_RECONINPROG (1 << 8) /* used in the new session in reconnect */
161 #define DSI_AFP_LOGGED_OUT (1 << 9) /* client called afp_logout, quit on next EOF from socket */
162 #define DSI_GOT_ECONNRESET (1 << 10) /* got ECONNRESET from client => exit */
164 /* basic initialization: dsi_init.c */
165 extern DSI *dsi_init (const dsi_proto /*protocol*/,
166 const char * /*program*/,
167 const char * /*host*/, const char * /*address*/,
168 const char * /*port*/, const int /*proxy*/,
169 const u_int32_t /* server quantum */);
170 extern void dsi_setstatus (DSI *, char *, const size_t);
172 /* in dsi_getsess.c */
173 extern afp_child_t *dsi_getsession (DSI *, server_child *, const int);
174 extern void dsi_kill (int);
177 /* DSI Commands: individual files */
178 extern void dsi_opensession (DSI *);
179 extern int dsi_attention (DSI *, AFPUserBytes);
180 extern int dsi_cmdreply (DSI *, const int);
181 extern int dsi_tickle (DSI *);
182 extern void dsi_getstatus (DSI *);
183 extern void dsi_close (DSI *);
186 /* low-level stream commands -- in dsi_stream.c */
187 extern ssize_t dsi_stream_write (DSI *, void *, const size_t, const int mode);
188 extern size_t dsi_stream_read (DSI *, void *, const size_t);
189 extern int dsi_stream_send (DSI *, void *, size_t);
190 extern int dsi_stream_receive (DSI *, void *, const size_t, size_t *);
191 extern int dsi_disconnect(DSI *dsi);
194 extern ssize_t dsi_stream_read_file(DSI *, int, off_t off, const size_t len);
197 /* client writes -- dsi_write.c */
198 extern size_t dsi_writeinit (DSI *, void *, const size_t);
199 extern size_t dsi_write (DSI *, void *, const size_t);
200 extern void dsi_writeflush (DSI *);
201 #define dsi_wrtreply(a,b) dsi_cmdreply(a,b)
203 /* client reads -- dsi_read.c */
204 extern ssize_t dsi_readinit (DSI *, void *, const size_t, const size_t,
206 extern ssize_t dsi_read (DSI *, void *, const size_t);
207 extern void dsi_readdone (DSI *);
209 /* some useful macros */
210 #define dsi_serverID(x) ((x)->serverID++)
211 #define dsi_send(x) do { \
212 (x)->header.dsi_len = htonl((x)->cmdlen); \
213 dsi_stream_send((x), (x)->commands, (x)->cmdlen); \
215 #define dsi_receive(x) (dsi_stream_receive((x), (x)->commands, \
216 DSI_CMDSIZ, &(x)->cmdlen))
217 #endif /* atalk/dsi.h */