Received: by 2002:ac0:a582:0:0:0:0:0 with SMTP id m2-v6csp4551868imm; Mon, 15 Oct 2018 17:30:22 -0700 (PDT) X-Google-Smtp-Source: ACcGV60mZVgr8ScIn4L3cEjghsPZD3w2dXr7rsl3srQ9HJNDs7kyvoX9xWgaDXueUSdsdpFWFl47 X-Received: by 2002:a17:902:650f:: with SMTP id b15-v6mr16779372plk.2.1539649822487; Mon, 15 Oct 2018 17:30:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1539649822; cv=none; d=google.com; s=arc-20160816; b=0VVwndy8FIr8+kNDTywjJkiPhZTZXJirODNC5ib90QWNzylccMxYozHlDm0H/pW3Ak y+DYPLu/NWv/crwubnqNvN7thDmBNpS5PUDqD9+WV8iA9WGerflVyzZgVTLk5fTLATff cqTV+j6j8oHpXBZL/tMrb6LVpSPon9K0ljQxA6AS0OBtEbIU1tR+HlmACDQfVilZsiU6 bqqWu/SqfPUq/Y34CWY1P6W/bmCrr8ewXVWYSyjn7wfcZd7o9G0cP76V3O+nY33e5gPl apbrvj7bejtpehgkP9oD7MhgUH2Zuf3OudeD0PFHwgDiYWzVXkSKMc+a+7kt57Sy0DSX ZEKg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:message-id:date:subject:cc:to:from :dkim-signature; bh=fZgDi/Qyak1ImGdAU2taT9OzCFCADEzEbpIWXhHTErY=; b=WuZmGBu6eZs/BaQpXNJdLFINc8qj12E4ywO7/SZltQwEAZrX2mkRNZwIsUdfPQewvT Ar/YkF+ZSlNnM4RebG/GRX0D8HvP7WQbfvOZksNbJDG4Jo1x8V3r2s33hqZ29DBgXJmh J+FNtfkl0BCIQtumXQrN64RzzpyxmOCkDEGVllI3MLT9MUOUb2n9wkMuT2wY1SSK5oJb dN/zM+bHUfaWkmn7Y0pIoeiTOzNbGtzLbGoD1hsQVGXZzl88lMF8DKBiVoIZ8Yl5cv/5 LExrwC52IodxEfSecDXPVkMPuS2AusAMh4bTaJcsK6Q4CzoI84bcNvnBy1o0GoEhSoT+ TfpA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=qdR4gPn4; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id t62-v6si12549691pfd.133.2018.10.15.17.30.06; Mon, 15 Oct 2018 17:30:22 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=qdR4gPn4; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726959AbeJPIQJ (ORCPT + 99 others); Tue, 16 Oct 2018 04:16:09 -0400 Received: from mail-pf1-f195.google.com ([209.85.210.195]:39023 "EHLO mail-pf1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726681AbeJPIQJ (ORCPT ); Tue, 16 Oct 2018 04:16:09 -0400 Received: by mail-pf1-f195.google.com with SMTP id c25-v6so10509469pfe.6; Mon, 15 Oct 2018 17:28:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=fZgDi/Qyak1ImGdAU2taT9OzCFCADEzEbpIWXhHTErY=; b=qdR4gPn4Er8eY0c94Yh1LSz+Iy0QL9hZ8yfsuJCGtMW+Z+bP3XPM7/NG4hgN38XyU0 yq76UlvW4DeO/W6WkZKp0xWcBlRZqeMlrV78pqDRm8b2hItON++76VoDxaWH7ljBor3k znieIieJKb12hdBSzHjwGoblgpn8WDd8dQJnDON8qpZ2Ge1Cw5yNk8vomNnZa7lzUPI/ JJhO+QsnDnA4E62UOzzT/JxQQ/hmrg/kJv3jvhlX2r7RUm7HFnANGVMldu+cT3RHObxd +k/icpxkDn7AgrkgnACvoDy+lb+aEUKrkTuFUJle8UyY0OiHD93iLtc2rG8gG1bXocGd tUFA== 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; bh=fZgDi/Qyak1ImGdAU2taT9OzCFCADEzEbpIWXhHTErY=; b=Io/24qP2KwdImHOPQQhjK0kdwVujqQFEwt1x3XDaTWEj1a7ZslOH9JVTdEfIepM86/ D5XCMDYQR0nQk1SWSRGOIsBaLm7gdcD/tYg/nQB7Am26tgOdr18YQ/FeOohzBem6a91X CySpMMzQXy6NGBf6+qZdxkYZrNly8AKJXp8O88p9c6MRw+JANbxNptKFxwWNyJa8uuAM FYZurVmwCTXrTT+VhJ97k2wt9o7ykuR5jbVWRFjYKFvJm2smUwylm022vXfrT1PLhwek zU710ooh3CpOdPXH9IWp6y1VoyxMmlOSoetAMU1o7Al2bPzwxSPV/IEq5bXjIJyM3yJA 5wjQ== X-Gm-Message-State: ABuFfoh0UfviZJo0f+JhPDiwYv4y9gM5hCUczn2w0IPVK1L/cIMe38B+ 4MpgI+KkE9BZa1TndBuzgPZ1U1tn X-Received: by 2002:a63:65c7:: with SMTP id z190-v6mr18100055pgb.146.1539649707831; Mon, 15 Oct 2018 17:28:27 -0700 (PDT) Received: from localhost.localdomain (c-24-6-192-50.hsd1.ca.comcast.net. [24.6.192.50]) by smtp.gmail.com with ESMTPSA id k70-v6sm15510196pfc.76.2018.10.15.17.28.26 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 15 Oct 2018 17:28:27 -0700 (PDT) From: frowand.list@gmail.com To: Rob Herring , pantelis.antoniou@konsulko.com, Pantelis Antoniou Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, geert@linux-m68k.org, Alan Tull Subject: [PATCH v2] of: overlay: user space synchronization Date: Mon, 15 Oct 2018 17:27:01 -0700 Message-Id: <1539649621-5518-1-git-send-email-frowand.list@gmail.com> X-Mailer: git-send-email 1.9.1 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Frank Rowand When an overlay is applied or removed, the live devicetree visible in /proc/device-tree/, aka /sys/firmware/devicetree/base/, reflects the changes. There is no method for user space to determine whether the live devicetree was modified by overlay actions. Provide a sysfs file, /sys/firmware/devicetree/tree_version, to allow user space to determine if the live devicetree has remained unchanged while a series of one or more accesses of /proc/device-tree/ occur. The use of both dynamic devicetree modifications and overlay apply and removal are not supported during the same boot cycle. Thus non-overlay dynamic modifications are not reflected in the value of tree_version. Example shell use: done=1 while [ $done = 1 ] ; do pre_version=$(cat /sys/firmware/devicetree/tree_version) while [ $(( ${pre_version} & 1 )) != 0 ] ; do # echo is optional, sleep value can be tuned echo "${pre_version} locked, sleeping 2 seconds" sleep 2; pre_version=$(cat /sys/firmware/devicetree/tree_version) version=${pre_version} done # 'critical region' # access /proc/device-tree/ one or more times post_version=$(cat /sys/firmware/devicetree/tree_version) if [ ${post_version} = ${pre_version} ] ; then done=0 fi done Signed-off-by: Frank Rowand --- updates since v1: - removed unneeded variable "version" from shell script - explicitly state that an odd value of tree_version means the devicetree is locked for an overlay update not just in the source, but also in Documentation/ABI/testing/sysfs-firmware-ofw - document that tree_version is reported as an ascii number, the internal representation, and the resultant wrap around behavior Documentation/ABI/testing/sysfs-firmware-ofw | 67 +++++++++++++++++++++++++--- drivers/of/base.c | 66 +++++++++++++++++++++++++++ drivers/of/of_private.h | 2 + drivers/of/overlay.c | 12 +++++ 4 files changed, 140 insertions(+), 7 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-firmware-ofw b/Documentation/ABI/testing/sysfs-firmware-ofw index edcab3ccfcc0..d2346eb61924 100644 --- a/Documentation/ABI/testing/sysfs-firmware-ofw +++ b/Documentation/ABI/testing/sysfs-firmware-ofw @@ -1,4 +1,10 @@ -What: /sys/firmware/devicetree/* +What: /sys/firmware/devicetree/ +Date: November 2013 +Contact: Frank Rowand , devicetree@vger.kernel.org +Description: + Top level Open Firmware, aka devicetree, sysfs directory. + +What: /sys/firmware/devicetree/base Date: November 2013 Contact: Grant Likely , devicetree@vger.kernel.org Description: @@ -6,11 +12,6 @@ Description: hardware, the device tree structure will be exposed in this directory. - It is possible for multiple device-tree directories to exist. - Some device drivers use a separate detached device tree which - have no attachment to the system tree and will appear in a - different subdirectory under /sys/firmware/devicetree. - Userspace must not use the /sys/firmware/devicetree/base path directly, but instead should follow /proc/device-tree symlink. It is possible that the absolute path will change @@ -20,13 +21,65 @@ Description: filesystem support, and has largely the same semantics and should be compatible with existing userspace. - The contents of /sys/firmware/devicetree/ is a + The /sys/firmware/devicetree/base directory is the root + node of the devicetree. + + The contents of /sys/firmware/devicetree/base is a hierarchy of directories, one per device tree node. The directory name is the resolved path component name (node name plus address). Properties are represented as files in the directory. The contents of each file is the exact binary data from the device tree. +What: /sys/firmware/devicetree/tree_version +Date: October 2018 +KernelVersion: 4.20 +Contact: Frank Rowand , devicetree@vger.kernel.org +Description: + When an overlay is applied or removed, the live devicetree + visible in /proc/device-tree/, aka + /sys/firmware/devicetree/base/, reflects the changes. + + tree_version provides a way for user space to determine if the + live devicetree has remained unchanged while a series of one + or more accesses of /proc/device-tree/ occur. If tree_version + is odd then the devicetree is locked for an overlay update. + + The contents of tree_version is the ascii representation of + a kernel unsigned 32 bit int variable, thus when incremented + from 4294967295 it will wrap around to 0. + + The use of both dynamic devicetree modifications and overlay + apply and removal are not supported during the same boot + cycle. Thus non-overlay dynamic modifications are not + reflected in the value of tree_version. + + Example shell use of tree_version: + + done=1 + + while [ $done = 1 ] ; do + + pre_version=$(cat /sys/firmware/devicetree/tree_version) + while [ $(( ${pre_version} & 1 )) != 0 ] ; do + # echo is optional, sleep value can be tuned + echo "${pre_version} tree locked, sleeping 2 seconds" + sleep 2; + pre_version=$(cat /sys/firmware/devicetree/tree_version) + done + + # 'critical region' + # access /proc/device-tree/ one or more times + + post_version=$(cat /sys/firmware/devicetree/tree_version) + + if [ ${post_version} = ${pre_version} ] ; then + done=0 + fi + + done + + What: /sys/firmware/fdt Date: February 2015 KernelVersion: 3.19 diff --git a/drivers/of/base.c b/drivers/of/base.c index 466e3c8582f0..ec0428e47577 100644 --- a/drivers/of/base.c +++ b/drivers/of/base.c @@ -151,9 +151,71 @@ int of_free_phandle_cache(void) late_initcall_sync(of_free_phandle_cache); #endif +#define show_one(object) \ + static ssize_t show_##object \ + (struct kobject *kobj, struct attribute *attr, char *buf) \ + { \ + return sprintf(buf, "%u\n", object); \ + } + +struct global_attr { + struct attribute attr; + ssize_t (*show)(struct kobject *kobj, + struct attribute *attr, char *buf); + ssize_t (*store)(struct kobject *a, struct attribute *b, + const char *c, size_t count); +}; + +#define define_one_global_ro(_name) \ +static struct global_attr attr_##_name = \ +__ATTR(_name, 0444, show_##_name, NULL) + +/* + * tree_version must be unsigned so that at maximum value it wraps + * from an odd value (4294967295) to an even value (0). + */ +static u32 tree_version; + +show_one(tree_version); + +define_one_global_ro(tree_version); + +static struct attribute *of_attributes[] = { + &attr_tree_version.attr, + NULL +}; + +static const struct attribute_group of_attr_group = { + .attrs = of_attributes, +}; + +/* + * internal documentation + * tree_version_increment() - increment base version + * + * Before starting overlay apply or overlay remove, call this function. + * After completing overlay apply or overlay remove, call this function. + * + * caller must hold of_mutex + * + * Userspace can use the value of this variable to determine whether the + * devicetree has changed while accessing the devicetree. An odd value + * means a modification is underway. An even value means no modification + * is underway. + * + * The use of both (1) dynamic devicetree modifications and (2) overlay apply + * and removal are not supported during the same boot cycle. Thus non-overlay + * dynamic modifications are not reflected in the value of tree_version. + */ +void tree_version_increment(void) +{ + tree_version++; +} + void __init of_core_init(void) { struct device_node *np; + int ret; of_populate_phandle_cache(); @@ -172,6 +234,10 @@ void __init of_core_init(void) /* Symlink in /proc as required by userspace ABI */ if (of_root) proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base"); + + ret = sysfs_create_group(&of_kset->kobj, &of_attr_group); + if (ret) + pr_err("sysfs_create_group of_attr_group failed: %d\n", ret); } static struct property *__of_find_property(const struct device_node *np, diff --git a/drivers/of/of_private.h b/drivers/of/of_private.h index 216175d11d3d..adf89f6bad81 100644 --- a/drivers/of/of_private.h +++ b/drivers/of/of_private.h @@ -31,6 +31,8 @@ struct alias_prop { extern struct list_head aliases_lookup; extern struct kset *of_kset; +void tree_version_increment(void); + #if defined(CONFIG_OF_DYNAMIC) extern int of_property_notify(int action, struct device_node *np, struct property *prop, struct property *old_prop); diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c index eda57ef12fd0..53b1810b1e03 100644 --- a/drivers/of/overlay.c +++ b/drivers/of/overlay.c @@ -770,6 +770,9 @@ static int of_overlay_apply(const void *fdt, struct device_node *tree, of_overlay_mutex_lock(); mutex_lock(&of_mutex); + /* live tree may change after this point, user space synchronization */ + tree_version_increment(); + ret = of_resolve_phandles(tree); if (ret) goto err_free_tree; @@ -832,6 +835,9 @@ static int of_overlay_apply(const void *fdt, struct device_node *tree, free_overlay_changeset(ovcs); out_unlock: + /* live tree change complete, user space synchronization */ + tree_version_increment(); + mutex_unlock(&of_mutex); of_overlay_mutex_unlock(); @@ -1028,6 +1034,9 @@ int of_overlay_remove(int *ovcs_id) mutex_lock(&of_mutex); + /* live tree may change after this point, user space synchronization */ + tree_version_increment(); + ovcs = idr_find(&ovcs_idr, *ovcs_id); if (!ovcs) { ret = -ENODEV; @@ -1083,6 +1092,9 @@ int of_overlay_remove(int *ovcs_id) free_overlay_changeset(ovcs); out_unlock: + /* live tree change complete, user space synchronization */ + tree_version_increment(); + mutex_unlock(&of_mutex); out: -- Frank Rowand