From patchwork Tue Jul 6 18:55:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361107 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 18145C07E9C for ; Tue, 6 Jul 2021 18:56:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E7D5F61C24 for ; Tue, 6 Jul 2021 18:56:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231572AbhGFS6k (ORCPT ); Tue, 6 Jul 2021 14:58:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35466 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231550AbhGFS6k (ORCPT ); Tue, 6 Jul 2021 14:58:40 -0400 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B6470C06175F for ; Tue, 6 Jul 2021 11:56:00 -0700 (PDT) Received: by mail-wr1-x431.google.com with SMTP id p8so195521wrr.1 for ; Tue, 06 Jul 2021 11:56:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=28uzDAeGOKcnmFSDAZZdAYg3F6G6ewQ9Uyr464q53QI=; b=KzFrEhzX8O8/v9/JsIMcwyUojUvxeMAeU13yi+grTpejJdec+yk2RV1bjC2rw9XN67 Ky1GrmyzrF6pgVtFhV6ep76wFFCzPOY6UT7T8eczmpFVHlRgeBUHhNJxq8x88SAhn6G+ 2loWFVnDIAA79Ealb5CQ4vaVE/Q1o3MUrhWM9xGBrsvr9Fm1rx8j6R5WxmnY0iPak8Q6 hzZ3R35RbMERN/E8p+wbkx+uaCxozZ6cn+HV8VoamDTlztgfRkjlq+ZWtXxlcf+L2j7L h5qeixgqkGF91uetOY1nLUEDRHvOuO45KZ1weh64yhPCAnuk1wXnFIkbJnWCvwzzShTj pweA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=28uzDAeGOKcnmFSDAZZdAYg3F6G6ewQ9Uyr464q53QI=; b=NnnSpVSknHuQaV6L4BOz0dzdqwR93S/XyZ9mJzAQ3R1x5dQ8hrUe5oUO7Arjmoe1v2 Iubnd0bTiEDAXe8A767ICj1Ku+zFhj7efBL59H8s2W2MvPqpnXtkhWDfDnYOEIxUkNTh SZkc+8L++TK93SlBggs/B3+EfM1x2TviCYLwnkvQhfdFjR3yTyrnY2AUGgHe9Tx13AB/ 2vliHnfCoyxBR7vsMLBr1IiKSLWSiqqHy8YeYJJv3aqJ52hXVSNz5TmJYKUN1MbL1JZa II+TfDNxG0C+xHxqc5+MI5FFWmLKIkbyHVbcJJpVD62CvCH6DT0IEpeOcnTw1/0ToYdX Mmjg== X-Gm-Message-State: AOAM533pcYIkQgiBw+M+poPGRafjfGE+IJE1z9Vus7rxjnHVkGIfbA2p xVJMvHF+r86JU4By6e4NHPPNK713DJ4= X-Google-Smtp-Source: ABdhPJyTp2TTkbRhxpTavHBf1v1/Ot84/PULqlQxiKyW4CNbRxc2pPrCPfztbbEP+UDNFte8Cp0P2w== X-Received: by 2002:a5d:4cc4:: with SMTP id c4mr20763447wrt.128.1625597759363; Tue, 06 Jul 2021 11:55:59 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n23sm3761140wmi.29.2021.07.06.11.55.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:55:59 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:52 +0000 Subject: [PATCH v4 1/6] refs: remove EINVAL errno output from specification of read_raw_ref_fn MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys This commit does not change code; it documents the fact that an alternate ref backend does not need to return EINVAL from read_raw_ref_fn to function properly. This is correct, because refs_read_raw_ref is only called from; * resolve_ref_unsafe(), which does not care for the EINVAL errno result. * refs_verify_refname_available(), which does not inspect errno. * files-backend.c, where errno is overwritten on failure. * packed-backend.c (is_packed_transaction_needed), which calls it for the packed ref backend, which never emits EINVAL. A grep for EINVAL */*c reveals that no code checks errno against EINVAL after reading references. In addition, the refs.h file does not mention errno at all. A grep over resolve_ref_unsafe() turned up the following callers that inspect errno: * sequencer.c::print_commit_summary, which uses it for die_errno * lock_ref_oid_basic(), which only treats EISDIR and ENOTDIR specially. The files ref backend does use EINVAL. The files backend does not call into the generic API (refs_read_raw), but into the files-specific function (files_read_raw_ref), which we are not changing in this commit. As the errno sideband is unintuitive and error-prone, remove EINVAL value, as a step towards getting rid of the errno sideband altogether. Spotted by Ævar Arnfjörð Bjarmason . Signed-off-by: Han-Wen Nienhuys --- refs/refs-internal.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/refs/refs-internal.h b/refs/refs-internal.h index 467f4b3c936..f4445e32904 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -619,9 +619,9 @@ typedef int reflog_expire_fn(struct ref_store *ref_store, * * Return 0 on success. If the ref doesn't exist, set errno to ENOENT * and return -1. If the ref exists but is neither a symbolic ref nor - * an object ID, it is broken; set REF_ISBROKEN in type, set errno to - * EINVAL, and return -1. If there is another error reading the ref, - * set errno appropriately and return -1. + * an object ID, it is broken; set REF_ISBROKEN in type, and return -1 + * (errno should not be ENOENT) If there is another error reading the + * ref, set errno appropriately and return -1. * * Backend-specific flags might be set in type as well, regardless of * outcome. From patchwork Tue Jul 6 18:55:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361109 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6F338C07E96 for ; Tue, 6 Jul 2021 18:56:04 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4EBB761C6F for ; Tue, 6 Jul 2021 18:56:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231609AbhGFS6m (ORCPT ); Tue, 6 Jul 2021 14:58:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35468 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231550AbhGFS6l (ORCPT ); Tue, 6 Jul 2021 14:58:41 -0400 Received: from mail-wm1-x32c.google.com (mail-wm1-x32c.google.com [IPv6:2a00:1450:4864:20::32c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5B715C061760 for ; Tue, 6 Jul 2021 11:56:01 -0700 (PDT) Received: by mail-wm1-x32c.google.com with SMTP id r9-20020a7bc0890000b02901f347b31d55so2521666wmh.2 for ; Tue, 06 Jul 2021 11:56:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=ygRVoOEReud17UIg0l3csEnkpcJVCYXEmlyrC68IMgs=; b=LANv9KlMwPgtCYrBADho8EZ/K98VSrEsCh3StJycG0uDDCB2tGq07qFK83WZg2kHHk 75QubojX+eiNXgxHpvlrJN8fZh7tHHPh8jNch3KwUGSxGRbEwxjLhCTOKRNuyFw2rO+8 dw0kAj4JhntD4mrE3h42sTjQVn3wxkPrI9y3hVtkRv4qT12JB6h8maKzRcClf8VZnc4k DVsGeQZ54lfXg4Aw1WyNmzZI/qPev24OEcHFPNpeRD7uGPKpEA4L6Ygmh3fcLRgbfAQK S9hucaRG6JSl9C2FeCa26izyZi+VVntJ+qxg+ESWhuK75xSr+N7QjFFatwHVCpGvjCtj Agzg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=ygRVoOEReud17UIg0l3csEnkpcJVCYXEmlyrC68IMgs=; b=WZgnmF8ojOgPRZAB1NrRcBb/UmGRC4DP7KQc910OmfOGdlPITRsTCTYYh1uyotpMyr Xzex7mZiFhGecsi2oCE6kOsDZflodU7M/yo3PvFAHvuUtjpxgRi4bWMke2K17yGFy9b8 9GriCCsuXzfjDCW2+pLbMpjKT0tcgGotvhSc9CVbDk+A6c7v2EJuYUomnHmK4EwiIJHY hxpDbjmHlx7e/1lLlDXiZJe7lWsr1fuNIprKm3JnBz3+vzU1+VPwOC3GXrXkr4iis4Lf Gj2g5TUufmQRCMmt77qMNQS89UUrWxklbtTYJFzu3C415FjNor+SM8erdV+IqrJ9ZsRR me7A== X-Gm-Message-State: AOAM532axgCY+ZRDNAQbjM+DSLlyMhjWCmhGG7GZiAX1EhqCffptNHd3 4HzBRBE4rAwyxLh5KAHtYOH2SmjZjgk= X-Google-Smtp-Source: ABdhPJz8fw4r6xuaa1KDtNoIsb7LGsl+M3Hja2FxDIIzlDidLMBkV4bW69kO63GGH0kh+FV0NhO4Jw== X-Received: by 2002:a05:600c:3399:: with SMTP id o25mr22054761wmp.3.1625597759971; Tue, 06 Jul 2021 11:55:59 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id r9sm12126042wmq.25.2021.07.06.11.55.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:55:59 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:53 +0000 Subject: [PATCH v4 2/6] refs/files-backend: stop setting errno from lock_ref_oid_basic MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys refs/files-backend.c::lock_ref_oid_basic() tries to signal how it failed to its callers using errno. It is safe to stop setting errno here, because the callers of this file-scope static function are * files_copy_or_rename_ref() * files_create_symref() * files_reflog_expire() None of them looks at errno after seeing a negative return from lock_ref_oid_basic() to make any decision, and no caller of these three functions looks at errno after they signal a failure by returning a negative value. In particular, * files_copy_or_rename_ref() - here, calls are followed by error() (which performs I/O) or write_ref_to_lockfile() (which calls parse_object() which may perform I/O) * files_create_symref() - here, calls are followed by error() or create_symref_locked() (which performs I/O and does not inspect errno) * files_reflog_expire() - here, calls are followed by error() or refs_reflog_exists() (which calls a function in a vtable that is not documented to use and/or preserve errno) Signed-off-by: Han-Wen Nienhuys Reviewed-By: Ævar Arnfjörð Bjarmason --- refs/files-backend.c | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/refs/files-backend.c b/refs/files-backend.c index 677b7e4cdd2..83ddfb3b627 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -910,7 +910,6 @@ static int create_reflock(const char *path, void *cb) /* * Locks a ref returning the lock on success and NULL on failure. - * On failure errno is set to something meaningful. */ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, const char *refname, @@ -922,7 +921,6 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, { struct strbuf ref_file = STRBUF_INIT; struct ref_lock *lock; - int last_errno = 0; int mustexist = (old_oid && !is_null_oid(old_oid)); int resolve_flags = RESOLVE_REF_NO_RECURSE; int resolved; @@ -949,7 +947,6 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, * to remain. */ if (remove_empty_directories(&ref_file)) { - last_errno = errno; if (!refs_verify_refname_available( &refs->base, refname, extras, skip, err)) @@ -962,10 +959,13 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, &lock->old_oid, type); } if (!resolved) { - last_errno = errno; + int last_errno = errno; if (last_errno != ENOTDIR || - !refs_verify_refname_available(&refs->base, refname, - extras, skip, err)) + /* in case of D/F conflict, try to generate a better error + * message. If that fails, fall back to strerror(ENOTDIR). + */ + !refs_verify_refname_available(&refs->base, refname, extras, + skip, err)) strbuf_addf(err, "unable to resolve reference '%s': %s", refname, strerror(last_errno)); @@ -981,20 +981,17 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, if (is_null_oid(&lock->old_oid) && refs_verify_refname_available(refs->packed_ref_store, refname, extras, skip, err)) { - last_errno = ENOTDIR; goto error_return; } lock->ref_name = xstrdup(refname); if (raceproof_create_file(ref_file.buf, create_reflock, &lock->lk)) { - last_errno = errno; unable_to_lock_message(ref_file.buf, errno, err); goto error_return; } if (verify_lock(&refs->base, lock, old_oid, mustexist, err)) { - last_errno = errno; goto error_return; } goto out; @@ -1005,7 +1002,6 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, out: strbuf_release(&ref_file); - errno = last_errno; return lock; } From patchwork Tue Jul 6 18:55:54 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361113 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 87006C07E96 for ; Tue, 6 Jul 2021 18:56:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 68E6A61C6C for ; Tue, 6 Jul 2021 18:56:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231660AbhGFS6o (ORCPT ); Tue, 6 Jul 2021 14:58:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35474 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231587AbhGFS6m (ORCPT ); Tue, 6 Jul 2021 14:58:42 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 59E5BC061574 for ; Tue, 6 Jul 2021 11:56:02 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id f17so166742wrt.6 for ; Tue, 06 Jul 2021 11:56:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=Ejf4FyM6cqx1x3SR1x29tSGVB2Xye8h3RJ3KYyUnxw8=; b=iNMCvxSjwj22LwLMIqXC8IH4Lm2Ms1nxnUh+p2mQicdhGjb7No2Uyo8hzbsmCWZKWB tzEd3dLZ3kZNn+FS1xUHk4Gv3Lm2GwJVs3z1g7uQ0fggQlRrSUrvtfwoVbbZVk6QakRG CPuuntKNo7eXHdVCb+FIU20diCG7/MLen3YyyRGRGu28uNl94byeRTPKJhDUwyCN7vRO y9CyRE5BpfcBcT7jl/kfPX11ooTs+KZtwYuoGn5LB8mDIByGdZrJaX0MtHNE3G9WLGvC bKRX9xvA6tGtm657i+DoKPmsrstGPBi30JKHB6bpb1PPB6qGAXQTA8J5H9p5kaJYDJfu /T4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=Ejf4FyM6cqx1x3SR1x29tSGVB2Xye8h3RJ3KYyUnxw8=; b=AdRkhAbHILPJTLs8db57EsSblmKyJDLsGI9zR82PtgoXp8jJgYMvdqyKlOPk7YTXHy KCoQkfjzDWBJnnDTwmCF8PLq1nOzstMqKaR9Z8CnJnpw20G2cJP4MQXhsDukOvHYnRXE fT7v/2GclN7GEREtslnyFVa0M5GY5y20mh+Yob/KwQnED+hZHdcnuvVouApLsnRYuC7O KV3nVi3l3YxbU/8bSNF3dXVQ7l+BhhXCZzgTVnZt631PuZsnroqa9YL/CtyjL26FUtPe g6tgbn+IMuyJ1oLBrVLFnon7dRm9KUpjAT9RXe3DvPnWN8WqLzepsk0fKo8mhQZ4ksDG eYkQ== X-Gm-Message-State: AOAM532rCeLRofg5C25lgAR+AMV66Q437q74JWi65niOmU3HQqOcW+3Y 9VOl12I+wjNJNSJvcO4Ul/FP91cdqjg= X-Google-Smtp-Source: ABdhPJwCpclWo9U0JIE1gMUSw/uMXrIvGWfweNK2PqLqrGc+Xs+QnmEC5B1mivXqC/Mu84F7Z5SE+g== X-Received: by 2002:a5d:4cc4:: with SMTP id c4mr20763506wrt.128.1625597760534; Tue, 06 Jul 2021 11:56:00 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id n2sm12104333wrx.40.2021.07.06.11.56.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:56:00 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:54 +0000 Subject: [PATCH v4 3/6] refs: make errno output explicit for read_raw_ref_fn MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys This makes it explicit how alternative ref backends should report errors in read_raw_ref_fn. read_raw_ref_fn needs to supply a credible errno for a number of cases. These are primarily: 1) The files backend calls read_raw_ref from lock_raw_ref, and uses the resulting error codes to create/remove directories as needed. 2) ENOENT should be translated in a zero OID, optionally with REF_ISBROKEN set, returning the last successfully resolved symref. This is necessary so read_raw_ref("HEAD") on an empty repo returns refs/heads/main (or the default branch du-jour), and we know on which branch to create the first commit. Make this information flow explicit by adding a failure_errno to the signature of read_raw_ref. All errnos from the files backend are still propagated unchanged, even though inspection suggests only ENOTDIR, EISDIR and ENOENT are relevant. Signed-off-by: Han-Wen Nienhuys Reviewed-By: Ævar Arnfjörð Bjarmason --- refs.c | 10 ++++++++-- refs/debug.c | 4 ++-- refs/files-backend.c | 23 +++++++++++------------ refs/packed-backend.c | 8 ++++---- refs/refs-internal.h | 20 ++++++++++++-------- 5 files changed, 37 insertions(+), 28 deletions(-) diff --git a/refs.c b/refs.c index 8c9490235ea..5e5e3af8da0 100644 --- a/refs.c +++ b/refs.c @@ -1675,13 +1675,19 @@ int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, struct object_id *oid, struct strbuf *referent, unsigned int *type) { + int result; + int failure_errno; if (!strcmp(refname, "FETCH_HEAD") || !strcmp(refname, "MERGE_HEAD")) { return refs_read_special_head(ref_store, refname, oid, referent, type); } - return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, - type); + failure_errno = 0; + result = ref_store->be->read_raw_ref(ref_store, refname, oid, referent, + type, &failure_errno); + if (failure_errno) + errno = failure_errno; + return result; } /* This function needs to return a meaningful errno on failure */ diff --git a/refs/debug.c b/refs/debug.c index 7db4abccc34..f12413a9bc0 100644 --- a/refs/debug.c +++ b/refs/debug.c @@ -238,7 +238,7 @@ debug_ref_iterator_begin(struct ref_store *ref_store, const char *prefix, static int debug_read_raw_ref(struct ref_store *ref_store, const char *refname, struct object_id *oid, struct strbuf *referent, - unsigned int *type) + unsigned int *type, int *failure_errno) { struct debug_ref_store *drefs = (struct debug_ref_store *)ref_store; int res = 0; @@ -246,7 +246,7 @@ static int debug_read_raw_ref(struct ref_store *ref_store, const char *refname, oidcpy(oid, null_oid()); errno = 0; res = drefs->refs->be->read_raw_ref(drefs->refs, refname, oid, referent, - type); + type, failure_errno); if (res == 0) { trace_printf_key(&trace_refs, "read_raw_ref: %s: %s (=> %s) type %x: %d\n", diff --git a/refs/files-backend.c b/refs/files-backend.c index 83ddfb3b627..f98b1be9386 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -341,9 +341,9 @@ static struct ref_cache *get_loose_ref_cache(struct files_ref_store *refs) return refs->loose; } -static int files_read_raw_ref(struct ref_store *ref_store, - const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type) +static int files_read_raw_ref(struct ref_store *ref_store, const char *refname, + struct object_id *oid, struct strbuf *referent, + unsigned int *type, int *failure_errno) { struct files_ref_store *refs = files_downcast(ref_store, REF_STORE_READ, "read_raw_ref"); @@ -354,7 +354,6 @@ static int files_read_raw_ref(struct ref_store *ref_store, struct stat st; int fd; int ret = -1; - int save_errno; int remaining_retries = 3; *type = 0; @@ -459,10 +458,9 @@ stat_ref: ret = parse_loose_ref_contents(buf, oid, referent, type); out: - save_errno = errno; + *failure_errno = errno; strbuf_release(&sb_path); strbuf_release(&sb_contents); - errno = save_errno; return ret; } @@ -541,6 +539,7 @@ static int lock_raw_ref(struct files_ref_store *refs, struct strbuf ref_file = STRBUF_INIT; int attempts_remaining = 3; int ret = TRANSACTION_GENERIC_ERROR; + int failure_errno = 0; assert(err); files_assert_main_repository(refs, "lock_raw_ref"); @@ -629,9 +628,9 @@ retry: * fear that its value will change. */ - if (files_read_raw_ref(&refs->base, refname, - &lock->old_oid, referent, type)) { - if (errno == ENOENT) { + if (files_read_raw_ref(&refs->base, refname, &lock->old_oid, referent, + type, &failure_errno)) { + if (failure_errno == ENOENT) { if (mustexist) { /* Garden variety missing reference. */ strbuf_addf(err, "unable to resolve reference '%s'", @@ -655,7 +654,7 @@ retry: * reference named "refs/foo/bar/baz". */ } - } else if (errno == EISDIR) { + } else if (failure_errno == EISDIR) { /* * There is a directory in the way. It might have * contained references that have been deleted. If @@ -693,13 +692,13 @@ retry: goto error_return; } } - } else if (errno == EINVAL && (*type & REF_ISBROKEN)) { + } else if (failure_errno == EINVAL && (*type & REF_ISBROKEN)) { strbuf_addf(err, "unable to resolve reference '%s': " "reference broken", refname); goto error_return; } else { strbuf_addf(err, "unable to resolve reference '%s': %s", - refname, strerror(errno)); + refname, strerror(failure_errno)); goto error_return; } diff --git a/refs/packed-backend.c b/refs/packed-backend.c index dfecdbc1db6..a457f18e93c 100644 --- a/refs/packed-backend.c +++ b/refs/packed-backend.c @@ -724,9 +724,9 @@ static struct snapshot *get_snapshot(struct packed_ref_store *refs) return refs->snapshot; } -static int packed_read_raw_ref(struct ref_store *ref_store, - const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type) +static int packed_read_raw_ref(struct ref_store *ref_store, const char *refname, + struct object_id *oid, struct strbuf *referent, + unsigned int *type, int *failure_errno) { struct packed_ref_store *refs = packed_downcast(ref_store, REF_STORE_READ, "read_raw_ref"); @@ -739,7 +739,7 @@ static int packed_read_raw_ref(struct ref_store *ref_store, if (!rec) { /* refname is not a packed reference. */ - errno = ENOENT; + *failure_errno = ENOENT; return -1; } diff --git a/refs/refs-internal.h b/refs/refs-internal.h index f4445e32904..79dfb3af484 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -617,11 +617,15 @@ typedef int reflog_expire_fn(struct ref_store *ref_store, * properly-formatted or even safe reference name. NEITHER INPUT NOR * OUTPUT REFERENCE NAMES ARE VALIDATED WITHIN THIS FUNCTION. * - * Return 0 on success. If the ref doesn't exist, set errno to ENOENT - * and return -1. If the ref exists but is neither a symbolic ref nor - * an object ID, it is broken; set REF_ISBROKEN in type, and return -1 - * (errno should not be ENOENT) If there is another error reading the - * ref, set errno appropriately and return -1. + * Return 0 on success, or -1 on failure. If the ref exists but is neither a + * symbolic ref nor an object ID, it is broken. In this case set REF_ISBROKEN in + * type, and return -1 (failure_errno should not be ENOENT) + * + * failure_errno provides errno codes that are interpreted beyond error + * reporting. The following error codes have special meaning: + * * ENOENT: the ref doesn't exist + * * EISDIR: ref name is a directory + * * ENOTDIR: ref prefix is not a directory * * Backend-specific flags might be set in type as well, regardless of * outcome. @@ -635,9 +639,9 @@ typedef int reflog_expire_fn(struct ref_store *ref_store, * - in all other cases, referent will be untouched, and therefore * refname will still be valid and unchanged. */ -typedef int read_raw_ref_fn(struct ref_store *ref_store, - const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type); +typedef int read_raw_ref_fn(struct ref_store *ref_store, const char *refname, + struct object_id *oid, struct strbuf *referent, + unsigned int *type, int *failure_errno); struct ref_storage_be { struct ref_storage_be *next; From patchwork Tue Jul 6 18:55:55 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361115 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EC034C07E9E for ; Tue, 6 Jul 2021 18:56:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C2E8061C6D for ; Tue, 6 Jul 2021 18:56:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231675AbhGFS6p (ORCPT ); Tue, 6 Jul 2021 14:58:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35468 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231590AbhGFS6m (ORCPT ); Tue, 6 Jul 2021 14:58:42 -0400 Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com [IPv6:2a00:1450:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 829FCC06175F for ; Tue, 6 Jul 2021 11:56:02 -0700 (PDT) Received: by mail-wr1-x434.google.com with SMTP id u8so156178wrq.8 for ; Tue, 06 Jul 2021 11:56:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=lF7kwj9wLaUuJXktR7Qa9ZkeHf3vP7VtGSTE1BGxVew=; b=oxzqGcfNxcYw1ZdJhARHXdmNQvZOIT/i49J5SgCKYJ8U3SoJSK7GjuzfpWoS4vLxXf WUk+8HwDw/nqL89RekZUFy8C1Q0ijFzPXHASWziOF62/MF5alByE9MBXtU/YVZhTdo4p 0YGykMGMF3r295Wf52jzTjwdXPuHSYJOCisNSVgkxmwQH34k31Hz+XV5+C5BhIrcjMtR kSpJESPiNf+gZvOFxp8q31oqMpnbDDnvCgz2rnTzW5lPgDdmY3LarjUvQ1ONmZO2lmUK SPtHfN8NPUFX0YMqx+pplk+w661Eknz4vHx8iZhxW9ZSXHA/F9t+InCr6xm2tAn0Fyhq dppw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=lF7kwj9wLaUuJXktR7Qa9ZkeHf3vP7VtGSTE1BGxVew=; b=ODFzNz5WY+Ayzh5DDwx6X6Yg0hjnM4NIUpalBt3tYv0eeAo3/1kbo+rAm5LmiQIqCv 1bcU2EcBp+rvu4+f0N9iH5he/T2Hzmj0QcjOYqa5qskIySDCquj7L2uL0/U0HyXGn4Dl TQVWq9r/NSeqqohEeajw2S95f4nusc9oEi4ns3bfMcfvLicwrl3ODchitlCYMpybukUU FTx5R7f5OR0EmHDcWtp3ijtCM0ZA7hZPhGJVWCMAsWrHkYSEq2L6Q5JHlenTf0Jv0IoJ 9q2vgibdcrq0cfuPCm18WpbOWPTtH6zG+64E+4ES6/9KpOG+qGh9XN/K/mkZTI4cydYE a6ig== X-Gm-Message-State: AOAM532jerW60h1o7e1YTKOL8bnpyEGrRYec33KZHhY0dXS/JAVLEHx1 u+0oJ1XettiZZi77AQGXqRzeFr/5sCw= X-Google-Smtp-Source: ABdhPJwrU1CtPK338Ap8W90BnauloxWo9wbh3ZO9EM+ptlOmgQFQqaZ6rzryzNjC9Wul0OKD0p4wnw== X-Received: by 2002:a5d:68d2:: with SMTP id p18mr23298883wrw.239.1625597761113; Tue, 06 Jul 2021 11:56:01 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 204sm18632041wma.30.2021.07.06.11.56.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:56:00 -0700 (PDT) Message-Id: <9c933706cb09265b62213b29f4a632c8a4445de1.1625597757.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:55 +0000 Subject: [PATCH v4 4/6] refs: add failure_errno to refs_read_raw_ref() signature MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys This lets us use the explicit errno output parameter in refs_resolve_ref_unsafe. Signed-off-by: Han-Wen Nienhuys Reviewed-By: Ævar Arnfjörð Bjarmason --- refs.c | 60 +++++++++++++++++++++++++++---------------- refs/files-backend.c | 8 +++--- refs/packed-backend.c | 7 ++--- refs/refs-internal.h | 6 ++--- 4 files changed, 49 insertions(+), 32 deletions(-) diff --git a/refs.c b/refs.c index 5e5e3af8da0..25d80e544d0 100644 --- a/refs.c +++ b/refs.c @@ -1671,34 +1671,35 @@ done: return result; } -int refs_read_raw_ref(struct ref_store *ref_store, - const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type) +int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, + struct object_id *oid, struct strbuf *referent, + unsigned int *type, int *failure_errno) { - int result; - int failure_errno; + int ignore; + if (failure_errno) + *failure_errno = 0; + else + failure_errno = &ignore; + if (!strcmp(refname, "FETCH_HEAD") || !strcmp(refname, "MERGE_HEAD")) { return refs_read_special_head(ref_store, refname, oid, referent, type); } - failure_errno = 0; - result = ref_store->be->read_raw_ref(ref_store, refname, oid, referent, - type, &failure_errno); - if (failure_errno) - errno = failure_errno; - return result; + return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, + type, failure_errno); } -/* This function needs to return a meaningful errno on failure */ -const char *refs_resolve_ref_unsafe(struct ref_store *refs, - const char *refname, - int resolve_flags, - struct object_id *oid, int *flags) +const char *refs_resolve_ref_unsafe_with_errno(struct ref_store *refs, + const char *refname, + int resolve_flags, + struct object_id *oid, + int *flags, int *failure_errno) { static struct strbuf sb_refname = STRBUF_INIT; struct object_id unused_oid; int unused_flags; + int unused_errno; int symref_count; if (!oid) @@ -1707,6 +1708,9 @@ const char *refs_resolve_ref_unsafe(struct ref_store *refs, flags = &unused_flags; *flags = 0; + if (!failure_errno) + failure_errno = &unused_errno; + *failure_errno = 0; if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) { if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) || @@ -1728,11 +1732,14 @@ const char *refs_resolve_ref_unsafe(struct ref_store *refs, for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) { unsigned int read_flags = 0; + int read_failure = 0; - if (refs_read_raw_ref(refs, refname, - oid, &sb_refname, &read_flags)) { + if (refs_read_raw_ref(refs, refname, oid, &sb_refname, + &read_flags, &read_failure)) { *flags |= read_flags; + *failure_errno = read_failure; + /* In reading mode, refs must eventually resolve */ if (resolve_flags & RESOLVE_REF_READING) return NULL; @@ -1742,9 +1749,8 @@ const char *refs_resolve_ref_unsafe(struct ref_store *refs, * may show errors besides ENOENT if there are * similarly-named refs. */ - if (errno != ENOENT && - errno != EISDIR && - errno != ENOTDIR) + if (read_failure != ENOENT && read_failure != EISDIR && + read_failure != ENOTDIR) return NULL; oidclr(oid); @@ -1783,6 +1789,15 @@ const char *refs_resolve_ref_unsafe(struct ref_store *refs, return NULL; } +const char *refs_resolve_ref_unsafe(struct ref_store *refs, const char *refname, + int resolve_flags, struct object_id *oid, + int *flags) +{ + int ignore = 0; + return refs_resolve_ref_unsafe_with_errno(refs, refname, resolve_flags, + oid, flags, &ignore); +} + /* backend functions */ int refs_init_db(struct strbuf *err) { @@ -2244,7 +2259,8 @@ int refs_verify_refname_available(struct ref_store *refs, if (skip && string_list_has_string(skip, dirname.buf)) continue; - if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent, &type)) { + if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent, + &type, NULL)) { strbuf_addf(err, _("'%s' exists; cannot create '%s'"), dirname.buf, refname); goto cleanup; diff --git a/refs/files-backend.c b/refs/files-backend.c index f98b1be9386..f38c9703504 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -383,8 +383,8 @@ stat_ref: if (lstat(path, &st) < 0) { if (errno != ENOENT) goto out; - if (refs_read_raw_ref(refs->packed_ref_store, refname, - oid, referent, type)) { + if (refs_read_raw_ref(refs->packed_ref_store, refname, oid, + referent, type, NULL)) { errno = ENOENT; goto out; } @@ -423,8 +423,8 @@ stat_ref: * ref is supposed to be, there could still be a * packed ref: */ - if (refs_read_raw_ref(refs->packed_ref_store, refname, - oid, referent, type)) { + if (refs_read_raw_ref(refs->packed_ref_store, refname, oid, + referent, type, NULL)) { errno = EISDIR; goto out; } diff --git a/refs/packed-backend.c b/refs/packed-backend.c index a457f18e93c..530dba29788 100644 --- a/refs/packed-backend.c +++ b/refs/packed-backend.c @@ -1347,6 +1347,7 @@ int is_packed_transaction_needed(struct ref_store *ref_store, ret = 0; for (i = 0; i < transaction->nr; i++) { struct ref_update *update = transaction->updates[i]; + int failure_errno = 0; unsigned int type; struct object_id oid; @@ -1357,9 +1358,9 @@ int is_packed_transaction_needed(struct ref_store *ref_store, */ continue; - if (!refs_read_raw_ref(ref_store, update->refname, - &oid, &referent, &type) || - errno != ENOENT) { + if (!refs_read_raw_ref(ref_store, update->refname, &oid, + &referent, &type, &failure_errno) || + failure_errno != ENOENT) { /* * We have to actually delete that reference * -> this transaction is needed. diff --git a/refs/refs-internal.h b/refs/refs-internal.h index 79dfb3af484..54f57c6a2df 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -149,9 +149,9 @@ struct ref_update { const char refname[FLEX_ARRAY]; }; -int refs_read_raw_ref(struct ref_store *ref_store, - const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type); +int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, + struct object_id *oid, struct strbuf *referent, + unsigned int *type, int *failure_errno); /* * Write an error to `err` and return a nonzero value iff the same From patchwork Tue Jul 6 18:55:56 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361111 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 22591C07E9C for ; Tue, 6 Jul 2021 18:56:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EE39D61C6F for ; Tue, 6 Jul 2021 18:56:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231618AbhGFS6n (ORCPT ); Tue, 6 Jul 2021 14:58:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35480 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231585AbhGFS6m (ORCPT ); Tue, 6 Jul 2021 14:58:42 -0400 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1B054C061760 for ; Tue, 6 Jul 2021 11:56:03 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id d2so239879wrn.0 for ; Tue, 06 Jul 2021 11:56:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=bFtXuM/sWnA/8YoiJSWANhxAp8hySBtltE3zBJr8eFM=; b=e2OZmdPUlY/bVXJdxtaJXzQ5sFSoHAuWhsX/B0JRFuHGpxrCilduHKH0/QNL2+JWPl EbitVrkYm+R9KUttoNdKW1vxloivdqdSc/Qv3sFdaVD81TVmze6j7L8Tg5V9E4KOTHYf npvLfgVER2MyYOXyjbhnj6dXOfmcLehf2Xw030NMdCU6vD41+V0kO5Q82jRvkWhEuZob BPbqzo8J5ny9awgTS+0KQB5ldYmzqCgXAcrICMB2y9fN0lnLWpCvyQAgewOOzydHApyV jQzrv5dLjSoEu+JbALDmqotoABhuNiaclQQ5u9IwPOD4snbp66buK/HAEE2+k0x9RIu1 Pf8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=bFtXuM/sWnA/8YoiJSWANhxAp8hySBtltE3zBJr8eFM=; b=WE4rdmi9GyKfqbow8VUgT7EihDnjI+pz3azPW8R6TmMK9MeI1TGMzBg0lWwHcpwudq dAqGtQPDFxyEJXoCJ1Vsics5r8d4CUd37UqSrEArzUbdGV/DV6ilmWyh3GiFfIFKlHma P/OvGKS+hSBtqzSadwYWPOmAdGkbzKEv4q1H9sxq+6e4Nlq+yw9jxnwYrEDJ4ApUVhuT y0kyqwD71vFWI2sWu0hcDyFlbpNC7yEbrxiXuUkR/vWoE8W1yeCEZ00342zyB771i5Cz wfScASPvfEFjOh5cvgK9i/qbQJ6q6/uAj6bF9XsUNi3RiM0GcFcJOxs6lXSPYw/n4mFA N65Q== X-Gm-Message-State: AOAM532Wo08yRnlWXoi5zi6QG0JPx6FcpqbIw5CzMW1gBM7GN7mfBXqA WmdfH0dykvtDoramaxrMMfOeN1Q061w= X-Google-Smtp-Source: ABdhPJyTVxZaTQXZHPKtTmypTiiOiRXNDm4YvZoD6mlUbwhIRTePpWl7UBAvd6zGo9cIwq8c7N+d5Q== X-Received: by 2002:a5d:5108:: with SMTP id s8mr23648662wrt.296.1625597761689; Tue, 06 Jul 2021 11:56:01 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id s8sm16485194wmh.36.2021.07.06.11.56.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:56:01 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:56 +0000 Subject: [PATCH v4 5/6] refs: explicitly return failure_errno from parse_loose_ref_contents MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys The EINVAL error from parse_loose_ref_contents is used in files-backend to create a custom error message. Signed-off-by: Han-Wen Nienhuys Reviewed-By: Ævar Arnfjörð Bjarmason --- refs.c | 8 +++++--- refs/files-backend.c | 13 +++++++++---- refs/refs-internal.h | 6 ++++-- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/refs.c b/refs.c index 25d80e544d0..eca7310e7a4 100644 --- a/refs.c +++ b/refs.c @@ -1653,7 +1653,8 @@ int for_each_fullref_in_prefixes(const char *namespace, static int refs_read_special_head(struct ref_store *ref_store, const char *refname, struct object_id *oid, - struct strbuf *referent, unsigned int *type) + struct strbuf *referent, unsigned int *type, + int *failure_errno) { struct strbuf full_path = STRBUF_INIT; struct strbuf content = STRBUF_INIT; @@ -1663,7 +1664,8 @@ static int refs_read_special_head(struct ref_store *ref_store, if (strbuf_read_file(&content, full_path.buf, 0) < 0) goto done; - result = parse_loose_ref_contents(content.buf, oid, referent, type); + result = parse_loose_ref_contents(content.buf, oid, referent, type, + failure_errno); done: strbuf_release(&full_path); @@ -1683,7 +1685,7 @@ int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, if (!strcmp(refname, "FETCH_HEAD") || !strcmp(refname, "MERGE_HEAD")) { return refs_read_special_head(ref_store, refname, oid, referent, - type); + type, failure_errno); } return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, diff --git a/refs/files-backend.c b/refs/files-backend.c index f38c9703504..b43ec4c66cb 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -455,9 +455,13 @@ stat_ref: strbuf_rtrim(&sb_contents); buf = sb_contents.buf; - ret = parse_loose_ref_contents(buf, oid, referent, type); - + ret = parse_loose_ref_contents(buf, oid, referent, type, failure_errno); + errno = *failure_errno; out: + /* Collect all types of failures from errno. Many system calls in this + * function can fail with ENOTDIR/EISDIR, and we want to collect all of + * them. + */ *failure_errno = errno; strbuf_release(&sb_path); strbuf_release(&sb_contents); @@ -465,7 +469,8 @@ out: } int parse_loose_ref_contents(const char *buf, struct object_id *oid, - struct strbuf *referent, unsigned int *type) + struct strbuf *referent, unsigned int *type, + int *failure_errno) { const char *p; if (skip_prefix(buf, "ref:", &buf)) { @@ -484,7 +489,7 @@ int parse_loose_ref_contents(const char *buf, struct object_id *oid, if (parse_oid_hex(buf, oid, &p) || (*p != '\0' && !isspace(*p))) { *type |= REF_ISBROKEN; - errno = EINVAL; + *failure_errno = EINVAL; return -1; } return 0; diff --git a/refs/refs-internal.h b/refs/refs-internal.h index 54f57c6a2df..bf581e70cf6 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -689,10 +689,12 @@ struct ref_store { }; /* - * Parse contents of a loose ref file. + * Parse contents of a loose ref file. *failure_errno maybe be set to EINVAL for + * invalid contents. */ int parse_loose_ref_contents(const char *buf, struct object_id *oid, - struct strbuf *referent, unsigned int *type); + struct strbuf *referent, unsigned int *type, + int *failure_errno); /* * Fill in the generic part of refs and add it to our collection of From patchwork Tue Jul 6 18:55:57 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Han-Wen Nienhuys X-Patchwork-Id: 12361117 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 55ECDC07E9B for ; Tue, 6 Jul 2021 18:56:07 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3766761C6F for ; Tue, 6 Jul 2021 18:56:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231681AbhGFS6p (ORCPT ); Tue, 6 Jul 2021 14:58:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35480 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231585AbhGFS6n (ORCPT ); Tue, 6 Jul 2021 14:58:43 -0400 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 885BBC061762 for ; Tue, 6 Jul 2021 11:56:03 -0700 (PDT) Received: by mail-wr1-x42c.google.com with SMTP id f17so166816wrt.6 for ; Tue, 06 Jul 2021 11:56:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=krPWG5SqZmFOvLTDeEwUTlBu94EEk4+AwWkQSEtZKk8=; b=T91zd/B7olST55vjmHJksG1XXxX+h9xPFHQ7mvX6Hgt8keee6ou2+0LRlrIgBLSMxc nH2jlozXZ5Jtu6Yk5J2WEwP7zFsClNdMBDrtdxm0HblQIZB6xViD3qQkq2Zesj4lvAfB +kK/20kx834+3Bcd13LLwaOUm7HDpQCdIUtiFN5k7G+h2DQj4Vbe7rYurB6cl1BccCxa FBf5NgXPVpNxWojkenoXxaSVwxbMpDtmHNGFXQPqnUcsHSutbixLDKCPWopJpJ7UyHyi edils5bgML8HWC7QCcT8PnSjG9WKzWqHexDVLb1bymooNOCRTiuaMfxLMsBSJKI7YmEM 8WmQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=krPWG5SqZmFOvLTDeEwUTlBu94EEk4+AwWkQSEtZKk8=; b=fBBBfKTvgDdy+eu4sneV/jlLrUol1fEbDiKolMX7tIhVFoFnqcbj4z5tEIgQy2/bj8 SX2eX5Jsyul5PaaSTtlVZ0sCiV7X1capViV0aEEF0JPyykP2EdVAY2aFcsANLdqkQ8hL 1dEdeKCfZgOfgtRErVfMACM8e9Mc3y78LCfA4k1lFp1KtCl0S/ZFPLERF5oZd6Z0nNrS VUWvl2dCQFE4z8U/j+PaO/pgeQZKiGaiavP70b7u0rVjaW1YzlSPEpD66qRkJI2fqMiR nqBFOV7mCWWnUgyyxFZ70rU5Njao2uMWI81HrEXmZPYInR4Q0FCcZnvF0NFybEW9ahBI 9cHg== X-Gm-Message-State: AOAM5326Onz/ja1jpkw2BNOoUwlIeuVcZOFvn6le7o7/dR6c4lFVT4D3 cT/IX7WQ05HgyNlS8jN7ERFrp41DK/Q= X-Google-Smtp-Source: ABdhPJzHrbWUNUQBUSA/e0nMTixihjrn6xHpx4X5PQ9cQ6+DrSQzR1zPemsnlFVW5G1IGOvSpj1Wrg== X-Received: by 2002:a5d:65d1:: with SMTP id e17mr22684046wrw.275.1625597762175; Tue, 06 Jul 2021 11:56:02 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id j12sm17516269wro.82.2021.07.06.11.56.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Jul 2021 11:56:01 -0700 (PDT) Message-Id: <0526a41b4b30cee67c6fea818202a106dbd66cb2.1625597757.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 06 Jul 2021 18:55:57 +0000 Subject: [PATCH v4 6/6] refs: make errno output explicit for refs_resolve_ref_unsafe MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Han-Wen Nienhuys , Jonathan Tan , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Han-Wen Nienhuys , Han-Wen Nienhuys Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Han-Wen Nienhuys From: Han-Wen Nienhuys This introduces refs_resolve_ref_unsafe_with_errno(), which makes the API contract for the errno output explicit. The implementation still relies on the global errno variable to ensure no side effects of this refactoring. lock_ref_oid_basic() in files-backend.c is the only caller of refs_resolve_ref() that needs error information to make logic decisions, so update that caller Signed-off-by: Han-Wen Nienhuys Reviewed-By: Ævar Arnfjörð Bjarmason --- refs/files-backend.c | 15 ++++++++------- refs/refs-internal.h | 8 ++++++++ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/refs/files-backend.c b/refs/files-backend.c index b43ec4c66cb..d86893c6e0a 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -928,6 +928,7 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, int mustexist = (old_oid && !is_null_oid(old_oid)); int resolve_flags = RESOLVE_REF_NO_RECURSE; int resolved; + int resolve_errno = 0; files_assert_main_repository(refs, "lock_ref_oid_basic"); assert(err); @@ -940,10 +941,11 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME; files_ref_path(refs, &ref_file, refname); - resolved = !!refs_resolve_ref_unsafe(&refs->base, - refname, resolve_flags, - &lock->old_oid, type); - if (!resolved && errno == EISDIR) { + resolved = !!refs_resolve_ref_unsafe_with_errno(&refs->base, refname, + resolve_flags, + &lock->old_oid, type, + &resolve_errno); + if (!resolved && resolve_errno == EISDIR) { /* * we are trying to lock foo but we used to * have foo/bar which now does not exist; @@ -963,15 +965,14 @@ static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs, &lock->old_oid, type); } if (!resolved) { - int last_errno = errno; - if (last_errno != ENOTDIR || + if (resolve_errno != ENOTDIR || /* in case of D/F conflict, try to generate a better error * message. If that fails, fall back to strerror(ENOTDIR). */ !refs_verify_refname_available(&refs->base, refname, extras, skip, err)) strbuf_addf(err, "unable to resolve reference '%s': %s", - refname, strerror(last_errno)); + refname, strerror(resolve_errno)); goto error_return; } diff --git a/refs/refs-internal.h b/refs/refs-internal.h index bf581e70cf6..df01d5dc8df 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -153,6 +153,14 @@ int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, struct object_id *oid, struct strbuf *referent, unsigned int *type, int *failure_errno); +/* Like refs_resolve_ref_unsafe, but provide access to errno code that lead to a + * failure. */ +const char *refs_resolve_ref_unsafe_with_errno(struct ref_store *refs, + const char *refname, + int resolve_flags, + struct object_id *oid, + int *flags, int *failure_errno); + /* * Write an error to `err` and return a nonzero value iff the same * refname appears multiple times in `refnames`. `refnames` must be