1 /*-------------------------------------------------------------------------
4 * routines to support manipulation of the pg_shdepend relation
6 * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $PostgreSQL: pgsql/src/backend/catalog/pg_shdepend.c,v 1.28 2008/05/12 00:00:47 alvherre Exp $
13 *-------------------------------------------------------------------------
17 #include "access/genam.h"
18 #include "access/heapam.h"
19 #include "access/xact.h"
20 #include "catalog/catalog.h"
21 #include "catalog/dependency.h"
22 #include "catalog/indexing.h"
23 #include "catalog/pg_authid.h"
24 #include "catalog/pg_conversion.h"
25 #include "catalog/pg_database.h"
26 #include "catalog/pg_language.h"
27 #include "catalog/pg_namespace.h"
28 #include "catalog/pg_operator.h"
29 #include "catalog/pg_proc.h"
30 #include "catalog/pg_shdepend.h"
31 #include "catalog/pg_tablespace.h"
32 #include "catalog/pg_type.h"
33 #include "commands/conversioncmds.h"
34 #include "commands/defrem.h"
35 #include "commands/proclang.h"
36 #include "commands/schemacmds.h"
37 #include "commands/tablecmds.h"
38 #include "commands/typecmds.h"
39 #include "storage/lmgr.h"
40 #include "miscadmin.h"
41 #include "utils/acl.h"
42 #include "utils/fmgroids.h"
43 #include "utils/syscache.h"
44 #include "utils/tqual.h"
54 static int getOidListDiff(Oid *list1, int nlist1, Oid *list2, int nlist2,
56 static Oid classIdGetDbId(Oid classId);
57 static void shdepLockAndCheckObject(Oid classId, Oid objectId);
58 static void shdepChangeDep(Relation sdepRel, Oid classid, Oid objid,
59 Oid refclassid, Oid refobjid,
60 SharedDependencyType deptype);
61 static void shdepAddDependency(Relation sdepRel, Oid classId, Oid objectId,
62 Oid refclassId, Oid refobjId,
63 SharedDependencyType deptype);
64 static void shdepDropDependency(Relation sdepRel, Oid classId, Oid objectId,
65 Oid refclassId, Oid refobjId,
66 SharedDependencyType deptype);
67 static void storeObjectDescription(StringInfo descs, objectType type,
68 ObjectAddress *object,
69 SharedDependencyType deptype,
71 static bool isSharedObjectPinned(Oid classId, Oid objectId, Relation sdepRel);
75 * recordSharedDependencyOn
77 * Record a dependency between 2 objects via their respective ObjectAddresses.
78 * The first argument is the dependent object, the second the one it
79 * references (which must be a shared object).
81 * This locks the referenced object and makes sure it still exists.
82 * Then it creates an entry in pg_shdepend. The lock is kept until
83 * the end of the transaction.
85 * Dependencies on pinned objects are not recorded.
88 recordSharedDependencyOn(ObjectAddress *depender,
89 ObjectAddress *referenced,
90 SharedDependencyType deptype)
95 * Objects in pg_shdepend can't have SubIds.
97 Assert(depender->objectSubId == 0);
98 Assert(referenced->objectSubId == 0);
101 * During bootstrap, do nothing since pg_shdepend may not exist yet.
102 * initdb will fill in appropriate pg_shdepend entries after bootstrap.
104 if (IsBootstrapProcessingMode())
107 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
109 /* If the referenced object is pinned, do nothing. */
110 if (!isSharedObjectPinned(referenced->classId, referenced->objectId,
113 shdepAddDependency(sdepRel, depender->classId, depender->objectId,
114 referenced->classId, referenced->objectId,
118 heap_close(sdepRel, RowExclusiveLock);
122 * recordDependencyOnOwner
124 * A convenient wrapper of recordSharedDependencyOn -- register the specified
125 * user as owner of the given object.
127 * Note: it's the caller's responsibility to ensure that there isn't an owner
128 * entry for the object already.
131 recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
133 ObjectAddress myself,
136 myself.classId = classId;
137 myself.objectId = objectId;
138 myself.objectSubId = 0;
140 referenced.classId = AuthIdRelationId;
141 referenced.objectId = owner;
142 referenced.objectSubId = 0;
144 recordSharedDependencyOn(&myself, &referenced, SHARED_DEPENDENCY_OWNER);
150 * Update shared dependency records to account for an updated referenced
151 * object. This is an internal workhorse for operations such as changing
154 * There must be no more than one existing entry for the given dependent
155 * object and dependency type! So in practice this can only be used for
156 * updating SHARED_DEPENDENCY_OWNER entries, which should have that property.
158 * If there is no previous entry, we assume it was referencing a PINned
159 * object, so we create a new entry. If the new referenced object is
160 * PINned, we don't create an entry (and drop the old one, if any).
162 * sdepRel must be the pg_shdepend relation, already opened and suitably
166 shdepChangeDep(Relation sdepRel, Oid classid, Oid objid,
167 Oid refclassid, Oid refobjid,
168 SharedDependencyType deptype)
170 Oid dbid = classIdGetDbId(classid);
171 HeapTuple oldtup = NULL;
177 * Make sure the new referenced object doesn't go away while we record the
180 shdepLockAndCheckObject(refclassid, refobjid);
183 * Look for a previous entry
186 Anum_pg_shdepend_dbid,
187 BTEqualStrategyNumber, F_OIDEQ,
188 ObjectIdGetDatum(dbid));
190 Anum_pg_shdepend_classid,
191 BTEqualStrategyNumber, F_OIDEQ,
192 ObjectIdGetDatum(classid));
194 Anum_pg_shdepend_objid,
195 BTEqualStrategyNumber, F_OIDEQ,
196 ObjectIdGetDatum(objid));
198 scan = systable_beginscan(sdepRel, SharedDependDependerIndexId, true,
199 SnapshotNow, 3, key);
201 while ((scantup = systable_getnext(scan)) != NULL)
203 /* Ignore if not of the target dependency type */
204 if (((Form_pg_shdepend) GETSTRUCT(scantup))->deptype != deptype)
206 /* Caller screwed up if multiple matches */
209 "multiple pg_shdepend entries for object %u/%u deptype %c",
210 classid, objid, deptype);
211 oldtup = heap_copytuple(scantup);
214 systable_endscan(scan);
216 if (isSharedObjectPinned(refclassid, refobjid, sdepRel))
218 /* No new entry needed, so just delete existing entry if any */
220 simple_heap_delete(sdepRel, &oldtup->t_self);
224 /* Need to update existing entry */
225 Form_pg_shdepend shForm = (Form_pg_shdepend) GETSTRUCT(oldtup);
227 /* Since oldtup is a copy, we can just modify it in-memory */
228 shForm->refclassid = refclassid;
229 shForm->refobjid = refobjid;
231 simple_heap_update(sdepRel, &oldtup->t_self, oldtup);
233 /* keep indexes current */
234 CatalogUpdateIndexes(sdepRel, oldtup);
238 /* Need to insert new entry */
239 Datum values[Natts_pg_shdepend];
240 bool nulls[Natts_pg_shdepend];
242 memset(nulls, 0, sizeof(nulls));
244 values[Anum_pg_shdepend_dbid - 1] = ObjectIdGetDatum(dbid);
245 values[Anum_pg_shdepend_classid - 1] = ObjectIdGetDatum(classid);
246 values[Anum_pg_shdepend_objid - 1] = ObjectIdGetDatum(objid);
248 values[Anum_pg_shdepend_refclassid - 1] = ObjectIdGetDatum(refclassid);
249 values[Anum_pg_shdepend_refobjid - 1] = ObjectIdGetDatum(refobjid);
250 values[Anum_pg_shdepend_deptype - 1] = CharGetDatum(deptype);
253 * we are reusing oldtup just to avoid declaring a new variable, but
254 * it's certainly a new tuple
256 oldtup = heap_form_tuple(RelationGetDescr(sdepRel), values, nulls);
257 simple_heap_insert(sdepRel, oldtup);
259 /* keep indexes current */
260 CatalogUpdateIndexes(sdepRel, oldtup);
264 heap_freetuple(oldtup);
268 * changeDependencyOnOwner
270 * Update the shared dependencies to account for the new owner.
273 changeDependencyOnOwner(Oid classId, Oid objectId, Oid newOwnerId)
277 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
279 /* Adjust the SHARED_DEPENDENCY_OWNER entry */
280 shdepChangeDep(sdepRel, classId, objectId,
281 AuthIdRelationId, newOwnerId,
282 SHARED_DEPENDENCY_OWNER);
285 * There should never be a SHARED_DEPENDENCY_ACL entry for the owner,
286 * so get rid of it if there is one. This can happen if the new owner
287 * was previously granted some rights to the object.
289 * This step is analogous to aclnewowner's removal of duplicate entries
290 * in the ACL. We have to do it to handle this scenario:
291 * A grants some rights on an object to B
292 * ALTER OWNER changes the object's owner to B
293 * ALTER OWNER changes the object's owner to C
294 * The third step would remove all mention of B from the object's ACL,
295 * but we'd still have a SHARED_DEPENDENCY_ACL for B if we did not do
298 * The rule against having a SHARED_DEPENDENCY_ACL entry for the owner
299 * allows us to fix things up in just this one place, without having
300 * to make the various ALTER OWNER routines each know about it.
303 shdepDropDependency(sdepRel, classId, objectId,
304 AuthIdRelationId, newOwnerId,
305 SHARED_DEPENDENCY_ACL);
307 heap_close(sdepRel, RowExclusiveLock);
312 * Helper for updateAclDependencies.
314 * Takes two Oid arrays and returns elements from the first not found in the
315 * second. We assume both arrays are sorted and de-duped, and that the
316 * second array does not contain any values not found in the first.
318 * NOTE: Both input arrays are pfreed.
321 getOidListDiff(Oid *list1, int nlist1, Oid *list2, int nlist2, Oid **diff)
328 AssertArg(nlist1 >= nlist2 && nlist2 >= 0);
330 result = palloc(sizeof(Oid) * (nlist1 - nlist2));
333 for (i = 0, j = 0; i < nlist1 && j < nlist2;)
335 if (list1[i] == list2[j])
340 else if (list1[i] < list2[j])
342 result[k++] = list1[i];
348 elog(WARNING, "invalid element %u in shorter list", list2[j]);
353 for (; i < nlist1; i++)
354 result[k++] = list1[i];
356 /* We should have copied the exact number of elements */
357 AssertState(k == (nlist1 - nlist2));
368 * updateAclDependencies
369 * Update the pg_shdepend info for an object's ACL during GRANT/REVOKE.
371 * classId, objectId: identify the object whose ACL this is
372 * ownerId: role owning the object
373 * isGrant: are we adding or removing ACL entries?
374 * noldmembers, oldmembers: array of roleids appearing in old ACL
375 * nnewmembers, newmembers: array of roleids appearing in new ACL
377 * We calculate the difference between the new and old lists of roles,
378 * and then insert (if it's a grant) or delete (if it's a revoke) from
379 * pg_shdepend as appropiate.
381 * Note that we can't insert blindly at grant, because we would end up with
382 * duplicate registered dependencies. We could check for existence of the
383 * tuple before inserting, but that seems to be more expensive than what we are
384 * doing now. On the other hand, we can't just delete the tuples blindly at
385 * revoke, because the user may still have other privileges.
387 * NOTE: Both input arrays must be sorted and de-duped. They are pfreed
391 updateAclDependencies(Oid classId, Oid objectId, Oid ownerId, bool isGrant,
392 int noldmembers, Oid *oldmembers,
393 int nnewmembers, Oid *newmembers)
401 * Calculate the differences between the old and new lists.
404 ndiff = getOidListDiff(newmembers, nnewmembers,
405 oldmembers, noldmembers, &diff);
407 ndiff = getOidListDiff(oldmembers, noldmembers,
408 newmembers, nnewmembers, &diff);
412 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
414 /* Add or drop the respective dependency */
415 for (i = 0; i < ndiff; i++)
417 Oid roleid = diff[i];
420 * Skip the owner: he has an OWNER shdep entry instead. (This is
421 * not just a space optimization; it makes ALTER OWNER easier. See
422 * notes in changeDependencyOnOwner.)
424 if (roleid == ownerId)
427 /* Skip pinned roles */
428 if (isSharedObjectPinned(AuthIdRelationId, roleid, sdepRel))
432 shdepAddDependency(sdepRel, classId, objectId,
433 AuthIdRelationId, roleid,
434 SHARED_DEPENDENCY_ACL);
436 shdepDropDependency(sdepRel, classId, objectId,
437 AuthIdRelationId, roleid,
438 SHARED_DEPENDENCY_ACL);
441 heap_close(sdepRel, RowExclusiveLock);
448 * A struct to keep track of dependencies found in other databases.
457 * checkSharedDependencies
459 * Check whether there are shared dependency entries for a given shared
460 * object; return true if so.
462 * In addition, return a string containing a newline-separated list of object
463 * descriptions that depend on the shared object, or NULL if none is found.
464 * We actually return two such strings; the "detail" result is suitable for
465 * returning to the client as an errdetail() string, and is limited in size.
466 * The "detail_log" string is potentially much longer, and should be emitted
467 * to the server log only.
469 * We can find three different kinds of dependencies: dependencies on objects
470 * of the current database; dependencies on shared objects; and dependencies
471 * on objects local to other databases. We can (and do) provide descriptions
472 * of the two former kinds of objects, but we can't do that for "remote"
473 * objects, so we just provide a count of them.
475 * If we find a SHARED_DEPENDENCY_PIN entry, we can error out early.
478 checkSharedDependencies(Oid classId, Oid objectId,
479 char **detail_msg, char **detail_log_msg)
485 int numReportedDeps = 0;
486 int numNotReportedDeps = 0;
487 int numNotReportedDbs = 0;
490 ObjectAddress object;
491 StringInfoData descs;
492 StringInfoData alldescs;
495 * We limit the number of dependencies reported to the client to
496 * MAX_REPORTED_DEPS, since client software may not deal well with
497 * enormous error strings. The server log always gets a full report.
499 #define MAX_REPORTED_DEPS 100
501 initStringInfo(&descs);
502 initStringInfo(&alldescs);
504 sdepRel = heap_open(SharedDependRelationId, AccessShareLock);
507 Anum_pg_shdepend_refclassid,
508 BTEqualStrategyNumber, F_OIDEQ,
509 ObjectIdGetDatum(classId));
511 Anum_pg_shdepend_refobjid,
512 BTEqualStrategyNumber, F_OIDEQ,
513 ObjectIdGetDatum(objectId));
515 scan = systable_beginscan(sdepRel, SharedDependReferenceIndexId, true,
516 SnapshotNow, 2, key);
518 while (HeapTupleIsValid(tup = systable_getnext(scan)))
520 Form_pg_shdepend sdepForm = (Form_pg_shdepend) GETSTRUCT(tup);
522 /* This case can be dispatched quickly */
523 if (sdepForm->deptype == SHARED_DEPENDENCY_PIN)
525 object.classId = classId;
526 object.objectId = objectId;
527 object.objectSubId = 0;
529 (errcode(ERRCODE_DEPENDENT_OBJECTS_STILL_EXIST),
530 errmsg("cannot drop %s because it is required by the database system",
531 getObjectDescription(&object))));
534 object.classId = sdepForm->classid;
535 object.objectId = sdepForm->objid;
536 object.objectSubId = 0;
539 * If it's a dependency local to this database or it's a shared
540 * object, describe it.
542 * If it's a remote dependency, keep track of it so we can report the
543 * number of them later.
545 if (sdepForm->dbid == MyDatabaseId)
547 if (numReportedDeps < MAX_REPORTED_DEPS)
550 storeObjectDescription(&descs, LOCAL_OBJECT, &object,
551 sdepForm->deptype, 0);
554 numNotReportedDeps++;
555 storeObjectDescription(&alldescs, LOCAL_OBJECT, &object,
556 sdepForm->deptype, 0);
558 else if (sdepForm->dbid == InvalidOid)
560 if (numReportedDeps < MAX_REPORTED_DEPS)
563 storeObjectDescription(&descs, SHARED_OBJECT, &object,
564 sdepForm->deptype, 0);
567 numNotReportedDeps++;
568 storeObjectDescription(&alldescs, SHARED_OBJECT, &object,
569 sdepForm->deptype, 0);
573 /* It's not local nor shared, so it must be remote. */
578 * XXX this info is kept on a simple List. Maybe it's not good
579 * for performance, but using a hash table seems needlessly
580 * complex. The expected number of databases is not high anyway,
583 foreach(cell, remDeps)
586 if (dep->dbOid == sdepForm->dbid)
595 dep = (remoteDep *) palloc(sizeof(remoteDep));
596 dep->dbOid = sdepForm->dbid;
598 remDeps = lappend(remDeps, dep);
603 systable_endscan(scan);
605 heap_close(sdepRel, AccessShareLock);
608 * Summarize dependencies in remote databases.
610 foreach(cell, remDeps)
612 remoteDep *dep = lfirst(cell);
614 object.classId = DatabaseRelationId;
615 object.objectId = dep->dbOid;
616 object.objectSubId = 0;
618 if (numReportedDeps < MAX_REPORTED_DEPS)
621 storeObjectDescription(&descs, REMOTE_OBJECT, &object,
622 SHARED_DEPENDENCY_INVALID, dep->count);
626 storeObjectDescription(&alldescs, REMOTE_OBJECT, &object,
627 SHARED_DEPENDENCY_INVALID, dep->count);
630 list_free_deep(remDeps);
635 pfree(alldescs.data);
636 *detail_msg = *detail_log_msg = NULL;
640 if (numNotReportedDeps > 0)
641 appendStringInfo(&descs, _("\nand %d other objects "
642 "(see server log for list)"),
644 if (numNotReportedDbs > 0)
645 appendStringInfo(&descs, _("\nand objects in %d other databases "
646 "(see server log for list)"),
649 *detail_msg = descs.data;
650 *detail_log_msg = alldescs.data;
655 * copyTemplateDependencies
657 * Routine to create the initial shared dependencies of a new database.
658 * We simply copy the dependencies from the template database.
661 copyTemplateDependencies(Oid templateDbId, Oid newDbId)
668 CatalogIndexState indstate;
669 Datum values[Natts_pg_shdepend];
670 bool nulls[Natts_pg_shdepend];
671 bool replace[Natts_pg_shdepend];
673 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
674 sdepDesc = RelationGetDescr(sdepRel);
676 indstate = CatalogOpenIndexes(sdepRel);
678 /* Scan all entries with dbid = templateDbId */
680 Anum_pg_shdepend_dbid,
681 BTEqualStrategyNumber, F_OIDEQ,
682 ObjectIdGetDatum(templateDbId));
684 scan = systable_beginscan(sdepRel, SharedDependDependerIndexId, true,
685 SnapshotNow, 1, key);
687 /* Set up to copy the tuples except for inserting newDbId */
688 memset(values, 0, sizeof(values));
689 memset(nulls, false, sizeof(nulls));
690 memset(replace, false, sizeof(replace));
692 replace[Anum_pg_shdepend_dbid - 1] = true;
693 values[Anum_pg_shdepend_dbid - 1] = ObjectIdGetDatum(newDbId);
696 * Copy the entries of the original database, changing the database Id to
697 * that of the new database. Note that because we are not copying rows
698 * with dbId == 0 (ie, rows describing dependent shared objects) we won't
699 * copy the ownership dependency of the template database itself; this is
702 while (HeapTupleIsValid(tup = systable_getnext(scan)))
706 newtup = heap_modify_tuple(tup, sdepDesc, values, nulls, replace);
707 simple_heap_insert(sdepRel, newtup);
709 /* Keep indexes current */
710 CatalogIndexInsert(indstate, newtup);
712 heap_freetuple(newtup);
715 systable_endscan(scan);
717 CatalogCloseIndexes(indstate);
718 heap_close(sdepRel, RowExclusiveLock);
722 * dropDatabaseDependencies
724 * Delete pg_shdepend entries corresponding to a database that's being
728 dropDatabaseDependencies(Oid databaseId)
735 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
738 * First, delete all the entries that have the database Oid in the dbid
742 Anum_pg_shdepend_dbid,
743 BTEqualStrategyNumber, F_OIDEQ,
744 ObjectIdGetDatum(databaseId));
745 /* We leave the other index fields unspecified */
747 scan = systable_beginscan(sdepRel, SharedDependDependerIndexId, true,
748 SnapshotNow, 1, key);
750 while (HeapTupleIsValid(tup = systable_getnext(scan)))
752 simple_heap_delete(sdepRel, &tup->t_self);
755 systable_endscan(scan);
757 /* Now delete all entries corresponding to the database itself */
758 shdepDropDependency(sdepRel, DatabaseRelationId, databaseId,
759 InvalidOid, InvalidOid,
760 SHARED_DEPENDENCY_INVALID);
762 heap_close(sdepRel, RowExclusiveLock);
766 * deleteSharedDependencyRecordsFor
768 * Delete all pg_shdepend entries corresponding to an object that's being
769 * dropped or modified. The object is assumed to be either a shared object
770 * or local to the current database (the classId tells us which).
773 deleteSharedDependencyRecordsFor(Oid classId, Oid objectId)
777 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
779 shdepDropDependency(sdepRel, classId, objectId,
780 InvalidOid, InvalidOid,
781 SHARED_DEPENDENCY_INVALID);
783 heap_close(sdepRel, RowExclusiveLock);
788 * Internal workhorse for inserting into pg_shdepend
790 * sdepRel must be the pg_shdepend relation, already opened and suitably
794 shdepAddDependency(Relation sdepRel, Oid classId, Oid objectId,
795 Oid refclassId, Oid refobjId,
796 SharedDependencyType deptype)
799 Datum values[Natts_pg_shdepend];
800 bool nulls[Natts_pg_shdepend];
803 * Make sure the object doesn't go away while we record the dependency on
804 * it. DROP routines should lock the object exclusively before they check
805 * shared dependencies.
807 shdepLockAndCheckObject(refclassId, refobjId);
809 memset(nulls, false, sizeof(nulls));
812 * Form the new tuple and record the dependency.
814 values[Anum_pg_shdepend_dbid - 1] = ObjectIdGetDatum(classIdGetDbId(classId));
815 values[Anum_pg_shdepend_classid - 1] = ObjectIdGetDatum(classId);
816 values[Anum_pg_shdepend_objid - 1] = ObjectIdGetDatum(objectId);
818 values[Anum_pg_shdepend_refclassid - 1] = ObjectIdGetDatum(refclassId);
819 values[Anum_pg_shdepend_refobjid - 1] = ObjectIdGetDatum(refobjId);
820 values[Anum_pg_shdepend_deptype - 1] = CharGetDatum(deptype);
822 tup = heap_form_tuple(sdepRel->rd_att, values, nulls);
824 simple_heap_insert(sdepRel, tup);
826 /* keep indexes current */
827 CatalogUpdateIndexes(sdepRel, tup);
834 * shdepDropDependency
835 * Internal workhorse for deleting entries from pg_shdepend.
837 * We drop entries having the following properties:
838 * dependent object is the one identified by classId/objectId
839 * if refclassId isn't InvalidOid, it must match the entry's refclassid
840 * if refobjId isn't InvalidOid, it must match the entry's refobjid
841 * if deptype isn't SHARED_DEPENDENCY_INVALID, it must match entry's deptype
843 * sdepRel must be the pg_shdepend relation, already opened and suitably
847 shdepDropDependency(Relation sdepRel, Oid classId, Oid objectId,
848 Oid refclassId, Oid refobjId,
849 SharedDependencyType deptype)
855 /* Scan for entries matching the dependent object */
857 Anum_pg_shdepend_dbid,
858 BTEqualStrategyNumber, F_OIDEQ,
859 ObjectIdGetDatum(classIdGetDbId(classId)));
861 Anum_pg_shdepend_classid,
862 BTEqualStrategyNumber, F_OIDEQ,
863 ObjectIdGetDatum(classId));
865 Anum_pg_shdepend_objid,
866 BTEqualStrategyNumber, F_OIDEQ,
867 ObjectIdGetDatum(objectId));
869 scan = systable_beginscan(sdepRel, SharedDependDependerIndexId, true,
870 SnapshotNow, 3, key);
872 while (HeapTupleIsValid(tup = systable_getnext(scan)))
874 Form_pg_shdepend shdepForm = (Form_pg_shdepend) GETSTRUCT(tup);
876 /* Filter entries according to additional parameters */
877 if (OidIsValid(refclassId) && shdepForm->refclassid != refclassId)
879 if (OidIsValid(refobjId) && shdepForm->refobjid != refobjId)
881 if (deptype != SHARED_DEPENDENCY_INVALID &&
882 shdepForm->deptype != deptype)
886 simple_heap_delete(sdepRel, &tup->t_self);
889 systable_endscan(scan);
895 * Get the database Id that should be used in pg_shdepend, given the OID
896 * of the catalog containing the object. For shared objects, it's 0
897 * (InvalidOid); for all other objects, it's the current database Id.
900 classIdGetDbId(Oid classId)
904 if (IsSharedRelation(classId))
913 * shdepLockAndCheckObject
915 * Lock the object that we are about to record a dependency on.
916 * After it's locked, verify that it hasn't been dropped while we
917 * weren't looking. If the object has been dropped, this function
921 shdepLockAndCheckObject(Oid classId, Oid objectId)
923 /* AccessShareLock should be OK, since we are not modifying the object */
924 LockSharedObject(classId, objectId, 0, AccessShareLock);
928 case AuthIdRelationId:
929 if (!SearchSysCacheExists(AUTHOID,
930 ObjectIdGetDatum(objectId),
933 (errcode(ERRCODE_UNDEFINED_OBJECT),
934 errmsg("role %u was concurrently dropped",
939 * Currently, this routine need not support any other shared
940 * object types besides roles. If we wanted to record explicit
941 * dependencies on databases or tablespaces, we'd need code along
945 case TableSpaceRelationId:
947 /* For lack of a syscache on pg_tablespace, do this: */
948 char *tablespace = get_tablespace_name(objectId);
950 if (tablespace == NULL)
952 (errcode(ERRCODE_UNDEFINED_OBJECT),
953 errmsg("tablespace %u was concurrently dropped",
961 elog(ERROR, "unrecognized shared classId: %u", classId);
967 * storeObjectDescription
968 * Append the description of a dependent object to "descs"
970 * While searching for dependencies of a shared object, we stash the
971 * descriptions of dependent objects we find in a single string, which we
972 * later pass to ereport() in the DETAIL field when somebody attempts to
973 * drop a referenced shared object.
975 * When type is LOCAL_OBJECT or SHARED_OBJECT, we expect object to be the
976 * dependent object, deptype is the dependency type, and count is not used.
977 * When type is REMOTE_OBJECT, we expect object to be the database object,
978 * and count to be nonzero; deptype is not used in this case.
981 storeObjectDescription(StringInfo descs, objectType type,
982 ObjectAddress *object,
983 SharedDependencyType deptype,
986 char *objdesc = getObjectDescription(object);
988 /* separate entries with a newline */
990 appendStringInfoChar(descs, '\n');
996 if (deptype == SHARED_DEPENDENCY_OWNER)
997 appendStringInfo(descs, _("owner of %s"), objdesc);
998 else if (deptype == SHARED_DEPENDENCY_ACL)
999 appendStringInfo(descs, _("access to %s"), objdesc);
1001 elog(ERROR, "unrecognized dependency type: %d",
1006 /* translator: %s will always be "database %s" */
1007 appendStringInfo(descs, _("%d objects in %s"), count, objdesc);
1011 elog(ERROR, "unrecognized object type: %d", type);
1019 * isSharedObjectPinned
1020 * Return whether a given shared object has a SHARED_DEPENDENCY_PIN entry.
1022 * sdepRel must be the pg_shdepend relation, already opened and suitably
1026 isSharedObjectPinned(Oid classId, Oid objectId, Relation sdepRel)
1028 bool result = false;
1033 ScanKeyInit(&key[0],
1034 Anum_pg_shdepend_refclassid,
1035 BTEqualStrategyNumber, F_OIDEQ,
1036 ObjectIdGetDatum(classId));
1037 ScanKeyInit(&key[1],
1038 Anum_pg_shdepend_refobjid,
1039 BTEqualStrategyNumber, F_OIDEQ,
1040 ObjectIdGetDatum(objectId));
1042 scan = systable_beginscan(sdepRel, SharedDependReferenceIndexId, true,
1043 SnapshotNow, 2, key);
1046 * Since we won't generate additional pg_shdepend entries for pinned
1047 * objects, there can be at most one entry referencing a pinned object.
1048 * Hence, it's sufficient to look at the first returned tuple; we don't
1051 tup = systable_getnext(scan);
1052 if (HeapTupleIsValid(tup))
1054 Form_pg_shdepend shdepForm = (Form_pg_shdepend) GETSTRUCT(tup);
1056 if (shdepForm->deptype == SHARED_DEPENDENCY_PIN)
1060 systable_endscan(scan);
1068 * Drop the objects owned by any one of the given RoleIds. If a role has
1069 * access to an object, the grant will be removed as well (but the object
1070 * will not, of course.)
1072 * We can revoke grants immediately while doing the scan, but drops are
1073 * saved up and done all at once with performMultipleDeletions. This
1074 * is necessary so that we don't get failures from trying to delete
1075 * interdependent objects in the wrong order.
1078 shdepDropOwned(List *roleids, DropBehavior behavior)
1082 ObjectAddresses *deleteobjs;
1084 deleteobjs = new_object_addresses();
1087 * We don't need this strong a lock here, but we'll call routines that
1088 * acquire RowExclusiveLock. Better get that right now to avoid potential
1089 * deadlock failures.
1091 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
1094 * For each role, find the dependent objects and drop them using the
1095 * regular (non-shared) dependency management.
1097 foreach(cell, roleids)
1099 Oid roleid = lfirst_oid(cell);
1104 /* Doesn't work for pinned objects */
1105 if (isSharedObjectPinned(AuthIdRelationId, roleid, sdepRel))
1109 obj.classId = AuthIdRelationId;
1110 obj.objectId = roleid;
1111 obj.objectSubId = 0;
1114 (errcode(ERRCODE_DEPENDENT_OBJECTS_STILL_EXIST),
1115 errmsg("cannot drop objects owned by %s because they are "
1116 "required by the database system",
1117 getObjectDescription(&obj))));
1120 ScanKeyInit(&key[0],
1121 Anum_pg_shdepend_refclassid,
1122 BTEqualStrategyNumber, F_OIDEQ,
1123 ObjectIdGetDatum(AuthIdRelationId));
1124 ScanKeyInit(&key[1],
1125 Anum_pg_shdepend_refobjid,
1126 BTEqualStrategyNumber, F_OIDEQ,
1127 ObjectIdGetDatum(roleid));
1129 scan = systable_beginscan(sdepRel, SharedDependReferenceIndexId, true,
1130 SnapshotNow, 2, key);
1132 while ((tuple = systable_getnext(scan)) != NULL)
1135 GrantObjectType objtype;
1136 InternalGrant istmt;
1137 Form_pg_shdepend sdepForm = (Form_pg_shdepend) GETSTRUCT(tuple);
1139 /* We only operate on objects in the current database */
1140 if (sdepForm->dbid != MyDatabaseId)
1143 switch (sdepForm->deptype)
1145 /* Shouldn't happen */
1146 case SHARED_DEPENDENCY_PIN:
1147 case SHARED_DEPENDENCY_INVALID:
1148 elog(ERROR, "unexpected dependency type");
1150 case SHARED_DEPENDENCY_ACL:
1151 switch (sdepForm->classid)
1153 case RelationRelationId:
1154 /* it's OK to use RELATION for a sequence */
1155 istmt.objtype = ACL_OBJECT_RELATION;
1157 case DatabaseRelationId:
1158 istmt.objtype = ACL_OBJECT_DATABASE;
1160 case ProcedureRelationId:
1161 istmt.objtype = ACL_OBJECT_FUNCTION;
1163 case LanguageRelationId:
1164 istmt.objtype = ACL_OBJECT_LANGUAGE;
1166 case NamespaceRelationId:
1167 istmt.objtype = ACL_OBJECT_NAMESPACE;
1169 case TableSpaceRelationId:
1170 istmt.objtype = ACL_OBJECT_TABLESPACE;
1173 elog(ERROR, "unexpected object type %d",
1175 /* keep compiler quiet */
1176 objtype = (GrantObjectType) 0;
1179 istmt.is_grant = false;
1180 istmt.objects = list_make1_oid(sdepForm->objid);
1181 istmt.all_privs = true;
1182 istmt.privileges = ACL_NO_RIGHTS;
1183 istmt.grantees = list_make1_oid(roleid);
1184 istmt.grant_option = false;
1185 istmt.behavior = DROP_CASCADE;
1187 ExecGrantStmt_oids(&istmt);
1189 case SHARED_DEPENDENCY_OWNER:
1190 /* Save it for deletion below */
1191 obj.classId = sdepForm->classid;
1192 obj.objectId = sdepForm->objid;
1193 obj.objectSubId = 0;
1194 add_exact_object_address(&obj, deleteobjs);
1199 systable_endscan(scan);
1202 /* the dependency mechanism does the actual work */
1203 performMultipleDeletions(deleteobjs, behavior);
1205 heap_close(sdepRel, RowExclusiveLock);
1207 free_object_addresses(deleteobjs);
1211 * shdepReassignOwned
1213 * Change the owner of objects owned by any of the roles in roleids to
1214 * newrole. Grants are not touched.
1217 shdepReassignOwned(List *roleids, Oid newrole)
1223 * We don't need this strong a lock here, but we'll call routines that
1224 * acquire RowExclusiveLock. Better get that right now to avoid potential
1225 * deadlock problems.
1227 sdepRel = heap_open(SharedDependRelationId, RowExclusiveLock);
1229 foreach(cell, roleids)
1234 Oid roleid = lfirst_oid(cell);
1236 /* Refuse to work on pinned roles */
1237 if (isSharedObjectPinned(AuthIdRelationId, roleid, sdepRel))
1241 obj.classId = AuthIdRelationId;
1242 obj.objectId = roleid;
1243 obj.objectSubId = 0;
1246 (errcode(ERRCODE_DEPENDENT_OBJECTS_STILL_EXIST),
1247 errmsg("cannot drop objects owned by %s because they are "
1248 "required by the database system",
1249 getObjectDescription(&obj))));
1252 * There's no need to tell the whole truth, which is that we
1253 * didn't track these dependencies at all ...
1257 ScanKeyInit(&key[0],
1258 Anum_pg_shdepend_refclassid,
1259 BTEqualStrategyNumber, F_OIDEQ,
1260 ObjectIdGetDatum(AuthIdRelationId));
1261 ScanKeyInit(&key[1],
1262 Anum_pg_shdepend_refobjid,
1263 BTEqualStrategyNumber, F_OIDEQ,
1264 ObjectIdGetDatum(roleid));
1266 scan = systable_beginscan(sdepRel, SharedDependReferenceIndexId, true,
1267 SnapshotNow, 2, key);
1269 while ((tuple = systable_getnext(scan)) != NULL)
1271 Form_pg_shdepend sdepForm = (Form_pg_shdepend) GETSTRUCT(tuple);
1273 /* We only operate on objects in the current database */
1274 if (sdepForm->dbid != MyDatabaseId)
1277 /* Unexpected because we checked for pins above */
1278 if (sdepForm->deptype == SHARED_DEPENDENCY_PIN)
1279 elog(ERROR, "unexpected shared pin");
1281 /* We leave non-owner dependencies alone */
1282 if (sdepForm->deptype != SHARED_DEPENDENCY_OWNER)
1285 /* Issue the appropriate ALTER OWNER call */
1286 switch (sdepForm->classid)
1288 case ConversionRelationId:
1289 AlterConversionOwner_oid(sdepForm->objid, newrole);
1292 case TypeRelationId:
1293 AlterTypeOwnerInternal(sdepForm->objid, newrole, true);
1296 case OperatorRelationId:
1297 AlterOperatorOwner_oid(sdepForm->objid, newrole);
1300 case NamespaceRelationId:
1301 AlterSchemaOwner_oid(sdepForm->objid, newrole);
1304 case RelationRelationId:
1307 * Pass recursing = true so that we don't fail on indexes,
1308 * owned sequences, etc when we happen to visit them
1309 * before their parent table.
1311 ATExecChangeOwner(sdepForm->objid, newrole, true);
1314 case ProcedureRelationId:
1315 AlterFunctionOwner_oid(sdepForm->objid, newrole);
1318 case LanguageRelationId:
1319 AlterLanguageOwner_oid(sdepForm->objid, newrole);
1323 elog(ERROR, "unexpected classid %d", sdepForm->classid);
1326 /* Make sure the next iteration will see my changes */
1327 CommandCounterIncrement();
1330 systable_endscan(scan);
1333 heap_close(sdepRel, RowExclusiveLock);