From patchwork Sun Oct 13 18:47:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Richard Henderson X-Patchwork-Id: 835083 Delivered-To: patch@linaro.org Received: by 2002:adf:b352:0:b0:37d:45d0:187 with SMTP id k18csp1686427wrd; Sun, 13 Oct 2024 11:48:39 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCW8J+zY0qvdZmcht+z8iHZn9V7RcDGVynlNKSkmY5M/3pg9sx7WRIk2IbpLq6k9W4RFQg3T5A==@linaro.org X-Google-Smtp-Source: AGHT+IGnTK5izOGaj9aAfZ69B89Xq1iaJc7THbL9Hmuo9WQP/Ebf08XGZqxFEfWZ/VeqyQXmQG5d X-Received: by 2002:a05:620a:2915:b0:7ad:832a:4063 with SMTP id af79cd13be357-7b11a35311dmr1649587185a.7.1728845319468; Sun, 13 Oct 2024 11:48:39 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1728845319; cv=none; d=google.com; s=arc-20240605; b=k71TmvQgLztqJ+yBS/CorhmjwVjQqWbZU05YhsaQQURNxKkDv+uvT2u4QmH9QOqEuq p8v2V1ARl1CYDio/ngp+Qbys8Vr55oNQAk628gK5aFIY76tFnpu4vuzfBTItR0RzsbVi 32vJ/bnsj78zvazBfQg2kUVdrj42jw2SCOyXq55ikUis5X9O+eEEzJviKxUUHZhvD1+Q HJgosbxrySXJMO77K/ApR8TUG/PJL++NXG7FAvPEUJNxiorrAE0F91+9OcZyoG6Y71dn MPirDpAMisaZ1lrRNtm3IOIQVOCocB1CFzgV4yFll/inLv4lVarexosQL8cp3X51xKij BWhg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=izfDyS+bmapVSfLYtSn4xLMYlKwDBm7aSJ/Y/fO7PVc=; fh=eu2DY09p+eeddYDiV+DalJS3Vr0kxK5BujclYkgWvDw=; b=WRJmXuL9mIX484ijcwosCYt9OH4a3bHyNNpWWQ3jdiUPjpqgDOUV52nmwmaGY45Qch HgCdn3FvUmo0k6815Pwr9Y/ELYGfRRl8ehHHW48CBOmLca1WHBhtkvhUwv+SYKRu4QzS 2dK9ZW0v50fXKnQoasbkV5amyVI4uc/+ILpv031dToDRMo4kQPtRDtTrF20ikzlOrXdl WLsqAgV32AEgW6KDKHgMVefVAQkVOj4ESEHYPhJBGIySl91oJyb53K+WwbuqM+AXV2tz /moLCQLrOhHXgqg2rZdTDSns2iH7mvlctpAEKMdZ/YuYqCNRwtUaR8z0Dp5UQQSlC32D xBnw==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=xw+Aqhga; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=fail header.i=@linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id af79cd13be357-7b1149a51a7si839545885a.437.2024.10.13.11.48.39 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Sun, 13 Oct 2024 11:48:39 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=xw+Aqhga; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=fail header.i=@linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t03cz-0001IJ-Eq; Sun, 13 Oct 2024 14:47:41 -0400 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 1t03cx-0001Hi-9k for qemu-devel@nongnu.org; Sun, 13 Oct 2024 14:47:39 -0400 Received: from mail-pl1-x629.google.com ([2607:f8b0:4864:20::629]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1t03cv-0002So-NL for qemu-devel@nongnu.org; Sun, 13 Oct 2024 14:47:39 -0400 Received: by mail-pl1-x629.google.com with SMTP id d9443c01a7336-20c805a0753so29309765ad.0 for ; Sun, 13 Oct 2024 11:47:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1728845256; x=1729450056; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=izfDyS+bmapVSfLYtSn4xLMYlKwDBm7aSJ/Y/fO7PVc=; b=xw+Aqhga1XmHQB4oBwwXzyZF+3mVHgEHq0KoZhlR5IcvF3ZJU5euEy1XmAUmLEjQ9J Yr6cvNyrtw/fczbLKyKUCdseJSkLbLERh6vu60Dh9XMSUvDog50XHo3U8NA9vpHTEexB To1aceN9agILl4ABYLU+P43CELDx7oHqWUiJZvQ17UnJXftVWhJ2lSkyFavsTs3/o9mE vKX1mGVP7Pd/UAIeoRcE3wB5KmpKe88mM/HMpv/ghXa+/5cjFXsgg9UnjFnP1D8eVX5+ /4QKD6Ca9v/iKZQG2qdSEMDUTTJ+mjUYq/6aS+YHsTzOdaej1unZ4jjiJRAXPBD/T6lo Ss+A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1728845256; x=1729450056; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=izfDyS+bmapVSfLYtSn4xLMYlKwDBm7aSJ/Y/fO7PVc=; b=p4z18/bA+xvq+EHQtXmLyDJCh9ky4/jFRXAQZEYyaGCo8HRVSbTi4WRhHuRVpbDkjr LHj4I48DEX5mAjzR40j/OIycl57+nSIY9nIBMNKBQPHwUWDeqvyryFtRZzbD0nhSHAcQ MEaJiFllDyAFdaFVg4btYfgSRcJ4J1LdlPptCQxVRRhjDJvY3Kxx+Iu4oqA0WRGQB3hl Az8dEikY3jJkfLh+RJvuM0krrCP+Xn3/rMkcK8Zzjg3eknxIkPkX19dzyMEBvrcelx/3 Q/u1mHuPVxSkkUepXoeijMqiCRZOEpTCrQGCwOVfyjlnBvUhOo5Ip7izQkkjnParV8Bj xbLQ== X-Gm-Message-State: AOJu0YyypFsLx3Sa11E9ZOGkGpm5YjZ4KByjRY69NvtE2/QdfFI4jpJ5 lhk7WldXLv2lvl+tGGj9jHRlAomMKN4pzdKHLJCpHTckYdOvpwbwv0JsnJgU1OEmRMyaT5lvJyC + X-Received: by 2002:a17:903:1d0:b0:20c:e262:2580 with SMTP id d9443c01a7336-20ce2622835mr28409195ad.44.1728845256268; Sun, 13 Oct 2024 11:47:36 -0700 (PDT) Received: from stoup.. (174-21-81-121.tukw.qwest.net. [174.21.81.121]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20c8c35522fsm52811805ad.296.2024.10.13.11.47.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 13 Oct 2024 11:47:35 -0700 (PDT) From: Richard Henderson To: qemu-devel@nongnu.org Cc: =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [PATCH v2 1/3] include/exec: Improve probe_access_full{, _mmu} documentation Date: Sun, 13 Oct 2024 11:47:31 -0700 Message-ID: <20241013184733.1423747-2-richard.henderson@linaro.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241013184733.1423747-1-richard.henderson@linaro.org> References: <20241013184733.1423747-1-richard.henderson@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::629; envelope-from=richard.henderson@linaro.org; helo=mail-pl1-x629.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org Suggested-by: Alex Bennée Signed-off-by: Richard Henderson Reviewed-by: Pierrick Bouvier Reviewed-by: Alex Bennée --- include/exec/exec-all.h | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/include/exec/exec-all.h b/include/exec/exec-all.h index 72240ef426..2e4c4cc4b4 100644 --- a/include/exec/exec-all.h +++ b/include/exec/exec-all.h @@ -368,6 +368,13 @@ int probe_access_flags(CPUArchState *env, vaddr addr, int size, * The CPUTLBEntryFull structure returned via @pfull is transient * and must be consumed or copied immediately, before any further * access or changes to TLB @mmu_idx. + * + * This function will not fault if @nonfault is set, but will + * return TLB_INVALID_MASK if the page is not mapped, or is not + * accessible with @access_type. + * + * This function will return TLB_MMIO in order to force the access + * to be handled out-of-line if plugins wish to instrument the access. */ int probe_access_full(CPUArchState *env, vaddr addr, int size, MMUAccessType access_type, int mmu_idx, @@ -375,22 +382,14 @@ int probe_access_full(CPUArchState *env, vaddr addr, int size, CPUTLBEntryFull **pfull, uintptr_t retaddr); /** - * probe_access_mmu() - Like probe_access_full except cannot fault and - * doesn't trigger instrumentation. + * probe_access_full_mmu: + * Like probe_access_full, except: * - * @env: CPUArchState - * @vaddr: virtual address to probe - * @size: size of the probe - * @access_type: read, write or execute permission - * @mmu_idx: softmmu index - * @phost: ptr to return value host address or NULL - * @pfull: ptr to return value CPUTLBEntryFull structure or NULL - * - * The CPUTLBEntryFull structure returned via @pfull is transient - * and must be consumed or copied immediately, before any further - * access or changes to TLB @mmu_idx. - * - * Returns: TLB flags as per probe_access_flags() + * This function is intended to be used for page table accesses by + * the target mmu itself. Since such page walking happens while + * handling another potential mmu fault, this function never raises + * exceptions (akin to @nonfault true for probe_access_full). + * Likewise this function does not trigger plugin instrumentation. */ int probe_access_full_mmu(CPUArchState *env, vaddr addr, int size, MMUAccessType access_type, int mmu_idx,