AnalysisServer.curry 13 KB
Newer Older
1
2
3
4
5
6
7
--------------------------------------------------------------------------
--- This is the main module of the analysis system.
--- One can either use the 'main' operation to start the system
--- in "server mode" or "batch mode" or use one of the operations below
--- to use the analysis system in another Curry program.
---
--- @author Heiko Hoffmann, Michael Hanus
8
--- @version May 2013
9
10
--------------------------------------------------------------------------

11
12
13
module AnalysisServer(main, initializeAnalysisSystem,
                      analyzeModuleForBrowser, analyzeFunctionForBrowser,
                      analyzeGeneric, analyzeInterface) where
14

15
16
import ReadNumeric(readNat)
import Char(isSpace)
17
import FlatCurry(QName)
18
import Socket(Socket(..),listenOn,listenOnFresh,sClose,waitForSocketAccept)
19
20
21
22
23
24
25
import IO
import ReadShowTerm(readQTerm,showQTerm)
import System(system,sleep,setEnviron,getArgs)
import AnalysisCollection
import ServerFormats
import ServerFunctions(WorkerMessage(..))
import Configuration
26
27
import GenericProgInfo
import Analysis(Analysis,AOutFormat(..))
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

-- Messages to communicate with the analysis server from external programs.
data AnalysisServerMessage = 
    GetAnalysis
  | AnalyzeModule    String String String Bool
  | AnalyzeEntity  String String String String
  | StopServer
  | SetCurryPath String
  | ParseError

--- Main function to start the server.
--- Without any program arguments, the server is started on a socket.
--- Otherwise, it is started in batch mode to analyze a module.
main = do
  debugMessageLevel 1 systemBanner
43
  initializeAnalysisSystem
44
  args <- getArgs
Michael Hanus 's avatar
Michael Hanus committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
  processArgs args

processArgs args = case args of
  [] -> mainServer Nothing
  ["-p",port] -> maybe showError
                       (\ (p,r) -> if all isSpace r
                                   then mainServer (Just p)
                                   else showError )
                       (readNat port)
  ["-h"]      -> showHelp
  ["-?"]      -> showHelp
  ["--help"]  -> showHelp
  (('-':'D':kvs):rargs) -> let (key,eqvalue) = break (=='=') kvs
                            in if null eqvalue
                               then showError
                               else do updateCurrentProperty key (tail eqvalue)
                                       processArgs rargs
  [ananame,mname] ->
63
      if ananame `elem` registeredAnalysisNames
64
65
      then analyzeModule ananame mname AText >>=
             putStrLn . formatResult mname "Text" Nothing True
66
      else showError
Michael Hanus 's avatar
Michael Hanus committed
67
  _ -> showError
68
 where
Michael Hanus 's avatar
Michael Hanus committed
69
70
  showError =
    error ("Illegal arguments (use '--help' for description):\n"++unwords args)
71
72

--- Initializations to be done when the system is started.
73
74
initializeAnalysisSystem :: IO ()
initializeAnalysisSystem = updateRCFile
75
76

showHelp = putStrLn $
Michael Hanus 's avatar
Michael Hanus committed
77
  "Usage: cass <options> [-p <port>] :\n" ++
78
79
80
  "       start analysis system in server mode\n\n"++
  "       <port>: port number for communication\n" ++
  "               (if omitted, a free port number is selected)\n\n"++
Michael Hanus 's avatar
Michael Hanus committed
81
  "Usage: cass <options> <analysis name> <module name> :\n"++
82
  "       analyze a module with a given analysis\n\n"++
Michael Hanus 's avatar
Michael Hanus committed
83
84
  "where <options> can contain:\n"++
  "-Dname=val : set property (of ~/.curryanalysisrc) 'name' as 'val'\n\n"++
85
86
87
  "Registered analyses names:\n" ++
  unlines registeredAnalysisNames

88
--- Start the analysis server on a socket.
89
90
mainServer :: Maybe Int -> IO ()
mainServer mbport = do
91
  putStrLn "Start Server"
92
93
94
  (port1,socket1) <- maybe listenOnFresh
                           (\p -> listenOn p >>= \s -> return (p,s))
                           mbport
95
96
97
98
99
100
101
102
103
104
  putStrLn ("Server Port: "++show port1)
  storeServerPortNumber port1
  getDefaultPath >>= setEnviron "CURRYPATH" 
  numworkers <- numberOfWorkers
  if numworkers>0
   then do
    serveraddress <- getServerAddress
    (workerport,workersocket) <- listenOnFresh
    debugMessageLevel 2 ("SERVER: port to workers: "++show workerport)
    handles <- startWorkers numworkers workersocket serveraddress workerport []
