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