Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Alan Maguire <alan.maguire@oracle.com>
To:     ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org
Cc:     kafai@fb.com, songliubraving@fb.com, yhs@fb.com,
        john.fastabend@gmail.com, kpsingh@kernel.org, morbo@google.com,
        shuah@kernel.org, bpf@vger.kernel.org, netdev@vger.kernel.org,
        linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org,
        Alan Maguire <alan.maguire@oracle.com>
Subject: [PATCH bpf-next] libbpf: clarify/fix unaligned data issues for btf typed dump
Date:   Fri, 16 Jul 2021 22:43:33 +0100
Message-Id: <1626471813-17736-1-git-send-email-alan.maguire@oracle.com>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
Received: from localhost.uk.oracle.com (95.45.14.174) by LNXP265CA0033.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:5c::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.21 via Frontend Transport; Fri, 16 Jul 2021 21:43:41 +0000
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-Correlation-Id: 57571b4b-9252-4270-85e0-08d948a2c7f5
X-MS-TrafficTypeDiagnostic: MN2PR10MB3728:
X-MS-Exchange-Transport-Forked: True
X-Microsoft-Antispam-PRVS: <MN2PR10MB3728FC9104E9A1E5FF610F92EF119@MN2PR10MB3728.namprd10.prod.outlook.com>
X-MS-Oob-TLC-OOBClassifiers: OLM:8273;
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: 67g6pZJ6AzkE/AH4DYc3Yn6Q6fJ/EhTB4O4ZvZu2JsEJFjVGq48jO2u3S9KIRj+wW65p2lMeFRtMnXYg4jVL7UFNnqFZs2TGD4wwda7Otoy5mStjEsdv75luQaCEpDIyUQdE79t3ygLq0SqSAqwxBL3kvqhlrYZtxsYtp1+QzK+xk2xD1mQx9y92GLnItlCArFc4jEvblvLKbzb6zPLHbE2hTZKT9BwF1PRpna3KXqVzlP3f3w/C60mMod12e/W+NqGcrZ2jKh3gXGGCwwL8/T4PxyPmsgH9TxD4IlcaiFWLiSh3eC7CUjJoOSGh6dUpLvguF6udeR6Ww88qZJgHDjp6X0tSkmv/M9Sat9T++WC9uo6v5pJFQpysMd2Ye1JO53tSBYr9cKVZQ21LDi5NCsHy9XO5hAVri5V1o3fKXFKLDsPduNWVa0gIKxOARr9CzYmkOfP0yj4RPis0V5x7K9MYhWVwWDosq2bc+YUfHSBX3wDkOQQri/bC9a0w+FSbDoj4CUdtlbfBL8A3RNQ4nVwHgFhfk0U6HyjyIZRPxpCdk9cmkl0vrLWbNuSx6P2jQQ1nfV9HUFzSyU6pA8kdDU3kSxS64VlzgxyJtfCM/5vgZSN3jLusuDBz29f/UyjWJ2zl/dvdOSWW3WhFGPMIh+es6+pPzywDVwNFSNPc7N9g+kRwJJQz4jQLj+NNxpSV5LUXGcfokde38mWRzjQXCg==
X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:BLAPR10MB5267.namprd10.prod.outlook.com;PTR:;CAT:NONE;SFS:(346002)(396003)(39860400002)(376002)(366004)(136003)(86362001)(107886003)(36756003)(6486002)(2906002)(316002)(26005)(44832011)(66476007)(4326008)(52116002)(478600001)(7696005)(66556008)(6666004)(8936002)(7416002)(83380400001)(38350700002)(5660300002)(2616005)(38100700002)(66946007)(8676002)(186003)(956004);DIR:OUT;SFP:1101;
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?KocBA6r97hC9CNBAKNdCmgN2LMn7Zy9mpV0NQOgdXwM0qWDiYoV/K7iLd+5u?=
 =?us-ascii?Q?tm1ss9AkcuBexodZCsOdPsiuy3a+D7ZEpqbBxt3B3pOJfcn1h1BPjQYipeMj?=
 =?us-ascii?Q?DDYB/N9je099O/uKFKfFQ8p8a70SSfJP0U3CWvYUyWZCyD65jIX8FLS1w5G1?=
 =?us-ascii?Q?Karr4GJ0d+i8/vsAdhVylhkf1sptWuacSNWHJrZbxatFlwrPXhOOGV6ahwJJ?=
 =?us-ascii?Q?rfy+qtekGPqPuOubpxxaEbNwW9f56ZYxZqHkL2m/BFWsv1sRzCFCknir96Uo?=
 =?us-ascii?Q?ctdcI1O+5AgULaZMYnMEtpIoOWksvnHiyYdm8t48DzMUHZG2wFWvRR8u3ahN?=
 =?us-ascii?Q?PyGlbi/j2d/ZZuMkU7eOU2MDHOnPfMfQtovUrnFTMV3OI3dCdM3Fzn7xQUNu?=
 =?us-ascii?Q?WsnYNj8xXWhGRaOZdF1nHVHVEUkzw4sh/KJCNilPjyZcdSAjTDL8sVwI35ur?=
 =?us-ascii?Q?axM097gN7fHX0Azdkmh5H4d8O3YiCFAPc5eyw4Lp4SxgRxMjWMZNDbZdR6IQ?=
 =?us-ascii?Q?eqjrvtDUu1g5jRqWr+blO+egXQmR9MyLUDXHy8Lx4P8cyuq6CHgr8tJGHKab?=
 =?us-ascii?Q?ksFztrg/7IDQscNp9m7UbRpFtiPsjM+uNJM0Iu/9fD6IV50VENxTM417/VAG?=
 =?us-ascii?Q?QGCYH/a4HEWCqA5rBIJU6GUutr9RfRCKoQXb1rcPjdRnKU+8YXz0Br4Pt6di?=
 =?us-ascii?Q?Xx04JwkZcDiNSTdIf0QkvSSayK8JN18vPPD2A5gr3CiqNSGHK6jzZ1MEbyky?=
 =?us-ascii?Q?sYMNoQv6slnp6z+umKIHHaIDeHWwPSYQ3PWJK7N/4i92aiwONWA/3bDQJvdW?=
 =?us-ascii?Q?9jkrL8dH+EkOTNwF/cCBSAlAepY/2V2gqFdoa6Z+TVvVhBEChn0p5SDE9Z04?=
 =?us-ascii?Q?TuaPZNv6fBr8WzEBOA/7hQOBk5OEN6I1BSPH7bn8/gWX1ZYZaw9GvszNvWn7?=
 =?us-ascii?Q?6yculVsBB6YN6EmWSEU3suDjQOifMOFlr61m9xg/OxlMMnJu7Roy16XpjPTf?=
 =?us-ascii?Q?ihA4PmhZXHQcNpLx/zS4/rp+Ni/iO51BgDHbk0K2eIkDwXyWgFeRXJuOtxIV?=
 =?us-ascii?Q?qaizES0uit2NxJ8R17E0SL6OiqatIMuwy1K9SDXyRIx0e+lwzqWM/3x70sy1?=
 =?us-ascii?Q?uzfnO7c9sQTotoLnBH7N50E6sRuFXKNi16zGqtNrkdr1nf90+fmTxUMT8AK4?=
 =?us-ascii?Q?r9pTjmotqWidUrCA0EIgdF2imFtnWT2mQX/Mo5V9uqDichgKOfix5Q48sPiR?=
 =?us-ascii?Q?cAwgcJlrKY+8nqZCyjcs6Wy59srqTlo3oUweuIDmih6xK9kwdTGeLRfNUKzW?=
 =?us-ascii?Q?CXXCwUTt95OI4iWDZIZpZW0z?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 57571b4b-9252-4270-85e0-08d948a2c7f5