105
    serverLoop socket1 handles
106
107
    sClose workersocket
   else
108
    serverLoop socket1 []
109
110


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
--- Run the analysis system to show the analysis results in the BrowserGUI.
--- Note that, before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeModuleForBrowser :: String -> String -> AOutFormat -> IO [(QName,String)]
analyzeModuleForBrowser ananame moduleName aoutformat =
  analyzeModule ananame moduleName aoutformat >>=
    return . either pinfo2list (const [])
 where
   pinfo2list pinfo = let (pubinfo,privinfo) = progInfo2Lists pinfo
                       in pubinfo++privinfo

--- Run the analysis system to show the analysis result of a single function
--- in the BrowserGUI.
--- Note that before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeFunctionForBrowser :: String -> QName -> AOutFormat -> IO String
analyzeFunctionForBrowser ananame qn@(mname,_) aoutformat = do
  analyzeModule ananame mname aoutformat >>=
    return . either (maybe "" id . lookupProgInfo qn) (const "")
130

131
132
133
134
135
136
--- Analyze a complete module for a given analysis result format.
--- Note that before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeModule :: String -> String -> AOutFormat
              -> IO (Either (ProgInfo String) String)
analyzeModule ananame moduleName aoutformat = do
137
138
139
140
141
142
  numworkers <- numberOfWorkers
  if numworkers>0
   then do
    serveraddress <- getServerAddress
    (port,socket) <- listenOnFresh
    handles <- startWorkers numworkers socket serveraddress port []
143
    result <- runAnalysisWithWorkers ananame aoutformat handles moduleName
144
145
    stopWorkers handles
    sClose socket
146
147
    return result
   else runAnalysisWithWorkers ananame aoutformat [] moduleName
148
149
150
151
152
   
--- Start the analysis system with a particular analysis.
--- The analysis must be a registered one if workers are used.
--- If it is a combined analysis, the base analysis must be also
--- a registered one.
153
154
--- Note that, before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
155
156
analyzeGeneric :: Analysis a -> String -> IO (Either (ProgInfo a) String)
analyzeGeneric analysis moduleName = do
157
  initializeAnalysisSystem
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  numworkers <- numberOfWorkers
  if numworkers>0
   then do
    serveraddress <- getServerAddress
    (port,socket) <- listenOnFresh
    handles <- startWorkers numworkers socket serveraddress port []
    result <- analyzeMain analysis moduleName handles True
    stopWorkers handles
    sClose socket
    return result
   else
    analyzeMain analysis moduleName [] True

--- Start the analysis system with a given analysis to compute properties
--- of a module interface.
--- The analysis must be a registered one if workers are used.
--- If it is a combined analysis, the base analysis must be also
--- a registered one.
176
177
--- Note that, before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
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
analyzeInterface :: Analysis a -> String -> IO (Either [(QName,a)] String)
analyzeInterface analysis moduleName = do
  analyzeGeneric analysis moduleName
    >>= return . either (Left . publicListFromProgInfo) Right

--------------------------------------------------------------------------
-- start a number of workers at server start
startWorkers:: Int -> Socket -> String -> Int -> [Handle] -> IO [Handle]
startWorkers number workersocket serveraddress workerport handles = do
  if number>0
    then do
      debugMessageLevel 4 ("Number:"++(show number))
      let command = baseDir++"/cass_worker "++serveraddress++" "
                                            ++(show workerport)++" &"
      debugMessageLevel 4 ("system command: "++command)
      system command
      debugMessageLevel 4 ("Wait for socket accept for client "++show number)
      connection <- waitForSocketAccept workersocket waitTime
      debugMessageLevel 4 ("Socket accept for client "++show number)
      case connection of
        Just (_,handle) -> do
          startWorkers (number-1) workersocket serveraddress workerport
                       (handle:handles)
        Nothing -> do
          putStrLn ("startWorkers: connection error worker "++(show number))
          startWorkers (number-1) workersocket serveraddress workerport handles
    else return handles

-- stop all workers at server stop
stopWorkers [] = done
stopWorkers (handle:whandles) = do
  hPutStrLn handle (showQTerm StopWorker)
  hClose handle
  stopWorkers whandles

--------------------------------------------------------------------------
-- server loop to answer analysis requests over network
215
216
serverLoop socket1 whandles = do
  --debugMessageLevel 3 "SERVER: serverLoop"
217
218
  connection <- waitForSocketAccept socket1 waitTime
  case connection of 
