AnalysisServer.curry 14.2 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 August 2014
9
10
--------------------------------------------------------------------------

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

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

-- 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
46
  initializeAnalysisSystem
47
  args <- getArgs
48
  processArgs False args
Michael Hanus 's avatar
Michael Hanus committed
49

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

--- Initializations to be done when the system is started.
77
78
initializeAnalysisSystem :: IO ()
initializeAnalysisSystem = updateRCFile
79
80

showHelp = putStrLn $
Michael Hanus 's avatar
Michael Hanus committed
81
  "Usage: cass <options> [-p <port>] :\n" ++
82
83
84
  "       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
85
  "Usage: cass <options> <analysis name> <module name> :\n"++
86
  "       analyze a module with a given analysis\n\n"++
Michael Hanus 's avatar
Michael Hanus committed
87
  "where <options> can contain:\n"++
88
89
90
  "-Dname=val : set property (of ~/.curryanalysisrc) 'name' as 'val'\n"++
  "-r         : force re-analysis (i.e., ignore old analysis information)\n"++
  "\nRegistered analyses names:\n" ++
91
92
  unlines registeredAnalysisNames

93
--- Start the analysis server on a socket.
94
95
mainServer :: Maybe Int -> IO ()
mainServer mbport = do
96
  putStrLn "Start Server"
97
98
99
  (port1,socket1) <- maybe listenOnFresh
                           (\p -> listenOn p >>= \s -> return (p,s))
                           mbport
100
101
102
103
104
105
106
107
108
109
  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 []
110
    serverLoop socket1 handles
111
112
    sClose workersocket
   else
113
    serverLoop socket1 []
114
115


116
117
118
119
120
--- 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 =
121
  analyzeModule ananame moduleName False aoutformat >>=
122
123
124
125
126
127
128
129
130
131
132
    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
133
  analyzeModule ananame mname False aoutformat >>=
134
    return . either (maybe "" id . lookupProgInfo qn) (const "")
135

136
--- Analyze a complete module for a given analysis result format.
137
138
--- The third argument is a flag indicating whether the
--- (re-)analysis should be enforced.
139
140
--- Note that before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
141
analyzeModule :: String -> String -> Bool -> AOutFormat
142
              -> IO (Either (ProgInfo String) String)
143
analyzeModule ananame moduleName enforce aoutformat = do
144
145
146
147
  let (mdir,mname) = splitDirectoryBaseName moduleName
  getDefaultPath >>= setEnviron "CURRYPATH"
  curdir <- getCurrentDirectory
  unless (mdir==".") $ setCurrentDirectory mdir
148
  numworkers <- numberOfWorkers
149
150
151
152
153
154
  aresult <-
   if numworkers>0
     then do
      serveraddress <- getServerAddress
      (port,socket) <- listenOnFresh
      handles <- startWorkers numworkers socket serveraddress port []
155
      result <- runAnalysisWithWorkers ananame aoutformat enforce handles mname
156
157
158
      stopWorkers handles
      sClose socket
      return result
159
     else runAnalysisWithWorkers ananame aoutformat enforce [] mname
160
161
162
  setCurrentDirectory curdir
  return aresult

163
164
165
166
167
168
--- 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.
analyzeGeneric :: Analysis a -> String -> IO (Either (ProgInfo a) String)
analyzeGeneric analysis moduleName = do
169
  initializeAnalysisSystem
170
  let (mdir,mname) = splitDirectoryBaseName moduleName
171
  getDefaultPath >>= setEnviron "CURRYPATH" 
172
173
  curdir <- getCurrentDirectory
  unless (mdir==".") $ setCurrentDirectory mdir
174
  numworkers <- numberOfWorkers
175
176
177
178
179
180
  aresult <-
    if numworkers>0
     then do
      serveraddress <- getServerAddress
      (port,socket) <- listenOnFresh
      handles <- startWorkers numworkers socket serveraddress port []
181
      result <- analyzeMain analysis mname handles False True
182
183
184
185
      stopWorkers handles
      sClose socket
      return result
     else
186
      analyzeMain analysis mname [] False True
187
188
189
  setCurrentDirectory curdir
  return aresult
 
190
191
192
193
194
195
196
197
198
199
--- 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.
analyzePublic :: Analysis a -> String -> IO (Either (ProgInfo a) String)
analyzePublic analysis moduleName =
  analyzeGeneric analysis moduleName
  >>= return . either (Left . publicProgInfo) Right

200
201
202
203
204
205
--- 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.
analyzeInterface :: Analysis a -> String -> IO (Either [(QName,a)] String)
206
analyzeInterface analysis moduleName =
207
  analyzeGeneric analysis moduleName
208
  >>= return . either (Left . publicListFromProgInfo) Right
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

--------------------------------------------------------------------------
-- 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
242
243
serverLoop socket1 whandles = do
  --debugMessageLevel 3 "SERVER: serverLoop"
244
245
  connection <- waitForSocketAccept socket1 waitTime
  case connection of 
246
247
248
    Just (_,handle) -> serverLoopOnHandle socket1 whandles handle
    Nothing -> do
      putStrLn "serverLoop: connection error: time out in waitForSocketAccept"
249
      sleep 1
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
      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)
272
     let force = False
273
274
275
276
277
278
279
280
     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 ->
281
         catch (runAnalysisWithWorkers ananame AText force whandles modname >>=
282
283
284
285
                return . formatResult modname outForm Nothing public >>=
                sendResult)
               sendAnalysisError
       AnalyzeEntity ananame outForm modname functionName ->
286
         catch (runAnalysisWithWorkers ananame AText force whandles modname >>=
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
                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
302
 where
303
304
305
306
  sendResult resultstring = do
    debugMessageLevel 4 ("formatted result:\n"++resultstring)
    sendServerResult handle resultstring
    serverLoopOnHandle socket1 whandles handle
307

308
309
310
  sendAnalysisError err = do
    sendServerError handle ("ERROR in analysis server: "++showError err)
    serverLoopOnHandle socket1 whandles handle
311
312

-- Send a server result in the format "ok <n>\n<result text>" where <n>
313
-- is the number of lines of the <result text>.
314
315
316
317
318
319
sendServerResult handle resultstring = do
  let resultlines = lines resultstring
  hPutStrLn handle ("ok " ++ show (length resultlines))
  hPutStr handle (unlines resultlines)
  hFlush handle

320
-- Send a server error in the format "error <error message>\n".
321
322
323
324
325
sendServerError handle errstring = do
  debugMessageLevel 1 errstring
  hPutStrLn handle ("error "++errstring)
  hFlush handle

326
327
328
-- Inform the worker threads about a given changed library search path
changeWorkerPath :: String -> [Handle] -> IO ()
changeWorkerPath _ [] = done
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
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)
365
                     registeredAnalysisNames)
366