diff options
| author | Simon McVittie <smcv@collabora.com> | 2020-06-30 19:13:17 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@collabora.com> | 2020-07-02 10:08:45 +0100 |
| commit | 37b36d49a67b0aee09051f5f76d33f69b67709ab (patch) | |
| tree | 6db60fea9e6c0e8ddabdc0829cfc3625b7b00800 | |
| parent | 732284d5302c19026356b82d8f39e70cf5fe7725 (diff) | |
| download | dbus-37b36d49a67b0aee09051f5f76d33f69b67709ab.tar.gz dbus-37b36d49a67b0aee09051f5f76d33f69b67709ab.tar.bz2 dbus-37b36d49a67b0aee09051f5f76d33f69b67709ab.zip | |
userdb: Make lookups return a const pointer
This makes it more obvious that the returned pointer points to a
struct owned by the userdb, which must not be freed or have its
contents modified, and is only valid to dereference until the next
modification to the userdb's underlying hash tables (which in practice
means until the lock is released, because after that we have no
guarantees about what might be going on in another thread).
Signed-off-by: Simon McVittie <smcv@collabora.com>
(cherry picked from commit 6ee66ff7bcc91803111d950512f02651e664f74f)
| -rw-r--r-- | dbus/dbus-userdb-util.c | 6 | ||||
| -rw-r--r-- | dbus/dbus-userdb.c | 6 | ||||
| -rw-r--r-- | dbus/dbus-userdb.h | 10 |
3 files changed, 13 insertions, 9 deletions
diff --git a/dbus/dbus-userdb-util.c b/dbus/dbus-userdb-util.c index 44a1a78c..af880ed0 100644 --- a/dbus/dbus-userdb-util.c +++ b/dbus/dbus-userdb-util.c @@ -240,9 +240,9 @@ _dbus_get_user_id_and_primary_group (const DBusString *username, * @param gid the group ID or #DBUS_GID_UNSET * @param groupname group name or #NULL * @param error error to fill in - * @returns the entry in the database + * @returns the entry in the database (borrowed, do not free) */ -DBusGroupInfo* +const DBusGroupInfo * _dbus_user_database_lookup_group (DBusUserDatabase *db, dbus_gid_t gid, const DBusString *groupname, @@ -328,6 +328,8 @@ _dbus_user_database_lookup_group (DBusUserDatabase *db, return NULL; } + /* Return a borrowed reference to the DBusGroupInfo owned by the + * two hash tables */ return info; } } diff --git a/dbus/dbus-userdb.c b/dbus/dbus-userdb.c index 4c42b7dd..223eaae6 100644 --- a/dbus/dbus-userdb.c +++ b/dbus/dbus-userdb.c @@ -122,9 +122,9 @@ _dbus_is_a_number (const DBusString *str, * @param uid the user ID or #DBUS_UID_UNSET * @param username username or #NULL * @param error error to fill in - * @returns the entry in the database + * @returns the entry in the database (borrowed, do not free) */ -DBusUserInfo* +const DBusUserInfo * _dbus_user_database_lookup (DBusUserDatabase *db, dbus_uid_t uid, const DBusString *username, @@ -211,6 +211,8 @@ _dbus_user_database_lookup (DBusUserDatabase *db, return NULL; } + /* Return a borrowed pointer to the DBusUserInfo owned by the + * hash tables */ return info; } } diff --git a/dbus/dbus-userdb.h b/dbus/dbus-userdb.h index 53fc90b5..9e9ed88a 100644 --- a/dbus/dbus-userdb.h +++ b/dbus/dbus-userdb.h @@ -76,15 +76,15 @@ dbus_bool_t _dbus_user_database_get_groupname (DBusUserDatabase *db, DBusError *error); DBUS_PRIVATE_EXPORT -DBusUserInfo* _dbus_user_database_lookup (DBusUserDatabase *db, +const DBusUserInfo *_dbus_user_database_lookup (DBusUserDatabase *db, dbus_uid_t uid, const DBusString *username, DBusError *error); DBUS_PRIVATE_EXPORT -DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db, - dbus_gid_t gid, - const DBusString *groupname, - DBusError *error); +const DBusGroupInfo* _dbus_user_database_lookup_group (DBusUserDatabase *db, + dbus_gid_t gid, + const DBusString *groupname, + DBusError *error); DBUS_PRIVATE_EXPORT void _dbus_user_info_free_allocated (DBusUserInfo *info); DBUS_PRIVATE_EXPORT |