listener.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: modlisp -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          listener.lisp
   6 ;;;; Purpose:       Listener and worker processes
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Dec 2002
   9 ;;;;
  10 ;;;; $Id: listener.lisp,v 1.2 2003/07/09 22:12:52 kevin Exp $
  11 ;;;; *************************************************************************
  12
  13 (in-package #:kmrcl)
  14
  15 ;;; Variables and data structures for Listener
  16
  17 (defvar *listener-count* 0
  18   "used to name listeners")
  19
  20 (defvar *worker-count* 0
  21   "used to name workers")
  22
  23 (defvar *active-listeners* nil
  24     "List of active listeners")
  25
  26 (defclass listener ()
  27   ((port :initarg :port :accessor port)
  28    (function :initarg :function :accessor listener-function
  29              :initform nil)
  30    (function-args :initarg :function-args :accessor function-args
  31                   :initform nil)
  32    (process :initarg :process :accessor process)
  33    (socket :initarg :socket :accessor socket)
  34    (workers :initform nil :accessor workers
  35             :documentation "list of worker threads")
  36    (name :initform "" :accessor name :initarg :name)
  37    (base-name :initform "listener" :accessor base-name :initarg :base-name)
  38    (wait :initform nil :accessor wait :initarg :wait)
  39    (catch-errors :initform nil :accessor catch-errors :initarg :catch-errors)
  40    (format :initform :text :accessor listener-format :initarg :format)))
  41
  42 (defclass worker ()
  43   ((listener :initarg :listener :accessor listener :initform nil)
  44    (connection :initarg :connection :accessor connection :initform nil)
  45    (name :initarg :name :accessor name :initform nil)
  46    (thread-fun :initarg :thread-fun :accessor thread-fun :initform nil)
  47    (process :initarg :process :accessor process :initform nil)))
  48
  49 (defmethod print-object ((obj listener) s)
  50   (print-unreadable-object (obj s :type t :identity nil)
  51     (format s "port ~A" (port obj))))
  52
  53 (defmethod print-object ((obj worker) s)
  54   (print-unreadable-object (obj s :type t :identity nil)
  55     (format s "port ~A" (port (listener obj)))))
  56
  57 ;; High-level API
  58
  59 (defun init/listener (listener state)
  60   (check-type listener listener)
  61   (case state
  62     (:start
  63      (when (member listener *active-listeners*)
  64        (warn "~&listener already started")
  65        (return-from init/listener listener))
  66      (handler-case
  67          (progn
  68            (setf (name listener) (next-server-name (base-name listener)))
  69            (make-socket-server listener))
  70        (error (e)
  71          (format t "~&Error while trying to start listener~&  ~A" e)
  72          (decf *listener-count*)
  73          nil)
  74        (:no-error (res)
  75          (declare (ignore res))
  76          (push listener *active-listeners*)
  77          listener)))
  78     (:stop
  79      (unless (member listener *active-listeners*)
  80        (warn "~&listener is not in active list")
  81        (return-from init/listener listener))
  82      (dolist (worker (workers listener))
  83        (close-active-socket (connection worker))
  84        (destroy-process (process worker))
  85        (setf (connection worker) nil)
  86        (setf (process worker) nil))
  87      (setf (workers listener) nil)
  88      (with-slots (process socket) listener
  89        (errorset (close-passive-socket socket) t)
  90        (errorset (destroy-process process) t)
  91        (setf process nil)
  92        (setf socket nil))
  93      (setq *active-listeners* (remove listener *active-listeners*)))
  94     (:restart
  95      (init/listener listener :stop)
  96      (init/listener listener :start))))
  97
  98 (defun stop-all/listener ()
  99   (dolist (listener *active-listeners*)
 100     (ignore-errors
 101        (init/listener listener :stop))))
 102
 103 ;; Low-level functions
 104
 105 (defun next-server-name (base-name)
 106   (format nil "~A-socket-server-~D" base-name (incf *listener-count*)))
 107
 108 (defun next-worker-name (base-name)
 109   (format nil "~A-worker-~D" base-name (incf *worker-count*)))
 110
 111 (defun make-socket-server (listener)
 112   (setf (socket listener) (create-inet-listener
 113                            (port listener)
 114                            :format (listener-format listener)))
 115   (setf (process listener) (make-process
 116                             (name listener)
 117                             #'(lambda () (start-socket-server listener))))
 118   listener)
 119
 120
 121 (defmethod initialize-instance :after
 122     ((self worker) &key listener connection name &allow-other-keys)
 123   (unless connection
 124     (error "connection not provided to modlisp-worker"))
 125   (setf (slot-value self 'listener) listener)
 126   (setf (slot-value self 'name) name)
 127   (setf (slot-value self 'connection) connection)
 128   (setf (slot-value self 'thread-fun)
 129         #'(lambda ()
 130             (unwind-protect
 131                 (if (catch-errors listener)
 132                     (handler-case
 133                         (apply (listener-function listener)
 134                                connection
 135                                (function-args listener))
 136                       (error (e)
 137                         (cmsg "Error ~A [~A]" e name)))
 138                   (apply (listener-function listener)
 139                          connection
 140                          (function-args listener)))
 141           (progn
 142             (errorset (close-active-socket connection) nil)
 143             (cmsg-c :threads "~A ended" name)
 144             (setf (workers listener)
 145                   (remove self (workers listener))))))))
 146
 147 (defun start-socket-server (listener)
 148   (unwind-protect
 149       (loop
 150        (let ((connection (accept-tcp-connection (socket listener))))
 151          (if (wait listener)
 152              (unwind-protect
 153                   (apply (listener-function listener)
 154                          connection
 155                          (function-args listener))
 156                (errorset (close connection) nil))
 157              (let ((worker (make-instance 'worker :listener listener
 158                                           :connection connection
 159                                           :name (next-worker-name
 160                                                  (base-name listener)))))
 161               (setf (process worker)
 162                 (make-process (name worker) (thread-fun worker)))
 163               (push worker (workers listener))))))
 164     (errorset (close-passive-socket (socket listener)) nil)))