From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Theodor Thornhill via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#70036: 30.0.50; Move file-truename to the C level Date: Sat, 30 Mar 2024 12:18:14 +0100 Message-ID: <874jcoeznt.fsf@thornhill.no> References: <87le63xzjt.fsf@thornhill.no> <87ttkrqvru.fsf@betli.tmit.bme.hu> <87il17xsea.fsf@thornhill.no> <86wmpmhp0a.fsf@gnu.org> <874jcqygpn.fsf@thornhill.no> <875xx6muzt.fsf@ulti.tmit.bme.hu> <8734say2wi.fsf@thornhill.no> <87zfugoxwn.fsf@betli.tmit.bme.hu> Reply-To: Theodor Thornhill Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="32226"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , 70036@debbugs.gnu.org To: Felician Nemeth Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Mar 30 12:19:27 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rqWkA-00086r-Sc for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 30 Mar 2024 12:19:27 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rqWjn-0007Vy-1G; Sat, 30 Mar 2024 07:19:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rqWjl-0007Vq-OV for bug-gnu-emacs@gnu.org; Sat, 30 Mar 2024 07:19:01 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rqWjl-0001Wo-67 for bug-gnu-emacs@gnu.org; Sat, 30 Mar 2024 07:19:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rqWjm-0006ts-1P for bug-gnu-emacs@gnu.org; Sat, 30 Mar 2024 07:19:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Theodor Thornhill Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Mar 2024 11:19:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 70036 X-GNU-PR-Package: emacs Original-Received: via spool by 70036-submit@debbugs.gnu.org id=B70036.171179751626452 (code B ref 70036); Sat, 30 Mar 2024 11:19:02 +0000 Original-Received: (at 70036) by debbugs.gnu.org; 30 Mar 2024 11:18:36 +0000 Original-Received: from localhost ([127.0.0.1]:44075 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rqWjK-0006sR-ER for submit@debbugs.gnu.org; Sat, 30 Mar 2024 07:18:36 -0400 Original-Received: from out-171.mta1.migadu.com ([95.215.58.171]:62773) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rqWjF-0006rq-HZ for 70036@debbugs.gnu.org; Sat, 30 Mar 2024 07:18:33 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=thornhill.no; s=key1; t=1711797501; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=gsvLo7fAxKVbHN9ZmYzSseK0okgzRIMPdyXy2G3fDeo=; b=sfO7KvYjLgnSOst58fzqcNxg0x/c42BTg1huTOlg67AmBWzzOVc2nHg7/ruKdACsFDfhlD uPs2fINI9Ch8IP6YhIW/A3Xj88ZjJl6DfnABuC+XoxY8nFcGzjPFrcDj2jI7PnAsly/TnZ YFDQs4RjOnlnuCnY+rbXmTJMgqVv4gecEgwIoy4x1Tj4JzbPozRgS57zaIsZwLeUKOmSqe FUDSKtWqfi/lCPQAXTPyZACWS+IdkFyLkYvw4+bJLuH94xz3g7raghAFHMQuptTVMAAhIo lDAIki26cfVWxSnb4CBbZvX4vd7na/sAkZ1NQwY3KqfRHWL6O2nJIodPeV+rBg== In-Reply-To: <87zfugoxwn.fsf@betli.tmit.bme.hu> X-Migadu-Flow: FLOW_OUT X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:282349 Archived-At: --=-=-= Content-Type: text/plain Felician Nemeth writes: > Theodor Thornhill writes: >> Felician Nemeth writes: > >>> Theo, can you email me the relevant messages that your server sends >>> to Emacs? Does the server send lots of similar diagnostics messages >>> frequently? > >> I'll try to include such a report a little later today. > > Thanks, that would be helpful. > It's a little hard scraping the logs for company related data, so I haven't done this yet, but the profiles should be pretty expanatory if you do some edits after applying the below patch. >> [2. text/x-diff; 0001-Don-t-use-file-truepath-in-Eglot-bug-70036.patch]... > > I think using find-buffer-visiting instead of get-file-buffer and > file-truename instead of expand-file-name in Eglot is problematic. > Let's say we have these files: > > /project/a.c > /project/a.h -> /other/a.h > > Eglot will communicate these file names to the LSP server: /project/a.c > and /other/a.h. Then the server cannot "associate" a.h with a.c. > Additionally, a.h will be outside of the LSP workspace. > > This indeed confuses clangd a bit: it only takes into account the > changes of buffer a.h when it is saved. (Because it assumes > /project/a.h is not opened in the editor.) So in other words this is already a bug in eglot? > > ------ > > Regarding the patch itself, cache invalidation is missing from it. The > user might kill a buffer or save it under a different name with > write-file. Changing (PATH -> BUFFER) to (PATH -> (BUFFER, FILENAME)) > would probably work. Eglot should save the current buffer-file-name > when it inserts a new item into the hash of managed-buffers. And when > it retrieves an item, it should verify whether the buffer-file-name is > the same as the saved file-name. > > Can file-truepath change while buffer-file-name remains the same? Yes, > but I think Eglot could ignore those rare cases, or handle it elsewhere. > (For example, it could update the cache entry after a buffer is saved.) Actually, cache invalidation is there, at least for killing a buffer. Major modes are disabled on killing buffer, and it is removed as a part of the teardown. Saving to a new buffer isn't handled properly yet, but this looks like something not really supported by Eglot yet anyway. If I resave a buffer with C-x C-w its content will be placed in a new buffer, but old one will not be deleted, and the new one will not be registered with the eglot server before running M-x revert-buffer anyways. So that seems like a different issue, really. Please check out the new patch. I find no issues diverging from the current behavior using this one. It seems to solve all the performance issues I stated, and now completely new stuff shows up in the profile, which to me sounds like the bottlenecks have moved, suggesting we get a nice performance upgrade. What do you think? I'll test this for a while and install to master in a few days if nothing comes up :-) Theo --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Don-t-use-file-truepath-in-Eglot-bug-70036.patch >From 26e5f3cc8e767215f7c50800a6d713702b8fa144 Mon Sep 17 00:00:00 2001 From: Theodor Thornhill Date: Thu, 28 Mar 2024 12:56:23 +0100 Subject: [PATCH] Don't use file-truepath in Eglot (bug#70036) `file-truepath' is slow because of recursive calls and being implemented in lisp. It seems to not be needed in eglot, but it is used behind the scenes in `find-buffer-visiting', thus appearing in profiles. Moving the implementation to a hash map will yield similar performance benefits, but wouldn't require us to rewrite `file-truename' in C. * lisp/progmodes/eglot.el (eglot-lsp-server): Convert 'managed-buffers' to a hashmap. (eglot-uri-to-path): Don't use file-truepath, as it is too slow to be included in the hot path. (eglot--on-shutdown): Use buffers from buffer map. (eglot--managed-mode): Add buffer to map, rather than list. Also remove it from the map on deactivation. (eglot-handle-notification): Expose server and get buffer from the buffer map. --- lisp/progmodes/eglot.el | 42 +++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el index f247c43203c..7f4284bf09d 100644 --- a/lisp/progmodes/eglot.el +++ b/lisp/progmodes/eglot.el @@ -1053,8 +1053,8 @@ eglot-lsp-server :documentation "Map (DIR -> (WATCH ID1 ID2...)) for `didChangeWatchedFiles'." :initform (make-hash-table :test #'equal) :accessor eglot--file-watches) (managed-buffers - :initform nil - :documentation "List of buffers managed by server." + :documentation "Map (PATH -> BUFFER) for buffers managed by server." + :initform (make-hash-table :test #'equal) :accessor eglot--managed-buffers) (saved-initargs :documentation "Saved initargs for reconnection purposes." @@ -1085,12 +1085,12 @@ eglot-uri-to-path (defun eglot-path-to-uri (path) "Convert PATH, a file name, to LSP URI string and return it." - (let ((truepath (file-truename path))) + (let ((expanded-path (expand-file-name path))) (if (and (url-type (url-generic-parse-url path)) ;; It might be MS Windows path which includes a drive ;; letter that looks like a URL scheme (bug#59338) (not (and (eq system-type 'windows-nt) - (file-name-absolute-p truepath)))) + (file-name-absolute-p expanded-path)))) ;; Path is already a URI, so forward it to the LSP server ;; untouched. The server should be able to handle it, since ;; it provided this URI to clients in the first place. @@ -1098,11 +1098,11 @@ eglot-path-to-uri (concat "file://" ;; Add a leading "/" for local MS Windows-style paths. (if (and (eq system-type 'windows-nt) - (not (file-remote-p truepath))) + (not (file-remote-p expanded-path))) "/") (url-hexify-string ;; Again watch out for trampy paths. - (directory-file-name (file-local-name truepath)) + (directory-file-name (file-local-name expanded-path)) eglot--uri-path-allowed-chars))))) (defun eglot-range-region (range &optional markers) @@ -1187,7 +1187,7 @@ eglot--servers-by-xrefed-file (defun eglot--on-shutdown (server) "Called by jsonrpc.el when SERVER is already dead." ;; Turn off `eglot--managed-mode' where appropriate. - (dolist (buffer (eglot--managed-buffers server)) + (dolist (buffer (map-values (eglot--managed-buffers server))) (let (;; Avoid duplicate shutdowns (github#389) (eglot-autoshutdown nil)) (eglot--when-live-buffer buffer (eglot--managed-mode-off)))) @@ -1992,7 +1992,11 @@ eglot--managed-mode (add-hook 'eldoc-documentation-functions #'eglot-signature-eldoc-function nil t) (eldoc-mode 1)) - (cl-pushnew (current-buffer) (eglot--managed-buffers (eglot-current-server)))) + + (let ((buffer (current-buffer))) + (puthash (expand-file-name (buffer-file-name buffer)) + buffer + (eglot--managed-buffers (eglot-current-server))))) (t (remove-hook 'after-change-functions #'eglot--after-change t) (remove-hook 'before-change-functions #'eglot--before-change t) @@ -2020,10 +2024,10 @@ eglot--managed-mode (let ((server eglot--cached-server)) (setq eglot--cached-server nil) (when server - (setf (eglot--managed-buffers server) - (delq (current-buffer) (eglot--managed-buffers server))) + (remhash (expand-file-name (buffer-file-name (current-buffer))) + (eglot--managed-buffers server)) (when (and eglot-autoshutdown - (null (eglot--managed-buffers server))) + (null (map-values (eglot--managed-buffers server)))) (eglot-shutdown server))))))) (defun eglot--managed-mode-off () @@ -2346,7 +2350,7 @@ eglot-handle-notification (remhash token (eglot--progress-reporters server)))))))))) (cl-defmethod eglot-handle-notification - (_server (_method (eql textDocument/publishDiagnostics)) &key uri diagnostics + (server (_method (eql textDocument/publishDiagnostics)) &key uri diagnostics &allow-other-keys) ; FIXME: doesn't respect `eglot-strict-mode' "Handle notification publishDiagnostics." (cl-flet ((eglot--diag-type (sev) @@ -2357,7 +2361,7 @@ eglot-handle-notification (mess (source code message) (concat source (and code (format " [%s]" code)) ": " message))) (if-let* ((path (expand-file-name (eglot-uri-to-path uri))) - (buffer (find-buffer-visiting path))) + (buffer (gethash path (eglot--managed-buffers server)))) (with-current-buffer buffer (cl-loop initially @@ -2842,7 +2846,7 @@ eglot--xref-make-match Try to visit the target file for a richer summary line." (pcase-let* ((file (eglot-uri-to-path uri)) - (visiting (or (find-buffer-visiting file) + (visiting (or (gethash file (eglot--managed-buffers (eglot-current-server))) (gethash uri eglot--temp-location-buffers))) (collect (lambda () (eglot--widening @@ -3542,13 +3546,14 @@ eglot--propose-changes-as-diff (with-current-buffer (get-buffer-create "*EGLOT proposed server changes*") (buffer-disable-undo (current-buffer)) (let ((inhibit-read-only t) - (target (current-buffer))) + (target (current-buffer)) + (managed-buffers (eglot--managed-buffers (eglot-current-server)))) (diff-mode) (erase-buffer) (pcase-dolist (`(,path ,edits ,_) prepared) (with-temp-buffer (let* ((diff (current-buffer)) - (existing-buf (find-buffer-visiting path)) + (existing-buf (gethash path (gethash path managed-buffers))) (existing-buf-label (prin1-to-string existing-buf))) (with-temp-buffer (if existing-buf @@ -3583,7 +3588,8 @@ eglot--apply-workspace-edit (eglot--dbind ((VersionedTextDocumentIdentifier) uri version) textDocument (list (eglot-uri-to-path uri) edits version))) - documentChanges))) + documentChanges)) + (managed-buffers (eglot--managed-buffers (eglot-current-server)))) (unless (and changes documentChanges) ;; We don't want double edits, and some servers send both ;; changes and documentChanges. This unless ensures that we @@ -3591,7 +3597,7 @@ eglot--apply-workspace-edit (cl-loop for (uri edits) on changes by #'cddr do (push (list (eglot-uri-to-path uri) edits) prepared))) (cl-flet ((notevery-visited-p () - (cl-notevery #'find-buffer-visiting + (cl-notevery (lambda (p) (gethash p managed-buffers)) (mapcar #'car prepared))) (accept-p () (y-or-n-p -- 2.40.1 --=-=-=--