From patchwork Fri Oct 25 07:33:24 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Thompson X-Patchwork-Id: 177675 Delivered-To: patches@linaro.org Received: by 2002:a92:409a:0:0:0:0:0 with SMTP id d26csp3285949ill; Fri, 25 Oct 2019 00:33:44 -0700 (PDT) X-Received: by 2002:adf:a497:: with SMTP id g23mr1425173wrb.135.1571988823931; Fri, 25 Oct 2019 00:33:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1571988823; cv=none; d=google.com; s=arc-20160816; b=tTQJaYLdClgoGQy4fz0eONx+khtAluaRyFzlOpxl51m9W+ZiPCj72vEdQFpmBUt3GN vJ3tr6XdK5g9gRsBAkOI75HOCnKhmj9cmPoSNZY5+MtXKvMgcTIFSSSocp8Mq+68apPq Xih+VoC7PPrZc+DxJq1aHBIEnHRmvsmRu60qtK2hfivlT/nh/LzAeo5gZEvJRsLPmLMN m3o0rmYJutF4ZMXlpeMDfHsgaY/OYHjjJAvpEC/4BKJnLLKU+KYFIvUTdwow15eqrbk+ irmfywdMNtQRbdEzxoYFoAZ6TF5B8/wx1ET9bWdgchrpJfdDORIZGFI4zI26AWT/G9bk zo6w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=K2G9g70k35Ma4xF7YfZ9Z31DwyEbpBEhJM1jJfvb0Ls=; b=jxVKo/55z0zGVi0vhXCh3ar9tqpaLePwId+G15tE3OAjhlkycusTw4otgb8Yk8J2GJ OcFrojFbtipkWZy6tCMpW0Rc55+xLjqdWXAIYZA9Z2Y4WJuqHxuc1j6kmrdXSQHdeHfz RYZ/DDZqMKQq8xgRvLVcuqsI+tEysJfssE57aVsc+fYaaj/IhMvr0vdG0+HDLz9bnDjx rIklCk4bzMyz8JtVHYo5x6cOSEDNjackz0vgIoIZmZAYaVJITCFPCdTkLx8w/QL/jpqK SxFdWytjk8gnaoCOoc5rBBfyB9t2IRYyNR4yueTLGSH6XTmLCnkdeE8Hcjd5um4W2atn RElA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KZPcyclU; spf=pass (google.com: domain of daniel.thompson@linaro.org designates 209.85.220.41 as permitted sender) smtp.mailfrom=daniel.thompson@linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from mail-sor-f41.google.com (mail-sor-f41.google.com. [209.85.220.41]) by mx.google.com with SMTPS id b73sor846283wme.6.2019.10.25.00.33.43 for (Google Transport Security); Fri, 25 Oct 2019 00:33:43 -0700 (PDT) Received-SPF: pass (google.com: domain of daniel.thompson@linaro.org designates 209.85.220.41 as permitted sender) client-ip=209.85.220.41; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KZPcyclU; spf=pass (google.com: domain of daniel.thompson@linaro.org designates 209.85.220.41 as permitted sender) smtp.mailfrom=daniel.thompson@linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=K2G9g70k35Ma4xF7YfZ9Z31DwyEbpBEhJM1jJfvb0Ls=; b=KZPcyclUjyY3yLuxdwofig+TMKb8hwaV/GkEcAnwSOzk46h9+ITKqyXeyxWpnIrWuX nDy7RdqY/pj3FifZQks815NKfP+KPn5CGujJofWfn2eHvm//5FawiG/ZIE0WF4Q6ZMjf sdgk8LCX96ssM3eihwYzq8pPN44a05KlVGxI2CSWb1d1qxakYWfvCZNsKuzYn4EVhTsQ mNisCKFMW1Nnn9Gw2WZpqru3/5txrIpYVrSwBF09yuJmL6nTE8ixDpPz7n2xANdjYbny 0ZRIWRinykxgRdKuuceIFRIngP4GJhTxKaVt0AU2PoIu1kKP16DK/0x/qNIJJiAooKh7 u/yw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=K2G9g70k35Ma4xF7YfZ9Z31DwyEbpBEhJM1jJfvb0Ls=; b=gW6pGAbp4JGLVfYj+vXdnYbyoRn++39trpPm2VwzM9ZsH8DS+W7mxVX5hAQ2w5wgeM HcPvrNdGp6etNwq8vMbY99vvgmweWZ3xNt6UEY16/Menni7mIplmDmej0X3XLMtu8ESZ oiiLVlAGiSONQ2mS/4iwOjavTCPhp0c//T1yH1Ynn5A5z0zk6jpjiRBQKiLAvfYol+5c 7Jy1OT9yznkN0FLAOnZfQDSDOw9FkmyRQJCjrIrTINqws7T1YUGOCt6mwWod6S+J1l08 8WMdLiUroH2/TE6STml9n9IehdECP9c0dioZTyfAoF/riaOPPoY2zWFlXMrT/RnNiSmG 9LTw== X-Gm-Message-State: APjAAAVZK6ZhZ8002kirPQFn/EL/Tbihuulp6BoCacFPVK1tZLvoyT88 EktPdJCEBeEafNr1RtiDAGgyqsRC X-Google-Smtp-Source: APXvYqyz5HgKF726DT+MGAt4cBrrtuTFCrfsKRMpI2Z6psLGtRU1rTjmt7F4Zu6P/chlp+WcoOAfaw== X-Received: by 2002:a1c:1d53:: with SMTP id d80mr1047271wmd.88.1571988823439; Fri, 25 Oct 2019 00:33:43 -0700 (PDT) Return-Path: Received: from wychelm.lan (cpc141214-aztw34-2-0-cust773.18-1.cable.virginm.net. [86.9.19.6]) by smtp.gmail.com with ESMTPSA id a11sm1586602wmh.40.2019.10.25.00.33.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 25 Oct 2019 00:33:42 -0700 (PDT) From: Daniel Thompson To: Douglas Anderson , Jason Wessel Cc: Daniel Thompson , kgdb-bugreport@lists.sourceforge.net, linux-kernel@vger.kernel.org, patches@linaro.org Subject: [PATCH v4 1/5] kdb: Tidy up code to handle escape sequences Date: Fri, 25 Oct 2019 08:33:24 +0100 Message-Id: <20191025073328.643-2-daniel.thompson@linaro.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191025073328.643-1-daniel.thompson@linaro.org> References: <20191025073328.643-1-daniel.thompson@linaro.org> MIME-Version: 1.0 kdb_read_get_key() has extremely complex break/continue control flow managed by state variables and is very hard to review or modify. In particular the way the escape sequence handling interacts with the general control flow is hard to follow. Separate out the escape key handling, without changing the control flow. This makes the main body of the code easier to review. Signed-off-by: Daniel Thompson Reviewed-by: Douglas Anderson --- kernel/debug/kdb/kdb_io.c | 128 ++++++++++++++++++++------------------ 1 file changed, 67 insertions(+), 61 deletions(-) -- 2.21.0 diff --git a/kernel/debug/kdb/kdb_io.c b/kernel/debug/kdb/kdb_io.c index 3a5184eb6977..cfc054fd8097 100644 --- a/kernel/debug/kdb/kdb_io.c +++ b/kernel/debug/kdb/kdb_io.c @@ -49,6 +49,65 @@ static int kgdb_transition_check(char *buffer) return 0; } +/** + * kdb_handle_escape() - validity check on an accumulated escape sequence. + * @buf: Accumulated escape characters to be examined. Note that buf + * is not a string, it is an array of characters and need not be + * nil terminated. + * @sz: Number of accumulated escape characters. + * + * Return: -1 if the escape sequence is unwanted, 0 if it is incomplete, + * otherwise it returns a mapped key value to pass to the upper layers. + */ +static int kdb_handle_escape(char *buf, size_t sz) +{ + char *lastkey = buf + sz - 1; + + switch (sz) { + case 1: + if (*lastkey == '\e') + return 0; + break; + + case 2: /* \e */ + if (*lastkey == '[') + return 0; + break; + + case 3: + switch (*lastkey) { + case 'A': /* \e[A, up arrow */ + return 16; + case 'B': /* \e[B, down arrow */ + return 14; + case 'C': /* \e[C, right arrow */ + return 6; + case 'D': /* \e[D, left arrow */ + return 2; + case '1': /* \e[<1,3,4>], may be home, del, end */ + case '3': + case '4': + return 0; + } + break; + + case 4: + if (*lastkey == '~') { + switch (buf[2]) { + case '1': /* \e[1~, home */ + return 1; + case '3': /* \e[3~, del */ + return 4; + case '4': /* \e[4~, end */ + return 5; + } + } + break; + } + + return -1; +} + static int kdb_read_get_key(char *buffer, size_t bufsize) { #define ESCAPE_UDELAY 1000 @@ -102,68 +161,15 @@ static int kdb_read_get_key(char *buffer, size_t bufsize) escape_delay = 2; continue; } - if (ped - escape_data == 1) { - /* \e */ - continue; - } else if (ped - escape_data == 2) { - /* \e */ - if (key != '[') - escape_delay = 2; - continue; - } else if (ped - escape_data == 3) { - /* \e[ */ - int mapkey = 0; - switch (key) { - case 'A': /* \e[A, up arrow */ - mapkey = 16; - break; - case 'B': /* \e[B, down arrow */ - mapkey = 14; - break; - case 'C': /* \e[C, right arrow */ - mapkey = 6; - break; - case 'D': /* \e[D, left arrow */ - mapkey = 2; - break; - case '1': /* dropthrough */ - case '3': /* dropthrough */ - /* \e[<1,3,4>], may be home, del, end */ - case '4': - mapkey = -1; - break; - } - if (mapkey != -1) { - if (mapkey > 0) { - escape_data[0] = mapkey; - escape_data[1] = '\0'; - } - escape_delay = 2; - } - continue; - } else if (ped - escape_data == 4) { - /* \e[<1,3,4> */ - int mapkey = 0; - if (key == '~') { - switch (escape_data[2]) { - case '1': /* \e[1~, home */ - mapkey = 1; - break; - case '3': /* \e[3~, del */ - mapkey = 4; - break; - case '4': /* \e[4~, end */ - mapkey = 5; - break; - } - } - if (mapkey > 0) { - escape_data[0] = mapkey; - escape_data[1] = '\0'; - } - escape_delay = 2; - continue; + + key = kdb_handle_escape(escape_data, ped - escape_data); + if (key > 0) { + escape_data[0] = key; + escape_data[1] = '\0'; } + if (key) + escape_delay = 2; + continue; } break; /* A key to process */ }