219
220
221
    Just (_,handle) -> serverLoopOnHandle socket1 whandles handle
    Nothing -> do
      putStrLn "serverLoop: connection error: time out in waitForSocketAccept"
222
      sleep 1
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
      serverLoop socket1 whandles

--- Reads a line from an input handle and returns it.
hGetLineUntilEOF  :: Handle -> IO String
hGetLineUntilEOF h = do
  eof <- hIsEOF h
  if eof
   then return ""
   else do c <- hGetChar h
           if c=='\n' then return ""
                      else do cs <- hGetLineUntilEOF h
                              return (c:cs)

serverLoopOnHandle socket1 whandles handle = do
  eof <- hIsEOF handle
  if eof
   then do hClose handle
           debugMessageLevel 2 "SERVER connection: eof"
           serverLoop socket1 whandles
   else do
     string <- hGetLineUntilEOF handle
     debugMessageLevel 2 ("SERVER got message: "++string)
     case parseServerMessage string of
       ParseError -> do
         sendServerError handle ("Illegal message received: "++string)
         serverLoopOnHandle socket1 whandles handle
       GetAnalysis -> do
         sendServerResult handle showAnalysisNamesAndFormats
         serverLoopOnHandle socket1 whandles handle
       AnalyzeModule ananame outForm modname public ->
253
         catch (runAnalysisWithWorkers ananame AText whandles modname >>=
254
255
256
257
                return . formatResult modname outForm Nothing public >>=
                sendResult)
               sendAnalysisError
       AnalyzeEntity ananame outForm modname functionName ->
258
         catch (runAnalysisWithWorkers ananame AText whandles modname >>=
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
                return . formatResult modname outForm
                                      (Just functionName) False >>= sendResult)
               sendAnalysisError
       SetCurryPath path -> do
         setEnviron "CURRYPATH" path
         changeWorkerPath path whandles
         sendServerResult handle ""
         serverLoopOnHandle socket1 whandles handle
       StopServer -> do
         stopWorkers whandles
         sendServerResult handle ""
         hClose handle
         sClose socket1
         putStrLn "Stop Server"
         removeServerPortNumber
274
 where
275
276
277
278
  sendResult resultstring = do
    debugMessageLevel 4 ("formatted result:\n"++resultstring)
    sendServerResult handle resultstring
    serverLoopOnHandle socket1 whandles handle
279

280
281
282
  sendAnalysisError err = do
    sendServerError handle ("ERROR in analysis server: "++showError err)
    serverLoopOnHandle socket1 whandles handle
283
284

-- Send a server result in the format "ok <n>\n<result text>" where <n>
285
-- is the number of lines of the <result text>.
286
287
288
289
290
291
sendServerResult handle resultstring = do
  let resultlines = lines resultstring
  hPutStrLn handle ("ok " ++ show (length resultlines))
  hPutStr handle (unlines resultlines)
  hFlush handle

292
-- Send a server error in the format "error <error message>\n".
293
294
295
296
297
sendServerError handle errstring = do
  debugMessageLevel 1 errstring
  hPutStrLn handle ("error "++errstring)
  hFlush handle

298
299
300
-- Inform the worker threads about a given changed library search path
changeWorkerPath :: String -> [Handle] -> IO ()
changeWorkerPath _ [] = done
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
329
330
331
332
333
334
335
336
changeWorkerPath path (handle:whandles) = do
  hPutStrLn handle (showQTerm (ChangePath path))
  changeWorkerPath path whandles

-- parse incoming message for type of request
parseServerMessage :: String -> AnalysisServerMessage
parseServerMessage message = case words message of
  [] -> ParseError
  w:ws -> case w of 
    "GetAnalysis" -> GetAnalysis
    "AnalyzeModule" -> case ws of 
      s1:s2:s3:[] -> checkFormat s2 $ AnalyzeModule s1 s2 s3 False
    "AnalyzeInterface" -> case ws of 
      s1:s2:s3:[] -> checkFormat s2 $ AnalyzeModule s1 s2 s3 True
      _ -> ParseError
    "AnalyzeFunction" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError
    "AnalyzeTypeConstructor" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError
    "AnalyzeDataConstructor" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError  
    "SetCurryPath" -> case ws of
      s:[] -> SetCurryPath s
      _ -> ParseError
    "StopServer" -> StopServer
    _ -> ParseError 
 where
  checkFormat fmt msg = if fmt `elem` serverFormats then msg else ParseError

--- Show all analysis names and formats.
showAnalysisNamesAndFormats :: String
showAnalysisNamesAndFormats =
  unlines (concatMap (\an -> map ((an++" ")++) serverFormats)
337
                     registeredAnalysisNames)
338