-
Notifications
You must be signed in to change notification settings - Fork 54
/
interface.m
328 lines (296 loc) · 11.8 KB
/
interface.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
%----------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%-----------------------------------------------------------------------------%
% Copyright (C) 2001-2002, 2004-2008 The University of Melbourne.
% This file may only be copied under the terms of the GNU General
% Public License - see the file COPYING in the Mercury distribution.
%-----------------------------------------------------------------------------%
%
% File: interface.m.
% Author: zs.
%
% This module defines interface between CGI programs acting as clients
% and CGI programs acting as servers.
%
% The interface consists of queries (sent from the CGI program to the server)
% and responses (sent back from the server to the CGI program), and shared
% knowledge of how to derive the names of some files from the name of the
% profiling data file being explored.
%
% Queries are sent and received as printed representations of Mercury terms,
% using the predicates send_term and recv_term. Responses are sent as strings
% using the predicates send_string and recv_string. Each response is actually
% the name of a file containing a web page, rather than the text of the web
% page itself. This makes things easy to debug (since we can leave the file
% around for inspection) and avoids any potential problems with the web page
% being too big to transmit atomically across the named pipe. (Printable
% representations of queries and filenames are both guaranteed to be smaller
% than eight kilobytes, which is the typical named pipe buffer size.)
%
% A query consists of three components, a command, a set of preferences, and
% the name of the profiling data file. The command tells the server what
% information the user wants displayed. The preferences tell the server how
% the user wants data displayed; they persist across queries unless the user
% changes them.
%
%-----------------------------------------------------------------------------%
:- module interface.
:- interface.
:- import_module bool.
:- import_module io.
%-----------------------------------------------------------------------------%
% These functions derive the names of auxiliary files (or parts thereof)
% from the name of the profiling data file being explored. The auxiliary
% files are:
%
% - the name of the named pipe for transmitting queries to the server;
% - the name of the named pipe for transmitting responses back to the
% CGI program;
% - the name of the file containing the output of the server program,
% which prints statistics about its own performance at startup
% (and if invoked with debugging option, debugging information
% during its execution);
% - the name of the mutual exclusion file (which is always empty);
% - the naming scheme of the `want' files (which are always empty);
% - the names of the files containing the web page responses;
% - the name of the file containing contour exclusion information
% (see exclude.m).
%
:- func to_server_pipe_name(string) = string.
:- func from_server_pipe_name(string) = string.
:- func server_startup_name(string) = string.
:- func mutex_file_name(string) = string.
:- func want_dir = string.
:- func want_prefix = string.
:- func want_file_name = string.
:- func response_file_name(string, int) = string.
% send_term(ToFileName, Debug, Term):
%
% Write the term Term to ToFileName, making it is new contents.
% If Debug is `yes', write it to the file `/tmp/.send_term' as well.
%
:- pred send_term(string::in, bool::in, T::in, io::di, io::uo) is det.
% send_string(ToFileName, Debug, Str):
%
% Write the string Str to ToFileName, making it is new contents.
% If Debug is `yes', write it to the file `/tmp/.send_string' as well.
%
:- pred send_string(string::in, bool::in, string::in, io::di, io::uo) is det.
% recv_term(FromFileName, Debug, Term):
%
% Read the contents of FromFileName, which should be a single Mercury term.
% If Debug is `yes', write the result of the read to the file
% `/tmp/.recv_term' as well.
%
:- pred recv_term(string::in, bool::in, T::out, io::di, io::uo) is det.
% recv_string(FromFileName, Debug, Str):
%
% Read the contents of FromFileName, and return it as Str.
% If Debug is `yes', write the result of the read to the file
% `/tmp/.recv_string' as well.
%
:- pred recv_string(string::in, bool::in, string::out, io::di, io::uo) is det.
%-----------------------------------------------------------------------------%
:- implementation.
:- import_module conf.
:- import_module util.
:- import_module query.
:- import_module char.
:- import_module int.
:- import_module list.
:- import_module require.
:- import_module string.
%-----------------------------------------------------------------------------%
to_server_pipe_name(DataFileName) =
server_dir ++ "/" ++
"mdprof_server_to" ++ filename_mangle(DataFileName).
from_server_pipe_name(DataFileName) =
server_dir ++ "/" ++
"mdprof_server_from" ++ filename_mangle(DataFileName).
server_startup_name(DataFileName) =
server_dir ++ "/" ++
"mdprof_startup_err" ++ filename_mangle(DataFileName).
mutex_file_name(DataFileName) =
server_dir ++ "/" ++
"mdprof_mutex" ++ filename_mangle(DataFileName).
want_dir = server_dir.
want_prefix = "mdprof_want".
want_file_name =
want_dir ++ "/" ++ want_prefix ++ string.int_to_string(getpid).
response_file_name(DataFileName, QueryNum) =
server_dir ++ "/" ++
"mdprof_response" ++ filename_mangle(DataFileName) ++
string.int_to_string(QueryNum).
:- func server_dir = string.
server_dir = "/var/tmp".
:- func filename_mangle(string) = string.
filename_mangle(FileName) = MangledFileName :-
FileNameChars = string.to_char_list(FileName),
MangledFileNameChars = filename_mangle_2(FileNameChars),
MangledFileName = string.from_char_list(MangledFileNameChars).
% This mangling scheme ensures that (a) the mangled filename doesn't
% contain any slashes, and (b) two different original filenames will
% always yield different mangled filenames.
%
:- func filename_mangle_2(list(char)) = list(char).
filename_mangle_2([]) = [].
filename_mangle_2([First | Rest]) = MangledChars :-
MangledRest = filename_mangle_2(Rest),
( First = ('/') ->
MangledChars = [':', '.' | MangledRest]
; First = (':') ->
MangledChars = [':', ':' | MangledRest]
;
MangledChars = [First | MangledRest]
).
send_term(ToPipeName, Debug, Data, !IO) :-
io.open_output(ToPipeName, ToPipeRes, !IO),
(
ToPipeRes = ok(ToStream),
io.write(ToStream, Data, !IO),
io.write_string(ToStream, ".\n", !IO),
io.close_output(ToStream, !IO)
;
ToPipeRes = error(ToPipeError),
io.error_message(ToPipeError, ToPipeErrorMsg),
string.format("send_term: couldn't open pipe %s: %s",
[s(ToPipeName), s(ToPipeErrorMsg)], ToPipeMsg),
error(ToPipeMsg)
),
(
Debug = yes,
DebugFileName = "/tmp/.send_term",
io.open_output(DebugFileName, DebugRes, !IO),
(
DebugRes = ok(DebugStream),
io.write(DebugStream, Data, !IO),
io.write_string(DebugStream, ".\n", !IO),
io.close_output(DebugStream, !IO)
;
DebugRes = error(DebugError),
io.error_message(DebugError, DebugErrorMsg),
string.format("send_term: couldn't open debug file %s: %s",
[s(DebugFileName), s(DebugErrorMsg)], DebugMsg),
error(DebugMsg)
)
;
Debug = no
).
send_string(ToPipeName, Debug, Data, !IO) :-
io.open_output(ToPipeName, ToPipeRes, !IO),
(
ToPipeRes = ok(ToStream),
io.write_string(ToStream, Data, !IO),
io.close_output(ToStream, !IO)
;
ToPipeRes = error(ToPipeError),
io.error_message(ToPipeError, ToPipeErrorMsg),
string.format("send_term: couldn't open pipe %s: %s",
[s(ToPipeName), s(ToPipeErrorMsg)], ToPipeMsg),
error(ToPipeMsg)
),
(
Debug = yes,
DebugFileName = "/tmp/.send_string",
io.open_output(DebugFileName, DebugRes, !IO),
(
DebugRes = ok(DebugStream),
io.write_string(DebugStream, Data, !IO),
io.close_output(DebugStream, !IO)
;
DebugRes = error(DebugError),
io.error_message(DebugError, DebugErrorMsg),
string.format("send_term: couldn't open debug file %s: %s",
[s(DebugFileName), s(DebugErrorMsg)], DebugMsg),
error(DebugMsg)
)
;
Debug = no
).
recv_term(FromPipeName, Debug, Resp, !IO) :-
io.open_input(FromPipeName, FromPipeRes, !IO),
(
FromPipeRes = ok(FromStream),
io.read(FromStream, ReadRes, !IO),
(
ReadRes = ok(Resp)
;
ReadRes = eof,
error("recv_term: read failed: premature eof")
;
ReadRes = error(ReadErrorMsg, ReadErrorLineNumber),
string.format("recv_term: read failed at line %d: %s",
[i(ReadErrorLineNumber), s(ReadErrorMsg)], ReadMsg),
error(ReadMsg)
),
io.close_input(FromStream, !IO),
(
Debug = yes,
DebugFileName = "/tmp/.recv_term",
io.open_output(DebugFileName, DebugRes, !IO),
(
DebugRes = ok(DebugStream),
io.write(DebugStream, ReadRes, !IO),
io.write_string(DebugStream, ".\n", !IO),
io.close_output(DebugStream, !IO)
;
DebugRes = error(DebugError),
io.error_message(DebugError, DebugErrorMsg),
string.format("recv_term: couldn't open debug file %s: %s",
[s(DebugFileName), s(DebugErrorMsg)], DebugMsg),
error(DebugMsg)
)
;
Debug = no
)
;
FromPipeRes = error(FromPipeError),
io.error_message(FromPipeError, FromPipeErrorMsg),
string.format("recv_term: couldn't open pipe %s: %s",
[s(FromPipeName), s(FromPipeErrorMsg)], FromPipeMsg),
error(FromPipeMsg)
).
recv_string(FromPipeName, Debug, Resp, !IO) :-
io.open_input(FromPipeName, FromPipeRes, !IO),
(
FromPipeRes = ok(FromStream),
io.read_file_as_string(FromStream, ReadRes, !IO),
(
ReadRes = ok(Resp)
;
ReadRes = error(_, ReadError),
io.error_message(ReadError, ReadErrorMsg),
string.format("recv_string: read failed: %s",
[s(ReadErrorMsg)], ReadMsg),
error(ReadMsg)
),
io.close_input(FromStream, !IO),
(
Debug = yes,
DebugFileName = "/tmp/.recv_string",
io.open_output(DebugFileName, DebugRes, !IO),
(
DebugRes = ok(DebugStream),
io.write(DebugStream, ReadRes, !IO),
io.write_string(DebugStream, ".\n", !IO),
io.close_output(DebugStream, !IO)
;
DebugRes = error(DebugError),
io.error_message(DebugError, DebugErrorMsg),
string.format("recv_string: couldn't open debug file %s: %s",
[s(DebugFileName), s(DebugErrorMsg)], DebugMsg),
error(DebugMsg)
)
;
Debug = no
)
;
FromPipeRes = error(FromPipeError),
io.error_message(FromPipeError, FromPipeErrorMsg),
string.format("recv_string: couldn't open pipe %s: %s",
[s(FromPipeName), s(FromPipeErrorMsg)], FromPipeMsg),
error(FromPipeMsg)
).
%-----------------------------------------------------------------------------%
:- end_module interface.
%-----------------------------------------------------------------------------%