2 * Copyright (c) 1997 Adrian Sun (asun@zoology.washington.edu)
11 #include <sys/socket.h>
13 #include <arpa/inet.h>
14 #include <netinet/in.h>
16 #include <atalk/afp.h>
17 #include <atalk/server_child.h>
18 #include <atalk/globals.h>
20 /* What a DSI packet looks like:
22 |-------------------------------|
23 |flags |command| requestID |
24 |-------------------------------|
25 |error code/enclosed data offset|
26 |-------------------------------|
28 |-------------------------------|
30 |-------------------------------|
32 CONVENTION: anything with a dsi_ prefix is kept in network byte order.
35 /* these need to be kept in sync w/ AFPTRANS_* in <atalk/afp.h>.
36 * convention: AFPTRANS_* = (1 << DSI_*) */
43 #define DSI_BLOCKSIZ 16
45 uint8_t dsi_flags; /* packet type: request or reply */
46 uint8_t dsi_command; /* command */
47 uint16_t dsi_requestID; /* request ID */
48 uint32_t dsi_code; /* error code or data offset */
49 uint32_t dsi_len; /* total data length */
50 uint32_t dsi_reserved; /* reserved field */
53 #define DSI_CMDSIZ 8192
54 #define DSI_DATASIZ 8192
56 /* child and parent processes might interpret a couple of these
59 struct DSI *next; /* multiple listening addresses */
64 struct dsi_block header;
65 struct sockaddr_storage server, client;
66 struct itimerval timer;
67 int tickle; /* tickle count */
68 int in_write; /* in the middle of writing multiple packets,
69 signal handlers can't write to the socket */
70 int msg_request; /* pending message to the client */
71 int down_request; /* pending SIGUSR1 down in 5 mn */
73 uint32_t attn_quantum, datasize, server_quantum;
74 uint16_t serverID, clientID;
75 uint8_t commands[DSI_CMDSIZ], data[DSI_DATASIZ];
76 size_t datalen, cmdlen;
77 off_t read_count, write_count;
78 uint32_t flags; /* DSI flags like DSI_SLEEPING, DSI_DISCONNECTED */
79 int socket; /* AFP session socket */
80 int serversock; /* listening socket */
82 /* DSI readahead buffer used for buffered reads in dsi_peek */
83 size_t dsireadbuf; /* size of the DSI readahead buffer used in dsi_peek() */
84 char *buffer; /* buffer start */
85 char *start; /* current buffer head */
86 char *eof; /* end of currently used buffer */
90 char *bonjourname; /* server name as UTF8 maxlen MAXINSTANCENAMELEN */
91 int zeroconf_registered;
94 /* protocol specific open/close, send/receive
95 * send/receive fill in the header and use dsi->commands.
96 * write/read just write/read data */
97 pid_t (*proto_open)(struct DSI *);
98 void (*proto_close)(struct DSI *);
102 #define DSIFL_REQUEST 0x00
103 #define DSIFL_REPLY 0x01
104 #define DSIFL_MAX 0x01
106 /* DSI session options */
107 #define DSIOPT_SERVQUANT 0x00 /* server request quantum */
108 #define DSIOPT_ATTNQUANT 0x01 /* attention quantum */
109 #define DSIOPT_REPLCSIZE 0x02 /* AFP replaycache size supported by the server (that's us) */
112 #define DSIFUNC_CLOSE 1 /* DSICloseSession */
113 #define DSIFUNC_CMD 2 /* DSICommand */
114 #define DSIFUNC_STAT 3 /* DSIGetStatus */
115 #define DSIFUNC_OPEN 4 /* DSIOpenSession */
116 #define DSIFUNC_TICKLE 5 /* DSITickle */
117 #define DSIFUNC_WRITE 6 /* DSIWrite */
118 #define DSIFUNC_ATTN 8 /* DSIAttention */
119 #define DSIFUNC_MAX 8 /* largest command */
121 /* DSI Error codes: most of these aren't used. */
122 #define DSIERR_OK 0x0000
123 #define DSIERR_BADVERS 0xfbd6
124 #define DSIERR_BUFSMALL 0xfbd5
125 #define DSIERR_NOSESS 0xfbd4
126 #define DSIERR_NOSERV 0xfbd3
127 #define DSIERR_PARM 0xfbd2
128 #define DSIERR_SERVBUSY 0xfbd1
129 #define DSIERR_SESSCLOS 0xfbd0
130 #define DSIERR_SIZERR 0xfbcf
131 #define DSIERR_TOOMANY 0xfbce
132 #define DSIERR_NOACK 0xfbcd
134 /* server and client quanta */
135 #define DSI_DEFQUANT 2 /* default attention quantum size */
136 #define DSI_SERVQUANT_MAX 0xffffffff /* server quantum */
137 #define DSI_SERVQUANT_MIN 32000 /* minimum server quantum */
138 #define DSI_SERVQUANT_DEF 0x0004A2E0L /* default server quantum */
140 /* default port number */
141 #define DSI_AFPOVERTCP_PORT 548
143 /* DSI session State flags */
144 #define DSI_DATA (1 << 0) /* we have received a DSI command */
145 #define DSI_RUNNING (1 << 1) /* we have received a AFP command */
146 #define DSI_SLEEPING (1 << 2) /* we're sleeping after FPZzz */
147 #define DSI_EXTSLEEP (1 << 3) /* we're sleeping after FPZzz */
148 #define DSI_DISCONNECTED (1 << 4) /* we're in diconnected state after a socket error */
149 #define DSI_DIE (1 << 5) /* SIGUSR1, going down in 5 minutes */
150 #define DSI_NOREPLY (1 << 6) /* in dsi_write we generate our own replies */
151 #define DSI_RECONSOCKET (1 << 7) /* we have a new socket from primary reconnect */
152 #define DSI_RECONINPROG (1 << 8) /* used in the new session in reconnect */
153 #define DSI_AFP_LOGGED_OUT (1 << 9) /* client called afp_logout, quit on next EOF from socket */
155 #define DSI_GOT_ECONNRESET (1 << 10) /* got ECONNRESET from client => exit */
158 /* basic initialization: dsi_init.c */
159 extern DSI *dsi_init(AFPObj *obj, const char *hostname, const char *address, const char *port);
160 extern void dsi_setstatus (DSI *, char *, const size_t);
161 extern int dsi_tcp_init(DSI *dsi, const char *hostname, const char *address, const char *port);
163 /* in dsi_getsess.c */
164 extern afp_child_t *dsi_getsession (DSI *, server_child *, const int);
165 extern void dsi_kill (int);
168 /* DSI Commands: individual files */
169 extern void dsi_opensession (DSI *);
170 extern int dsi_attention (DSI *, AFPUserBytes);
171 extern int dsi_cmdreply (DSI *, const int);
172 extern int dsi_tickle (DSI *);
173 extern void dsi_getstatus (DSI *);
174 extern void dsi_close (DSI *);
177 /* low-level stream commands -- in dsi_stream.c */
178 extern ssize_t dsi_stream_write (DSI *, void *, const size_t, const int mode);
179 extern size_t dsi_stream_read (DSI *, void *, const size_t);
180 extern int dsi_stream_send (DSI *, void *, size_t);
181 extern int dsi_stream_receive (DSI *);
182 extern int dsi_disconnect(DSI *dsi);
185 extern ssize_t dsi_stream_read_file(DSI *, int, off_t off, const size_t len);
188 /* client writes -- dsi_write.c */
189 extern size_t dsi_writeinit (DSI *, void *, const size_t);
190 extern size_t dsi_write (DSI *, void *, const size_t);
191 extern void dsi_writeflush (DSI *);
192 #define dsi_wrtreply(a,b) dsi_cmdreply(a,b)
194 /* client reads -- dsi_read.c */
195 extern ssize_t dsi_readinit (DSI *, void *, const size_t, const size_t,
197 extern ssize_t dsi_read (DSI *, void *, const size_t);
198 extern void dsi_readdone (DSI *);
200 /* some useful macros */
201 #define dsi_serverID(x) ((x)->serverID++)
202 #define dsi_send(x) do { \
203 (x)->header.dsi_len = htonl((x)->cmdlen); \
204 dsi_stream_send((x), (x)->commands, (x)->cmdlen); \
207 #endif /* atalk/dsi.h */