X-MS-Exchange-CrossTenant-AuthSource: BLAPR10MB5267.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Jul 2021 21:43:42.8564
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 3HbuoJl8U/QkTa9rfqiJMnXRiiiVwifEis4J+NU81n8hbKrhSGdlKb7oz/mMeZOIK7551DSLYTLqZymGfiN51A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR10MB3728
X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=10047 signatures=668682
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 mlxscore=0 phishscore=0
 suspectscore=0 malwarescore=0 mlxlogscore=999 adultscore=0 bulkscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2104190000
 definitions=main-2107160137
X-Proofpoint-GUID: 0Lnnayhc4bBK6eGj8G0hgT0cn3G3q9m4
X-Proofpoint-ORIG-GUID: 0Lnnayhc4bBK6eGj8G0hgT0cn3G3q9m4
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

If data is packed, data structures can store it outside of usual
boundaries.  For example a 4-byte int can be stored on a unaligned
boundary in a case like this:

struct s {
	char f1;
	int f2;
} __attribute((packed));

...the int is stored at an offset of one byte.  Some platforms have
problems dereferencing data that is not aligned with its size, and
code exists to handle most cases of this for BTF typed data display.
However pointer display was missed, and a simple macro to test if
"data_is_unaligned(data, data_sz)" would help clarify this code.

Suggested-by: Andrii Nakryiko <andrii@kernel.org>
Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
---
 tools/lib/bpf/btf_dump.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/tools/lib/bpf/btf_dump.c b/tools/lib/bpf/btf_dump.c
index 929cf93..9dfe9c1 100644
--- a/tools/lib/bpf/btf_dump.c
+++ b/tools/lib/bpf/btf_dump.c
@@ -1654,6 +1654,8 @@ static int btf_dump_base_type_check_zero(struct btf_dump *d,
 	return 0;
 }
 
+#define data_is_unaligned(data, data_sz)	(((uintptr_t)data) % data_sz)
+
 static int btf_dump_int_data(struct btf_dump *d,
 			     const struct btf_type *t,
 			     __u32 type_id,
@@ -1672,7 +1674,7 @@ static int btf_dump_int_data(struct btf_dump *d,
 	/* handle packed int data - accesses of integers not aligned on
 	 * int boundaries can cause problems on some platforms.
 	 */
-	if (((uintptr_t)data) % sz)
+	if (data_is_unaligned(data, sz))
 		return btf_dump_bitfield_data(d, t, data, 0, 0);
 
 	switch (sz) {
@@ -1739,7 +1741,7 @@ static int btf_dump_float_data(struct btf_dump *d,
 	int sz = t->size;
 
 	/* handle unaligned data; copy to local union */
-	if (((uintptr_t)data) % sz) {
+	if (data_is_unaligned(data, sz)) {
 		memcpy(&fl, data, sz);
 		flp = &fl;
 	}
@@ -1897,7 +1899,10 @@ static int btf_dump_ptr_data(struct btf_dump *d,
 			      __u32 id,
 			      const void *data)
 {
-	btf_dump_type_values(d, "%p", *(void **)data);
+	void *ptrval;
+
+	memcpy(&ptrval, data, d->ptr_sz);
+	btf_dump_type_values(d, "%p", ptrval);
 	return 0;
 }
 
@@ -1910,7 +1915,7 @@ static int btf_dump_get_enum_value(struct btf_dump *d,
 	int sz = t->size;
 
 	/* handle unaligned enum value */
-	if (((uintptr_t)data) % sz) {
+	if (data_is_unaligned(data, sz)) {
 		*value = (__s64)btf_dump_bitfield_get_data(d, t, data, 0, 0);
 		return 0;
 	}
-- 
1.8.3.1